MigrationsExtension::addConfigurationDefinition() - Code Metrics - Zenify/DoctrineMigrations - Measure and Improve Code Quality continuously with Scrutinizer

MigrationsExtension::addConfigurationDefinition() A
last analyzed 2016-12-29 23:33 UTC

↳ Parent: MigrationsExtension

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3.0416

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	10
cts	12
cp	0.8333
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	13
nc	3
nop	1
crap	3.0416

<?php

declare(strict_types=1);

/*
 * This file is part of Zenify
 * Copyright (c) 2014 Tomas Votruba (http://tomasvotruba.cz)
 */

namespace Zenify\DoctrineMigrations\DI;

use Arachne\EventDispatcher\DI\EventDispatcherExtension;
use Doctrine\DBAL\Migrations\Tools\Console\Command\AbstractCommand;
use Nette\DI\Compiler;
use Nette\DI\CompilerExtension;
use Symfony\Component\Console\Application;
use Zenify\DoctrineMigrations\CodeStyle\CodeStyle;
use Zenify\DoctrineMigrations\Configuration\Configuration;
use Zenify\DoctrineMigrations\EventSubscriber\ChangeCodingStandardEventSubscriber;
use Zenify\DoctrineMigrations\EventSubscriber\RegisterMigrationsEventSubscriber;
use Zenify\DoctrineMigrations\EventSubscriber\SetConsoleOutputEventSubscriber;
use Zenify\DoctrineMigrations\Exception\DI\MissingExtensionException;


final class MigrationsExtension extends CompilerExtension
{

	/**
	 * @var string[]
	 */
	private $defaults = [
		'table' => 'doctrine_migrations',
		'column' => 'version',
		'directory' => '%appDir%/../migrations',
		'namespace' => 'Migrations',
		'codingStandard' => CodeStyle::INDENTATION_TABS,
		'versionsOrganization' => NULL,
	];

	/**
	 * @var string[]
	 */
	private $subscribers = [
		ChangeCodingStandardEventSubscriber::class,
		RegisterMigrationsEventSubscriber::class,
		SetConsoleOutputEventSubscriber::class,
	];


	public function loadConfiguration()
	{
		$this->ensureEventDispatcherExtensionIsRegistered();

		$containerBuilder = $this->getContainerBuilder();

		Compiler::loadDefinitions(
			$containerBuilder,
			$this->loadFromFile(__DIR__ . '/../config/services.neon')['services']
		);

		foreach ($this->subscribers as $key => $subscriber) {
			$containerBuilder->addDefinition($this->prefix('listener' . $key))
				->setClass($subscriber)
				->addTag(EventDispatcherExtension::TAG_SUBSCRIBER);
		}

		$config = $this->getValidatedConfig();

		$containerBuilder->addDefinition($this->prefix('codeStyle'))
			->setClass(CodeStyle::class)
			->setArguments([$config['codingStandard']]);

		$this->addConfigurationDefinition($config);
	}


	public function beforeCompile()
	{
		$containerBuilder = $this->getContainerBuilder();
		$containerBuilder->prepareClassList();

		$this->setConfigurationToCommands();
		$this->loadCommandsToApplication();
	}


	private function addConfigurationDefinition(array $config)
	{
		$containerBuilder = $this->getContainerBuilder();
		$configurationDefinition = $containerBuilder->addDefinition($this->prefix('configuration'));
		$configurationDefinition
			->setClass(Configuration::class)
			->addSetup('setMigrationsTableName', [$config['table']])
			->addSetup('setMigrationsColumnName', [$config['column']])
			->addSetup('setMigrationsDirectory', [$config['directory']])
			->addSetup('setMigrationsNamespace', [$config['namespace']]);

		if ($config['versionsOrganization'] === Configuration::VERSIONS_ORGANIZATION_BY_YEAR) {
			$configurationDefinition->addSetup('setMigrationsAreOrganizedByYear');

		} elseif ($config['versionsOrganization'] === Configuration::VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH) {
			$configurationDefinition->addSetup('setMigrationsAreOrganizedByYearAndMonth');
		}
	}


	private function setConfigurationToCommands()

	{
		$containerBuilder = $this->getContainerBuilder();
		$configurationDefinition = $containerBuilder->getDefinition($containerBuilder->getByType(Configuration::class));

		foreach ($containerBuilder->findByType(AbstractCommand::class) as $commandDefinition) {
			$commandDefinition->addSetup('setMigrationConfiguration', ['@' . $configurationDefinition->getClass()]);
		}
	}


	private function loadCommandsToApplication()

	{
		$containerBuilder = $this->getContainerBuilder();
		$applicationDefinition = $containerBuilder->getDefinition($containerBuilder->getByType(Application::class));
		foreach ($containerBuilder->findByType(AbstractCommand::class) as $name => $commandDefinition) {
			$applicationDefinition->addSetup('add', ['@' . $name]);
		}
	}


	private function getValidatedConfig() : array
	{
		$configuration = $this->getConfig($this->defaults);
		$this->validateConfig($configuration);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		$configuration['directory'] = $this->getContainerBuilder()->expand($configuration['directory']);


		return $configuration;
	}


	private function ensureEventDispatcherExtensionIsRegistered()
	{
		if ( ! $this->compiler->getExtensions(EventDispatcherExtension::class)) {
			throw new MissingExtensionException(
				sprintf('Please register required extension "%s" to your config.', EventDispatcherExtension::class)
			);
		}
	}

}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of Zenify
7			* Copyright (c) 2014 Tomas Votruba (http://tomasvotruba.cz)
8			*/
9
10			namespace Zenify\DoctrineMigrations\DI;
11
12			use Arachne\EventDispatcher\DI\EventDispatcherExtension;
13			use Doctrine\DBAL\Migrations\Tools\Console\Command\AbstractCommand;
14			use Nette\DI\Compiler;
15			use Nette\DI\CompilerExtension;
16			use Symfony\Component\Console\Application;
17			use Zenify\DoctrineMigrations\CodeStyle\CodeStyle;
18			use Zenify\DoctrineMigrations\Configuration\Configuration;
19			use Zenify\DoctrineMigrations\EventSubscriber\ChangeCodingStandardEventSubscriber;
20			use Zenify\DoctrineMigrations\EventSubscriber\RegisterMigrationsEventSubscriber;
21			use Zenify\DoctrineMigrations\EventSubscriber\SetConsoleOutputEventSubscriber;
22			use Zenify\DoctrineMigrations\Exception\DI\MissingExtensionException;
23
24
25			final class MigrationsExtension extends CompilerExtension
26			{
27
28			/**
29			* @var string[]
30			*/
31			private $defaults = [
32			'table' => 'doctrine_migrations',
33			'column' => 'version',
34			'directory' => '%appDir%/../migrations',
35			'namespace' => 'Migrations',
36			'codingStandard' => CodeStyle::INDENTATION_TABS,
37			'versionsOrganization' => NULL,
38			];
39
40			/**
41			* @var string[]
42			*/
43			private $subscribers = [
44			ChangeCodingStandardEventSubscriber::class,
45			RegisterMigrationsEventSubscriber::class,
46			SetConsoleOutputEventSubscriber::class,
47	6		];
48
49	6
50			public function loadConfiguration()
51	5		{
52			$this->ensureEventDispatcherExtensionIsRegistered();
53	5
54			$containerBuilder = $this->getContainerBuilder();
55	5
56			Compiler::loadDefinitions(
57			$containerBuilder,
58	5		$this->loadFromFile(__DIR__ . '/../config/services.neon')['services']
59	5		);
60	5
61	5		foreach ($this->subscribers as $key => $subscriber) {
62			$containerBuilder->addDefinition($this->prefix('listener' . $key))
63			->setClass($subscriber)
64	5		->addTag(EventDispatcherExtension::TAG_SUBSCRIBER);
65			}
66	5
67	5		$config = $this->getValidatedConfig();
68	5
69			$containerBuilder->addDefinition($this->prefix('codeStyle'))
70	5		->setClass(CodeStyle::class)
71	5		->setArguments([$config['codingStandard']]);
72
73			$this->addConfigurationDefinition($config);
74	4		}
75
76	4
77	4		public function beforeCompile()
78			{
79	4		$containerBuilder = $this->getContainerBuilder();
80	4		$containerBuilder->prepareClassList();
81	4
82			$this->setConfigurationToCommands();
83			$this->loadCommandsToApplication();
84	5		}
85
86	5
87	5		private function addConfigurationDefinition(array $config)
88			{
89	5		$containerBuilder = $this->getContainerBuilder();
90	5		$configurationDefinition = $containerBuilder->addDefinition($this->prefix('configuration'));
91	5		$configurationDefinition
92	5		->setClass(Configuration::class)
93	5		->addSetup('setMigrationsTableName', [$config['table']])
94			->addSetup('setMigrationsColumnName', [$config['column']])
95	5		->addSetup('setMigrationsDirectory', [$config['directory']])
96			->addSetup('setMigrationsNamespace', [$config['namespace']]);
97
98	5		if ($config['versionsOrganization'] === Configuration::VERSIONS_ORGANIZATION_BY_YEAR) {
99			$configurationDefinition->addSetup('setMigrationsAreOrganizedByYear');
100
101	5		} elseif ($config['versionsOrganization'] === Configuration::VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH) {
102			$configurationDefinition->addSetup('setMigrationsAreOrganizedByYearAndMonth');
103			}
104	4		}
105
106	4
107	4	View Code Duplication	private function setConfigurationToCommands()
			0 ignored issues – show Duplication introduced 2015-11-22 16:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108			{
109	4		$containerBuilder = $this->getContainerBuilder();
110	4		$configurationDefinition = $containerBuilder->getDefinition($containerBuilder->getByType(Configuration::class));
111
112	4		foreach ($containerBuilder->findByType(AbstractCommand::class) as $commandDefinition) {
113			$commandDefinition->addSetup('setMigrationConfiguration', ['@' . $configurationDefinition->getClass()]);
114			}
115	4		}
116
117	4
118	4	View Code Duplication	private function loadCommandsToApplication()
			0 ignored issues – show Duplication introduced 2015-11-22 16:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
119	4		{
120	4		$containerBuilder = $this->getContainerBuilder();
121			$applicationDefinition = $containerBuilder->getDefinition($containerBuilder->getByType(Application::class));
122	4		foreach ($containerBuilder->findByType(AbstractCommand::class) as $name => $commandDefinition) {
123			$applicationDefinition->addSetup('add', ['@' . $name]);
124			}
125			}
126
127
128	5		private function getValidatedConfig() : array
129			{
130	5		$configuration = $this->getConfig($this->defaults);
131	5		$this->validateConfig($configuration);
			0 ignored issues – show Bug introduced 2016-08-09 16:30 UTC by Report Bug Copy Issue Report It seems like `$configuration` defined by `$this->getConfig($this->defaults)` on line `130` can also be of type `string`; however, `Nette\DI\CompilerExtension::validateConfig()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
132	5		$configuration['directory'] = $this->getContainerBuilder()->expand($configuration['directory']);
			0 ignored issues – show Deprecated Code introduced 2015-11-22 16:07 UTC by Report Bug Copy Issue Report The method `Nette\DI\ContainerBuilder::expand()` has been deprecated. This method has been deprecated. Loading history...
133
134	5		return $configuration;
135			}
136
137
138	6		private function ensureEventDispatcherExtensionIsRegistered()
139			{
140	6		if ( ! $this->compiler->getExtensions(EventDispatcherExtension::class)) {
141	1		throw new MissingExtensionException(
142	1		sprintf('Please register required extension "%s" to your config.', EventDispatcherExtension::class)
143			);
144			}
145	5		}
146
147			}
148

Zenify / DoctrineMigrations

MigrationsExtension::addConfigurationDefinition() A last analyzed 2016-12-29 23:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

MigrationsExtension::addConfigurationDefinition() A
last analyzed 2016-12-29 23:33 UTC