BazingaGeocoderExtension::load() - Code Metrics - Inspection of "Merge pull request #284 from teo-sk/master" - geocoder-php/BazingaGeocoderBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 054afb...cddf5a )

by Tomas

created 2020-08-12 07:24 UTC

BazingaGeocoderExtension::load() A

↳ Parent: BazingaGeocoderExtension

Complexity

Conditions	5
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	5.675

Importance

Changes

Metric	Value
dl	0
loc	31
ccs	14
cts	20
cp	0.7
rs	9.1128
c	0
b	0
f	0
cc	5
nc	6
nop	2
crap	5.675

<?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\DependencyInjection\Compiler\FactoryValidatorPass;
use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
use Bazinga\GeocoderBundle\ProviderFactory\PluginProviderFactory;
use Bazinga\GeocoderBundle\ProviderFactory\ProviderFactoryInterface;
use Faker\Generator;
use Geocoder\Dumper\Dumper;
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 Geocoder\Provider\Provider;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\HttpKernel\Kernel;

/**
 * @author 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(0, $config['fake_ip']['local_ip']);
            $definition->replaceArgument(1, $config['fake_ip']['ip']);
            $definition->replaceArgument(2, $config['fake_ip']['use_faker']);

            if ($config['fake_ip']['use_faker'] && !class_exists(Generator::class)) {
                throw new \LogicException('To enable this option, you must install fzaninotto/faker package.');
            }
        } else {
            $container->removeDefinition(FakeIpPlugin::class);
        }

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

        $container->registerForAutoconfiguration(Dumper::class)
            ->addTag('bazinga_geocoder.dumper');
    }

    private function loadProviders(ContainerBuilder $container, array $config)
    {
        foreach ($config['providers'] as $providerName => $providerConfig) {
            try {
                $factoryService = $container->getDefinition($providerConfig['factory']);
                $factoryClass = $factoryService->getClass() ?: $providerConfig['factory'];
                if (!$this->implementsProviderFactory($factoryClass)) {
                    throw new \LogicException(sprintf('Provider factory "%s" must implement ProviderFactoryInterface', $providerConfig['factory']));
                }
                // See if any option has a service reference
                $providerConfig['options'] = $this->findReferences($providerConfig['options']);
                $factoryClass::validate($providerConfig['options'], $providerName);
            } catch (ServiceNotFoundException $e) {
                // Assert: We are using a custom factory. If invalid config, it will be caught in FactoryValidatorPass
                $providerConfig['options'] = $this->findReferences($providerConfig['options']);
                FactoryValidatorPass::addFactoryServiceId($providerConfig['factory']);
            }

            $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);
            }

            if (Kernel::VERSION_ID > 40200) {
                $container->registerAliasForArgument($serviceId, Provider::class, "{$providerName}Geocoder");
            }
        }
    }

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

        if (isset($config['cache']) || isset($config['cache_lifetime']) || isset($config['cache_precision'])) {
            $cacheLifetime = isset($config['cache_lifetime']) ? (int) $config['cache_lifetime'] : null;

            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), $cacheLifetime, $config['cache_precision']]);
        }

        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'));
    }

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

        return $options;
    }

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

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


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\DependencyInjection\Compiler\FactoryValidatorPass;
17			use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
18			use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
19			use Bazinga\GeocoderBundle\ProviderFactory\PluginProviderFactory;
20			use Bazinga\GeocoderBundle\ProviderFactory\ProviderFactoryInterface;
21			use Faker\Generator;
22			use Geocoder\Dumper\Dumper;
23			use Geocoder\Plugin\Plugin\CachePlugin;
24			use Geocoder\Plugin\Plugin\LimitPlugin;
25			use Geocoder\Plugin\Plugin\LocalePlugin;
26			use Geocoder\Plugin\Plugin\LoggerPlugin;
27			use Geocoder\Plugin\PluginProvider;
28			use Geocoder\Provider\Provider;
29			use Symfony\Component\Config\Definition\Processor;
30			use Symfony\Component\Config\FileLocator;
31			use Symfony\Component\DependencyInjection\ContainerBuilder;
32			use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
33			use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
34			use Symfony\Component\DependencyInjection\Reference;
35			use Symfony\Component\HttpKernel\DependencyInjection\Extension;
36			use Symfony\Component\HttpKernel\Kernel;
37
38			/**
39			* @author William Durand <[email protected]>.
40			*/
41			class BazingaGeocoderExtension extends Extension
42			{
43	33		public function load(array $configs, ContainerBuilder $container)
44			{
45	33		$processor = new Processor();
46	33		$configuration = $this->getConfiguration($configs, $container);
47	33		$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 `46` 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...
48
49	33		$loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
50	33		$loader->load('services.yml');
51
52	33		if (true === $config['profiling']['enabled']) {
53	3		$loader->load('profiling.yml');
54			}
55
56	33		if ($config['fake_ip']['enabled']) {
57			$definition = $container->getDefinition(FakeIpPlugin::class);
58			$definition->replaceArgument(0, $config['fake_ip']['local_ip']);
59			$definition->replaceArgument(1, $config['fake_ip']['ip']);
60			$definition->replaceArgument(2, $config['fake_ip']['use_faker']);
61
62			if ($config['fake_ip']['use_faker'] && !class_exists(Generator::class)) {
63			throw new \LogicException('To enable this option, you must install fzaninotto/faker package.');
64			}
65			} else {
66	33		$container->removeDefinition(FakeIpPlugin::class);
67			}
68
69	33		$this->loadProviders($container, $config);
70
71	33		$container->registerForAutoconfiguration(Dumper::class)
72	33		->addTag('bazinga_geocoder.dumper');
73	33		}
74
75	33		private function loadProviders(ContainerBuilder $container, array $config)
76			{
77	33		foreach ($config['providers'] as $providerName => $providerConfig) {
78			try {
79	31		$factoryService = $container->getDefinition($providerConfig['factory']);
80	31		$factoryClass = $factoryService->getClass() ?: $providerConfig['factory'];
81	31		if (!$this->implementsProviderFactory($factoryClass)) {
82			throw new \LogicException(sprintf('Provider factory "%s" must implement ProviderFactoryInterface', $providerConfig['factory']));
83			}
84			// See if any option has a service reference
85	31		$providerConfig['options'] = $this->findReferences($providerConfig['options']);
86	31		$factoryClass::validate($providerConfig['options'], $providerName);
87			} catch (ServiceNotFoundException $e) {
88			// Assert: We are using a custom factory. If invalid config, it will be caught in FactoryValidatorPass
89			$providerConfig['options'] = $this->findReferences($providerConfig['options']);
90			FactoryValidatorPass::addFactoryServiceId($providerConfig['factory']);
91			}
92
93	31		$serviceId = 'bazinga_geocoder.provider.'.$providerName;
94	31		$plugins = $this->configureProviderPlugins($container, $providerConfig, $serviceId);
95
96	31		$def = $container->register($serviceId, PluginProvider::class)
97	31		->setFactory([PluginProviderFactory::class, 'createPluginProvider'])
98	31		->addArgument($plugins)
99	31		->addArgument(new Reference($providerConfig['factory']))
100	31		->addArgument($providerConfig['options']);
101
102	31		$def->addTag('bazinga_geocoder.provider');
103	31		foreach ($providerConfig['aliases'] as $alias) {
104			$container->setAlias($alias, $serviceId);
105			}
106
107	31		if (Kernel::VERSION_ID > 40200) {
108	31		$container->registerAliasForArgument($serviceId, Provider::class, "{$providerName}Geocoder");
109			}
110			}
111	33		}
112
113			/**
114			* Configure plugins for a client.
115			*/
116	31		public function configureProviderPlugins(ContainerBuilder $container, array $config, string $providerServiceId): array
117			{
118	31		$plugins = [];
119	31		foreach ($config['plugins'] as $plugin) {
120	2		if ($plugin['reference']['enabled']) {
121	2		$plugins[] = $plugin['reference']['id'];
122			}
123			}
124
125	31		if (isset($config['cache']) \|\| isset($config['cache_lifetime']) \|\| isset($config['cache_precision'])) {
126	2		$cacheLifetime = isset($config['cache_lifetime']) ? (int) $config['cache_lifetime'] : null;
127
128	2		if (null === $cacheServiceId = $config['cache']) {
129			if (!$container->has('app.cache')) {
130			throw new \LogicException('You need to specify a service for cache.');
131			}
132			$cacheServiceId = 'app.cache';
133			}
134	2		$plugins[] = $providerServiceId.'.cache';
135	2		$container->register($providerServiceId.'.cache', CachePlugin::class)
136	2		->setPublic(false)
137	2		->setArguments([new Reference($cacheServiceId), $cacheLifetime, $config['cache_precision']]);
138			}
139
140	31	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...
141			$plugins[] = $providerServiceId.'.limit';
142			$container->register($providerServiceId.'.limit', LimitPlugin::class)
143			->setPublic(false)
144			->setArguments([(int) $config['limit']]);
145			}
146
147	31	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...
148			$plugins[] = $providerServiceId.'.locale';
149			$container->register($providerServiceId.'.locale', LocalePlugin::class)
150			->setPublic(false)
151			->setArguments([$config['locale']]);
152			}
153
154	31	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...
155			$plugins[] = $providerServiceId.'.logger';
156			$container->register($providerServiceId.'.logger', LoggerPlugin::class)
157			->setPublic(false)
158			->setArguments([new Reference($config['logger'])]);
159			}
160
161	31		if ($container->has(FakeIpPlugin::class)) {
162			$plugins[] = FakeIpPlugin::class;
163			}
164
165	31		if ($container->has(GeocoderDataCollector::class)) {
166	1		$plugins[] = $providerServiceId.'.profiler';
167	1		$container->register($providerServiceId.'.profiler', ProfilingPlugin::class)
168	1		->setPublic(false)
169	1		->setArguments([substr($providerServiceId, strlen('bazinga_geocoder.provider.'))])
170	1		->addTag('bazinga_geocoder.profiling_plugin');
171			}
172
173			return array_map(function (string $id) {
174	4		return new Reference($id);
175	31		}, $plugins);
176			}
177
178			/**
179			* {@inheritdoc}
180			*/
181	33		public function getConfiguration(array $config, ContainerBuilder $container)
182			{
183	33		return new Configuration($container->getParameter('kernel.debug'));
184			}
185
186	31		private function findReferences(array $options): array
187			{
188	31		foreach ($options as $key => $value) {
189	23		if (is_array($value)) {
190	1		$options[$key] = $this->findReferences($value);
191	23		} elseif ('_service' === substr((string) $key, -8) \|\| 0 === strpos((string) $value, '@') \|\| 'service' === $key) {
192			$options[$key] = new Reference(ltrim($value, '@'));
193			}
194			}
195
196	31		return $options;
197			}
198
199			/**
200			* @param mixed $factoryClass
201			*/
202	31		private function implementsProviderFactory($factoryClass): bool
203			{
204	31		if (false === $interfaces = class_implements($factoryClass)) {
205			return false;
206			}
207
208	31		return in_array(ProviderFactoryInterface::class, $interfaces, true);
209			}
210			}
211

geocoder-php / BazingaGeocoderBundle

Push — master ( 054afb...cddf5a )

BazingaGeocoderExtension::load() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like