Metadata::getName() - Code Metrics - Inspection of "Allow analyzers to be configured" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#139)

by Kévin

created 2016-09-19 19:04 UTC

Metadata::getName() A

↳ Parent: Metadata

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php
/**
 * @author Kévin Gomez https://github.com/K-Phoen <[email protected]>
 */

namespace PHPSA\Analyzer\Pass;

use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

/**
 * Describes an analyzer pass.
 */
class Metadata
{
    /** @var string */
    private $name;

    /** @var string|null */
    private $description;

    /** @var \Symfony\Component\Config\Definition\Builder\NodeDefinition */
    private $configuration;

    /** @var string|null */
    private $requiredPhpVersion;

    /**
     * @param string $name
     * @param string|null $description
     *
     * @return Metadata
     */
    public static function create($name, $description = null)
    {
        $treeBuilder = new TreeBuilder();

        $config = $treeBuilder->root($name)
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($description)
            ->canBeDisabled()
        ;

        return new self($name, $config, $description);

    }

    /**
     * @param string $name
     * @param null $description
     * @param NodeDefinition|null $config
     */
    private function __construct($name, NodeDefinition $config, $description = null)
    {
        $this->name = $name;
        $this->configuration = $config;
        $this->description = $description;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @return string|null
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     * @return NodeDefinition
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * @return string|null
     */
    public function getRequiredPhpVersion()
    {
        return $this->requiredPhpVersion;
    }

    /**
     * @param string $requiredPhpVersion
     */
    public function setRequiredPhpVersion($requiredPhpVersion)
    {
        $this->requiredPhpVersion = $requiredPhpVersion;
    }

    /**
     * Tells if the current analyzer can be used with code written in a given PHP version.
     *
     * @param string $version
     *
     * @return bool
     */
    public function allowsPhpVersion($version)
    {
        return $this->requiredPhpVersion === null || version_compare($version, $this->requiredPhpVersion, '>=');
    }
}


1		<?php
2		/**
3		* @author Kévin Gomez https://github.com/K-Phoen <[email protected]>
4		*/
5
6		namespace PHPSA\Analyzer\Pass;
7
8		use Symfony\Component\Config\Definition\Builder\NodeDefinition;
9		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
10
11		/**
12		* Describes an analyzer pass.
13		*/
14		class Metadata
15		{
16		/** @var string */
17		private $name;
18
19		/** @var string\|null */
20		private $description;
21
22		/** @var \Symfony\Component\Config\Definition\Builder\NodeDefinition */
23		private $configuration;
24
25		/** @var string\|null */
26		private $requiredPhpVersion;
27
28		/**
29		* @param string $name
30		* @param string\|null $description
31		*
32		* @return Metadata
33		*/
34	1	public static function create($name, $description = null)
35		{
36	1	$treeBuilder = new TreeBuilder();
37
38	1	$config = $treeBuilder->root($name)
		0 ignored issues – show Bug introduced 2016-09-19 19:08 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...
39	1	->info($description)
40	1	->canBeDisabled()
41	1	;
42
43	1	return new self($name, $config, $description);
		0 ignored issues – show Bug introduced 2016-09-19 19:08 UTC by Report Bug Copy Issue Report It seems like `$description` defined by parameter `$description` on line 34 can also be of type `string`; however, `PHPSA\Analyzer\Pass\Metadata::__construct()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
44		}
45
46		/**
47		* @param string $name
48		* @param null $description
49		* @param NodeDefinition\|null $config
50		*/
51	1	private function __construct($name, NodeDefinition $config, $description = null)
52		{
53	1	$this->name = $name;
54	1	$this->configuration = $config;
55	1	$this->description = $description;
56	1	}
57
58		/**
59		* @return string
60		*/
61	1	public function getName()
62		{
63	1	return $this->name;
64		}
65
66		/**
67		* @return string\|null
68		*/
69		public function getDescription()
70		{
71		return $this->description;
72		}
73
74		/**
75		* @param string $description
76		*/
77		public function setDescription($description)
78		{
79		$this->description = $description;
80		}
81
82		/**
83		* @return NodeDefinition
84		*/
85	1	public function getConfiguration()
86		{
87	1	return $this->configuration;
88		}
89
90		/**
91		* @return string\|null
92		*/
93		public function getRequiredPhpVersion()
94		{
95		return $this->requiredPhpVersion;
96		}
97
98		/**
99		* @param string $requiredPhpVersion
100		*/
101	1	public function setRequiredPhpVersion($requiredPhpVersion)
102		{
103	1	$this->requiredPhpVersion = $requiredPhpVersion;
104	1	}
105
106		/**
107		* Tells if the current analyzer can be used with code written in a given PHP version.
108		*
109		* @param string $version
110		*
111		* @return bool
112		*/
113	1	public function allowsPhpVersion($version)
114		{
115	1	return $this->requiredPhpVersion === null \|\| version_compare($version, $this->requiredPhpVersion, '>=');
116		}
117		}
118

ovr / phpsa

Pull Request — master (#139)

Metadata::getName() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like