ProvidesTypeHint - Code Metrics - Inspection of "Add ir validation" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( a0eed4...bb00ac )

by Kirill

created 2018-09-11 23:49 UTC

ProvidesTypeHint A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

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

3 Methods

Rating	Name	Size	Complexity
A	getTypeHint()	4	1
A	getHintModifiers()	8	2
A	getHintTypeName()	10	2

<?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\SDL\Frontend\AST\Definition\Provider;

use Railt\SDL\Frontend\AST\Definition\Common\TypeHintNode;

/**
 * Trait ProvidesTypeHint
 */
trait ProvidesTypeHint
{
    /**
     * @return null|TypeHintNode
     */
    private function getTypeHint(): ?TypeHintNode
    {
        return $this->first('TypeHint', 1);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @return int
     */
    public function getHintModifiers(): int
    {
        if ($hint = $this->getTypeHint()) {
            return $hint->getModifiers();
        }

        return 0;
    }

    /**
     * @return null|string
     */
    public function getHintTypeName(): ?string
    {
        if ($hint = $this->getTypeHint()) {
            return $hint->first('TypeName', 6)
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.
    }
}
                ->getChild(0)
                ->getValue();
        }

        return null;
    }
}


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\SDL\Frontend\AST\Definition\Provider;
11
12			use Railt\SDL\Frontend\AST\Definition\Common\TypeHintNode;
13
14			/**
15			* Trait ProvidesTypeHint
16			*/
17			trait ProvidesTypeHint
18			{
19			/**
20			* @return null\|TypeHintNode
21			*/
22			private function getTypeHint(): ?TypeHintNode
23			{
24			return $this->first('TypeHint', 1);
			0 ignored issues – show Bug introduced 2018-08-20 02:41 UTC by Report Bug Copy Issue Report It seems like `first()` 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...
25			}
26
27			/**
28			* @return int
29			*/
30			public function getHintModifiers(): int
31			{
32			if ($hint = $this->getTypeHint()) {
33			return $hint->getModifiers();
34			}
35
36			return 0;
37			}
38
39			/**
40			* @return null\|string
41			*/
42			public function getHintTypeName(): ?string
43			{
44			if ($hint = $this->getTypeHint()) {
45			return $hint->first('TypeName', 6)
			0 ignored issues – show Bug introduced 2018-09-12 02:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\NodeInterface` as the method `getChild()` does only exist in the following implementations of said interface: `Railt\Compiler\Grammar\Delegate\IncludeDelegate`, `Railt\Compiler\Grammar\Delegate\RuleDelegate`, `Railt\Compiler\Grammar\Delegate\TokenDelegate`, `Railt\Parser\Ast\Rule`, `Railt\SDL\Frontend\AST\D...\ArgumentDefinitionNode`, `Railt\SDL\Frontend\AST\D...ion\Common\TypeHintNode`, `Railt\SDL\Frontend\AST\D...DirectiveDefinitionNode`, `Railt\SDL\Frontend\AST\D...tion\EnumDefinitionNode`, `Railt\SDL\Frontend\AST\D...EnumValueDefinitionNode`, `Railt\SDL\Frontend\AST\D...ion\FieldDefinitionNode`, `Railt\SDL\Frontend\AST\D...ion\InputDefinitionNode`, `Railt\SDL\Frontend\AST\D...nputFieldDefinitionNode`, `Railt\SDL\Frontend\AST\D...InterfaceDefinitionNode`, `Railt\SDL\Frontend\AST\D...on\ObjectDefinitionNode`, `Railt\SDL\Frontend\AST\D...on\ScalarDefinitionNode`, `Railt\SDL\Frontend\AST\D...on\SchemaDefinitionNode`, `Railt\SDL\Frontend\AST\D...hemaFieldDefinitionNode`, `Railt\SDL\Frontend\AST\D...tion\TypeDefinitionNode`, `Railt\SDL\Frontend\AST\D...ion\UnionDefinitionNode`, `Railt\SDL\Frontend\AST\I...ation\AbstractValueNode`, `Railt\SDL\Frontend\AST\I...ation\ArgumentValueNode`, `Railt\SDL\Frontend\AST\Invocation\BooleanValueNode`, `Railt\SDL\Frontend\AST\I...ation\ConstantValueNode`, `Railt\SDL\Frontend\AST\I...on\DescriptionValueNode`, `Railt\SDL\Frontend\AST\I...tion\DirectiveValueNode`, `Railt\SDL\Frontend\AST\Invocation\InputValueNode`, `Railt\SDL\Frontend\AST\Invocation\ListValueNode`, `Railt\SDL\Frontend\AST\Invocation\NullValueNode`, `Railt\SDL\Frontend\AST\Invocation\NumberValueNode`, `Railt\SDL\Frontend\AST\Invocation\StringValueNode`. 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...
46			->getChild(0)
47			->getValue();
48			}
49
50			return null;
51			}
52			}
53

railt / sdl

Push — master ( a0eed4...bb00ac )

ProvidesTypeHint A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like