Configuration::configurePlugins() - Code Metrics - Inspection of "Configure plugins" - php-http/HttplugBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#37)

by Tobias

created 2016-01-17 12:35 UTC

Configuration::configurePlugins() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	88
Code Lines	76

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	88
rs	8.6012
cc	1
eloc	76
nc	1
nop	1

How to fix Long Method

<?php

namespace Http\HttplugBundle\DependencyInjection;

use Symfony\Component\Config\Definition\ArrayNode;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;

/**
 * This class contains the configuration information for the bundle.
 *
 * This information is solely responsible for how the different configuration
 * sections are normalized, and merged.
 *
 * @author David Buchmann <[email protected]>
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('httplug');

        $this->configureClients($rootNode);
        $this->configurePlugins($rootNode);

        $rootNode
            ->validate()
                ->ifTrue(function ($v) {
                    return !empty($v['classes']['client'])
                        || !empty($v['classes']['message_factory'])
                        || !empty($v['classes']['uri_factory'])
                        || !empty($v['classes']['stream_factory']);
                })
                ->then(function ($v) {
                    foreach ($v['classes'] as $key => $class) {
                        if (null !== $class && !class_exists($class)) {
                            throw new InvalidConfigurationException(sprintf(
                                'Class %s specified for httplug.classes.%s does not exist.',
                                $class,
                                $key
                            ));
                        }
                    }

                    return $v;
                })
            ->end()
            ->children()
                ->arrayNode('main_alias')
                    ->addDefaultsIfNotSet()
                    ->info('Configure which service the main alias point to.')
                    ->children()
                        ->scalarNode('client')->defaultValue('httplug.client.default')->end()
                        ->scalarNode('message_factory')->defaultValue('httplug.message_factory.default')->end()
                        ->scalarNode('uri_factory')->defaultValue('httplug.uri_factory.default')->end()
                        ->scalarNode('stream_factory')->defaultValue('httplug.stream_factory.default')->end()
                    ->end()
                ->end()
                ->arrayNode('classes')
                    ->addDefaultsIfNotSet()
                    ->info('Overwrite a service class instead of using the discovery mechanism.')
                    ->children()
                        ->scalarNode('client')->defaultNull()->end()
                        ->scalarNode('message_factory')->defaultNull()->end()
                        ->scalarNode('uri_factory')->defaultNull()->end()
                        ->scalarNode('stream_factory')->defaultNull()->end()
                    ->end()
                ->end()
                ->arrayNode('toolbar')
                    ->addDefaultsIfNotSet()
                    ->info('Extend the debug profiler with inforation about requests.')
                    ->children()
                        ->enumNode('enabled')
                            ->info('If "auto" (default), the toolbar is activated when kernel.debug is true. You can force the toolbar on and off by changing this option.')
                            ->values([true, false, 'auto'])
                            ->defaultValue('auto')
                        ->end()
                        ->scalarNode('formatter')->defaultNull()->end()
                    ->end()
                ->end()
            ->end();

        return $treeBuilder;
    }

    protected function configureClients(ArrayNodeDefinition $root)
    {
        $root->children()
            ->arrayNode('clients')
                ->useAttributeAsKey('name')
                ->prototype('array')
                ->children()
                    ->scalarNode('factory')
                        ->isRequired()
                        ->cannotBeEmpty()
                        ->info('The service id of a factory to use when creating the adapter.')
                    ->end()
                    ->arrayNode('plugins')
                        ->info('A list of service ids of plugins. The order is important.')
                        ->prototype('scalar')->end()
                    ->end()
                    ->variableNode('config')->defaultValue([])->end()
                ->end()
            ->end();
    }

    /**
     * @param ArrayNodeDefinition $root
     */
    protected function configurePlugins(ArrayNodeDefinition $root)
    {
        $root->children()
            ->arrayNode('plugins')
                ->addDefaultsIfNotSet()
                ->children()

                    ->arrayNode('authentication')
                    ->canBeEnabled()
                        ->children()
                            ->scalarNode('authentication')->isRequired()->cannotBeEmpty()->end()
                        ->end()
                    ->end() // End authentication plugin

                    ->arrayNode('cache')
                    ->canBeEnabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('cache_pool')->isRequired()->cannotBeEmpty()->end()
                            ->scalarNode('stream_factory')->cannotBeEmpty()->defaultValue('httplug.stream_factory')->end()
                            ->arrayNode('config')
                                ->children()
                                    ->scalarNode('default_ttl')->defaultNull()->end()
                                    ->scalarNode('respect_cache_headers')->defaultTrue()->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end() // End cache plugin

                    ->arrayNode('cookie')
                    ->canBeEnabled()
                        ->children()
                            ->scalarNode('cookie_jar')->isRequired()->cannotBeEmpty()->end()
                        ->end()
                    ->end() // End cookie plugin

                    ->arrayNode('decoder')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('use_content_encoding')->defaultTrue()->end()
                        ->end()
                    ->end() // End decoder plugin

                    ->arrayNode('history')
                    ->canBeEnabled()
                        ->children()
                            ->scalarNode('journal')->isRequired()->cannotBeEmpty()->end()
                        ->end()
                    ->end() // End history plugin

                    ->arrayNode('logger')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('logger')->isRequired()->cannotBeEmpty()->defaultValue('logger')->end()
                            ->scalarNode('formatter')->defaultNull()->end()
                        ->end()
                    ->end() // End logger plugin

                    ->arrayNode('redirect')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('preserve_header')->defaultTrue()->end()
                            ->scalarNode('use_default_for_multiple')->defaultTrue()->end()
                        ->end()
                    ->end() // End redirect plugin

                    ->arrayNode('retry')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('retry')->defaultValue(1)->end()
                        ->end()
                    ->end() // End retry plugin

                    ->arrayNode('stopwatch')
                    ->canBeEnabled()
                        ->children()
                            ->scalarNode('stopwatch')->isRequired()->cannotBeEmpty()->end()
                        ->end()
                    ->end() // End stopwatch plugin

                ->end()
            ->end()
        ->end();
    }
}


1			<?php
2
3			namespace Http\HttplugBundle\DependencyInjection;
4
5			use Symfony\Component\Config\Definition\ArrayNode;
6			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
7			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
8			use Symfony\Component\Config\Definition\ConfigurationInterface;
9			use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
10
11			/**
12			* This class contains the configuration information for the bundle.
13			*
14			* This information is solely responsible for how the different configuration
15			* sections are normalized, and merged.
16			*
17			* @author David Buchmann <[email protected]>
18			*/
19			class Configuration implements ConfigurationInterface
20			{
21			/**
22			* {@inheritdoc}
23			*/
24			public function getConfigTreeBuilder()
25			{
26			$treeBuilder = new TreeBuilder();
27			$rootNode = $treeBuilder->root('httplug');
28
29			$this->configureClients($rootNode);
30			$this->configurePlugins($rootNode);
31
32			$rootNode
33			->validate()
34			->ifTrue(function ($v) {
35			return !empty($v['classes']['client'])
36			\|\| !empty($v['classes']['message_factory'])
37			\|\| !empty($v['classes']['uri_factory'])
38			\|\| !empty($v['classes']['stream_factory']);
39			})
40			->then(function ($v) {
41			foreach ($v['classes'] as $key => $class) {
42			if (null !== $class && !class_exists($class)) {
43			throw new InvalidConfigurationException(sprintf(
44			'Class %s specified for httplug.classes.%s does not exist.',
45			$class,
46			$key
47			));
48			}
49			}
50
51			return $v;
52			})
53			->end()
54			->children()
55			->arrayNode('main_alias')
56			->addDefaultsIfNotSet()
57			->info('Configure which service the main alias point to.')
58			->children()
59			->scalarNode('client')->defaultValue('httplug.client.default')->end()
60			->scalarNode('message_factory')->defaultValue('httplug.message_factory.default')->end()
61			->scalarNode('uri_factory')->defaultValue('httplug.uri_factory.default')->end()
62			->scalarNode('stream_factory')->defaultValue('httplug.stream_factory.default')->end()
63			->end()
64			->end()
65			->arrayNode('classes')
66			->addDefaultsIfNotSet()
67			->info('Overwrite a service class instead of using the discovery mechanism.')
68			->children()
69			->scalarNode('client')->defaultNull()->end()
70			->scalarNode('message_factory')->defaultNull()->end()
71			->scalarNode('uri_factory')->defaultNull()->end()
72			->scalarNode('stream_factory')->defaultNull()->end()
73			->end()
74			->end()
75			->arrayNode('toolbar')
76			->addDefaultsIfNotSet()
77			->info('Extend the debug profiler with inforation about requests.')
78			->children()
79			->enumNode('enabled')
80			->info('If "auto" (default), the toolbar is activated when kernel.debug is true. You can force the toolbar on and off by changing this option.')
81			->values([true, false, 'auto'])
82			->defaultValue('auto')
83			->end()
84			->scalarNode('formatter')->defaultNull()->end()
85			->end()
86			->end()
87			->end();
88
89			return $treeBuilder;
90			}
91
92			protected function configureClients(ArrayNodeDefinition $root)
93			{
94			$root->children()
95			->arrayNode('clients')
96			->useAttributeAsKey('name')
97			->prototype('array')
98			->children()
99			->scalarNode('factory')
100			->isRequired()
101			->cannotBeEmpty()
102			->info('The service id of a factory to use when creating the adapter.')
103			->end()
104			->arrayNode('plugins')
105			->info('A list of service ids of plugins. The order is important.')
106			->prototype('scalar')->end()
107			->end()
108			->variableNode('config')->defaultValue([])->end()
109			->end()
110			->end();
111			}
112
113			/**
114			* @param ArrayNodeDefinition $root
115			*/
116			protected function configurePlugins(ArrayNodeDefinition $root)
117			{
118			$root->children()
119			->arrayNode('plugins')
120			->addDefaultsIfNotSet()
121			->children()
122
123			->arrayNode('authentication')
124			->canBeEnabled()
125			->children()
126			->scalarNode('authentication')->isRequired()->cannotBeEmpty()->end()
127			->end()
128			->end() // End authentication plugin
129
130			->arrayNode('cache')
131			->canBeEnabled()
132			->addDefaultsIfNotSet()
133			->children()
134			->scalarNode('cache_pool')->isRequired()->cannotBeEmpty()->end()
135			->scalarNode('stream_factory')->cannotBeEmpty()->defaultValue('httplug.stream_factory')->end()
136			->arrayNode('config')
137			->children()
138			->scalarNode('default_ttl')->defaultNull()->end()
139			->scalarNode('respect_cache_headers')->defaultTrue()->end()
140			->end()
141			->end()
142			->end()
143			->end() // End cache plugin
144
145			->arrayNode('cookie')
146			->canBeEnabled()
147			->children()
148			->scalarNode('cookie_jar')->isRequired()->cannotBeEmpty()->end()
149			->end()
150			->end() // End cookie plugin
151
152			->arrayNode('decoder')
153			->canBeDisabled()
154			->addDefaultsIfNotSet()
155			->children()
156			->scalarNode('use_content_encoding')->defaultTrue()->end()
157			->end()
158			->end() // End decoder plugin
159
160			->arrayNode('history')
161			->canBeEnabled()
162			->children()
163			->scalarNode('journal')->isRequired()->cannotBeEmpty()->end()
164			->end()
165			->end() // End history plugin
166
167			->arrayNode('logger')
168			->canBeDisabled()
169			->addDefaultsIfNotSet()
170			->children()
171			->scalarNode('logger')->isRequired()->cannotBeEmpty()->defaultValue('logger')->end()
172			->scalarNode('formatter')->defaultNull()->end()
173			->end()
174			->end() // End logger plugin
175
176			->arrayNode('redirect')
177			->canBeDisabled()
178			->addDefaultsIfNotSet()
179			->children()
180			->scalarNode('preserve_header')->defaultTrue()->end()
181			->scalarNode('use_default_for_multiple')->defaultTrue()->end()
182			->end()
183			->end() // End redirect plugin
184
185			->arrayNode('retry')
186			->canBeDisabled()
187			->addDefaultsIfNotSet()
188			->children()
189			->scalarNode('retry')->defaultValue(1)->end()
190			->end()
191			->end() // End retry plugin
192
193			->arrayNode('stopwatch')
194			->canBeEnabled()
195			->children()
196			->scalarNode('stopwatch')->isRequired()->cannotBeEmpty()->end()
197			->end()
198			->end() // End stopwatch plugin
199
200			->end()
201			->end()
202			->end();
203			}
204			}
205

php-http / HttplugBundle

Pull Request — master (#37)

Configuration::configurePlugins() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like