BroadcasterFactory - Code Metrics - Inspection of "WIP: Initial slack channel implentation" - irishdan/NotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ccd20f...6ee4e9 )

by dan

created 2017-08-18 13:28 UTC

BroadcasterFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	28
Duplicated Lines	32.14 %

Coupling/Cohesion

Components	0
Dependencies	4

Importance

Changes

Metric	Value
wmc	3
lcom	0
cbo	4
dl	9
loc	28
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getKey()	0	4	1
A	create()	9	9	1
A	addConfiguration()	0	10	1

How to fix Duplicated Code

<?php

namespace IrishDan\NotificationBundle\DependencyInjection\Factory\Broadcaster;

use IrishDan\NotificationBundle\DependencyInjection\Factory\BroadcasterFactoryInterface;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\DefinitionDecorator;
use Symfony\Component\DependencyInjection\Reference;

class BroadcasterFactory implements BroadcasterFactoryInterface
{
    public function getKey()
    {
        return 'adapter';
    }

    public function create(ContainerBuilder $container, $id, array $config)

    {
        $container
            ->setDefinition($id, new DefinitionDecorator('oneup_flysystem.cache.adapter'))

            ->replaceArgument(0, new Reference(sprintf('oneup_flysystem.%s_adapter', $config['adapter'])))
            // ->replaceArgument(1, $config['key'])

            // ->replaceArgument(2, $config['expires'])

        ;
    }

    public function addConfiguration(NodeDefinition $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('adapter')->isRequired()->end()
                ->scalarNode('key')->defaultValue('flysystem')->end()
                ->scalarNode('expires')->defaultNull()->end()
            ->end()
        ;
    }
}


1		<?php
2
3		namespace IrishDan\NotificationBundle\DependencyInjection\Factory\Broadcaster;
4
5		use IrishDan\NotificationBundle\DependencyInjection\Factory\BroadcasterFactoryInterface;
6		use Symfony\Component\Config\Definition\Builder\NodeDefinition;
7		use Symfony\Component\DependencyInjection\ContainerBuilder;
8		use Symfony\Component\DependencyInjection\DefinitionDecorator;
9		use Symfony\Component\DependencyInjection\Reference;
10
11		class BroadcasterFactory implements BroadcasterFactoryInterface
12		{
13		public function getKey()
14		{
15		return 'adapter';
16		}
17
18	View Code Duplication	public function create(ContainerBuilder $container, $id, array $config)
		0 ignored issues – show Duplication introduced 2017-08-18 13:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
19		{
20		$container
21		->setDefinition($id, new DefinitionDecorator('oneup_flysystem.cache.adapter'))
		0 ignored issues – show Deprecated Code introduced 2017-08-18 13:30 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Depend...ion\DefinitionDecorator` has been deprecated with message: The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
22		->replaceArgument(0, new Reference(sprintf('oneup_flysystem.%s_adapter', $config['adapter'])))
23		// ->replaceArgument(1, $config['key'])
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-18 13:30 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
24		// ->replaceArgument(2, $config['expires'])
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-08-18 13:30 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
25		;
26		}
27
28		public function addConfiguration(NodeDefinition $node)
29		{
30		$node
		0 ignored issues – show Bug introduced 2017-08-18 13:30 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...
31		->children()
32		->scalarNode('adapter')->isRequired()->end()
33		->scalarNode('key')->defaultValue('flysystem')->end()
34		->scalarNode('expires')->defaultNull()->end()
35		->end()
36		;
37		}
38		}
39

irishdan / NotificationBundle

Push — master ( ccd20f...6ee4e9 )

BroadcasterFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like