OpenIdConnectSource - Code Metrics - Inspection of "Better OpenID Connect support" - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#31)

by Florent

created 2017-04-09 13:26 UTC

OpenIdConnectSource A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

Metric	Value
wmc	9
lcom	1
cbo	9
dl	0
loc	77
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
A	name()	4	1
A	continueLoading()	11	3
A	prepend()	7	2
A	continueConfiguration()	22	2

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace OAuth2Framework\Bundle\Server\DependencyInjection\Source\OpenIdConnect;

use Fluent\PhpConfigFileLoader;
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\SourceInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;

final class OpenIdConnectSource extends ActionableSource
{
    /**
     * @var SourceInterface[]
     */
    private $subSources;

    /**
     * OpenIdConnectSource constructor.
     */
    public function __construct()
    {
        $this->subSources = [
            new UserinfoEndpointSource(),
            new IdTokenSource(),
            new AuthorizationEndpointIdTokenHintSource(),
            new PairwiseSubjectSource(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function name(): string
    {
        return 'openid_connect';
    }

    /**
     * {@inheritdoc}
     */
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
    {
        foreach ($this->subSources as $source) {
            $source->load($path, $container, $config);
        }
        foreach (['claims_supported', 'claims_locales_supported'] as $k) {
            $container->setParameter($path.'.'.$k, $config[$k]);
        }
        $loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/openid_connect'));
        $loader->load('openid_connect.php');
    }

    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
    {
        parent::prepend($bundleConfig, $path, $container);
        foreach ($this->subSources as $source) {
            $source->prepend($bundleConfig, $path.'['.$this->name().']', $container);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function continueConfiguration(NodeDefinition $node)
    {
        parent::continueConfiguration($node);
        $node
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('claims_supported')
                    ->info('Supported claims.')
                    ->useAttributeAsKey('name')
                    ->prototype('scalar')->end()
                    ->treatNullLike([])
                ->end()
                ->arrayNode('claims_locales_supported')
                    ->info('Supported claims locales.')
                    ->useAttributeAsKey('name')
                    ->prototype('scalar')->end()
                    ->treatNullLike([])
                ->end()
            ->end();
        foreach ($this->subSources as $source) {
            $source->addConfiguration($node);
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2017 Spomky-Labs
9			*
10			* This software may be modified and distributed under the terms
11			* of the MIT license. See the LICENSE file for details.
12			*/
13
14			namespace OAuth2Framework\Bundle\Server\DependencyInjection\Source\OpenIdConnect;
15
16			use Fluent\PhpConfigFileLoader;
17			use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
18			use OAuth2Framework\Bundle\Server\DependencyInjection\Source\SourceInterface;
19			use Symfony\Component\Config\FileLocator;
20			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
21			use Symfony\Component\DependencyInjection\ContainerBuilder;
22
23			final class OpenIdConnectSource extends ActionableSource
24			{
25			/**
26			* @var SourceInterface[]
27			*/
28			private $subSources;
29
30			/**
31			* OpenIdConnectSource constructor.
32			*/
33			public function __construct()
34			{
35			$this->subSources = [
36			new UserinfoEndpointSource(),
37			new IdTokenSource(),
38			new AuthorizationEndpointIdTokenHintSource(),
39			new PairwiseSubjectSource(),
40			];
41			}
42
43			/**
44			* {@inheritdoc}
45			*/
46			protected function name(): string
47			{
48			return 'openid_connect';
49			}
50
51			/**
52			* {@inheritdoc}
53			*/
54			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
55			{
56			foreach ($this->subSources as $source) {
57			$source->load($path, $container, $config);
58			}
59			foreach (['claims_supported', 'claims_locales_supported'] as $k) {
60			$container->setParameter($path.'.'.$k, $config[$k]);
61			}
62			$loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/openid_connect'));
63			$loader->load('openid_connect.php');
64			}
65
66			public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
67			{
68			parent::prepend($bundleConfig, $path, $container);
69			foreach ($this->subSources as $source) {
70			$source->prepend($bundleConfig, $path.'['.$this->name().']', $container);
71			}
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77			protected function continueConfiguration(NodeDefinition $node)
78			{
79			parent::continueConfiguration($node);
80			$node
			0 ignored issues – show Bug introduced 2017-04-09 13:29 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 `children()` 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...
81			->children()
82			->arrayNode('claims_supported')
83			->info('Supported claims.')
84			->useAttributeAsKey('name')
85			->prototype('scalar')->end()
86			->treatNullLike([])
87			->end()
88			->arrayNode('claims_locales_supported')
89			->info('Supported claims locales.')
90			->useAttributeAsKey('name')
91			->prototype('scalar')->end()
92			->treatNullLike([])
93			->end()
94			->end();
95			foreach ($this->subSources as $source) {
96			$source->addConfiguration($node);
97			}
98			}
99			}
100

OAuth2-Framework / oauth2-framework

Pull Request — master (#31)

OpenIdConnectSource A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like