JWSBuilder::createService() - Code Metrics - Inspection of "JWE Builder factory service" - Spomky-Labs/jose - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — v7 ( 0b3eb8...e446d4 )

by Florent

created 2017-09-05 11:11 UTC

JWSBuilder::createService() A

↳ Parent: JWSBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	3

<?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 Jose\Bundle\Signature\DependencyInjection\Source;

use Jose\Bundle\JoseFramework\DependencyInjection\Source\SourceInterface;
use Jose\Component\Signature\JWSBuilderFactory;
use Jose\Component\Signature\JWSBuilder as JWSBuilderService;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;

final class JWSBuilder implements SourceInterface
{
    /**
     * {@inheritdoc}
     */
    public function name(): string
    {
        return 'jws_builders';
    }

    /**
     * {@inheritdoc}
     */
    public function createService(string $name, array $config, ContainerBuilder $container)
    {
        $service_id = sprintf('jose.jws_builder.%s', $name);
        $definition = new Definition(JWSBuilderService::class);
        $definition
            ->setFactory([new Reference(JWSBuilderFactory::class), 'create'])
            ->setArguments([$config['signature_algorithms']])
            ->setPublic($config['is_public']);

        $container->setDefinition($service_id, $definition);
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeDefinition(ArrayNodeDefinition $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()
                ->arrayNode($this->name())
                    ->useAttributeAsKey('name')
                    ->prototype('array')
                        ->children()
                            ->booleanNode('is_public')
                                ->info('If true, the service will be public, else private.')
                                ->defaultTrue()
                            ->end()
                            ->arrayNode('signature_algorithms')
                                ->useAttributeAsKey('name')
                                ->isRequired()
                                ->prototype('scalar')->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    /**
     * {@inheritdoc}
     */
    public function prepend(ContainerBuilder $container, array $config): ?array
    {
        return null;
    }
}


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 Jose\Bundle\Signature\DependencyInjection\Source;
15
16			use Jose\Bundle\JoseFramework\DependencyInjection\Source\SourceInterface;
17			use Jose\Component\Signature\JWSBuilderFactory;
18			use Jose\Component\Signature\JWSBuilder as JWSBuilderService;
19			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
20			use Symfony\Component\DependencyInjection\ContainerBuilder;
21			use Symfony\Component\DependencyInjection\Definition;
22			use Symfony\Component\DependencyInjection\Reference;
23
24			final class JWSBuilder implements SourceInterface
25			{
26			/**
27			* {@inheritdoc}
28			*/
29			public function name(): string
30			{
31			return 'jws_builders';
32			}
33
34			/**
35			* {@inheritdoc}
36			*/
37			public function createService(string $name, array $config, ContainerBuilder $container)
38			{
39			$service_id = sprintf('jose.jws_builder.%s', $name);
40			$definition = new Definition(JWSBuilderService::class);
41			$definition
42			->setFactory([new Reference(JWSBuilderFactory::class), 'create'])
43			->setArguments([$config['signature_algorithms']])
44			->setPublic($config['is_public']);
45
46			$container->setDefinition($service_id, $definition);
47			}
48
49			/**
50			* {@inheritdoc}
51			*/
52			public function getNodeDefinition(ArrayNodeDefinition $node)
53			{
54			$node
			1 ignored issue – show Bug introduced 2017-09-05 11:14 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...
55			->children()
56			->arrayNode($this->name())
57			->useAttributeAsKey('name')
58			->prototype('array')
59			->children()
60			->booleanNode('is_public')
61			->info('If true, the service will be public, else private.')
62			->defaultTrue()
63			->end()
64			->arrayNode('signature_algorithms')
65			->useAttributeAsKey('name')
66			->isRequired()
67			->prototype('scalar')->end()
68			->end()
69			->end()
70			->end()
71			->end()
72			->end();
73			}
74
75			/**
76			* {@inheritdoc}
77			*/
78			public function prepend(ContainerBuilder $container, array $config): ?array
79			{
80			return null;
81			}
82			}
83

Spomky-Labs / jose

Push — v7 ( 0b3eb8...e446d4 )

JWSBuilder::createService() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like