DirectiveBuilder::buildLocations() - Code Metrics - Inspection of "Merge" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 08713d...9fa0b4 )

by Kirill

created 2018-08-09 01:02 UTC

DirectiveBuilder::buildLocations() A

↳ Parent: DirectiveBuilder

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
nc	3
nop	2
dl	0
loc	21
ccs	0
cts	17
cp	0
crap	12
rs	9.584
c	0
b	0
f	0

<?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\Definition;

use Railt\Parser\Ast\LeafInterface;
use Railt\Parser\Ast\RuleInterface;
use Railt\Reflection\Contracts\Definition;
use Railt\Reflection\Definition\Dependent\DirectiveLocation;
use Railt\Reflection\Definition\DirectiveDefinition;
use Railt\SDL\Compiler\Ast\Definition\DirectiveDefinitionNode;
use Railt\SDL\Compiler\Builder\Builder;
use Railt\SDL\Exception\TypeConflictException;

/**
 * Class DirectiveBuilder
 */
class DirectiveBuilder extends Builder
{
    /**
     * @param RuleInterface|DirectiveDefinitionNode $rule
     * @param Definition $parent
     * @return Definition
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    public function build(RuleInterface $rule, Definition $parent): Definition
    {
        $directive = new DirectiveDefinition($parent->getDocument(), $rule->getTypeName());
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.
    }
}
        $directive->withOffset($rule->getOffset());
        $directive->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->buildLocations($directive, $rule);

        $this->buildArguments($directive, $rule);


        return $directive;
    }

    /**
     * @param DirectiveDefinition $directive
     * @param DirectiveDefinitionNode $rule
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    private function buildArguments(DirectiveDefinition $directive, DirectiveDefinitionNode $rule): void
    {
        foreach ($rule->getArguments() as $ast) {
            /** @var Definition\Dependent\ArgumentDefinition $argument */
            $argument = $this->dependent($ast, $directive);

            $directive->withArgument($argument);
        }
    }

    /**
     * @param DirectiveDefinition $directive
     * @param DirectiveDefinitionNode $rule
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    private function buildLocations(DirectiveDefinition $directive, DirectiveDefinitionNode $rule): void
    {
        $locations = \array_merge(
            DirectiveLocation::EXECUTABLE_LOCATIONS,
            DirectiveLocation::SDL_LOCATIONS
        );

        /** @var LeafInterface $ast */
        foreach ($rule->getLocations() as $ast => $name) {
            $location = new DirectiveLocation($directive, $name);
            $location->withOffset($ast->getOffset());


            if (! \in_array($name, $locations, true)) {
                $error = \sprintf('Invalid directive location %s, only one of {%s} allowed',
                    $location, \implode(', ', $locations));
                throw (new TypeConflictException($error))->throwsIn($directive->getFile(), $ast->getOffset());

            }

            $directive->withLocation($location);
        }
    }
}


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\Definition;
11
12			use Railt\Parser\Ast\LeafInterface;
13			use Railt\Parser\Ast\RuleInterface;
14			use Railt\Reflection\Contracts\Definition;
15			use Railt\Reflection\Definition\Dependent\DirectiveLocation;
16			use Railt\Reflection\Definition\DirectiveDefinition;
17			use Railt\SDL\Compiler\Ast\Definition\DirectiveDefinitionNode;
18			use Railt\SDL\Compiler\Builder\Builder;
19			use Railt\SDL\Exception\TypeConflictException;
20
21			/**
22			* Class DirectiveBuilder
23			*/
24			class DirectiveBuilder extends Builder
25			{
26			/**
27			* @param RuleInterface\|DirectiveDefinitionNode $rule
28			* @param Definition $parent
29			* @return Definition
30			* @throws \Railt\Io\Exception\ExternalFileException
31			*/
32			public function build(RuleInterface $rule, Definition $parent): Definition
33			{
34			$directive = new DirectiveDefinition($parent->getDocument(), $rule->getTypeName());
			0 ignored issues – show Bug introduced 2018-08-09 01:05 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 `getTypeName()` 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...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\TypeHintNode`, `Railt\SDL\Compiler\Ast\TypeNameNode`. 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->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...
35			$directive->withOffset($rule->getOffset());
36			$directive->withDescription($rule->getDescription());
			0 ignored issues – show Bug introduced 2018-08-09 01:05 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...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...
37
38			$this->buildLocations($directive, $rule);
			0 ignored issues – show Compatibility introduced 2018-08-09 01:05 UTC by Report Bug Copy Issue Report `$rule` of type `object<Railt\Parser\Ast\RuleInterface>` is not a sub-type of `object<Railt\SDL\Compile...irectiveDefinitionNode>`. It seems like you assume a concrete implementation of the interface `Railt\Parser\Ast\RuleInterface` 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...
39			$this->buildArguments($directive, $rule);
			0 ignored issues – show Compatibility introduced 2018-08-09 01:05 UTC by Report Bug Copy Issue Report `$rule` of type `object<Railt\Parser\Ast\RuleInterface>` is not a sub-type of `object<Railt\SDL\Compile...irectiveDefinitionNode>`. It seems like you assume a concrete implementation of the interface `Railt\Parser\Ast\RuleInterface` 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...
40
41			return $directive;
42			}
43
44			/**
45			* @param DirectiveDefinition $directive
46			* @param DirectiveDefinitionNode $rule
47			* @throws \Railt\Io\Exception\ExternalFileException
48			*/
49			private function buildArguments(DirectiveDefinition $directive, DirectiveDefinitionNode $rule): void
50			{
51			foreach ($rule->getArguments() as $ast) {
52			/** @var Definition\Dependent\ArgumentDefinition $argument */
53			$argument = $this->dependent($ast, $directive);
54
55			$directive->withArgument($argument);
56			}
57			}
58
59			/**
60			* @param DirectiveDefinition $directive
61			* @param DirectiveDefinitionNode $rule
62			* @throws \Railt\Io\Exception\ExternalFileException
63			*/
64			private function buildLocations(DirectiveDefinition $directive, DirectiveDefinitionNode $rule): void
65			{
66			$locations = \array_merge(
67			DirectiveLocation::EXECUTABLE_LOCATIONS,
68			DirectiveLocation::SDL_LOCATIONS
69			);
70
71			/** @var LeafInterface $ast */
72			foreach ($rule->getLocations() as $ast => $name) {
73			$location = new DirectiveLocation($directive, $name);
74			$location->withOffset($ast->getOffset());
			0 ignored issues – show Bug introduced 2018-08-09 01:05 UTC by Report Bug Copy Issue Report The method `getOffset` cannot be called on `$ast` (of type `integer\|string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
75
76			if (! \in_array($name, $locations, true)) {
77			$error = \sprintf('Invalid directive location %s, only one of {%s} allowed',
78			$location, \implode(', ', $locations));
79			throw (new TypeConflictException($error))->throwsIn($directive->getFile(), $ast->getOffset());
			0 ignored issues – show Bug introduced 2018-08-09 01:05 UTC by Report Bug Copy Issue Report The method `getOffset` cannot be called on `$ast` (of type `integer\|string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
80			}
81
82			$directive->withLocation($location);
83			}
84			}
85			}
86

railt / sdl

Push — master ( 08713d...9fa0b4 )

DirectiveBuilder::buildLocations() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like