Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "Merge pull request #36 from SURFnet/release-1.x" - OpenConext/Stepup-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d4426a...04c02a )

by Boy

created 2016-06-08 11:47 UTC

Configuration::getConfigTreeBuilder() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	71
Code Lines	62

Duplication

Lines	0
Ratio	0 %

Importance

Changes	6
Bugs	0	Features	1

Metric	Value
c	6
b	0
f	1
dl	0
loc	71
rs	9.1369
cc	1
eloc	62
nc	1
nop	0

How to fix Long Method

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * @codeCoverageIgnore
 */
class Configuration implements ConfigurationInterface
{
    const DEFAULT_SMS_SERVICE = 'surfnet_stepup.service.gateway_api_sms';

    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder;

        $rootNode = $treeBuilder->root('surfnet_bundle');
        $rootNode
            ->children()
                ->arrayNode('logging')
                    ->isRequired()
                    ->children()
                        ->scalarNode('application_name')
                            ->info('This is the application name that is included with each log message')
                            ->isRequired()
                            ->validate()
                                ->ifTrue(function ($name) {
                                    return !is_string($name);
                                })
                                ->thenInvalid('surfnet_bundle.logging.application_name must be string')
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('loa_definition')
                    ->children()
                        ->scalarNode('loa1')
                            ->example('https://gateway.tld/authentication/loa1')
                            ->isRequired()
                            ->validate()
                            ->ifTrue(function ($value) {
                                return !is_string($value);
                            })
                                ->thenInvalid('Loa definition for "loa1" must be a string')
                            ->end()
                        ->end()
                        ->scalarNode('loa2')
                            ->example('https://gateway.tld/authentication/loa2')
                            ->isRequired()
                            ->validate()
                            ->ifTrue(function ($value) {
                                return !is_string($value);
                            })
                                ->thenInvalid('Loa definition for "loa2" must be a string')
                            ->end()
                        ->end()
                        ->scalarNode('loa3')
                            ->example('https://gateway.tld/authentication/loa3')
                            ->isRequired()
                            ->validate()
                            ->ifTrue(function ($value) {
                                return !is_string($value);
                            })
                                ->thenInvalid('Loa definition for "loa3" must be a string')
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('attach_request_id_injector_to')
                    ->prototype('scalar')
                    ->validate()
                        ->ifTrue(function ($serviceId) { return !is_string($serviceId); })
                        ->thenInvalid('surfnet_bundle.attach_request_id_injector_to must be array of strings')
                    ->end()
                ->end()
            ->end();

        $this->createGatewayApiConfiguration($rootNode);
        $this->createSmsConfiguration($rootNode);
        $this->createLocaleCookieConfiguration($rootNode);

        return $treeBuilder;
    }

    private function createGatewayApiConfiguration(ArrayNodeDefinition $root)
    {
        $root
            ->children()
                ->arrayNode('gateway_api')
                    ->canBeEnabled()
                    ->info('Gateway API configuration')
                    ->children()
                        ->arrayNode('credentials')
                            ->info('Basic authentication credentials')
                            ->children()
                                ->scalarNode('username')
                                    ->info('Username for the Gateway API')
                                    ->isRequired()
                                    ->validate()
                                        ->ifTrue(function ($value) {
                                            return (!is_string($value) || empty($value));
                                        })
                                        ->thenInvalid(
                                            'Invalid Gateway API username specified: "%s". Must be non-empty string'
                                        )
                                    ->end()
                                ->end()
                                ->scalarNode('password')
                                    ->info('Password for the Gateway API')
                                    ->isRequired()
                                    ->validate()
                                        ->ifTrue(function ($value) {
                                            return (!is_string($value) || empty($value));
                                        })
                                        ->thenInvalid(
                                            'Invalid Gateway API password specified: "%s". Must be non-empty string'
                                        )
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                        ->scalarNode('url')
                            ->info('The URL to the Gateway application (e.g. https://gateway.tld)')
                            ->isRequired()
                            ->validate()
                                ->ifTrue(function ($value) {
                                    return (!is_string($value) || empty($value) || !preg_match('~/$~', $value));
                                })
                                ->thenInvalid(
                                    'Invalid Gateway URL specified: "%s". Must be string ending in forward slash'
                                )
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    private function createSmsConfiguration(ArrayNodeDefinition $root)
    {
        $root
            ->children()
                ->arrayNode('sms')
                    ->canBeDisabled()
                    ->info('SMS configuration')
                    ->isRequired()
                    ->children()
                        ->scalarNode('service')
                            ->info(
                                'The ID of the SMS service used for sending SMS messages. ' .
                                'Must implement "Surfnet\StepupBundle\Service\SmsService".'
                            )
                            ->defaultValue(self::DEFAULT_SMS_SERVICE)
                            ->validate()
                                ->ifTrue(function ($value) {
                                    return !is_string($value);
                                })
                                ->thenInvalid('The SMS service ID must be specified using a string.')
                            ->end()
                        ->end()
                        ->scalarNode('originator')
                            ->info('Originator (sender) for SMS messages')
                            ->validate()
                                ->ifTrue(function ($value) {
                                    return (!is_string($value) || !preg_match('~^[a-z0-9]{1,11}$~i', $value));
                                })
                                ->thenInvalid(
                                    'Invalid SMS originator specified: "%s". Must be a string matching '
                                    . '"~^[a-z0-9]{1,11}$~i".'
                                )
                            ->end()
                        ->end()
                        ->integerNode('otp_expiry_interval')
                            ->info('After how many seconds an SMS challenge OTP expires')
                            ->validate()
                                ->ifTrue(function ($value) {
                                    return $value <= 0;
                                })
                                ->thenInvalid(
                                    'Invalid SMS challenge OTP expiry, must be one or more seconds.'
                                )
                            ->end()
                        ->end()
                        ->integerNode('maximum_otp_requests')
                            ->info('How many challenges a user may request during a session')
                            ->validate()
                                ->ifTrue(function ($value) {
                                    return $value <= 0;
                                })
                                ->thenInvalid(
                                    'Maximum OTP requests has a minimum of 1'
                                )
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    private function createLocaleCookieConfiguration(ArrayNodeDefinition $root)
    {
        $root
            ->children()
                ->arrayNode('locale_cookie')
                    ->info('Cookie settings for locale cookie')
                    ->isRequired()
                    ->children()
                        ->scalarNode('name')
                            ->info('Name for the cookie')
                            ->defaultValue('stepup_locale')
                        ->end()
                        ->scalarNode('domain')
                            ->info('Domain the cookie is scoped to')
                            ->defaultValue('surfconext.nl')
                        ->end()
                        ->integerNode('expire')
                            ->info('Defines a specific number of seconds for when the browser should delete the cookie.')

                            ->defaultValue(0)
                        ->end()
                        ->scalarNode('path')
                            ->info('Path the cookie is scoped to')
                            ->defaultValue('/')
                        ->end()
                        ->booleanNode('secure')
                            ->info('Only transmit cookie over secure connections?')
                            ->defaultValue(true)
                        ->end()
                        ->booleanNode('http_only')
                            ->info('Directs browsers not to expose cookies through channels other than HTTP (and HTTPS) requests')

                            ->defaultValue(true)
                        ->end()
                    ->end()
                ->end()
            ->end();
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupBundle\DependencyInjection;
20
21			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
22			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
23			use Symfony\Component\Config\Definition\ConfigurationInterface;
24
25			/**
26			* @codeCoverageIgnore
27			*/
28			class Configuration implements ConfigurationInterface
29			{
30			const DEFAULT_SMS_SERVICE = 'surfnet_stepup.service.gateway_api_sms';
31
32			public function getConfigTreeBuilder()
33			{
34			$treeBuilder = new TreeBuilder;
35
36			$rootNode = $treeBuilder->root('surfnet_bundle');
37			$rootNode
38			->children()
39			->arrayNode('logging')
40			->isRequired()
41			->children()
42			->scalarNode('application_name')
43			->info('This is the application name that is included with each log message')
44			->isRequired()
45			->validate()
46			->ifTrue(function ($name) {
47			return !is_string($name);
48			})
49			->thenInvalid('surfnet_bundle.logging.application_name must be string')
50			->end()
51			->end()
52			->end()
53			->end()
54			->arrayNode('loa_definition')
55			->children()
56			->scalarNode('loa1')
57			->example('https://gateway.tld/authentication/loa1')
58			->isRequired()
59			->validate()
60			->ifTrue(function ($value) {
61			return !is_string($value);
62			})
63			->thenInvalid('Loa definition for "loa1" must be a string')
64			->end()
65			->end()
66			->scalarNode('loa2')
67			->example('https://gateway.tld/authentication/loa2')
68			->isRequired()
69			->validate()
70			->ifTrue(function ($value) {
71			return !is_string($value);
72			})
73			->thenInvalid('Loa definition for "loa2" must be a string')
74			->end()
75			->end()
76			->scalarNode('loa3')
77			->example('https://gateway.tld/authentication/loa3')
78			->isRequired()
79			->validate()
80			->ifTrue(function ($value) {
81			return !is_string($value);
82			})
83			->thenInvalid('Loa definition for "loa3" must be a string')
84			->end()
85			->end()
86			->end()
87			->end()
88			->arrayNode('attach_request_id_injector_to')
89			->prototype('scalar')
90			->validate()
91			->ifTrue(function ($serviceId) { return !is_string($serviceId); })
92			->thenInvalid('surfnet_bundle.attach_request_id_injector_to must be array of strings')
93			->end()
94			->end()
95			->end();
96
97			$this->createGatewayApiConfiguration($rootNode);
98			$this->createSmsConfiguration($rootNode);
99			$this->createLocaleCookieConfiguration($rootNode);
100
101			return $treeBuilder;
102			}
103
104			private function createGatewayApiConfiguration(ArrayNodeDefinition $root)
105			{
106			$root
107			->children()
108			->arrayNode('gateway_api')
109			->canBeEnabled()
110			->info('Gateway API configuration')
111			->children()
112			->arrayNode('credentials')
113			->info('Basic authentication credentials')
114			->children()
115			->scalarNode('username')
116			->info('Username for the Gateway API')
117			->isRequired()
118			->validate()
119			->ifTrue(function ($value) {
120			return (!is_string($value) \|\| empty($value));
121			})
122			->thenInvalid(
123			'Invalid Gateway API username specified: "%s". Must be non-empty string'
124			)
125			->end()
126			->end()
127			->scalarNode('password')
128			->info('Password for the Gateway API')
129			->isRequired()
130			->validate()
131			->ifTrue(function ($value) {
132			return (!is_string($value) \|\| empty($value));
133			})
134			->thenInvalid(
135			'Invalid Gateway API password specified: "%s". Must be non-empty string'
136			)
137			->end()
138			->end()
139			->end()
140			->end()
141			->scalarNode('url')
142			->info('The URL to the Gateway application (e.g. https://gateway.tld)')
143			->isRequired()
144			->validate()
145			->ifTrue(function ($value) {
146			return (!is_string($value) \|\| empty($value) \|\| !preg_match('~/$~', $value));
147			})
148			->thenInvalid(
149			'Invalid Gateway URL specified: "%s". Must be string ending in forward slash'
150			)
151			->end()
152			->end()
153			->end()
154			->end()
155			->end();
156			}
157
158			private function createSmsConfiguration(ArrayNodeDefinition $root)
159			{
160			$root
161			->children()
162			->arrayNode('sms')
163			->canBeDisabled()
164			->info('SMS configuration')
165			->isRequired()
166			->children()
167			->scalarNode('service')
168			->info(
169			'The ID of the SMS service used for sending SMS messages. ' .
170			'Must implement "Surfnet\StepupBundle\Service\SmsService".'
171			)
172			->defaultValue(self::DEFAULT_SMS_SERVICE)
173			->validate()
174			->ifTrue(function ($value) {
175			return !is_string($value);
176			})
177			->thenInvalid('The SMS service ID must be specified using a string.')
178			->end()
179			->end()
180			->scalarNode('originator')
181			->info('Originator (sender) for SMS messages')
182			->validate()
183			->ifTrue(function ($value) {
184			return (!is_string($value) \|\| !preg_match('~^[a-z0-9]{1,11}$~i', $value));
185			})
186			->thenInvalid(
187			'Invalid SMS originator specified: "%s". Must be a string matching '
188			. '"~^[a-z0-9]{1,11}$~i".'
189			)
190			->end()
191			->end()
192			->integerNode('otp_expiry_interval')
193			->info('After how many seconds an SMS challenge OTP expires')
194			->validate()
195			->ifTrue(function ($value) {
196			return $value <= 0;
197			})
198			->thenInvalid(
199			'Invalid SMS challenge OTP expiry, must be one or more seconds.'
200			)
201			->end()
202			->end()
203			->integerNode('maximum_otp_requests')
204			->info('How many challenges a user may request during a session')
205			->validate()
206			->ifTrue(function ($value) {
207			return $value <= 0;
208			})
209			->thenInvalid(
210			'Maximum OTP requests has a minimum of 1'
211			)
212			->end()
213			->end()
214			->end()
215			->end()
216			->end();
217			}
218
219			private function createLocaleCookieConfiguration(ArrayNodeDefinition $root)
220			{
221			$root
222			->children()
223			->arrayNode('locale_cookie')
224			->info('Cookie settings for locale cookie')
225			->isRequired()
226			->children()
227			->scalarNode('name')
228			->info('Name for the cookie')
229			->defaultValue('stepup_locale')
230			->end()
231			->scalarNode('domain')
232			->info('Domain the cookie is scoped to')
233			->defaultValue('surfconext.nl')
234			->end()
235			->integerNode('expire')
236			->info('Defines a specific number of seconds for when the browser should delete the cookie.')
			0 ignored issues – show Coding Style introduced 2016-06-07 08:48 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 121 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
237			->defaultValue(0)
238			->end()
239			->scalarNode('path')
240			->info('Path the cookie is scoped to')
241			->defaultValue('/')
242			->end()
243			->booleanNode('secure')
244			->info('Only transmit cookie over secure connections?')
245			->defaultValue(true)
246			->end()
247			->booleanNode('http_only')
248			->info('Directs browsers not to expose cookies through channels other than HTTP (and HTTPS) requests')
			0 ignored issues – show Coding Style introduced 2016-06-07 08:02 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 130 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
249			->defaultValue(true)
250			->end()
251			->end()
252			->end()
253			->end();
254			}
255			}
256

OpenConext / Stepup-bundle

GitHub Access Token became invalid

Push — master ( d4426a...04c02a )

Configuration::getConfigTreeBuilder() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like