DirectiveDelegate::verifyDuplication() - Code Metrics - Inspection of "Add all definitions prebuilding" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fe9d21...06b28a )

by Kirill

created 2018-08-01 13:45 UTC

DirectiveDelegate::verifyDuplication() A

↳ Parent: DirectiveDelegate

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	6
Ratio	66.67 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
nc	2
nop	2
dl	6
loc	9
ccs	0
cts	8
cp	0
crap	6
rs	9.9666
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\Definition;

use Railt\Parser\Ast\LeafInterface;
use Railt\Reflection\Contracts\Definition;
use Railt\Reflection\Contracts\Document as DocumentInterface;
use Railt\Reflection\Definition\Dependent\DirectiveLocation;
use Railt\Reflection\Definition\DirectiveDefinition;
use Railt\Reflection\Document;
use Railt\SDL\Exception\TypeConflictException;

/**
 * Class DirectiveDelegate
 */
class DirectiveDelegate extends DefinitionDelegate
{
    /**
     * @param DocumentInterface|Document $document
     * @return Definition
     */
    protected function bootDefinition(DocumentInterface $document): Definition
    {
        return new DirectiveDefinition($document, $this->getTypeName());

    }

    /**
     * @param Definition|DirectiveDefinition $definition
     */
    protected function before(Definition $definition): void
    {
        $this->bootLocations($definition);

    }

    /**
     * @param DirectiveDefinition $directive
     */
    private function bootLocations(DirectiveDefinition $directive): void
    {
        foreach ($this->getLocations($directive) as $offset => $location) {
            $this->transaction($location, function (DirectiveLocation $location) use ($directive): void {
                $this->verifyLocation($location);
                $this->verifyDuplication($directive, $location);

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

    /**
     * @param DirectiveDefinition $directive
     * @param DirectiveLocation $location
     * @throws \Railt\SDL\Exception\CompilerException
     */
    private function verifyDuplication(DirectiveDefinition $directive, DirectiveLocation $location): void

    {
        if ($directive->hasLocation($location->getName())) {

            $error = 'Could not determine the location %s, because %s already exists';
            $error = \sprintf($error, $location, $directive->getLocation($location->getName()));

            throw (new TypeConflictException($error))->using($this->getCallStack())->in($location);
        }
    }

    /**
     * @param DirectiveDefinition $definition
     * @return iterable|DirectiveLocation[]
     */
    private function getLocations(DirectiveDefinition $definition): iterable
    {
        /** @var LeafInterface $child */
        foreach ($this->first('DirectiveLocations', 1) as $child) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            yield (new DirectiveLocation($definition, $child->getValue()))->withOffset($child->getOffset());
        }
    }

    /**
     * @param DirectiveLocation $location
     * @throws \Railt\SDL\Exception\CompilerException
     */
    private function verifyLocation(DirectiveLocation $location): void
    {
        $isValid = $location->isExecutable() || $location->isPrivate();

        if (! $isValid) {
            $error = \sprintf('Invalid directive location %s', $location);

            throw $this->error(new TypeConflictException($error))->in($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\Definition;
11
12		use Railt\Parser\Ast\LeafInterface;
13		use Railt\Reflection\Contracts\Definition;
14		use Railt\Reflection\Contracts\Document as DocumentInterface;
15		use Railt\Reflection\Definition\Dependent\DirectiveLocation;
16		use Railt\Reflection\Definition\DirectiveDefinition;
17		use Railt\Reflection\Document;
18		use Railt\SDL\Exception\TypeConflictException;
19
20		/**
21		* Class DirectiveDelegate
22		*/
23		class DirectiveDelegate extends DefinitionDelegate
24		{
25		/**
26		* @param DocumentInterface\|Document $document
27		* @return Definition
28		*/
29		protected function bootDefinition(DocumentInterface $document): Definition
30		{
31		return new DirectiveDefinition($document, $this->getTypeName());
		0 ignored issues – show Compatibility introduced 2018-08-01 12:19 UTC by Report Bug Copy Issue Report `$document` 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...
32		}
33
34		/**
35		* @param Definition\|DirectiveDefinition $definition
36		*/
37		protected function before(Definition $definition): void
38		{
39		$this->bootLocations($definition);
		0 ignored issues – show Compatibility introduced 2018-08-01 12:19 UTC by Report Bug Copy Issue Report `$definition` of type `object<Railt\Reflection\Contracts\Definition>` is not a sub-type of `object<Railt\Reflection\...on\DirectiveDefinition>`. It seems like you assume a concrete implementation 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...
40		}
41
42		/**
43		* @param DirectiveDefinition $directive
44		*/
45		private function bootLocations(DirectiveDefinition $directive): void
46		{
47		foreach ($this->getLocations($directive) as $offset => $location) {
48		$this->transaction($location, function (DirectiveLocation $location) use ($directive): void {
49		$this->verifyLocation($location);
50		$this->verifyDuplication($directive, $location);
51
52		$directive->withLocation($location);
53		});
54		}
55		}
56
57		/**
58		* @param DirectiveDefinition $directive
59		* @param DirectiveLocation $location
60		* @throws \Railt\SDL\Exception\CompilerException
61		*/
62		private function verifyDuplication(DirectiveDefinition $directive, DirectiveLocation $location): void
		0 ignored issues – show Bug introduced 2018-08-01 13:49 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
63		{
64	View Code Duplication	if ($directive->hasLocation($location->getName())) {
		0 ignored issues – show Duplication introduced 2018-08-01 13:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		$error = 'Could not determine the location %s, because %s already exists';
66		$error = \sprintf($error, $location, $directive->getLocation($location->getName()));
67
68		throw (new TypeConflictException($error))->using($this->getCallStack())->in($location);
69		}
70		}
71
72		/**
73		* @param DirectiveDefinition $definition
74		* @return iterable\|DirectiveLocation[]
75		*/
76		private function getLocations(DirectiveDefinition $definition): iterable
77		{
78		/** @var LeafInterface $child */
79		foreach ($this->first('DirectiveLocations', 1) as $child) {
		0 ignored issues – show Bug introduced 2018-08-01 12:19 UTC by Report Bug Copy Issue Report The expression `$this->first('DirectiveLocations', 1)` of type `null\|object<Railt\Parser\Ast\NodeInterface>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
80		yield (new DirectiveLocation($definition, $child->getValue()))->withOffset($child->getOffset());
81		}
82		}
83
84		/**
85		* @param DirectiveLocation $location
86		* @throws \Railt\SDL\Exception\CompilerException
87		*/
88		private function verifyLocation(DirectiveLocation $location): void
89		{
90		$isValid = $location->isExecutable() \|\| $location->isPrivate();
91
92		if (! $isValid) {
93		$error = \sprintf('Invalid directive location %s', $location);
94
95		throw $this->error(new TypeConflictException($error))->in($location);
96		}
97		}
98		}
99

railt / sdl

Push — master ( fe9d21...06b28a )

DirectiveDelegate::verifyDuplication() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like