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-21 19:21 UTC

Configuration::configurePlugins() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	116
Code Lines	104

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	116
rs	8.2857
cc	1
eloc	104
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]>
 * @author Tobias Nyholm <[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')
                                ->info('This must be a service id to a service implementing Http\Message\Authentication')
                                ->isRequired()
                                ->cannotBeEmpty()
                            ->end()
                        ->end()
                    ->end() // End authentication plugin

                    ->arrayNode('cache')
                    ->canBeEnabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('cache_pool')
                                ->info('This must be a service id to a service implementing Psr\Cache\CacheItemPoolInterface')
                                ->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')
                                ->info('This must be a service id to a service implementing Http\Message\CookieJar')
                                ->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')
                                ->info('This must be a service id to a service implementing Http\Client\Plugin\Journal')
                                ->isRequired()
                                ->cannotBeEmpty()
                            ->end()
                        ->end()
                    ->end() // End history plugin

                    ->arrayNode('logger')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('logger')
                                ->info('This must be a service id to a service implementing Psr\Log\LoggerInterface')
                                ->defaultValue('logger')
                                ->cannotBeEmpty()
                            ->end()
                            ->scalarNode('formatter')
                                ->info('This must be a service id to a service implementing Http\Message\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')
                    ->canBeDisabled()
                    ->addDefaultsIfNotSet()
                        ->children()
                            ->scalarNode('stopwatch')
                                ->info('This must be a service id to a service extending Symfony\Component\Stopwatch\Stopwatch')
                                ->defaultValue('debug.stopwatch')
                                ->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			* @author Tobias Nyholm <[email protected]>
19			*/
20			class Configuration implements ConfigurationInterface
21			{
22			/**
23			* {@inheritdoc}
24			*/
25			public function getConfigTreeBuilder()
26			{
27			$treeBuilder = new TreeBuilder();
28			$rootNode = $treeBuilder->root('httplug');
29
30			$this->configureClients($rootNode);
31			$this->configurePlugins($rootNode);
32
33			$rootNode
34			->validate()
35			->ifTrue(function ($v) {
36			return !empty($v['classes']['client'])
37			\|\| !empty($v['classes']['message_factory'])
38			\|\| !empty($v['classes']['uri_factory'])
39			\|\| !empty($v['classes']['stream_factory']);
40			})
41			->then(function ($v) {
42			foreach ($v['classes'] as $key => $class) {
43			if (null !== $class && !class_exists($class)) {
44			throw new InvalidConfigurationException(sprintf(
45			'Class %s specified for httplug.classes.%s does not exist.',
46			$class,
47			$key
48			));
49			}
50			}
51
52			return $v;
53			})
54			->end()
55			->children()
56			->arrayNode('main_alias')
57			->addDefaultsIfNotSet()
58			->info('Configure which service the main alias point to.')
59			->children()
60			->scalarNode('client')->defaultValue('httplug.client.default')->end()
61			->scalarNode('message_factory')->defaultValue('httplug.message_factory.default')->end()
62			->scalarNode('uri_factory')->defaultValue('httplug.uri_factory.default')->end()
63			->scalarNode('stream_factory')->defaultValue('httplug.stream_factory.default')->end()
64			->end()
65			->end()
66			->arrayNode('classes')
67			->addDefaultsIfNotSet()
68			->info('Overwrite a service class instead of using the discovery mechanism.')
69			->children()
70			->scalarNode('client')->defaultNull()->end()
71			->scalarNode('message_factory')->defaultNull()->end()
72			->scalarNode('uri_factory')->defaultNull()->end()
73			->scalarNode('stream_factory')->defaultNull()->end()
74			->end()
75			->end()
76			->arrayNode('toolbar')
77			->addDefaultsIfNotSet()
78			->info('Extend the debug profiler with inforation about requests.')
79			->children()
80			->enumNode('enabled')
81			->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.')
82			->values([true, false, 'auto'])
83			->defaultValue('auto')
84			->end()
85			->scalarNode('formatter')->defaultNull()->end()
86			->end()
87			->end()
88			->end();
89
90			return $treeBuilder;
91			}
92
93			protected function configureClients(ArrayNodeDefinition $root)
94			{
95			$root->children()
96			->arrayNode('clients')
97			->useAttributeAsKey('name')
98			->prototype('array')
99			->children()
100			->scalarNode('factory')
101			->isRequired()
102			->cannotBeEmpty()
103			->info('The service id of a factory to use when creating the adapter.')
104			->end()
105			->arrayNode('plugins')
106			->info('A list of service ids of plugins. The order is important.')
107			->prototype('scalar')->end()
108			->end()
109			->variableNode('config')->defaultValue([])->end()
110			->end()
111			->end();
112			}
113
114			/**
115			* @param ArrayNodeDefinition $root
116			*/
117			protected function configurePlugins(ArrayNodeDefinition $root)
118			{
119			$root->children()
120			->arrayNode('plugins')
121			->addDefaultsIfNotSet()
122			->children()
123
124			->arrayNode('authentication')
125			->canBeEnabled()
126			->children()
127			->scalarNode('authentication')
128			->info('This must be a service id to a service implementing Http\Message\Authentication')
129			->isRequired()
130			->cannotBeEmpty()
131			->end()
132			->end()
133			->end() // End authentication plugin
134
135			->arrayNode('cache')
136			->canBeEnabled()
137			->addDefaultsIfNotSet()
138			->children()
139			->scalarNode('cache_pool')
140			->info('This must be a service id to a service implementing Psr\Cache\CacheItemPoolInterface')
141			->isRequired()
142			->cannotBeEmpty()
143			->end()
144			->scalarNode('stream_factory')->cannotBeEmpty()->defaultValue('httplug.stream_factory')->end()
145			->arrayNode('config')
146			->children()
147			->scalarNode('default_ttl')->defaultNull()->end()
148			->scalarNode('respect_cache_headers')->defaultTrue()->end()
149			->end()
150			->end()
151			->end()
152			->end() // End cache plugin
153
154			->arrayNode('cookie')
155			->canBeEnabled()
156			->children()
157			->scalarNode('cookie_jar')
158			->info('This must be a service id to a service implementing Http\Message\CookieJar')
159			->isRequired()
160			->cannotBeEmpty()
161			->end()
162			->end()
163			->end() // End cookie plugin
164
165			->arrayNode('decoder')
166			->canBeDisabled()
167			->addDefaultsIfNotSet()
168			->children()
169			->scalarNode('use_content_encoding')->defaultTrue()->end()
170			->end()
171			->end() // End decoder plugin
172
173			->arrayNode('history')
174			->canBeEnabled()
175			->children()
176			->scalarNode('journal')
177			->info('This must be a service id to a service implementing Http\Client\Plugin\Journal')
178			->isRequired()
179			->cannotBeEmpty()
180			->end()
181			->end()
182			->end() // End history plugin
183
184			->arrayNode('logger')
185			->canBeDisabled()
186			->addDefaultsIfNotSet()
187			->children()
188			->scalarNode('logger')
189			->info('This must be a service id to a service implementing Psr\Log\LoggerInterface')
190			->defaultValue('logger')
191			->cannotBeEmpty()
192			->end()
193			->scalarNode('formatter')
194			->info('This must be a service id to a service implementing Http\Message\Formatter')
195			->defaultNull()
196			->end()
197			->end()
198			->end() // End logger plugin
199
200			->arrayNode('redirect')
201			->canBeDisabled()
202			->addDefaultsIfNotSet()
203			->children()
204			->scalarNode('preserve_header')->defaultTrue()->end()
205			->scalarNode('use_default_for_multiple')->defaultTrue()->end()
206			->end()
207			->end() // End redirect plugin
208
209			->arrayNode('retry')
210			->canBeDisabled()
211			->addDefaultsIfNotSet()
212			->children()
213			->scalarNode('retry')->defaultValue(1)->end()
214			->end()
215			->end() // End retry plugin
216
217			->arrayNode('stopwatch')
218			->canBeDisabled()
219			->addDefaultsIfNotSet()
220			->children()
221			->scalarNode('stopwatch')
222			->info('This must be a service id to a service extending Symfony\Component\Stopwatch\Stopwatch')
223			->defaultValue('debug.stopwatch')
224			->cannotBeEmpty()
225			->end()
226			->end()
227			->end() // End stopwatch plugin
228
229			->end()
230			->end()
231			->end();
232			}
233			}
234

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