EnumValueBuilder::virtualTypeHint() - Code Metrics - Inspection of "Add more types support" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8afd90...4bf010 )

by Kirill

created 2018-08-07 22:19 UTC

EnumValueBuilder::virtualTypeHint() A

↳ Parent: EnumValueBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

1 Method

Rating	Name	Duplication	Size	Complexity
A	EnumValueBuilder.php$0 ➔ getType()	0	4	1

<?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\Compiler\Builder\Dependent;

use Railt\Parser\Ast\RuleInterface;
use Railt\Reflection\Contracts\Definition;
use Railt\Reflection\Contracts\Type as TypeInterface;
use Railt\Reflection\Definition\Dependent\EnumValueDefinition;
use Railt\Reflection\Definition\EnumDefinition;
use Railt\Reflection\Type;
use Railt\SDL\Compiler\Ast\Dependent\EnumValueDefinitionNode;
use Railt\SDL\Compiler\Ast\TypeHintNode;
use Railt\SDL\Compiler\Builder\Builder;
use Railt\SDL\Compiler\Builder\Virtual\TypeHint;

/**
 * Class EnumValueBuilder
 */
class EnumValueBuilder extends Builder
{
    /**
     * @param RuleInterface|EnumValueDefinitionNode $rule
     * @param Definition|EnumDefinition $parent
     * @return Definition
     */
    public function build(RuleInterface $rule, Definition $parent): Definition
    {
        $value = new EnumValueDefinition($parent, $rule->getValueName());
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.
    }
}
        $value->withOffset($rule->getOffset());
        $value->withDescription($rule->getDescription());
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->when->runtime(function () use ($rule, $value) {
            if ($hint = $rule->getTypeHint()) {
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.
    }
}
                $value->withValue($this->valueOf($this->virtualTypeHint($value, $hint), $rule->getValue()));

            }

            foreach ($rule->getDirectives() as $ast) {
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.
    }
}
                $value->withDirective($this->dependent($ast, $value));
            }
        });

        return $value;
    }

    /**
     * @param EnumValueDefinition $value
     * @param TypeHintNode $ast
     * @return TypeHint
     */
    private function virtualTypeHint(EnumValueDefinition $value, TypeHintNode $ast): TypeHint
    {
        $virtual = new class($value->getDocument()) extends TypeHint

        {
            public static function getType(): TypeInterface
            {
                return Type::of(Type::ENUM_VALUE);
            }
        };

        $virtual->withOffset($ast->getOffset());
        $virtual->withTypeDefinition($ast->getTypeName());
        $virtual->withModifiers($ast->getModifiers());

        return $virtual;
    }
}


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\Compiler\Builder\Dependent;
11
12			use Railt\Parser\Ast\RuleInterface;
13			use Railt\Reflection\Contracts\Definition;
14			use Railt\Reflection\Contracts\Type as TypeInterface;
15			use Railt\Reflection\Definition\Dependent\EnumValueDefinition;
16			use Railt\Reflection\Definition\EnumDefinition;
17			use Railt\Reflection\Type;
18			use Railt\SDL\Compiler\Ast\Dependent\EnumValueDefinitionNode;
19			use Railt\SDL\Compiler\Ast\TypeHintNode;
20			use Railt\SDL\Compiler\Builder\Builder;
21			use Railt\SDL\Compiler\Builder\Virtual\TypeHint;
22
23			/**
24			* Class EnumValueBuilder
25			*/
26			class EnumValueBuilder extends Builder
27			{
28			/**
29			* @param RuleInterface\|EnumValueDefinitionNode $rule
30			* @param Definition\|EnumDefinition $parent
31			* @return Definition
32			*/
33			public function build(RuleInterface $rule, Definition $parent): Definition
34			{
35			$value = new EnumValueDefinition($parent, $rule->getValueName());
			0 ignored issues – show Bug introduced 2018-08-07 22:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\RuleInterface` as the method `getValueName()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode`. 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... Compatibility introduced 2018-08-06 18:25 UTC by Report Bug Copy Issue Report `$parent` of type `object<Railt\Reflection\Contracts\Definition>` is not a sub-type of `object<Railt\Reflection\...inition\TypeDefinition>`. It seems like you assume a child interface of the interface `Railt\Reflection\Contracts\Definition` 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...
36			$value->withOffset($rule->getOffset());
37			$value->withDescription($rule->getDescription());
			0 ignored issues – show Bug introduced 2018-08-06 18:25 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\RuleInterface` as the method `getDescription()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...DirectiveDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\EnumDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ion\InputDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputUnionDefinitionNode`, `Railt\SDL\Compiler\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ObjectDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ScalarDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\SchemaDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\TypeDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ion\UnionDefinitionNode`, `Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode`, `Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode`. 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...
38
39			$this->when->runtime(function () use ($rule, $value) {
40			if ($hint = $rule->getTypeHint()) {
			0 ignored issues – show Bug introduced 2018-08-06 18:25 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\RuleInterface` as the method `getTypeHint()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode`, `Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode`, `Railt\SDL\Compiler\Ast\D...hemaFieldDefinitionNode`. 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...
41			$value->withValue($this->valueOf($this->virtualTypeHint($value, $hint), $rule->getValue()));
			0 ignored issues – show Bug introduced 2018-08-07 22:23 UTC by Report Bug Copy Issue Report The method `getValue()` does not exist on `Railt\Parser\Ast\RuleInterface`. Did you maybe mean `getValues()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
42			}
43
44			foreach ($rule->getDirectives() as $ast) {
			0 ignored issues – show Bug introduced 2018-08-06 18:25 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Railt\Parser\Ast\RuleInterface` as the method `getDirectives()` does only exist in the following implementations of said interface: `Railt\SDL\Compiler\Ast\D...DirectiveDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\EnumDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ion\InputDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputUnionDefinitionNode`, `Railt\SDL\Compiler\Ast\D...InterfaceDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ObjectDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\ScalarDefinitionNode`, `Railt\SDL\Compiler\Ast\D...on\SchemaDefinitionNode`, `Railt\SDL\Compiler\Ast\D...tion\TypeDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ion\UnionDefinitionNode`, `Railt\SDL\Compiler\Ast\D...\ArgumentDefinitionNode`, `Railt\SDL\Compiler\Ast\D...EnumValueDefinitionNode`, `Railt\SDL\Compiler\Ast\D...ent\FieldDefinitionNode`, `Railt\SDL\Compiler\Ast\D...nputFieldDefinitionNode`. 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...
45			$value->withDirective($this->dependent($ast, $value));
46			}
47			});
48
49			return $value;
50			}
51
52			/**
53			* @param EnumValueDefinition $value
54			* @param TypeHintNode $ast
55			* @return TypeHint
56			*/
57			private function virtualTypeHint(EnumValueDefinition $value, TypeHintNode $ast): TypeHint
58			{
59			$virtual = new class($value->getDocument()) extends TypeHint
			0 ignored issues – show Compatibility introduced 2018-08-07 22:23 UTC by Report Bug Copy Issue Report `$value->getDocument()` of type `object<Railt\Reflection\Contracts\Document>` is not a sub-type of `object<Railt\Reflection\Document>`. It seems like you assume a concrete implementation of the interface `Railt\Reflection\Contracts\Document` 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...
60			{
61			public static function getType(): TypeInterface
62			{
63			return Type::of(Type::ENUM_VALUE);
64			}
65			};
66
67			$virtual->withOffset($ast->getOffset());
68			$virtual->withTypeDefinition($ast->getTypeName());
69			$virtual->withModifiers($ast->getModifiers());
70
71			return $virtual;
72			}
73			}
74

railt / sdl

Push — master ( 8afd90...4bf010 )

EnumValueBuilder::virtualTypeHint() A

Complexity

Size

Duplication

Code Coverage

Importance

1 Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like