UserAccountSource::continueConfiguration() - Code Metrics - Inspection of "Better User Account and Resource Server Configurat..." - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#41)

by Florent

created 2017-04-13 13:38 UTC

UserAccountSource::continueConfiguration() A

↳ Parent: UserAccountSource

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	13
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;

use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;

final class UserAccountSource extends ArraySource
{
    /**
     * {@inheritdoc}
     */
    protected function name(): string
    {
        return 'user_account';
    }

    /**
     * {@inheritdoc}
     */
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
    {
        foreach (['repository', 'manager'] as $k) {
            $container->setAlias($path.'.'.$k, $config[$k]);
        }
    }

    /**
     * {@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()
                ->scalarNode('repository')
                    ->info('The user account repository.')
                    ->isRequired()
                ->end()
                ->scalarNode('manager')
                    ->info('The user account manager.')
                    ->isRequired()
                ->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;
15
16			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
17			use Symfony\Component\DependencyInjection\ContainerBuilder;
18
19			final class UserAccountSource extends ArraySource
20			{
21			/**
22			* {@inheritdoc}
23			*/
24			protected function name(): string
25			{
26			return 'user_account';
27			}
28
29			/**
30			* {@inheritdoc}
31			*/
32			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
33			{
34			foreach (['repository', 'manager'] as $k) {
35			$container->setAlias($path.'.'.$k, $config[$k]);
36			}
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			protected function continueConfiguration(NodeDefinition $node)
43			{
44			parent::continueConfiguration($node);
45			$node
			0 ignored issues – show Bug introduced 2017-04-13 13:42 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...
46			->children()
47			->scalarNode('repository')
48			->info('The user account repository.')
49			->isRequired()
50			->end()
51			->scalarNode('manager')
52			->info('The user account manager.')
53			->isRequired()
54			->end()
55			->end();
56			}
57			}
58

OAuth2-Framework / oauth2-framework

Pull Request — master (#41)

UserAccountSource::continueConfiguration() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like