KeySet::prepend() - 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

KeySet::prepend() A

↳ Parent: KeySet

Complexity

Conditions	3
Paths	4

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	4
nop	2

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

use Jose\Bundle\JoseFramework\Helper\ConfigurationHelper;
use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;

final class KeySet implements Component

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

    /**
     * {@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.
    }
}
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('signature')->defaultNull()->end()
                ->scalarNode('encryption')->defaultNull()->end()
            ->end();
    }


    /**
     * {@inheritdoc}
     */
    public function prepend(ContainerBuilder $container, array $config): array
    {
        if (null !== $config['key_set']['signature']) {
            ConfigurationHelper::addKeyset($container, 'oauth2_server.key_set.signature', 'jwkset', ['value' => $config['key_set']['signature']]);
        }
        if (null !== $config['key_set']['encryption']) {
            ConfigurationHelper::addKeyset($container, 'oauth2_server.key_set.encryption', 'jwkset', ['value' => $config['key_set']['encryption']]);
        }
        return [];
    }
}


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\Core;
15
16			use Jose\Bundle\JoseFramework\Helper\ConfigurationHelper;
17			use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
18			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
19			use Symfony\Component\DependencyInjection\ContainerBuilder;
20
21			final class KeySet implements Component
			0 ignored issues – show Bug introduced 2018-01-31 21:55 UTC by Report Bug Copy Issue Report There is one abstract method `load` in this class; you could implement it, or declare this class as abstract. Loading history...
22			{
23			/**
24			* {@inheritdoc}
25			*/
26			public function name(): string
27			{
28			return 'key_set';
29			}
30
31			/**
32			* {@inheritdoc}
33			*/
34			public function getNodeDefinition(NodeDefinition $node)
35			{
36
37			$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 `addDefaultsIfNotSet()` 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...
38			->addDefaultsIfNotSet()
39			->children()
40			->scalarNode('signature')->defaultNull()->end()
41			->scalarNode('encryption')->defaultNull()->end()
42			->end();
43			}
44
45
46			/**
47			* {@inheritdoc}
48			*/
49			public function prepend(ContainerBuilder $container, array $config): array
50			{
51			if (null !== $config['key_set']['signature']) {
52			ConfigurationHelper::addKeyset($container, 'oauth2_server.key_set.signature', 'jwkset', ['value' => $config['key_set']['signature']]);
53			}
54			if (null !== $config['key_set']['encryption']) {
55			ConfigurationHelper::addKeyset($container, 'oauth2_server.key_set.encryption', 'jwkset', ['value' => $config['key_set']['encryption']]);
56			}
57			return [];
58			}
59			}
60

OAuth2-Framework / oauth2-framework

Push — ng ( e90992...13fb6e )

KeySet::prepend() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like