BazingaGeocoderExtension::implementsPoviderFactory() - Code Metrics - Inspection of "Updating the documentation for 5.0 (#158)" - geocoder-php/BazingaGeocoderBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c5a4d3...721d0a )

by Tobias

created 2017-08-06 16:34 UTC

implementsPoviderFactory() A

↳ Parent: BazingaGeocoderExtension

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	3
cts	4
cp	0.75
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1
crap	2.0625

<?php

declare(strict_types=1);

/*
 * This file is part of the BazingaGeocoderBundle package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Bazinga\GeocoderBundle\DependencyInjection;

use Bazinga\GeocoderBundle\DataCollector\GeocoderDataCollector;
use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
use Bazinga\GeocoderBundle\ProviderFactory\PluginProviderFactory;
use Bazinga\GeocoderBundle\ProviderFactory\ProviderFactoryInterface;
use Geocoder\Plugin\Plugin\CachePlugin;
use Geocoder\Plugin\Plugin\LimitPlugin;
use Geocoder\Plugin\Plugin\LocalePlugin;
use Geocoder\Plugin\Plugin\LoggerPlugin;
use Geocoder\Plugin\PluginProvider;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

/**
 * William Durand <[email protected]>.
 */
class BazingaGeocoderExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container)
    {
        $processor = new Processor();
        $configuration = $this->getConfiguration($configs, $container);
        $config = $processor->processConfiguration($configuration, $configs);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.yml');

        if (true === $config['profiling']['enabled']) {
            $loader->load('profiling.yml');
        }

        if ($config['fake_ip']['enabled']) {
            $definition = $container->getDefinition(FakeIpPlugin::class);
            $definition->replaceArgument(1, $config['fake_ip']['ip']);
        } else {
            $container->removeDefinition(FakeIpPlugin::class);
        }

        $this->loadProviders($container, $config);
    }

    private function loadProviders(ContainerBuilder $container, array $config)
    {
        foreach ($config['providers'] as $providerName => $providerConfig) {
            $factoryService = $container->getDefinition($providerConfig['factory']);
            $factoryClass = $factoryService->getClass() ?: $providerConfig['factory'];
            if (!$this->implementsPoviderFactory($factoryClass)) {
                throw new \LogicException(sprintf('Provider factory "%s" must implement ProviderFactoryInterface', $providerConfig['factory']));
            }
            $factoryClass::validate($providerConfig['options'], $providerName);

            // See if any option has a service reference
            $providerConfig['options'] = $this->findReferences($providerConfig['options']);

            $serviceId = 'bazinga_geocoder.provider.'.$providerName;
            $plugins = $this->configureProviderPlugins($container, $providerConfig, $serviceId);

            $def = $container->register($serviceId, PluginProvider::class)
                ->setFactory([PluginProviderFactory::class, 'createPluginProvider'])
                ->addArgument($plugins)
                ->addArgument(new Reference($providerConfig['factory']))
                ->addArgument($providerConfig['options']);

            $def->addTag('bazinga_geocoder.provider');
            foreach ($providerConfig['aliases'] as $alias) {
                $container->setAlias($alias, $serviceId);
            }
        }
    }

    /**
     * Configure plugins for a client.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     * @param string           $providerServiceId
     *
     * @return array
     */
    public function configureProviderPlugins(ContainerBuilder $container, array $config, string $providerServiceId): array
    {
        $plugins = [];
        foreach ($config['plugins'] as $plugin) {
            $plugins[] = $plugin['id'];
        }

        if (isset($config['cache']) || isset($config['cache_lifetime'])) {
            if (null === $cacheServiceId = $config['cache']) {
                if (!$container->has('app.cache')) {
                    throw new \LogicException('You need to specify a service for cache.');
                }
                $cacheServiceId = 'app.cache';
            }
            $plugins[] = $providerServiceId.'.cache';
            $container->register($providerServiceId.'.cache', CachePlugin::class)
                ->setPublic(false)
                ->setArguments([new Reference($cacheServiceId), (int) $config['cache_lifetime']]);
        }

        if (isset($config['limit'])) {

            $plugins[] = $providerServiceId.'.limit';
            $container->register($providerServiceId.'.limit', LimitPlugin::class)
                ->setPublic(false)
                ->setArguments([(int) $config['limit']]);
        }

        if (isset($config['locale'])) {

            $plugins[] = $providerServiceId.'.locale';
            $container->register($providerServiceId.'.locale', LocalePlugin::class)
                ->setPublic(false)
                ->setArguments([$config['locale']]);
        }

        if (isset($config['logger'])) {

            $plugins[] = $providerServiceId.'.logger';
            $container->register($providerServiceId.'.logger', LoggerPlugin::class)
                ->setPublic(false)
                ->setArguments([new Reference($config['logger'])]);
        }

        if ($container->has(FakeIpPlugin::class)) {
            $plugins[] = FakeIpPlugin::class;
        }

        if ($container->has(GeocoderDataCollector::class)) {
            $plugins[] = $providerServiceId.'.profiler';
            $container->register($providerServiceId.'.profiler', ProfilingPlugin::class)
                ->setPublic(false)
                ->setArguments([substr($providerServiceId, strlen('bazinga_geocoder.provider.'))])
                ->addTag('bazinga_geocoder.profiling_plugin');
        }

        return array_map(function (string $id) {
            return new Reference($id);
        }, $plugins);
    }

    /**
     * {@inheritdoc}
     */
    public function getConfiguration(array $config, ContainerBuilder $container)
    {
        return new Configuration($container->getParameter('kernel.debug'));
    }

    /**
     * @param array $options
     *
     * @return array
     */
    private function findReferences(array $options): array
    {
        foreach ($options as $key => $value) {
            if (is_array($value)) {
                $options[$key] = $this->findReferences($value);
            } elseif (substr((string) $key, -8) === '_service' || strpos((string) $value, '@') === 0 || $key === 'service') {
                $options[$key] = new Reference(ltrim($value, '@'));
            }
        }

        return $options;
    }

    /**
     * @param mixed $factoryClass
     *
     * @return bool
     */
    private function implementsPoviderFactory($factoryClass): bool
    {
        if (false === $interfaces = class_implements($factoryClass)) {
            return false;
        }

        return in_array(ProviderFactoryInterface::class, $interfaces);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the BazingaGeocoderBundle package.
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*
10			* @license MIT License
11			*/
12
13			namespace Bazinga\GeocoderBundle\DependencyInjection;
14
15			use Bazinga\GeocoderBundle\DataCollector\GeocoderDataCollector;
16			use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
17			use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
18			use Bazinga\GeocoderBundle\ProviderFactory\PluginProviderFactory;
19			use Bazinga\GeocoderBundle\ProviderFactory\ProviderFactoryInterface;
20			use Geocoder\Plugin\Plugin\CachePlugin;
21			use Geocoder\Plugin\Plugin\LimitPlugin;
22			use Geocoder\Plugin\Plugin\LocalePlugin;
23			use Geocoder\Plugin\Plugin\LoggerPlugin;
24			use Geocoder\Plugin\PluginProvider;
25			use Symfony\Component\Config\Definition\Processor;
26			use Symfony\Component\Config\FileLocator;
27			use Symfony\Component\DependencyInjection\ContainerBuilder;
28			use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
29			use Symfony\Component\DependencyInjection\Reference;
30			use Symfony\Component\HttpKernel\DependencyInjection\Extension;
31
32			/**
33			* William Durand <[email protected]>.
34			*/
35			class BazingaGeocoderExtension extends Extension
36			{
37	23		public function load(array $configs, ContainerBuilder $container)
38			{
39	23		$processor = new Processor();
40	23		$configuration = $this->getConfiguration($configs, $container);
41	23		$config = $processor->processConfiguration($configuration, $configs);
			0 ignored issues – show Bug introduced 2017-07-06 18:57 UTC by Report Bug Copy Issue Report It seems like `$configuration` defined by `$this->getConfiguration($configs, $container)` on line `40` can be `null`; however, `Symfony\Component\Config...:processConfiguration()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
42
43	23		$loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
44	23		$loader->load('services.yml');
45
46	23		if (true === $config['profiling']['enabled']) {
47	1		$loader->load('profiling.yml');
48			}
49
50	23		if ($config['fake_ip']['enabled']) {
51			$definition = $container->getDefinition(FakeIpPlugin::class);
52			$definition->replaceArgument(1, $config['fake_ip']['ip']);
53			} else {
54	23		$container->removeDefinition(FakeIpPlugin::class);
55			}
56
57	23		$this->loadProviders($container, $config);
58	23		}
59
60	23		private function loadProviders(ContainerBuilder $container, array $config)
61			{
62	23		foreach ($config['providers'] as $providerName => $providerConfig) {
63	22		$factoryService = $container->getDefinition($providerConfig['factory']);
64	22		$factoryClass = $factoryService->getClass() ?: $providerConfig['factory'];
65	22		if (!$this->implementsPoviderFactory($factoryClass)) {
66			throw new \LogicException(sprintf('Provider factory "%s" must implement ProviderFactoryInterface', $providerConfig['factory']));
67			}
68	22		$factoryClass::validate($providerConfig['options'], $providerName);
69
70			// See if any option has a service reference
71	22		$providerConfig['options'] = $this->findReferences($providerConfig['options']);
72
73	22		$serviceId = 'bazinga_geocoder.provider.'.$providerName;
74	22		$plugins = $this->configureProviderPlugins($container, $providerConfig, $serviceId);
75
76	22		$def = $container->register($serviceId, PluginProvider::class)
77	22		->setFactory([PluginProviderFactory::class, 'createPluginProvider'])
78	22		->addArgument($plugins)
79	22		->addArgument(new Reference($providerConfig['factory']))
80	22		->addArgument($providerConfig['options']);
81
82	22		$def->addTag('bazinga_geocoder.provider');
83	22		foreach ($providerConfig['aliases'] as $alias) {
84	22		$container->setAlias($alias, $serviceId);
85			}
86			}
87	23		}
88
89			/**
90			* Configure plugins for a client.
91			*
92			* @param ContainerBuilder $container
93			* @param array $config
94			* @param string $providerServiceId
95			*
96			* @return array
97			*/
98	22		public function configureProviderPlugins(ContainerBuilder $container, array $config, string $providerServiceId): array
99			{
100	22		$plugins = [];
101	22		foreach ($config['plugins'] as $plugin) {
102			$plugins[] = $plugin['id'];
103			}
104
105	22		if (isset($config['cache']) \|\| isset($config['cache_lifetime'])) {
106	1		if (null === $cacheServiceId = $config['cache']) {
107			if (!$container->has('app.cache')) {
108			throw new \LogicException('You need to specify a service for cache.');
109			}
110			$cacheServiceId = 'app.cache';
111			}
112	1		$plugins[] = $providerServiceId.'.cache';
113	1		$container->register($providerServiceId.'.cache', CachePlugin::class)
114	1		->setPublic(false)
115	1		->setArguments([new Reference($cacheServiceId), (int) $config['cache_lifetime']]);
116			}
117
118	22	View Code Duplication	if (isset($config['limit'])) {
			0 ignored issues – show Duplication introduced 2017-08-03 16:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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			$plugins[] = $providerServiceId.'.limit';
120			$container->register($providerServiceId.'.limit', LimitPlugin::class)
121			->setPublic(false)
122			->setArguments([(int) $config['limit']]);
123			}
124
125	22	View Code Duplication	if (isset($config['locale'])) {
			0 ignored issues – show Duplication introduced 2017-08-03 16:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
126			$plugins[] = $providerServiceId.'.locale';
127			$container->register($providerServiceId.'.locale', LocalePlugin::class)
128			->setPublic(false)
129			->setArguments([$config['locale']]);
130			}
131
132	22	View Code Duplication	if (isset($config['logger'])) {
			0 ignored issues – show Duplication introduced 2017-08-03 16:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
133			$plugins[] = $providerServiceId.'.logger';
134			$container->register($providerServiceId.'.logger', LoggerPlugin::class)
135			->setPublic(false)
136			->setArguments([new Reference($config['logger'])]);
137			}
138
139	22		if ($container->has(FakeIpPlugin::class)) {
140			$plugins[] = FakeIpPlugin::class;
141			}
142
143	22		if ($container->has(GeocoderDataCollector::class)) {
144			$plugins[] = $providerServiceId.'.profiler';
145			$container->register($providerServiceId.'.profiler', ProfilingPlugin::class)
146			->setPublic(false)
147			->setArguments([substr($providerServiceId, strlen('bazinga_geocoder.provider.'))])
148			->addTag('bazinga_geocoder.profiling_plugin');
149			}
150
151	22		return array_map(function (string $id) {
152	1		return new Reference($id);
153	22		}, $plugins);
154			}
155
156			/**
157			* {@inheritdoc}
158			*/
159	23		public function getConfiguration(array $config, ContainerBuilder $container)
160			{
161	23		return new Configuration($container->getParameter('kernel.debug'));
162			}
163
164			/**
165			* @param array $options
166			*
167			* @return array
168			*/
169	22		private function findReferences(array $options): array
170			{
171	22		foreach ($options as $key => $value) {
172	18		if (is_array($value)) {
173	1		$options[$key] = $this->findReferences($value);
174	18		} elseif (substr((string) $key, -8) === '_service' \|\| strpos((string) $value, '@') === 0 \|\| $key === 'service') {
175	18		$options[$key] = new Reference(ltrim($value, '@'));
176			}
177			}
178
179	22		return $options;
180			}
181
182			/**
183			* @param mixed $factoryClass
184			*
185			* @return bool
186			*/
187	22		private function implementsPoviderFactory($factoryClass): bool
188			{
189	22		if (false === $interfaces = class_implements($factoryClass)) {
190			return false;
191			}
192
193	22		return in_array(ProviderFactoryInterface::class, $interfaces);
194			}
195			}
196

geocoder-php / BazingaGeocoderBundle

Push — master ( c5a4d3...721d0a )

implementsPoviderFactory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like