Configuration - Code Metrics - Inspection of "added seo bundle and component (#787)" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e48710...5fe26c )

by Rafał

created 2019-05-07 11:17 UTC

Configuration A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	49
Duplicated Lines	100 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
wmc	1
lcom	0
cbo	1
dl	49
loc	49
rs	10
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getConfigTreeBuilder()	46	46	1

How to fix Duplicated Code

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Web Publisher Seo Bundle.
 *
 * Copyright 2019 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2019 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\SeoBundle\DependencyInjection;

use SWP\Bundle\StorageBundle\Doctrine\ORM\EntityRepository;
use SWP\Component\Seo\Model\SeoImage;
use SWP\Component\Seo\Model\SeoImageInterface;
use SWP\Component\Seo\Model\SeoMetadata;
use SWP\Component\Seo\Model\SeoMetadataInterface;
use SWP\Component\Storage\Factory\Factory;
use Symfony\Component\Config\Definition\Builder\NodeParentInterface;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder(): NodeParentInterface
    {
        $treeBuilder = new TreeBuilder('swp_seo');
        $treeBuilder->getRootNode()
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('upload_destination')->cannotBeEmpty()->end()
                ->arrayNode('persistence')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->arrayNode('orm')
                            ->addDefaultsIfNotSet()
                            ->canBeEnabled()
                            ->children()
                                ->arrayNode('classes')
                                ->addDefaultsIfNotSet()
                                ->children()
                                    ->arrayNode('seo_metadata')
                                        ->addDefaultsIfNotSet()
                                        ->children()
                                            ->scalarNode('model')->cannotBeEmpty()->defaultValue(SeoMetadata::class)->end()
                                            ->scalarNode('repository')->defaultValue(EntityRepository::class)->end()
                                            ->scalarNode('factory')->defaultValue(Factory::class)->end()
                                            ->scalarNode('interface')->defaultValue(SeoMetadataInterface::class)->end()
                                            ->scalarNode('object_manager_name')->defaultValue(null)->end()
                                        ->end()
                                    ->end()
                                    ->arrayNode('seo_image')
                                        ->addDefaultsIfNotSet()
                                        ->children()
                                            ->scalarNode('model')->cannotBeEmpty()->defaultValue(SeoImage::class)->end()
                                            ->scalarNode('repository')->defaultValue(EntityRepository::class)->end()
                                            ->scalarNode('factory')->defaultValue(Factory::class)->end()
                                            ->scalarNode('interface')->defaultValue(SeoImageInterface::class)->end()
                                            ->scalarNode('object_manager_name')->defaultValue(null)->end()
                                        ->end()
                                    ->end()
                                ->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();

        return $treeBuilder;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of the Superdesk Web Publisher Seo Bundle.
7		*
8		* Copyright 2019 Sourcefabric z.ú. and contributors.
9		*
10		* For the full copyright and license information, please see the
11		* AUTHORS and LICENSE files distributed with this source code.
12		*
13		* @copyright 2019 Sourcefabric z.ú
14		* @license http://www.superdesk.org/license
15		*/
16
17		namespace SWP\Bundle\SeoBundle\DependencyInjection;
18
19		use SWP\Bundle\StorageBundle\Doctrine\ORM\EntityRepository;
20		use SWP\Component\Seo\Model\SeoImage;
21		use SWP\Component\Seo\Model\SeoImageInterface;
22		use SWP\Component\Seo\Model\SeoMetadata;
23		use SWP\Component\Seo\Model\SeoMetadataInterface;
24		use SWP\Component\Storage\Factory\Factory;
25		use Symfony\Component\Config\Definition\Builder\NodeParentInterface;
26		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
27		use Symfony\Component\Config\Definition\ConfigurationInterface;
28
29	View Code Duplication	class Configuration implements ConfigurationInterface
30		{
31		public function getConfigTreeBuilder(): NodeParentInterface
32		{
33		$treeBuilder = new TreeBuilder('swp_seo');
34		$treeBuilder->getRootNode()
		0 ignored issues – show Bug introduced 2019-04-04 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...
35		->children()
36		->scalarNode('upload_destination')->cannotBeEmpty()->end()
37		->arrayNode('persistence')
38		->addDefaultsIfNotSet()
39		->children()
40		->arrayNode('orm')
41		->addDefaultsIfNotSet()
42		->canBeEnabled()
43		->children()
44		->arrayNode('classes')
45		->addDefaultsIfNotSet()
46		->children()
47		->arrayNode('seo_metadata')
48		->addDefaultsIfNotSet()
49		->children()
50		->scalarNode('model')->cannotBeEmpty()->defaultValue(SeoMetadata::class)->end()
51		->scalarNode('repository')->defaultValue(EntityRepository::class)->end()
52		->scalarNode('factory')->defaultValue(Factory::class)->end()
53		->scalarNode('interface')->defaultValue(SeoMetadataInterface::class)->end()
54		->scalarNode('object_manager_name')->defaultValue(null)->end()
55		->end()
56		->end()
57		->arrayNode('seo_image')
58		->addDefaultsIfNotSet()
59		->children()
60		->scalarNode('model')->cannotBeEmpty()->defaultValue(SeoImage::class)->end()
61		->scalarNode('repository')->defaultValue(EntityRepository::class)->end()
62		->scalarNode('factory')->defaultValue(Factory::class)->end()
63		->scalarNode('interface')->defaultValue(SeoImageInterface::class)->end()
64		->scalarNode('object_manager_name')->defaultValue(null)->end()
65		->end()
66		->end()
67		->end()
68		->end()
69		->end()
70		->end()
71		->end()
72		->end()
73		->end();
74
75		return $treeBuilder;
76		}
77		}
78

superdesk / web-publisher

Push — master ( e48710...5fe26c )

Configuration A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like