Hydrate::warnForUnusedVariables() - Code Metrics - Inspection of "fix: files can now start with comments" - Niktux/karma - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — nln-php7 ( 5c4f20...6ce259 )

by Nicolas

created 2018-08-25 13:44 UTC

Hydrate::warnForUnusedVariables() A

↳ Parent: Hydrate

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	16
Ratio	100 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
dl	16
loc	16
ccs	9
cts	9
cp	1
rs	9.7333
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

<?php

declare(strict_types = 1);

namespace Karma\Console;

use Karma\ConfigurableProcessor;
use Karma\Application;
use Karma\Hydrator;

class Hydrate extends ConfigureActionCommand
{
    public function __construct(Application $app)
    {
        parent::__construct(
            $app,
            'hydrate',
            'Hydrate dist files',
            'Hydrate'
        );
    }

    protected function getProcessor(): ConfigurableProcessor
    {
        return $this->app['hydrator'];
    }

    protected function launchConfigurationAction(ConfigurableProcessor $processor): void
    {
        $processor->hydrate($this->environment);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
        $this->warnForUnusedVariables($processor);

        $this->warnForUnvaluedVariables($processor);

    }

    private function warnForUnusedVariables(Hydrator $processor)

    {
        $unusedVariables = $processor->getUnusedVariables();

        if(! empty($unusedVariables))
        {
            $logger = $this->app['logger'];

            $logger->warning('You have unused variables : you should remove them or check if you have not mispelled them');

            $logger->warning(sprintf(
                'Unused variables : %s',
                implode(', ', $unusedVariables)
            ));
        }
    }

    private function warnForUnvaluedVariables(Hydrator $processor): void

    {
        $unvaluedVariables = $processor->getUnvaluedVariables();

        if(! empty($unvaluedVariables))
        {
            $logger = $this->app['logger'];

            $logger->warning(sprintf(
                'Missing values for variables : %s (TODO markers found)',
                implode(', ', $unvaluedVariables)
            ));
        }
    }
}


1			<?php
2
3			declare(strict_types = 1);
4
5			namespace Karma\Console;
6
7			use Karma\ConfigurableProcessor;
8			use Karma\Application;
9			use Karma\Hydrator;
10
11			class Hydrate extends ConfigureActionCommand
12			{
13	36		public function __construct(Application $app)
14			{
15	36		parent::__construct(
16	36		$app,
17	36		'hydrate',
18	36		'Hydrate dist files',
19	36		'Hydrate'
20			);
21	36		}
22
23	10		protected function getProcessor(): ConfigurableProcessor
24			{
25	10		return $this->app['hydrator'];
26			}
27
28	10		protected function launchConfigurationAction(ConfigurableProcessor $processor): void
29			{
30	10		$processor->hydrate($this->environment);
			0 ignored issues – show Bug introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Karma\ConfigurableProcessor` as the method `hydrate()` does only exist in the following implementations of said interface: `Karma\Hydrator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
31	10		$this->warnForUnusedVariables($processor);
			0 ignored issues – show Compatibility introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report `$processor` of type `object<Karma\ConfigurableProcessor>` is not a sub-type of `object<Karma\Hydrator>`. It seems like you assume a concrete implementation of the interface `Karma\ConfigurableProcessor` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
32	10		$this->warnForUnvaluedVariables($processor);
			0 ignored issues – show Compatibility introduced 2015-12-04 15:18 UTC by Report Bug Copy Issue Report `$processor` of type `object<Karma\ConfigurableProcessor>` is not a sub-type of `object<Karma\Hydrator>`. It seems like you assume a concrete implementation of the interface `Karma\ConfigurableProcessor` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
33	10		}
34
35	10	View Code Duplication	private function warnForUnusedVariables(Hydrator $processor)
			0 ignored issues – show Duplication introduced 2018-03-12 08:23 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...
36			{
37	10		$unusedVariables = $processor->getUnusedVariables();
38
39	10		if(! empty($unusedVariables))
40			{
41	8		$logger = $this->app['logger'];
42
43	8		$logger->warning('You have unused variables : you should remove them or check if you have not mispelled them');
44
45	8		$logger->warning(sprintf(
46	8		'Unused variables : %s',
47	8		implode(', ', $unusedVariables)
48			));
49			}
50	10		}
51
52	10	View Code Duplication	private function warnForUnvaluedVariables(Hydrator $processor): void
			0 ignored issues – show Duplication introduced 2018-03-12 08:23 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...
53			{
54	10		$unvaluedVariables = $processor->getUnvaluedVariables();
55
56	10		if(! empty($unvaluedVariables))
57			{
58	1		$logger = $this->app['logger'];
59
60	1		$logger->warning(sprintf(
61	1		'Missing values for variables : %s (TODO markers found)',
62	1		implode(', ', $unvaluedVariables)
63			));
64			}
65	10		}
66			}
67

Niktux / karma

Push — nln-php7 ( 5c4f20...6ce259 )

Hydrate::warnForUnusedVariables() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like