Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "Support auto-registration of commands" - dunglas/DunglasActionBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

by Guilh

created 2016-03-08 17:41 UTC

Configuration::getConfigTreeBuilder() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	38
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	38
rs	8.8571
cc	1
eloc	33
nc	1
nop	0

<?php

/*
 * (c) Kévin Dunglas <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Dunglas\ActionBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * {@inheritdoc}
 *
 * @author Kévin Dunglas <[email protected]>
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $autodiscoverNode = new ArrayNodeDefinition('autodiscover');
        $autodiscoverNode
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.
    }
}
            ->info('Autodiscover classes stored in the configured directory of bundles and register them as service.')
            ->canBeDisabled()
            ->children()
                ->arrayNode('directories')
                    ->info('The directories name to autodiscover in bundles.')
                    ->prototype('scalar')->end()
                    ->defaultValue(['Action'])
                ->end()
            ->end();

        $directoriesNode = new ArrayNodeDefinition('directories');
        $directoriesNode
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.
    }
}
            ->info('List of directories relative to the kernel root directory containing action classes.')
            ->prototype('scalar')->end()
            ->defaultValue([]);

        $treeBuilder = new TreeBuilder();
        $treeBuilder->root('dunglas_action')
            ->children()
                ->arrayNode('actions')
                    ->canBeDisabled()
                    ->append($autodiscoverNode)
                    ->append($directoriesNode)
                ->end()
                ->arrayNode('commands')
                    ->canBeDisabled()
                    ->append($autodiscoverNode)
                    ->append($directoriesNode)
                ->end()
            ->end()
        ->end();

        return $treeBuilder;
    }
}


Pull Request — master (#12)

Configuration::getConfigTreeBuilder() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			/*
4			* (c) Kévin Dunglas <[email protected]>
5			*
6			* This source file is subject to the MIT license that is bundled
7			* with this source code in the file LICENSE.
8			*/
9
10			namespace Dunglas\ActionBundle\DependencyInjection;
11
12			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
13			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
14			use Symfony\Component\Config\Definition\ConfigurationInterface;
15
16			/**
17			* {@inheritdoc}
18			*
19			* @author Kévin Dunglas <[email protected]>
20			*/
21			class Configuration implements ConfigurationInterface
22			{
23			/**
24			* {@inheritdoc}
25			*/
26			public function getConfigTreeBuilder()
27			{
28			$autodiscoverNode = new ArrayNodeDefinition('autodiscover');
29			$autodiscoverNode
			0 ignored issues – show Bug introduced 2016-03-08 17: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 `canBeDisabled()` 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...
30			->info('Autodiscover classes stored in the configured directory of bundles and register them as service.')
31			->canBeDisabled()
32			->children()
33			->arrayNode('directories')
34			->info('The directories name to autodiscover in bundles.')
35			->prototype('scalar')->end()
36			->defaultValue(['Action'])
37			->end()
38			->end();
39
40			$directoriesNode = new ArrayNodeDefinition('directories');
41			$directoriesNode
			0 ignored issues – show Bug introduced 2016-03-08 17: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 `prototype()` 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...
42			->info('List of directories relative to the kernel root directory containing action classes.')
43			->prototype('scalar')->end()
44			->defaultValue([]);
45
46			$treeBuilder = new TreeBuilder();
47			$treeBuilder->root('dunglas_action')
48			->children()
49			->arrayNode('actions')
50			->canBeDisabled()
51			->append($autodiscoverNode)
52			->append($directoriesNode)
53			->end()
54			->arrayNode('commands')
55			->canBeDisabled()
56			->append($autodiscoverNode)
57			->append($directoriesNode)
58			->end()
59			->end()
60			->end();
61
62			return $treeBuilder;
63			}
64			}
65

dunglas / DunglasActionBundle

Pull Request — master (#12)

Configuration::getConfigTreeBuilder() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like