Builder::reduce() - Code Metrics - Inspection of "Add basic interpreter implementation" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( b7ab7b...94ee03 )

by Kirill

created 2018-10-02 21:32 UTC

Builder::reduce() A

↳ Parent: Builder

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
nc	4
nop	2
dl	0
loc	14
ccs	0
cts	12
cp	0
crap	12
rs	9.7998
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\Frontend;

use Railt\Io\Readable;
use Railt\Parser\Ast\RuleInterface;
use Railt\SDL\Exception\CompilerException;
use Railt\SDL\Exception\InternalException;
use Railt\SDL\Frontend;
use Railt\SDL\Frontend\Context\ContextInterface;
use Railt\SDL\Frontend\Context\GlobalContext;
use Railt\SDL\Frontend\Context\GlobalContextInterface;
use Railt\SDL\IR\SymbolTable;
use Railt\SDL\IR\SymbolTable\ValueInterface;
use Railt\SDL\IR\SymbolTableInterface;
use Railt\SDL\IR\Type\TypeNameInterface;

/**
 * Class Builder
 */
class Builder
{
    /**
     * @var string[]|Builder\BuilderInterface[]
     */
    private const DEFAULT_BUILDER_DEFINITIONS = [
        Builder\Instruction\ImportBuilder::class,
        Builder\Instruction\NamespaceBuilder::class,
        Builder\Instruction\VariableBuilder::class,
        Builder\Instruction\VariableReassigmentBuilder::class,

        //
        Builder\DefinitionBuilder::class,

        // Values
        Builder\Value\ScalarValueBuilder::class,
        Builder\Value\VariableValueBuilder::class,
        Builder\Value\TypeInvocationBuilder::class,
        Builder\Value\ConstantValueBuilder::class,
        Builder\Value\BooleanValueBuilder::class,

        //
        Builder\Common\TypeNameBuilder::class,
        Builder\TypeDefinitionBuilder::class,
    ];

    /**
     * @var array|Builder\BuilderInterface[]
     */
    private $builders = [];

    /**
     * @var Frontend
     */
    private $frontend;

    /**
     * @var SymbolTableInterface
     */
    private $table;

    /**
     * Builder constructor.
     * @param Frontend $frontend
     * @param SymbolTable $table
     */
    public function __construct(Frontend $frontend, SymbolTable $table)
    {
        $this->table    = $table;
        $this->frontend = $frontend;
        $this->bootDefaults();
    }

    /**
     * @return void
     */
    private function bootDefaults(): void
    {
        foreach (self::DEFAULT_BUILDER_DEFINITIONS as $builder) {
            $this->builders[] = new $builder($this);
        }
    }

    /**
     * @param Readable $readable
     * @return \Traversable
     * @throws \Railt\Io\Exception\ExternalFileException
     * @throws \Railt\SDL\Exception\SyntaxException
     */
    public function load(Readable $readable): iterable
    {
        return $this->frontend->load($readable);
    }

    /**
     * @param Readable $file
     * @param iterable $ast
     * @return iterable
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    public function build(Readable $file, iterable $ast): iterable
    {
        $context = new GlobalContext($file, $this->table);

        foreach ($ast as $child) {
            if ($this->filter([$context, $result] = $this->reduce($context, $child))) {
                yield $result;

            }
        }


        echo \str_repeat('=', 60) . "\n";
        echo \sprintf('| %5s | %-48s |', 'ID', 'VARIABLE') . "\n";
        echo \str_repeat('-', 60) . "\n";
        foreach ($this->table as $id => $var) {
            echo \sprintf('| %5d | %-48s |', $id, $var) . "\n";
        }
        echo \str_repeat('=', 60) . "\n";
    }

    /**
     * @param mixed $result
     * @return bool
     */
    private function filter($result): bool

    {
        return false;
    }

    /**
     * @param ContextInterface $context
     * @param RuleInterface $ast
     * @return array|iterable<int,ContextInterface|mixed>

     * @throws \Railt\Io\Exception\ExternalFileException
     */
    private function reduce(ContextInterface $context, RuleInterface $ast): array
    {
        try {
            $process = $this->resolve($context, $ast);

            if ($process instanceof \Generator) {
                return $this->run($context, $process);
            }

            return [$context, $process];
        } catch (CompilerException $e) {
            throw $e->throwsIn($context->getFile(), $ast->getOffset());
        }
    }

    /**
     * @param ContextInterface $context
     * @param RuleInterface $ast
     * @return mixed|\Traversable|void
     * @throws \Railt\Io\Exception\ExternalFileException
     */
    private function resolve(ContextInterface $context, RuleInterface $ast)
    {
        foreach ($this->builders as $builder) {
            if ($builder->match($ast)) {
                return $builder->reduce($context, $ast);
            }
        }

        $error = \sprintf('Unrecognized rule %s in (%s)', $ast->getName(), $ast);
        throw (new InternalException($error))->throwsIn($context->getFile(), $ast->getOffset());
    }

    /**
     * @param ContextInterface $ctx
     * @param \Generator $process
     * @return array|iterable<int, ContextInterface|mixed>

     */
    private function run(ContextInterface $ctx, \Generator $process): array
    {
        while ($process->valid()) {
            try {
                $value = $process->current();

                switch (true) {
                    case $value instanceof ContextInterface:
                        $ctx = $value;
                        break;

                    case $value instanceof RuleInterface:
                        [$ctx, $value] = $this->reduce($ctx, $value);
                        break;

                    case $value instanceof ValueInterface:
                        $value = $ctx->declare($process->key(), $value);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

                    case \is_string($value):
                        $value = $ctx->fetch($value);
                        break;
                }

                $process->send($value);
            } catch (\Throwable $e) {
                $process->throw($e);
            }
        }

        return [$ctx, $process->getReturn()];
    }
}


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;
11
12			use Railt\Io\Readable;
13			use Railt\Parser\Ast\RuleInterface;
14			use Railt\SDL\Exception\CompilerException;
15			use Railt\SDL\Exception\InternalException;
16			use Railt\SDL\Frontend;
17			use Railt\SDL\Frontend\Context\ContextInterface;
18			use Railt\SDL\Frontend\Context\GlobalContext;
19			use Railt\SDL\Frontend\Context\GlobalContextInterface;
20			use Railt\SDL\IR\SymbolTable;
21			use Railt\SDL\IR\SymbolTable\ValueInterface;
22			use Railt\SDL\IR\SymbolTableInterface;
23			use Railt\SDL\IR\Type\TypeNameInterface;
24
25			/**
26			* Class Builder
27			*/
28			class Builder
29			{
30			/**
31			* @var string[]\|Builder\BuilderInterface[]
32			*/
33			private const DEFAULT_BUILDER_DEFINITIONS = [
34			Builder\Instruction\ImportBuilder::class,
35			Builder\Instruction\NamespaceBuilder::class,
36			Builder\Instruction\VariableBuilder::class,
37			Builder\Instruction\VariableReassigmentBuilder::class,
38
39			//
40			Builder\DefinitionBuilder::class,
41
42			// Values
43			Builder\Value\ScalarValueBuilder::class,
44			Builder\Value\VariableValueBuilder::class,
45			Builder\Value\TypeInvocationBuilder::class,
46			Builder\Value\ConstantValueBuilder::class,
47			Builder\Value\BooleanValueBuilder::class,
48
49			//
50			Builder\Common\TypeNameBuilder::class,
51			Builder\TypeDefinitionBuilder::class,
52			];
53
54			/**
55			* @var array\|Builder\BuilderInterface[]
56			*/
57			private $builders = [];
58
59			/**
60			* @var Frontend
61			*/
62			private $frontend;
63
64			/**
65			* @var SymbolTableInterface
66			*/
67			private $table;
68
69			/**
70			* Builder constructor.
71			* @param Frontend $frontend
72			* @param SymbolTable $table
73			*/
74			public function __construct(Frontend $frontend, SymbolTable $table)
75			{
76			$this->table = $table;
77			$this->frontend = $frontend;
78			$this->bootDefaults();
79			}
80
81			/**
82			* @return void
83			*/
84			private function bootDefaults(): void
85			{
86			foreach (self::DEFAULT_BUILDER_DEFINITIONS as $builder) {
87			$this->builders[] = new $builder($this);
88			}
89			}
90
91			/**
92			* @param Readable $readable
93			* @return \Traversable
94			* @throws \Railt\Io\Exception\ExternalFileException
95			* @throws \Railt\SDL\Exception\SyntaxException
96			*/
97			public function load(Readable $readable): iterable
98			{
99			return $this->frontend->load($readable);
100			}
101
102			/**
103			* @param Readable $file
104			* @param iterable $ast
105			* @return iterable
106			* @throws \Railt\Io\Exception\ExternalFileException
107			*/
108			public function build(Readable $file, iterable $ast): iterable
109			{
110			$context = new GlobalContext($file, $this->table);
111
112			foreach ($ast as $child) {
113			if ($this->filter([$context, $result] = $this->reduce($context, $child))) {
114			yield $result;
			0 ignored issues – show Bug introduced 2018-10-02 21:35 UTC by Report Bug Copy Issue Report The variable `$result` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
115			}
116			}
117
118
119			echo \str_repeat('=', 60) . "\n";
120			echo \sprintf('\| %5s \| %-48s \|', 'ID', 'VARIABLE') . "\n";
121			echo \str_repeat('-', 60) . "\n";
122			foreach ($this->table as $id => $var) {
123			echo \sprintf('\| %5d \| %-48s \|', $id, $var) . "\n";
124			}
125			echo \str_repeat('=', 60) . "\n";
126			}
127
128			/**
129			* @param mixed $result
130			* @return bool
131			*/
132			private function filter($result): bool
			0 ignored issues – show Unused Code introduced 2018-10-02 21:35 UTC by Report Bug Copy Issue Report The parameter `$result` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
133			{
134			return false;
135			}
136
137			/**
138			* @param ContextInterface $context
139			* @param RuleInterface $ast
140			* @return array\|iterable<int,ContextInterface\|mixed>
			0 ignored issues – show Documentation introduced 2018-10-02 21:35 UTC by Report Bug Copy Issue Report The doc-type `array\|iterable<int,ContextInterface\|mixed>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 14. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
141			* @throws \Railt\Io\Exception\ExternalFileException
142			*/
143			private function reduce(ContextInterface $context, RuleInterface $ast): array
144			{
145			try {
146			$process = $this->resolve($context, $ast);
147
148			if ($process instanceof \Generator) {
149			return $this->run($context, $process);
150			}
151
152			return [$context, $process];
153			} catch (CompilerException $e) {
154			throw $e->throwsIn($context->getFile(), $ast->getOffset());
155			}
156			}
157
158			/**
159			* @param ContextInterface $context
160			* @param RuleInterface $ast
161			* @return mixed\|\Traversable\|void
162			* @throws \Railt\Io\Exception\ExternalFileException
163			*/
164			private function resolve(ContextInterface $context, RuleInterface $ast)
165			{
166			foreach ($this->builders as $builder) {
167			if ($builder->match($ast)) {
168			return $builder->reduce($context, $ast);
169			}
170			}
171
172			$error = \sprintf('Unrecognized rule %s in (%s)', $ast->getName(), $ast);
173			throw (new InternalException($error))->throwsIn($context->getFile(), $ast->getOffset());
174			}
175
176			/**
177			* @param ContextInterface $ctx
178			* @param \Generator $process
179			* @return array\|iterable<int, ContextInterface\|mixed>
			0 ignored issues – show Documentation introduced 2018-10-02 21:35 UTC by Report Bug Copy Issue Report The doc-type `array\|iterable<int,` could not be parsed: Expected "\|" or "end of type", but got "<" at position 14. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
180			*/
181			private function run(ContextInterface $ctx, \Generator $process): array
182			{
183			while ($process->valid()) {
184			try {
185			$value = $process->current();
186
187			switch (true) {
188			case $value instanceof ContextInterface:
189			$ctx = $value;
190			break;
191
192			case $value instanceof RuleInterface:
193			[$ctx, $value] = $this->reduce($ctx, $value);
194			break;
195
196			case $value instanceof ValueInterface:
197			$value = $ctx->declare($process->key(), $value);
			0 ignored issues – show Documentation introduced 2018-10-02 21:35 UTC by Report Bug Copy Issue Report `$value` is of type `object<Railt\SDL\IR\SymbolTable\ValueInterface>`, but the function expects a `null\|object<Railt\SDL\IR\Type\TypeInterface>`. 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...
198			break;
199
200			case \is_string($value):
201			$value = $ctx->fetch($value);
202			break;
203			}
204
205			$process->send($value);
206			} catch (\Throwable $e) {
207			$process->throw($e);
208			}
209			}
210
211			return [$ctx, $process->getReturn()];
212			}
213			}
214

railt / sdl

Push — master ( b7ab7b...94ee03 )

Builder::reduce() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like