Configuration::addProvidersSection() - Code Metrics - Inspection of "Merge pull request #102 from SURFnet/release-2.x" - OpenConext/Stepup-Gateway - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 00f21d...76f138 )

by Boy

created 2016-06-22 11:01 UTC

Configuration::addProvidersSection() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	82
Code Lines	76

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	82
rs	8.7769
cc	1
eloc	76
nc	1
nop	1

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\StepupGateway\SamlStepupProviderBundle\DependencyInjection;

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

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('surfnet_stepup_gateway_saml_stepup_provider');

        $rootNode
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->children()
            ->arrayNode('allowed_sps')
                ->isRequired()
                ->requiresAtLeastOneElement()
                ->prototype('scalar')
                ->end()
            ->end();

        $this->addRoutesSection($rootNode);
        $this->addProvidersSection($rootNode);

        return $treeBuilder;
    }

    /**
     * @param ArrayNodeDefinition $rootNode
     */
    private function addRoutesSection(ArrayNodeDefinition $rootNode)
    {
        $rootNode
            ->children()
            ->arrayNode('routes')
                ->children()
                    ->scalarNode('sso')
                        ->isRequired()
                        ->validate()
                            ->ifTrue(function ($v) {
                                return !is_string($v) || strlen($v) === 0;
                            })
                            ->thenInvalid('SSO route must be a non-empty string')
                        ->end()
                    ->end()
                    ->scalarNode('consume_assertion')
                        ->isRequired()
                        ->validate()
                            ->ifTrue(function ($v) {
                                return !is_string($v) || strlen($v) === 0;
                            })
                            ->thenInvalid('Consume assertion route must be a non-empty string')
                        ->end()
                    ->end()
                    ->scalarNode('metadata')
                        ->isRequired()
                        ->validate()
                            ->ifTrue(function ($v) {
                                return !is_string($v) || strlen($v) === 0;
                            })
                            ->thenInvalid('Metadata route must be a non-empty string')
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    /**
     * @param ArrayNodeDefinition $rootNode
     */
    private function addProvidersSection(ArrayNodeDefinition $rootNode)
    {
        /** @var ArrayNodeDefinition $protoType */
        $protoType = $rootNode
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->children()
            ->arrayNode('providers')
                ->isRequired()
                ->requiresAtLeastOneElement()
                ->useAttributeAsKey('type')
                ->prototype('array');

        $protoType
            ->canBeDisabled()
            ->children()
                ->arrayNode('hosted')
                    ->children()
                        ->arrayNode('service_provider')
                            ->children()
                                ->scalarNode('public_key')
                                    ->isRequired()
                                    ->info('The absolute path to the public key used to sign AuthnRequests')
                                ->end()
                                ->scalarNode('private_key')
                                    ->isRequired()
                                    ->info('The absolute path to the private key used to sign AuthnRequests')
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('identity_provider')
                            ->children()
                                ->scalarNode('service_provider_repository')
                                    ->isRequired()
                                    ->info(
                                        'Name of the service that is the Entity Repository. Must implement the '
                                        . ' Surfnet\SamlBundle\Entity\ServiceProviderRepository interface.'
                                    )
                                ->end()
                                ->scalarNode('public_key')
                                    ->isRequired()
                                    ->info('The absolute path to the public key used to sign Responses to AuthRequests with')

                                ->end()
                                ->scalarNode('private_key')
                                    ->isRequired()
                                    ->info('The absolute path to the private key used to sign Responses to AuthRequests with')

                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('metadata')
                            ->children()
                                ->scalarNode('public_key')
                                    ->isRequired()
                                    ->info('The absolute path to the public key used to sign the metadata')
                                ->end()
                                ->scalarNode('private_key')
                                    ->isRequired()
                                    ->info('The absolute path to the private key used to sign the metadata')
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('remote')
                    ->children()
                        ->scalarNode('entity_id')
                            ->isRequired()
                            ->info('The EntityID of the remote identity provider')
                        ->end()
                        ->scalarNode('sso_url')
                            ->isRequired()
                            ->info('The name of the route to generate the SSO URL')
                        ->end()
                        ->scalarNode('certificate')
                            ->isRequired()
                            ->info(
                                'The contents of the certificate used to sign the AuthnResponse with, if different from'
                                . ' the public key configured below'
                            )
                        ->end()
                    ->end()
                ->end()
            ->end();
    }
}


Push — master ( 00f21d...76f138 )

Configuration::addProvidersSection() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

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\StepupGateway\SamlStepupProviderBundle\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			class Configuration implements ConfigurationInterface
26			{
27			public function getConfigTreeBuilder()
28			{
29			$treeBuilder = new TreeBuilder();
30			$rootNode = $treeBuilder->root('surfnet_stepup_gateway_saml_stepup_provider');
31
32			$rootNode
			0 ignored issues – show Bug introduced 2015-12-15 13:35 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `requiresAtLeastOneElement()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
33			->children()
34			->arrayNode('allowed_sps')
35			->isRequired()
36			->requiresAtLeastOneElement()
37			->prototype('scalar')
38			->end()
39			->end();
40
41			$this->addRoutesSection($rootNode);
42			$this->addProvidersSection($rootNode);
43
44			return $treeBuilder;
45			}
46
47			/**
48			* @param ArrayNodeDefinition $rootNode
49			*/
50			private function addRoutesSection(ArrayNodeDefinition $rootNode)
51			{
52			$rootNode
53			->children()
54			->arrayNode('routes')
55			->children()
56			->scalarNode('sso')
57			->isRequired()
58			->validate()
59			->ifTrue(function ($v) {
60			return !is_string($v) \|\| strlen($v) === 0;
61			})
62			->thenInvalid('SSO route must be a non-empty string')
63			->end()
64			->end()
65			->scalarNode('consume_assertion')
66			->isRequired()
67			->validate()
68			->ifTrue(function ($v) {
69			return !is_string($v) \|\| strlen($v) === 0;
70			})
71			->thenInvalid('Consume assertion route must be a non-empty string')
72			->end()
73			->end()
74			->scalarNode('metadata')
75			->isRequired()
76			->validate()
77			->ifTrue(function ($v) {
78			return !is_string($v) \|\| strlen($v) === 0;
79			})
80			->thenInvalid('Metadata route must be a non-empty string')
81			->end()
82			->end()
83			->end()
84			->end();
85			}
86
87			/**
88			* @param ArrayNodeDefinition $rootNode
89			*/
90			private function addProvidersSection(ArrayNodeDefinition $rootNode)
91			{
92			/** @var ArrayNodeDefinition $protoType */
93			$protoType = $rootNode
			0 ignored issues – show Bug introduced 2015-12-15 13:35 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `requiresAtLeastOneElement()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
94			->children()
95			->arrayNode('providers')
96			->isRequired()
97			->requiresAtLeastOneElement()
98			->useAttributeAsKey('type')
99			->prototype('array');
100
101			$protoType
102			->canBeDisabled()
103			->children()
104			->arrayNode('hosted')
105			->children()
106			->arrayNode('service_provider')
107			->children()
108			->scalarNode('public_key')
109			->isRequired()
110			->info('The absolute path to the public key used to sign AuthnRequests')
111			->end()
112			->scalarNode('private_key')
113			->isRequired()
114			->info('The absolute path to the private key used to sign AuthnRequests')
115			->end()
116			->end()
117			->end()
118			->arrayNode('identity_provider')
119			->children()
120			->scalarNode('service_provider_repository')
121			->isRequired()
122			->info(
123			'Name of the service that is the Entity Repository. Must implement the '
124			. ' Surfnet\SamlBundle\Entity\ServiceProviderRepository interface.'
125			)
126			->end()
127			->scalarNode('public_key')
128			->isRequired()
129			->info('The absolute path to the public key used to sign Responses to AuthRequests with')
			0 ignored issues – show Coding Style introduced 2016-04-29 09:07 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 125 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...
130			->end()
131			->scalarNode('private_key')
132			->isRequired()
133			->info('The absolute path to the private key used to sign Responses to AuthRequests with')
			0 ignored issues – show Coding Style introduced 2016-04-29 09:07 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 126 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...
134			->end()
135			->end()
136			->end()
137			->arrayNode('metadata')
138			->children()
139			->scalarNode('public_key')
140			->isRequired()
141			->info('The absolute path to the public key used to sign the metadata')
142			->end()
143			->scalarNode('private_key')
144			->isRequired()
145			->info('The absolute path to the private key used to sign the metadata')
146			->end()
147			->end()
148			->end()
149			->end()
150			->end()
151			->arrayNode('remote')
152			->children()
153			->scalarNode('entity_id')
154			->isRequired()
155			->info('The EntityID of the remote identity provider')
156			->end()
157			->scalarNode('sso_url')
158			->isRequired()
159			->info('The name of the route to generate the SSO URL')
160			->end()
161			->scalarNode('certificate')
162			->isRequired()
163			->info(
164			'The contents of the certificate used to sign the AuthnResponse with, if different from'
165			. ' the public key configured below'
166			)
167			->end()
168			->end()
169			->end()
170			->end();
171			}
172			}
173

OpenConext / Stepup-Gateway

Push — master ( 00f21d...76f138 )

Configuration::addProvidersSection() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like