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

Failed Conditions

Pull Request — master (#37)

by Florent

created 2017-04-12 15:41 UTC

MetadataEndpointSource::continueConfiguration() B

↳ Parent: MetadataEndpointSource

Complexity

Conditions	2
Paths	1

Size

Total Lines	39
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	39
rs	8.8571
c	0
b	0
f	0
cc	2
eloc	36
nc	1
nop	1

<?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 Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;

final class MetadataEndpointSource extends ActionableSource
{
    /**
     * {@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');
    }

    /**
     * {@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(); //FIXME: add signature support
    }
}


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 Symfony\Component\Config\Definition\Builder\NodeDefinition;
19			use Symfony\Component\Config\FileLocator;
20			use Symfony\Component\DependencyInjection\ContainerBuilder;
21
22			final class MetadataEndpointSource extends ActionableSource
23			{
24			/**
25			* {@inheritdoc}
26			*/
27			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
28			{
29			foreach (['path', 'custom_values', 'custom_routes'] as $key) {
30			$container->setParameter($path.'.'.$key, $config[$key]);
31			}
32			$loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/endpoint'));
33			$loader->load('metadata.php');
34			}
35
36			/**
37			* {@inheritdoc}
38			*/
39			protected function name(): string
40			{
41			return 'metadata';
42			}
43
44			/**
45			* {@inheritdoc}
46			*/
47			protected function continueConfiguration(NodeDefinition $node)
48			{
49			parent::continueConfiguration($node);
50			$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...
51			->validate()
52			->ifTrue(function ($config) {
53			return true === $config['enabled'] && empty($config['path']);
54			})
55			->thenInvalid('The route name must be set.')
56			->end()
57			->children()
58			->scalarNode('path')->defaultValue('/.well-known/openid-configuration')->end()
59			->arrayNode('custom_routes')
60			->info('Custom routes added to the metadata response.')
61			->useAttributeAsKey('name')
62			->prototype('array')
63			->children()
64			->scalarNode('route_name')
65			->info('Route name.')
66			->isRequired()
67			->end()
68			->arrayNode('route_parameters')
69			->info('Parameters associated to the route (if needed).')
70			->useAttributeAsKey('name')
71			->prototype('variable')->end()
72			->treatNullLike([])
73			->end()
74			->end()
75			->end()
76			->treatNullLike([])
77			->end()
78			->arrayNode('custom_values')
79			->info('Custom values added to the metadata response.')
80			->useAttributeAsKey('name')
81			->prototype('variable')->end()
82			->treatNullLike([])
83			->end()
84			->end(); //FIXME: add signature support
85			}
86			}
87

OAuth2-Framework / oauth2-framework

Pull Request — master (#37)

MetadataEndpointSource::continueConfiguration() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like