BazingaGeocoderExtension::load() - Code Metrics - Inspection of "Merge pull request #256 from norkunas/autotag" - geocoder-php/BazingaGeocoderBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 918599...285013 )

by Tomas

created 2019-10-21 06:29 UTC

BazingaGeocoderExtension::load() A

↳ Parent: BazingaGeocoderExtension

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	3.0175

Importance

Changes

Metric	Value
dl	0
loc	25
ccs	14
cts	16
cp	0.875
rs	9.52
c	0
b	0
f	0
cc	3
nc	4
nop	2
crap	3.0175

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

geocoder-php / BazingaGeocoderBundle

Push — master ( 918599...285013 )

BazingaGeocoderExtension::load() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like