Oauth::getType() - Code Metrics - Inspection of "bc fix" - ozo2003/HelperBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (a0cc06)

by Dāvis

created 2017-10-13 07:16 UTC

Oauth::getType() A

↳ Parent: Oauth

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Sludio\HelperBundle\DependencyInjection\Component;

use LogicException;
use Sludio\HelperBundle\Oauth\Configurator;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Processor;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

class Oauth implements Extensionable
{
    protected $checkExternalClassExistence;


    protected $configurators = [];

    protected $type;

    /**
     * List of available Oauth providers
     * @var array
     */
    protected static $supportedProviderTypes = [
        'custom' => Configurator\CustomProviderConfigurator::class,
        'facebook' => Configurator\FacebookProviderConfigurator::class,
        'google' => Configurator\GoogleProviderConfigurator::class,
        'twitter' => Configurator\TwitterProviderConfigurator::class,
        'draugiem' => Configurator\DraugiemProviderConfigurator::class,
    ];

    public function __construct($checkExternalClassExistence = true)

    {
        $this->checkExternalClassExistence = $checkExternalClassExistence;
    }

    public static function getAllSupportedTypes()
    {
        return array_keys(self::$supportedProviderTypes);
    }

    public function getConfigurator($type)

    {
        if (!isset($this->configurators[$type])) {
            $class = self::$supportedProviderTypes[$type];

            $this->configurators[$type] = new $class();
        }

        return $this->configurators[$type];
    }

    public function buildClientConfiguration(NodeDefinition &$node)
    {
        $optionsNode = $node->children();

        // @formatter:off
        $optionsNode
            ->scalarNode('client_id')->isRequired()->cannotBeEmpty()->end()
            ->scalarNode('client_secret')->isRequired()->cannotBeEmpty()->end()
            ->booleanNode('use_state')->defaultValue(true)->end()
        ;
        // @formatter:on

        $this->getConfigurator($this->getType())->buildConfiguration($optionsNode);
        $optionsNode->end();
    }

    public function configureClient(ContainerBuilder $container, $clientServiceKey, array $options = [])
    {
        $providerClass = $options['provider_class'];
        if ($this->checkExternalClassExistence && !class_exists($providerClass)) {
            throw new LogicException(sprintf('Class "%s" does not exist.', $providerClass));
        }

        $providerServiceKey = sprintf('sludio_helper.oauth.provider.%s', $clientServiceKey);

        $providerDefinition = $container->register($providerServiceKey, $providerClass);
        $providerDefinition->setPublic(false);

        $providerDefinition->setFactory([
            new Reference('sludio_helper.oauth.provider_factory'),
            'createProvider',
        ]);

        $mandatory = [
            $providerClass,
            $options['provider_options'],
        ];

        $optional = [];

        if (isset($options['provider_options']['params'])) {
            $optional[] = $options['provider_options']['params'];
        }

        $providerDefinition->setArguments(array_merge($mandatory, $optional));

        $clientServiceKey = sprintf('sludio_helper.oauth.client.%s', $clientServiceKey);
        $clientClass = $options['client_class'];
        $clientDefinition = $container->register($clientServiceKey, $clientClass);
        $clientDefinition->setArguments([
            new Reference($providerServiceKey),
            new Reference('request_stack'),
            new Reference('sludio_helper.logger'),
        ]);

        if (!$options['state']) {
            $clientDefinition->addMethodCall('setAsStateless');
        }

        return $clientServiceKey;
    }

    public function configure(ContainerBuilder &$container)
    {
        $clientConfigurations = $container->getParameter('sludio_helper.oauth.clients');
        $clientServiceKeys = [];
        foreach ($clientConfigurations as $key => $clientConfig) {
            $tree = new TreeBuilder();
            $processor = new Processor();

            if (!isset($clientConfig['type'])) {
                throw new InvalidConfigurationException(sprintf('Your "sludio_helper_oauth_client.clients.%s" config entry is missing the "type" key.', $key));
            }

            $this->type = $clientConfig['type'];
            unset($clientConfig['type']);
            if (!isset(self::$supportedProviderTypes[$this->type])) {

                $supportedKeys = array_keys(self::$supportedProviderTypes);
                sort($supportedKeys);
                throw new InvalidConfigurationException(sprintf('The "sludio_helper_oauth_client.clients" config "type" key "%s" is not supported. We support: %s', $this->type, implode(', ', $supportedKeys)));
            }

            $node = $tree->root('sludio_helper_oauth_client/clients/'.$key);
            $this->buildClientConfiguration($node);
            $config = $processor->process($tree->buildTree(), [$clientConfig]);

            $configurator = $this->getConfigurator($this->type);

            $options = [
                'provider_class' => $configurator->getProviderClass($config),
                'client_class' => $configurator->getClientClass($config),
                'provider_options' => $configurator->getProviderOptions($config),
                'state' => $config['use_state'],
            ];

            $clientServiceKey = $this->configureClient($container, $key, $options);

            $service = [
                'key' => $clientServiceKey,
            ];
            if (isset($config['provider_options']) && isset($config['provider_options']['name'])) {

                $service['name'] = $config['provider_options']['name'];
            } else {
                $service['name'] = ucfirst($key);
            }

            $clientServiceKeys[$key] = $service;
        }

        $container->getDefinition('sludio_helper.oauth.registry')->replaceArgument(1, $clientServiceKeys);
        $container->getDefinition('sludio_helper.registry')->replaceArgument(1, $clientServiceKeys);
    }

    /**
     * Get the value of Type
     *
     * @return mixed
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Set the value of Type
     *
     * @param mixed type
filter:
    dependency_paths: ["lib/*"]
     *
     * @return self
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }
}


1		<?php
2
3		namespace Sludio\HelperBundle\DependencyInjection\Component;
4
5		use LogicException;
6		use Sludio\HelperBundle\Oauth\Configurator;
7		use Symfony\Component\Config\Definition\Builder\NodeDefinition;
8		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
9		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
10		use Symfony\Component\Config\Definition\Processor;
11		use Symfony\Component\DependencyInjection\ContainerBuilder;
12		use Symfony\Component\DependencyInjection\Reference;
13
14		class Oauth implements Extensionable
15		{
16		protected $checkExternalClassExistence;
		0 ignored issues – show Comprehensibility Naming introduced 2017-10-07 19:21 UTC by Report Bug Copy Issue Report The variable name `$checkExternalClassExistence` exceeds the maximum configured length of `25`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
17
18		protected $configurators = [];
19
20		protected $type;
21
22		/**
23		* List of available Oauth providers
24		* @var array
25		*/
26		protected static $supportedProviderTypes = [
27		'custom' => Configurator\CustomProviderConfigurator::class,
28		'facebook' => Configurator\FacebookProviderConfigurator::class,
29		'google' => Configurator\GoogleProviderConfigurator::class,
30		'twitter' => Configurator\TwitterProviderConfigurator::class,
31		'draugiem' => Configurator\DraugiemProviderConfigurator::class,
32		];
33
34		public function __construct($checkExternalClassExistence = true)
		0 ignored issues – show Comprehensibility Naming introduced 2017-10-07 19:21 UTC by Report Bug Copy Issue Report The variable name `$checkExternalClassExistence` exceeds the maximum configured length of `25`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
35		{
36		$this->checkExternalClassExistence = $checkExternalClassExistence;
37		}
38
39		public static function getAllSupportedTypes()
40		{
41		return array_keys(self::$supportedProviderTypes);
42		}
43
44	View Code Duplication	public function getConfigurator($type)
		0 ignored issues – show Duplication introduced 2017-10-07 18:41 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...
45		{
46		if (!isset($this->configurators[$type])) {
47		$class = self::$supportedProviderTypes[$type];
48
49		$this->configurators[$type] = new $class();
50		}
51
52		return $this->configurators[$type];
53		}
54
55		public function buildClientConfiguration(NodeDefinition &$node)
56		{
57		$optionsNode = $node->children();
58
59		// @formatter:off
60		$optionsNode
61		->scalarNode('client_id')->isRequired()->cannotBeEmpty()->end()
62		->scalarNode('client_secret')->isRequired()->cannotBeEmpty()->end()
63		->booleanNode('use_state')->defaultValue(true)->end()
64		;
65		// @formatter:on
66
67		$this->getConfigurator($this->getType())->buildConfiguration($optionsNode);
68		$optionsNode->end();
69		}
70
71		public function configureClient(ContainerBuilder $container, $clientServiceKey, array $options = [])
72		{
73		$providerClass = $options['provider_class'];
74		if ($this->checkExternalClassExistence && !class_exists($providerClass)) {
75		throw new LogicException(sprintf('Class "%s" does not exist.', $providerClass));
76		}
77
78		$providerServiceKey = sprintf('sludio_helper.oauth.provider.%s', $clientServiceKey);
79
80		$providerDefinition = $container->register($providerServiceKey, $providerClass);
81		$providerDefinition->setPublic(false);
82
83		$providerDefinition->setFactory([
84		new Reference('sludio_helper.oauth.provider_factory'),
85		'createProvider',
86		]);
87
88		$mandatory = [
89		$providerClass,
90		$options['provider_options'],
91		];
92
93		$optional = [];
94
95		if (isset($options['provider_options']['params'])) {
96		$optional[] = $options['provider_options']['params'];
97		}
98
99		$providerDefinition->setArguments(array_merge($mandatory, $optional));
100
101		$clientServiceKey = sprintf('sludio_helper.oauth.client.%s', $clientServiceKey);
102		$clientClass = $options['client_class'];
103		$clientDefinition = $container->register($clientServiceKey, $clientClass);
104		$clientDefinition->setArguments([
105		new Reference($providerServiceKey),
106		new Reference('request_stack'),
107		new Reference('sludio_helper.logger'),
108		]);
109
110		if (!$options['state']) {
111		$clientDefinition->addMethodCall('setAsStateless');
112		}
113
114		return $clientServiceKey;
115		}
116
117		public function configure(ContainerBuilder &$container)
118		{
119		$clientConfigurations = $container->getParameter('sludio_helper.oauth.clients');
120		$clientServiceKeys = [];
121		foreach ($clientConfigurations as $key => $clientConfig) {
122		$tree = new TreeBuilder();
123		$processor = new Processor();
124
125		if (!isset($clientConfig['type'])) {
126		throw new InvalidConfigurationException(sprintf('Your "sludio_helper_oauth_client.clients.%s" config entry is missing the "type" key.', $key));
127		}
128
129		$this->type = $clientConfig['type'];
130		unset($clientConfig['type']);
131	View Code Duplication	if (!isset(self::$supportedProviderTypes[$this->type])) {
		0 ignored issues – show Duplication introduced 2017-10-07 18:41 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...
132		$supportedKeys = array_keys(self::$supportedProviderTypes);
133		sort($supportedKeys);
134		throw new InvalidConfigurationException(sprintf('The "sludio_helper_oauth_client.clients" config "type" key "%s" is not supported. We support: %s', $this->type, implode(', ', $supportedKeys)));
135		}
136
137		$node = $tree->root('sludio_helper_oauth_client/clients/'.$key);
138		$this->buildClientConfiguration($node);
139		$config = $processor->process($tree->buildTree(), [$clientConfig]);
140
141		$configurator = $this->getConfigurator($this->type);
142
143		$options = [
144		'provider_class' => $configurator->getProviderClass($config),
145		'client_class' => $configurator->getClientClass($config),
146		'provider_options' => $configurator->getProviderOptions($config),
147		'state' => $config['use_state'],
148		];
149
150		$clientServiceKey = $this->configureClient($container, $key, $options);
151
152		$service = [
153		'key' => $clientServiceKey,
154		];
155	View Code Duplication	if (isset($config['provider_options']) && isset($config['provider_options']['name'])) {
		0 ignored issues – show Duplication introduced 2017-10-07 18:41 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...
156		$service['name'] = $config['provider_options']['name'];
157		} else {
158		$service['name'] = ucfirst($key);
159		}
160
161		$clientServiceKeys[$key] = $service;
162		}
163
164		$container->getDefinition('sludio_helper.oauth.registry')->replaceArgument(1, $clientServiceKeys);
165		$container->getDefinition('sludio_helper.registry')->replaceArgument(1, $clientServiceKeys);
166		}
167
168		/**
169		* Get the value of Type
170		*
171		* @return mixed
172		*/
173		public function getType()
174		{
175		return $this->type;
176		}
177
178		/**
179		* Set the value of Type
180		*
181		* @param mixed type
		0 ignored issues – show Bug introduced 2017-10-07 18:41 UTC by Report Bug Copy Issue Report The type `Sludio\HelperBundle\Depe...njection\Component\type` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
182		*
183		* @return self
184		*/
185		public function setType($type)
186		{
187		$this->type = $type;
188
189		return $this;
190		}
191		}
192

ozo2003 / HelperBundle

Branch — master (a0cc06)

Oauth::getType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like