EnumDelegate::bootDefinition() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/railt/..." - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ee9170...1dcd4f )

by Kirill

created 2018-08-01 16:38 UTC

EnumDelegate::bootDefinition() A

↳ Parent: EnumDelegate

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	1
dl	0
loc	4
ccs	0
cts	4
cp	0
crap	2
rs	10
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\Parser\Ast\NodeInterface;
use Railt\Parser\Ast\RuleInterface;
use Railt\Parser\Environment;
use Railt\Reflection\Contracts\Definition;
use Railt\Reflection\Contracts\Definition\TypeDefinition;
use Railt\Reflection\Contracts\Document as DocumentInterface;
use Railt\Reflection\Definition\Dependent\EnumValueDefinition;
use Railt\Reflection\Definition\EnumDefinition;
use Railt\Reflection\Document;
use Railt\SDL\Compiler\Pipeline;
use Railt\SDL\Exception\TypeConflictException;

/**
 * Class EnumDelegate
 */
class EnumDelegate extends TypeDefinitionDelegate
{
    /**
     * @param DocumentInterface|Document $document
     * @return Definition
     */
    protected function create(DocumentInterface $document): Definition
    {
        return new EnumDefinition($document, $this->getTypeName());

    }

    /**
     * @param Environment $env
     */
    public function boot(Environment $env): void
    {
        parent::boot($env);

        $this->future(Pipeline::PRIORITY_DEFINITION, function() {
            $this->bootValues($this->definition);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        });
    }

    /**
     * @param EnumDefinition|TypeDefinition $enum
     */
    private function bootValues(EnumDefinition $enum): void
    {
        foreach ($this->getEnumValues($enum) as $value) {
            $this->transaction($value, function (EnumValueDefinition $value) use ($enum): void {
                $this->verifyDuplication($enum, $value);

                $enum->withValue($value);
            });
        }
    }

    /**
     * @param EnumDefinition $enum
     * @return iterable
     */
    private function getEnumValues(EnumDefinition $enum): iterable
    {
        /** @var RuleInterface $ast */
        foreach ($this->first('EnumValues', 1) as $ast) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $enumValue = $this->createEnumValue($enum, $ast->first('T_NAME', 1));

            $this->transaction($enumValue, function (EnumValueDefinition $def) use ($ast): void {
                //$this->withDescription($def, $ast);


                /** @var RuleInterface $defValue */
                if ($defValue = $ast->first('Value', 1)) {
                    $def->withValue($this->value($defValue)->toScalar());
                }
            });

            yield $enumValue;
        }
    }

    /**
     * @param EnumDefinition $enum
     * @param LeafInterface|NodeInterface $name
     * @return EnumValueDefinition
     */
    private function createEnumValue(EnumDefinition $enum, LeafInterface $name): EnumValueDefinition
    {
        $def = new EnumValueDefinition($enum, $name->getValue());
        $def->withOffset($name->getOffset());

        return $def;
    }

    /**
     * @param EnumDefinition $enum
     * @param EnumValueDefinition $value
     * @throws \Railt\SDL\Exception\CompilerException
     */
    private function verifyDuplication(EnumDefinition $enum, EnumValueDefinition $value): void

    {
        if ($enum->hasValue($value->getName())) {

            $error = 'Could not define %s, because %s already exists';
            $error = \sprintf($error, $value, $enum->getValue($value->getName()));

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


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\Parser\Ast\NodeInterface;
14		use Railt\Parser\Ast\RuleInterface;
15		use Railt\Parser\Environment;
16		use Railt\Reflection\Contracts\Definition;
17		use Railt\Reflection\Contracts\Definition\TypeDefinition;
18		use Railt\Reflection\Contracts\Document as DocumentInterface;
19		use Railt\Reflection\Definition\Dependent\EnumValueDefinition;
20		use Railt\Reflection\Definition\EnumDefinition;
21		use Railt\Reflection\Document;
22		use Railt\SDL\Compiler\Pipeline;
23		use Railt\SDL\Exception\TypeConflictException;
24
25		/**
26		* Class EnumDelegate
27		*/
28		class EnumDelegate extends TypeDefinitionDelegate
29		{
30		/**
31		* @param DocumentInterface\|Document $document
32		* @return Definition
33		*/
34		protected function create(DocumentInterface $document): Definition
35		{
36		return new EnumDefinition($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...
37		}
38
39		/**
40		* @param Environment $env
41		*/
42		public function boot(Environment $env): void
43		{
44		parent::boot($env);
45
46		$this->future(Pipeline::PRIORITY_DEFINITION, function() {
47		$this->bootValues($this->definition);
		0 ignored issues – show Documentation introduced 2018-08-01 16:41 UTC by Report Bug Copy Issue Report `$this->definition` is of type `object<Railt\Reflection\...AbstractTypeDefinition>`, but the function expects a `object<Railt\Reflection\...inition\EnumDefinition>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
48		});
49		}
50
51		/**
52		* @param EnumDefinition\|TypeDefinition $enum
53		*/
54		private function bootValues(EnumDefinition $enum): void
55		{
56		foreach ($this->getEnumValues($enum) as $value) {
57		$this->transaction($value, function (EnumValueDefinition $value) use ($enum): void {
58		$this->verifyDuplication($enum, $value);
59
60		$enum->withValue($value);
61		});
62		}
63		}
64
65		/**
66		* @param EnumDefinition $enum
67		* @return iterable
68		*/
69		private function getEnumValues(EnumDefinition $enum): iterable
70		{
71		/** @var RuleInterface $ast */
72		foreach ($this->first('EnumValues', 1) as $ast) {
		0 ignored issues – show Bug introduced 2018-08-01 12:19 UTC by Report Bug Copy Issue Report The expression `$this->first('EnumValues', 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...
73		$enumValue = $this->createEnumValue($enum, $ast->first('T_NAME', 1));
74
75		$this->transaction($enumValue, function (EnumValueDefinition $def) use ($ast): void {
76		//$this->withDescription($def, $ast);
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-08-01 16:41 UTC by Report Bug Copy Issue Report `80%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
77
78		/** @var RuleInterface $defValue */
79		if ($defValue = $ast->first('Value', 1)) {
80		$def->withValue($this->value($defValue)->toScalar());
81		}
82		});
83
84		yield $enumValue;
85		}
86		}
87
88		/**
89		* @param EnumDefinition $enum
90		* @param LeafInterface\|NodeInterface $name
91		* @return EnumValueDefinition
92		*/
93		private function createEnumValue(EnumDefinition $enum, LeafInterface $name): EnumValueDefinition
94		{
95		$def = new EnumValueDefinition($enum, $name->getValue());
96		$def->withOffset($name->getOffset());
97
98		return $def;
99		}
100
101		/**
102		* @param EnumDefinition $enum
103		* @param EnumValueDefinition $value
104		* @throws \Railt\SDL\Exception\CompilerException
105		*/
106		private function verifyDuplication(EnumDefinition $enum, EnumValueDefinition $value): void
		0 ignored issues – show Bug introduced 2018-08-01 12:19 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...
107		{
108	View Code Duplication	if ($enum->hasValue($value->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...
109		$error = 'Could not define %s, because %s already exists';
110		$error = \sprintf($error, $value, $enum->getValue($value->getName()));
111
112		throw (new TypeConflictException($error))->using($this->getCallStack())->in($value);
113		}
114		}
115		}
116

railt / sdl

Push — master ( ee9170...1dcd4f )

EnumDelegate::bootDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like