MetadataEndpointSource::continueLoading() - Code Metrics - Inspection of "Metadata (#37)" - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( af58b3...cca06a )

by Florent

created 2017-04-13 10:58 UTC

MetadataEndpointSource::continueLoading() A

↳ Parent: MetadataEndpointSource

Complexity

Conditions	3
Paths	4

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	4
nop	3

<?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\Endpoint;

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

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

    /**
     * AuthorizationEndpointSource constructor.
     */
    public function __construct()
    {
        $this->subSources = [
            new SignedMetadataEndpointSource(),
        ];
    }

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

    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 name(): string
    {
        return 'metadata';
    }

    /**
     * {@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.
    }
}
            ->validate()
                ->ifTrue(function ($config) {
                    return true === $config['enabled'] && empty($config['path']);
                })
                ->thenInvalid('The route name must be set.')
            ->end()
            ->children()
                ->scalarNode('path')->defaultValue('/.well-known/openid-configuration')->end()
                ->arrayNode('custom_routes')
                    ->info('Custom routes added to the metadata response.')
                    ->useAttributeAsKey('name')
                    ->prototype('array')
                        ->children()
                            ->scalarNode('route_name')
                                ->info('Route name.')
                                ->isRequired()
                            ->end()
                            ->arrayNode('route_parameters')
                                ->info('Parameters associated to the route (if needed).')
                                ->useAttributeAsKey('name')
                                ->prototype('variable')->end()
                                ->treatNullLike([])
                            ->end()
                        ->end()
                    ->end()
                    ->treatNullLike([])
                ->end()
                ->arrayNode('custom_values')
                    ->info('Custom values added to the metadata response.')
                    ->useAttributeAsKey('name')
                    ->prototype('variable')->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\Endpoint;
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\Definition\Builder\NodeDefinition;
20			use Symfony\Component\Config\FileLocator;
21			use Symfony\Component\DependencyInjection\ContainerBuilder;
22
23			final class MetadataEndpointSource extends ActionableSource
24			{
25			/**
26			* @var SourceInterface[]
27			*/
28			private $subSources;
29
30			/**
31			* AuthorizationEndpointSource constructor.
32			*/
33			public function __construct()
34			{
35			$this->subSources = [
36			new SignedMetadataEndpointSource(),
37			];
38			}
39
40			/**
41			* {@inheritdoc}
42			*/
43			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
44			{
45			foreach (['path', 'custom_values', 'custom_routes'] as $key) {
46			$container->setParameter($path.'.'.$key, $config[$key]);
47			}
48			$loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/endpoint'));
49			$loader->load('metadata.php');
50			foreach ($this->subSources as $source) {
51			$source->load($path, $container, $config);
52			}
53			}
54
55			public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
56			{
57			parent::prepend($bundleConfig, $path, $container);
58			foreach ($this->subSources as $source) {
59			$source->prepend($bundleConfig, $path.'['.$this->name().']', $container);
60			}
61			}
62
63			/**
64			* {@inheritdoc}
65			*/
66			protected function name(): string
67			{
68			return 'metadata';
69			}
70
71			/**
72			* {@inheritdoc}
73			*/
74			protected function continueConfiguration(NodeDefinition $node)
75			{
76			parent::continueConfiguration($node);
77			$node
			0 ignored issues – show Bug introduced 2017-04-12 12:03 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...
78			->validate()
79			->ifTrue(function ($config) {
80			return true === $config['enabled'] && empty($config['path']);
81			})
82			->thenInvalid('The route name must be set.')
83			->end()
84			->children()
85			->scalarNode('path')->defaultValue('/.well-known/openid-configuration')->end()
86			->arrayNode('custom_routes')
87			->info('Custom routes added to the metadata response.')
88			->useAttributeAsKey('name')
89			->prototype('array')
90			->children()
91			->scalarNode('route_name')
92			->info('Route name.')
93			->isRequired()
94			->end()
95			->arrayNode('route_parameters')
96			->info('Parameters associated to the route (if needed).')
97			->useAttributeAsKey('name')
98			->prototype('variable')->end()
99			->treatNullLike([])
100			->end()
101			->end()
102			->end()
103			->treatNullLike([])
104			->end()
105			->arrayNode('custom_values')
106			->info('Custom values added to the metadata response.')
107			->useAttributeAsKey('name')
108			->prototype('variable')->end()
109			->treatNullLike([])
110			->end()
111			->end();
112			foreach ($this->subSources as $source) {
113			$source->addConfiguration($node);
114			}
115			}
116			}
117

OAuth2-Framework / oauth2-framework

Push — master ( af58b3...cca06a )

MetadataEndpointSource::continueLoading() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like