MetadataEndpointSource::getNodeDefinition() - Code Metrics - Inspection of "Bundle updated (WIP)" - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — ng ( e90992...13fb6e )

by Florent

created 2018-01-31 21:37 UTC

MetadataEndpointSource::getNodeDefinition() B

↳ Parent: MetadataEndpointSource

Complexity

Conditions	2
Paths	1

Size

Total Lines	39
Code Lines	35

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	35
nc	1
nop	1

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 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\DependencyInjection\Component\Endpoint;

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

final class MetadataEndpointSource implements Component

{
    /**
     * MetadataEndpointSource constructor.
     */
    public function __construct()
    {
        $this->addSubSource(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');
    }

    /**
     * {@inheritdoc}
     */
    public function name(): string
    {
        return 'metadata';
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeDefinition(NodeDefinition $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();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2018 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\DependencyInjection\Component\Endpoint;
15
16			use Fluent\PhpConfigFileLoader;
17			use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
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 implements Component
			0 ignored issues – show Bug introduced 2018-01-31 21:55 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: load, prepend Loading history...
23			{
24			/**
25			* MetadataEndpointSource constructor.
26			*/
27			public function __construct()
28			{
29			$this->addSubSource(new SignedMetadataEndpointSource());
			0 ignored issues – show Bug introduced 2018-01-31 21:55 UTC by Report Bug Copy Issue Report The method `addSubSource()` does not seem to exist on `object<OAuth2Framework\B...MetadataEndpointSource>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
30			}
31
32			/**
33			* {@inheritdoc}
34			*/
35			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
36			{
37			foreach (['path', 'custom_values', 'custom_routes'] as $key) {
38			$container->setParameter($path.'.'.$key, $config[$key]);
39			}
40			$loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/endpoint'));
41			$loader->load('metadata.php');
42			}
43
44			/**
45			* {@inheritdoc}
46			*/
47			public function name(): string
48			{
49			return 'metadata';
50			}
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function getNodeDefinition(NodeDefinition $node)
56			{
57
58			$node
			0 ignored issues – show Bug introduced 2018-01-31 21:55 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...
59			->validate()
60			->ifTrue(function ($config) {
61			return true === $config['enabled'] && empty($config['path']);
62			})
63			->thenInvalid('The route name must be set.')
64			->end()
65			->children()
66			->scalarNode('path')->defaultValue('/.well-known/openid-configuration')->end()
67			->arrayNode('custom_routes')
68			->info('Custom routes added to the metadata response.')
69			->useAttributeAsKey('name')
70			->prototype('array')
71			->children()
72			->scalarNode('route_name')
73			->info('Route name.')
74			->isRequired()
75			->end()
76			->arrayNode('route_parameters')
77			->info('Parameters associated to the route (if needed).')
78			->useAttributeAsKey('name')
79			->prototype('variable')->end()
80			->treatNullLike([])
81			->end()
82			->end()
83			->end()
84			->treatNullLike([])
85			->end()
86			->arrayNode('custom_values')
87			->info('Custom values added to the metadata response.')
88			->useAttributeAsKey('name')
89			->prototype('variable')->end()
90			->treatNullLike([])
91			->end()
92			->end();
93			}
94			}
95

OAuth2-Framework / oauth2-framework

Push — ng ( e90992...13fb6e )

MetadataEndpointSource::getNodeDefinition() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like