HasInheritance::instanceOf() - Code Metrics - Inspection of "Fix inheritance tests" - railt/reflection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 690c53...b92a26 )

by Kirill

created 2018-08-08 13:28 UTC

HasInheritance::instanceOf() A

↳ Parent: HasInheritance

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	29
ccs	12
cts	12
cp	1
rs	9.1448
c	0
b	0
f	0
cc	5
nc	5
nop	1
crap	5

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\Reflection\Definition\Behaviour;

use Railt\Reflection\Contracts\Definition\Behaviour\ProvidesInheritance;
use Railt\Reflection\Contracts\Definition\TypeDefinition;
use Railt\Reflection\Type;

/**
 * Trait HasInheritance
 */
trait HasInheritance
{
    /**
     * @var string|null
     */
    protected $extends;

    /**
     * @var string[]|array
     */
    protected $extendedBy = [];

    /**
     * @param string|TypeDefinition $type
     * @return TypeDefinition
     */
    abstract protected function fetch($type): TypeDefinition;

    /**
     * @return iterable|TypeDefinition[]
     */
    public function inheritedBy(): iterable
    {
        foreach ($this->extendedBy as $parent) {
            yield $this->fetch($parent);
        }
    }

    /**
     * @return null|TypeDefinition
     */
    public function getInheritedParent(): ?TypeDefinition
    {
        return $this->extends ? $this->fetch($this->extends) : null;
    }

    /**
     * @return bool
     */
    public function hasInheritance(): bool
    {
        return $this->extends !== null;
    }

    /**
     * @param TypeDefinition|string $definition
     * @return ProvidesInheritance|$this
     */
    public function extends($definition): ProvidesInheritance
    {
        $this->extends = $this->nameOf($definition);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if ($definition instanceof ProvidesInheritance) {
            /** @var HasInheritance $definition */
            $definition->extendedBy[] = $this->extends;
        }

        return $this;
    }

    /**
     * @param TypeDefinition|string $definition
     * @return ProvidesInheritance|$this
     */
    public function extendsBy($definition): ProvidesInheritance
    {
        /** @var HasInheritance $definition */
        $definition = $this->fetch($definition);

        $definition->extends($this);

        return $this;
    }

    /**
     * @param TypeDefinition|string $type
     * @return bool
     */
    public function extendsOf($type): bool
    {
        return $this->extends === $this->nameOf($type);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @param TypeDefinition|string $type
     * @return bool
     */
    public function instanceOf($type): bool
    {
        /**
         * @var TypeDefinition $type
         * @var TypeDefinition $context
         */
        [$type, $context] = [$this->fetch($type), $this];
function someFunction() {
    $x = 5;
    echo $x;
}

        if ($type::getType()->is(Type::ANY)) {
            return true;
        }

        if ($type === $context) {
function someFunction() {
    $x = 5;
    echo $x;
}
            return true;
        }

        while ($context) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            /** @var TypeDefinition $context */
            $context = $this->fetch($context);

            if ($context->extendsOf($type)) {
                return true;
            }

            $context = $context->getInheritedParent();
        }

        return false;
    }
}


1		<?php
2		/**
3		* This file is part of Railt package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8		declare(strict_types=1);
9
10		namespace Railt\Reflection\Definition\Behaviour;
11
12		use Railt\Reflection\Contracts\Definition\Behaviour\ProvidesInheritance;
13		use Railt\Reflection\Contracts\Definition\TypeDefinition;
14		use Railt\Reflection\Type;
15
16		/**
17		* Trait HasInheritance
18		*/
19		trait HasInheritance
20		{
21		/**
22		* @var string\|null
23		*/
24		protected $extends;
25
26		/**
27		* @var string[]\|array
28		*/
29		protected $extendedBy = [];
30
31		/**
32		* @param string\|TypeDefinition $type
33		* @return TypeDefinition
34		*/
35		abstract protected function fetch($type): TypeDefinition;
36
37		/**
38		* @return iterable\|TypeDefinition[]
39		*/
40		public function inheritedBy(): iterable
41		{
42		foreach ($this->extendedBy as $parent) {
43		yield $this->fetch($parent);
44		}
45		}
46
47		/**
48		* @return null\|TypeDefinition
49		*/
50	8	public function getInheritedParent(): ?TypeDefinition
51		{
52	8	return $this->extends ? $this->fetch($this->extends) : null;
53		}
54
55		/**
56		* @return bool
57		*/
58		public function hasInheritance(): bool
59		{
60		return $this->extends !== null;
61		}
62
63		/**
64		* @param TypeDefinition\|string $definition
65		* @return ProvidesInheritance\|$this
66		*/
67	25	public function extends($definition): ProvidesInheritance
68		{
69	25	$this->extends = $this->nameOf($definition);
		0 ignored issues – show Bug introduced 2018-08-06 10:27 UTC by Report Bug Copy Issue Report It seems like `nameOf()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
70
71	25	if ($definition instanceof ProvidesInheritance) {
72		/** @var HasInheritance $definition */
73	25	$definition->extendedBy[] = $this->extends;
74		}
75
76	25	return $this;
77		}
78
79		/**
80		* @param TypeDefinition\|string $definition
81		* @return ProvidesInheritance\|$this
82		*/
83		public function extendsBy($definition): ProvidesInheritance
84		{
85		/** @var HasInheritance $definition */
86		$definition = $this->fetch($definition);
87
88		$definition->extends($this);
89
90		return $this;
91		}
92
93		/**
94		* @param TypeDefinition\|string $type
95		* @return bool
96		*/
97	8	public function extendsOf($type): bool
98		{
99	8	return $this->extends === $this->nameOf($type);
		0 ignored issues – show Bug introduced 2018-08-08 13:06 UTC by Report Bug Copy Issue Report It seems like `nameOf()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
100		}
101
102		/**
103		* @param TypeDefinition\|string $type
104		* @return bool
105		*/
106	8	public function instanceOf($type): bool
107		{
108		/**
109		* @var TypeDefinition $type
110		* @var TypeDefinition $context
111		*/
112	8	[$type, $context] = [$this->fetch($type), $this];
		0 ignored issues – show Bug introduced 2018-08-08 13:31 UTC by Report Bug Copy Issue Report The variable `$context` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
113
114	8	if ($type::getType()->is(Type::ANY)) {
115	8	return true;
116		}
117
118	8	if ($type === $context) {
		0 ignored issues – show Bug introduced 2018-08-08 13:31 UTC by Report Bug Copy Issue Report The variable `$context` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
119	8	return true;
120		}
121
122	8	while ($context) {
		0 ignored issues – show Bug introduced 2018-08-08 13:31 UTC by Report Bug Copy Issue Report The variable `$context` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
123		/** @var TypeDefinition $context */
124	8	$context = $this->fetch($context);
125
126	8	if ($context->extendsOf($type)) {
127	8	return true;
128		}
129
130	8	$context = $context->getInheritedParent();
131		}
132
133	8	return false;
134		}
135		}
136

railt / reflection

Push — master ( 690c53...b92a26 )

HasInheritance::instanceOf() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like