ScopePolicySource - Code Metrics - Inspection of "Missing Configuration Options and Better sub-Sourc..." - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( a4b7bc...6567cc )

by Florent

created 2017-04-21 09:09 UTC

ScopePolicySource A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	8

Importance

Changes

Metric	Value
wmc	6
lcom	0
cbo	8
dl	0
loc	52
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	name()	4	1
A	continueLoading()	8	2
A	continueConfiguration()	17	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\Scope;

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

final class ScopePolicySource extends ActionableSource
{
    /**
     * ScopePolicySource constructor.
     */
    public function __construct()
    {
        $this->addSubSource(new ScopePolicyErrorSource());
        $this->addSubSource(new ScopePolicyDefaultSource());
    }

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

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

    /**
     * {@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['by_default']);
                })
                ->thenInvalid('The option "repository" must be set.')
            ->end()
            ->children()
                ->scalarNode('by_default')
                    ->info('Default scope policy.')
                    ->defaultValue('none')
                ->end()
            ->end();
    }
}


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\Scope;
15
16			use Fluent\PhpConfigFileLoader;
17			use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
18			use Symfony\Component\Config\FileLocator;
19			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
20			use Symfony\Component\DependencyInjection\ContainerBuilder;
21
22			final class ScopePolicySource extends ActionableSource
23			{
24			/**
25			* ScopePolicySource constructor.
26			*/
27			public function __construct()
28			{
29			$this->addSubSource(new ScopePolicyErrorSource());
30			$this->addSubSource(new ScopePolicyDefaultSource());
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			protected function name(): string
37			{
38			return 'policy';
39			}
40
41			/**
42			* {@inheritdoc}
43			*/
44			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
45			{
46			foreach (['by_default'] as $k) {
47			$container->setParameter($path.'.'.$k, $config[$k]);
48			}
49			$loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/scope'));
50			$loader->load('policy.php');
51			}
52
53			/**
54			* {@inheritdoc}
55			*/
56			protected function continueConfiguration(NodeDefinition $node)
57			{
58			parent::continueConfiguration($node);
59			$node
			0 ignored issues – show Bug introduced 2017-04-04 20:51 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...
60			->validate()
61			->ifTrue(function ($config) {
62			return true === $config['enabled'] && empty($config['by_default']);
63			})
64			->thenInvalid('The option "repository" must be set.')
65			->end()
66			->children()
67			->scalarNode('by_default')
68			->info('Default scope policy.')
69			->defaultValue('none')
70			->end()
71			->end();
72			}
73			}
74

OAuth2-Framework / oauth2-framework

Push — master ( a4b7bc...6567cc )

ScopePolicySource A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like