KeyFile::createDefinition() - Code Metrics - Inspection of "WIP JoseFrameworkBundle" - Spomky-Labs/jose - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — v7 ( 477009...5356df )

by Florent

created 2017-09-04 22:40 UTC

KeyFile::createDefinition() A

↳ Parent: KeyFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	10

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	10
nc	1
nop	2

<?php

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2016 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace Jose\Bundle\JoseFramework\DependencyInjection\Source\JWKSource;

use Jose\Bundle\JoseFramework\DependencyInjection\Source\AbstractSource;
use Jose\Component\Core\JWKFactory;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;

final class KeyFile extends AbstractSource implements JWKSourceInterface
{
    /**
     * {@inheritdoc}
     */
    public function createDefinition(ContainerBuilder $container, array $config): Definition
    {
        $definition = new Definition(JWK::class);
        $definition->setFactory([
            new Reference(JWKFactory::class),
            'createFromKeyFile',
        ]);
        $definition->setArguments([
            $config['path'],
            $config['password'],
            $config['additional_values'],
        ]);

        return $definition;
    }

    /**
     * {@inheritdoc}
     */
    public function getKey(): string
    {
        return 'file';
    }

    /**
     * {@inheritdoc}
     */
    public function addConfiguration(NodeDefinition $node)
    {
        parent::addConfiguration($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('path')->isRequired()->end()
                ->scalarNode('password')->defaultNull()->end()
                ->arrayNode('additional_values')
                    ->defaultValue([])
                    ->useAttributeAsKey('key')
                    ->prototype('variable')->end()
                ->end()
            ->end();
    }
}


1			<?php
2
3			/*
4			* The MIT License (MIT)
5			*
6			* Copyright (c) 2014-2016 Spomky-Labs
7			*
8			* This software may be modified and distributed under the terms
9			* of the MIT license. See the LICENSE file for details.
10			*/
11
12			namespace Jose\Bundle\JoseFramework\DependencyInjection\Source\JWKSource;
13
14			use Jose\Bundle\JoseFramework\DependencyInjection\Source\AbstractSource;
15			use Jose\Component\Core\JWKFactory;
16			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
17			use Symfony\Component\DependencyInjection\ContainerBuilder;
18			use Symfony\Component\DependencyInjection\Definition;
19			use Symfony\Component\DependencyInjection\Reference;
20
21			final class KeyFile extends AbstractSource implements JWKSourceInterface
22			{
23			/**
24			* {@inheritdoc}
25			*/
26			public function createDefinition(ContainerBuilder $container, array $config): Definition
27			{
28			$definition = new Definition(JWK::class);
29			$definition->setFactory([
30			new Reference(JWKFactory::class),
31			'createFromKeyFile',
32			]);
33			$definition->setArguments([
34			$config['path'],
35			$config['password'],
36			$config['additional_values'],
37			]);
38
39			return $definition;
40			}
41
42			/**
43			* {@inheritdoc}
44			*/
45			public function getKey(): string
46			{
47			return 'file';
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function addConfiguration(NodeDefinition $node)
54			{
55			parent::addConfiguration($node);
56			$node
			1 ignored issue – show Bug introduced 2017-09-04 22:43 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...
57			->children()
58			->scalarNode('path')->isRequired()->end()
59			->scalarNode('password')->defaultNull()->end()
60			->arrayNode('additional_values')
61			->defaultValue([])
62			->useAttributeAsKey('key')
63			->prototype('variable')->end()
64			->end()
65			->end();
66			}
67			}
68

Spomky-Labs / jose

Push — v7 ( 477009...5356df )

KeyFile::createDefinition() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like