MigrationsExtension::loadConfiguration() - Code Metrics - Inspection of "Refresh" - Zenify/DoctrineMigrations - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32)

by Tomáš

created 2016-11-01 22:34 UTC

MigrationsExtension::loadConfiguration() B

↳ Parent: MigrationsExtension

Complexity

Conditions	2
Paths	2

Size

Total Lines	25
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	25
ccs	15
cts	15
cp	1
rs	8.8571
cc	2
eloc	15
nc	2
nop	0
crap	2

<?php

/*
 * 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\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();

		$this->compiler->parseServices(

			$containerBuilder,
			$this->loadFromFile(__DIR__ . '/../config/services.neon')

		);

		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);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
	}


	/**
	 * {@inheritdoc}
	 */
	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]);
		}
	}


	/**
	 * @return array
	 */
	private function getValidatedConfig()
	{
		$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			/*
4			* This file is part of Zenify
5			* Copyright (c) 2014 Tomas Votruba (http://tomasvotruba.cz)
6			*/
7
8			namespace Zenify\DoctrineMigrations\DI;
9
10			use Arachne\EventDispatcher\DI\EventDispatcherExtension;
11			use Doctrine\DBAL\Migrations\Tools\Console\Command\AbstractCommand;
12			use Nette\DI\CompilerExtension;
13			use Symfony\Component\Console\Application;
14			use Zenify\DoctrineMigrations\CodeStyle\CodeStyle;
15			use Zenify\DoctrineMigrations\Configuration\Configuration;
16			use Zenify\DoctrineMigrations\EventSubscriber\ChangeCodingStandardEventSubscriber;
17			use Zenify\DoctrineMigrations\EventSubscriber\RegisterMigrationsEventSubscriber;
18			use Zenify\DoctrineMigrations\EventSubscriber\SetConsoleOutputEventSubscriber;
19			use Zenify\DoctrineMigrations\Exception\DI\MissingExtensionException;
20
21
22			final class MigrationsExtension extends CompilerExtension
23			{
24
25			/**
26			* @var string[]
27			*/
28			private $defaults = [
29			'table' => 'doctrine_migrations',
30			'column' => 'version',
31			'directory' => '%appDir%/../migrations',
32			'namespace' => 'Migrations',
33			'codingStandard' => CodeStyle::INDENTATION_TABS,
34			'versionsOrganization' => NULL,
35			];
36
37			/**
38			* @var string[]
39			*/
40			private $subscribers = [
41			ChangeCodingStandardEventSubscriber::class,
42			RegisterMigrationsEventSubscriber::class,
43			SetConsoleOutputEventSubscriber::class,
44			];
45
46
47	6		public function loadConfiguration()
48			{
49	6		$this->ensureEventDispatcherExtensionIsRegistered();
50
51	5		$containerBuilder = $this->getContainerBuilder();
52
53	5		$this->compiler->parseServices(
			0 ignored issues – show Deprecated Code introduced 2016-08-09 16:30 UTC by Report Bug Copy Issue Report The method `Nette\DI\Compiler::parseServices()` has been deprecated. This method has been deprecated. Loading history...
54			$containerBuilder,
55	5		$this->loadFromFile(__DIR__ . '/../config/services.neon')
			0 ignored issues – show Bug introduced 2015-11-22 16:07 UTC by Report Bug Copy Issue Report It seems like `$this->loadFromFile(__DI.../config/services.neon')` targeting `Nette\DI\CompilerExtension::loadFromFile()` can also be of type `string`; however, `Nette\DI\Compiler::parseServices()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
56			);
57
58	5		foreach ($this->subscribers as $key => $subscriber) {
59	5		$containerBuilder->addDefinition($this->prefix('listener' . $key))
60	5		->setClass($subscriber)
61	5		->addTag(EventDispatcherExtension::TAG_SUBSCRIBER);
62			}
63
64	5		$config = $this->getValidatedConfig();
65
66	5		$containerBuilder->addDefinition($this->prefix('codeStyle'))
67	5		->setClass(CodeStyle::class)
68	5		->setArguments([$config['codingStandard']]);
69
70	5		$this->addConfigurationDefinition($config);
			0 ignored issues – show Bug introduced 2016-08-10 19:10 UTC by Report Bug Copy Issue Report It seems like `$config` defined by `$this->getValidatedConfig()` on line `64` can also be of type `string`; however, `Zenify\DoctrineMigration...nfigurationDefinition()` 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...
71	5		}
72
73
74			/**
75			* {@inheritdoc}
76			*/
77	4		public function beforeCompile()
78			{
79	4		$containerBuilder = $this->getContainerBuilder();
80	4		$containerBuilder->prepareClassList();
81
82	4		$this->setConfigurationToCommands();
83	4		$this->loadCommandsToApplication();
84	4		}
85
86
87	5		private function addConfigurationDefinition(array $config)
88			{
89	5		$containerBuilder = $this->getContainerBuilder();
90	5		$configurationDefinition = $containerBuilder->addDefinition($this->prefix('configuration'));
91			$configurationDefinition
92	5		->setClass(Configuration::class)
93	5		->addSetup('setMigrationsTableName', [$config['table']])
94	5		->addSetup('setMigrationsColumnName', [$config['column']])
95	5		->addSetup('setMigrationsDirectory', [$config['directory']])
96	5		->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	5		}
105
106
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	4		$commandDefinition->addSetup('setMigrationConfiguration', ['@' . $configurationDefinition->getClass()]);
114			}
115	4		}
116
117
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			{
120	4		$containerBuilder = $this->getContainerBuilder();
121	4		$applicationDefinition = $containerBuilder->getDefinition($containerBuilder->getByType(Application::class));
122	4		foreach ($containerBuilder->findByType(AbstractCommand::class) as $name => $commandDefinition) {
123	4		$applicationDefinition->addSetup('add', ['@' . $name]);
124			}
125	4		}
126
127
128			/**
129			* @return array
130			*/
131	5		private function getValidatedConfig()
132			{
133	5		$configuration = $this->getConfig($this->defaults);
134	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 `133` 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...
135	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...
136
137	5		return $configuration;
138			}
139
140
141	6		private function ensureEventDispatcherExtensionIsRegistered()
142			{
143	6		if ( ! $this->compiler->getExtensions(EventDispatcherExtension::class)) {
144	1		throw new MissingExtensionException(
145	1		sprintf('Please register required extension "%s" to your config.', EventDispatcherExtension::class)
146			);
147			}
148	5		}
149
150			}
151

Zenify / DoctrineMigrations

Pull Request — master (#32)

MigrationsExtension::loadConfiguration() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like