Configuration::addResourcesSection() - Code Metrics - Inspection of "Merge pull request #6522 from coudenysj/patch-1" - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 85508a...fbb5f8 )

by Kamil

created 2016-10-25 08:12 UTC

Configuration::addResourcesSection() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	68
Code Lines	65

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	68
rs	9.2447
c	0
b	0
f	0
cc	1
eloc	65
nc	1
nop	1

How to fix Long Method

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sylius\Bundle\ReviewBundle\DependencyInjection;

use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
use Sylius\Bundle\ResourceBundle\SyliusResourceBundle;
use Sylius\Bundle\ReviewBundle\Form\Type\ReviewType;
use Sylius\Component\Resource\Factory\Factory;
use Sylius\Component\Review\Model\ReviewerInterface;
use Sylius\Component\Review\Model\ReviewInterface;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * @author Daniel Richter <[email protected]>
 * @author Grzegorz Sadowski <[email protected]>
 */
final class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('sylius_review');

        $rootNode
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('driver')->defaultValue(SyliusResourceBundle::DRIVER_DOCTRINE_ORM)->end()
            ->end()
        ;

        $this->addResourcesSection($rootNode);

        return $treeBuilder;
    }

    /**
     * @param ArrayNodeDefinition $node
     */
    private function addResourcesSection(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('resources')
                ->useAttributeAsKey('name')
                ->prototype('array')
                    ->children()
                        ->scalarNode('subject')->isRequired()->end()
                        ->arrayNode('review')
                            ->isRequired()
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('classes')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('model')->isRequired()->end()
                                        ->scalarNode('interface')->defaultValue(ReviewInterface::class)->cannotBeEmpty()->end()
                                        ->scalarNode('controller')->defaultValue(ResourceController::class)->cannotBeEmpty()->end()
                                        ->scalarNode('repository')->defaultValue(EntityRepository::class)->cannotBeEmpty()->end()
                                        ->scalarNode('factory')->defaultValue(Factory::class)->cannotBeEmpty()->end()
                                        ->arrayNode('form')
                                            ->addDefaultsIfNotSet()
                                            ->children()
                                                ->scalarNode('default')->defaultValue(ReviewType::class)->cannotBeEmpty()->end()
                                            ->end()
                                        ->end()
                                    ->end()
                                ->end()
                                ->arrayNode('validation_groups')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->arrayNode('default')
                                            ->prototype('scalar')->end()
                                            ->defaultValue(['sylius'])
                                        ->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('reviewer')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('classes')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('model')->isRequired()->end()
                                        ->scalarNode('interface')->defaultValue(ReviewerInterface::class)->cannotBeEmpty()->end()
                                        ->scalarNode('repository')->cannotBeEmpty()->end()
                                        ->scalarNode('factory')->defaultValue(Factory::class)->cannotBeEmpty()->end()
                                    ->end()
                                ->end()
                                ->arrayNode('validation_groups')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->arrayNode('default')
                                            ->prototype('scalar')->end()
                                            ->defaultValue(['sylius'])
                                        ->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Bundle\ReviewBundle\DependencyInjection;
13
14			use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
15			use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
16			use Sylius\Bundle\ResourceBundle\SyliusResourceBundle;
17			use Sylius\Bundle\ReviewBundle\Form\Type\ReviewType;
18			use Sylius\Component\Resource\Factory\Factory;
19			use Sylius\Component\Review\Model\ReviewerInterface;
20			use Sylius\Component\Review\Model\ReviewInterface;
21			use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
22			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
23			use Symfony\Component\Config\Definition\ConfigurationInterface;
24
25			/**
26			* @author Daniel Richter <[email protected]>
27			* @author Grzegorz Sadowski <[email protected]>
28			*/
29			final class Configuration implements ConfigurationInterface
30			{
31			/**
32			* {@inheritdoc}
33			*/
34			public function getConfigTreeBuilder()
35			{
36			$treeBuilder = new TreeBuilder();
37			$rootNode = $treeBuilder->root('sylius_review');
38
39			$rootNode
40			->addDefaultsIfNotSet()
41			->children()
42			->scalarNode('driver')->defaultValue(SyliusResourceBundle::DRIVER_DOCTRINE_ORM)->end()
43			->end()
44			;
45
46			$this->addResourcesSection($rootNode);
47
48			return $treeBuilder;
49			}
50
51			/**
52			* @param ArrayNodeDefinition $node
53			*/
54			private function addResourcesSection(ArrayNodeDefinition $node)
55			{
56			$node
			0 ignored issues – show Bug introduced 2016-06-24 14:31 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			->arrayNode('resources')
59			->useAttributeAsKey('name')
60			->prototype('array')
61			->children()
62			->scalarNode('subject')->isRequired()->end()
63			->arrayNode('review')
64			->isRequired()
65			->addDefaultsIfNotSet()
66			->children()
67			->arrayNode('classes')
68			->addDefaultsIfNotSet()
69			->children()
70			->scalarNode('model')->isRequired()->end()
71			->scalarNode('interface')->defaultValue(ReviewInterface::class)->cannotBeEmpty()->end()
72			->scalarNode('controller')->defaultValue(ResourceController::class)->cannotBeEmpty()->end()
73			->scalarNode('repository')->defaultValue(EntityRepository::class)->cannotBeEmpty()->end()
74			->scalarNode('factory')->defaultValue(Factory::class)->cannotBeEmpty()->end()
75			->arrayNode('form')
76			->addDefaultsIfNotSet()
77			->children()
78			->scalarNode('default')->defaultValue(ReviewType::class)->cannotBeEmpty()->end()
79			->end()
80			->end()
81			->end()
82			->end()
83			->arrayNode('validation_groups')
84			->addDefaultsIfNotSet()
85			->children()
86			->arrayNode('default')
87			->prototype('scalar')->end()
88			->defaultValue(['sylius'])
89			->end()
90			->end()
91			->end()
92			->end()
93			->end()
94			->arrayNode('reviewer')
95			->addDefaultsIfNotSet()
96			->children()
97			->arrayNode('classes')
98			->addDefaultsIfNotSet()
99			->children()
100			->scalarNode('model')->isRequired()->end()
101			->scalarNode('interface')->defaultValue(ReviewerInterface::class)->cannotBeEmpty()->end()
102			->scalarNode('repository')->cannotBeEmpty()->end()
103			->scalarNode('factory')->defaultValue(Factory::class)->cannotBeEmpty()->end()
104			->end()
105			->end()
106			->arrayNode('validation_groups')
107			->addDefaultsIfNotSet()
108			->children()
109			->arrayNode('default')
110			->prototype('scalar')->end()
111			->defaultValue(['sylius'])
112			->end()
113			->end()
114			->end()
115			->end()
116			->end()
117			->end()
118			->end()
119			->end()
120			;
121			}
122			}
123

pamil / Sylius

Push — master ( 85508a...fbb5f8 )

Configuration::addResourcesSection() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like