CallbackBuilder - Code Metrics - Inspection of "Query callback builder methods renamed" - remorhaz/php-json-path - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6413a2...041d4b )

by Edward

created 2019-07-27 20:55 UTC

CallbackBuilder B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	393
Duplicated Lines	0 %

Importance

Changes

Metric	Value
eloc	248
dl	0
loc	393
rs	8.72
c	0
b	0
f	0
wmc	46

13 Methods

Rating	Name	Size	Complexity
A	hasReference()	3	1
A	setReference()	7	2
A	onStart()	4	1
A	createReference()	6	1
A	addMethodCall()	6	1
A	getVarName()	3	1
A	onFinish()	30	2
F	onFinishProduction()	257	29
A	getReference()	7	2
A	__construct()	3	1
A	onBeginProduction()	3	1
A	getCapabilities()	7	2
A	getCallback()	7	2

How to fix Complexity

<?php
declare(strict_types=1);

namespace Remorhaz\JSON\Path\Query;

use function array_map;
use function array_reverse;
use PhpParser\BuilderFactory;
use PhpParser\Node as PhpAstNode;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Return_;
use PhpParser\PrettyPrinter\Standard;
use Remorhaz\JSON\Data\Value\NodeValueInterface;
use Remorhaz\JSON\Path\Value\ValueListInterface;
use Remorhaz\JSON\Path\Runtime\RuntimeInterface;
use Remorhaz\UniLex\AST\AbstractTranslatorListener;
use Remorhaz\UniLex\AST\Node as QueryAstNode;
use Remorhaz\UniLex\Exception as UniLexException;
use Remorhaz\UniLex\Stack\PushInterface;

final class CallbackBuilder extends AbstractTranslatorListener implements CallbackBuilderInterface
{

    private const ARG_RUNTIME = 'runtime';

    private const ARG_INPUT = 'input';

    private $php;

    private $references = [];

    private $runtime;

    private $input;

    private $stmts = [];

    private $queryCallback;

    private $capabilities;

    public function __construct()
    {
        $this->php = new BuilderFactory;
    }

    public function getCallback(): callable
    {
        if (isset($this->queryCallback)) {
            return $this->queryCallback;
        }

        throw new Exception\QueryCallbackNotFoundException;
    }

    public function getCapabilities(): CapabilitiesInterface
    {
        if (isset($this->capabilities)) {
            return $this->capabilities;
        }

        throw new Exception\CapabilitiesNotFoundException;
    }

    public function onStart(QueryAstNode $node): void
    {
        $this->runtime = $this->php->var(self::ARG_RUNTIME);
        $this->input = $this->php->var(self::ARG_INPUT);
    }

    public function onFinish(): void
    {
        $runtimeParam = $this
            ->php
            ->param(self::ARG_RUNTIME)
            ->setType(RuntimeInterface::class)
            ->getNode();
        $inputParam = $this
            ->php
            ->param(self::ARG_INPUT)
            ->setType(NodeValueInterface::class)
            ->getNode();
        $stmts = array_map(
            function (PhpAstNode $stmt): PhpAstNode {
                return $stmt instanceof Expr ? new Expression($stmt): $stmt;
            },
            $this->stmts
        );

        $closure = new Expr\Closure(
            [
                'stmts' => $stmts,
                'returnType' => ValueListInterface::class,
                'params' => [$runtimeParam, $inputParam],
            ]
        );
        $return = new Return_($closure);

        $callbackCode = (new Standard)->prettyPrint([$return]);
        $this->queryCallback = eval($callbackCode);
    }

    public function onBeginProduction(QueryAstNode $node, PushInterface $stack): void
    {
        $stack->push(...array_reverse($node->getChildList()));
    }

    /**
     * @param QueryAstNode $node
     * @throws UniLexException
     */
    public function onFinishProduction(QueryAstNode $node): void
    {
        if ($this->hasReference($node)) {
            return;
        }
        switch ($node->getName()) {
            case AstNodeType::GET_INPUT:
                $this->addMethodCall(
                    $node,
                    'getInput',
                    $this->input
                );
                break;

            case AstNodeType::SET_OUTPUT:
                $this->capabilities = new Capabilities(
                    $node->getAttribute('is_definite'),
                    $node->getAttribute('is_path')
                );
                $this->stmts[] = new Return_($this->getReference($node->getChild(0)));
                break;

            case AstNodeType::CREATE_FILTER_CONTEXT:
                $this->addMethodCall(
                    $node,
                    'createFilterContext',
                    $this->getReference($node->getChild(0))
                );
                break;

            case AstNodeType::SPLIT:
                $this->addMethodCall(
                    $node,
                    'split',
                    $this->getReference($node->getChild(0))
                );
                break;

            case AstNodeType::EVALUATE:
                $this->addMethodCall(
                    $node,
                    'evaluate',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::FILTER:
                $this->addMethodCall(
                    $node,
                    'filter',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::EVALUATE_LOGICAL_OR:
                $this->addMethodCall(
                    $node,
                    'evaluateLogicalOr',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::EVALUATE_LOGICAL_AND:
                $this->addMethodCall(
                    $node,
                    'evaluateLogicalAnd',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::EVALUATE_LOGICAL_NOT:
                $this->addMethodCall(
                    $node,
                    'evaluateLogicalNot',
                    $this->getReference($node->getChild(0))
                );
                break;

            case AstNodeType::CALCULATE_IS_EQUAL:
                $this->addMethodCall(
                    $node,
                    'calculateIsEqual',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::CALCULATE_IS_GREATER:
                $this->addMethodCall(
                    $node,
                    'calculateIsGreater',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::CALCULATE_IS_REGEXP:
                $this->addMethodCall(
                    $node,
                    'calculateIsRegExp',
                    $this->php->val($node->getAttribute('pattern')),
                    $this->getReference($node->getChild(0))
                );
                break;

            case AstNodeType::FETCH_CHILDREN:
                $this->addMethodCall(
                    $node,
                    'fetchChildren',
                    $this->getReference($node->getChild(0)),
                    new Arg(
                        $this->getReference($node->getChild(1)),
                        false,
                        true
                    )
                );
                break;

            case AstNodeType::FETCH_CHILDREN_DEEP:
                $this->addMethodCall(
                    $node,
                    'fetchChildrenDeep',
                    $this->getReference($node->getChild(0)),
                    new Arg(
                        $this->getReference($node->getChild(1)),
                        false,
                        true
                    )
                );
                break;

            case AstNodeType::MATCH_ANY_CHILD:
                $this->addMethodCall(
                    $node,
                    'matchAnyChild',
                    $this->getReference($node->getChild(0))
                );
                break;

            case AstNodeType::MATCH_PROPERTY_STRICTLY:
                $this->addMethodCall(
                    $node,
                    'matchPropertyStrictly',
                    $this->getReference($node->getChild(0)),
                );
                break;

            case AstNodeType::MATCH_ELEMENT_STRICTLY:
                $this->addMethodCall(
                    $node,
                    'matchElementStrictly',
                    $this->getReference($node->getChild(0)),
                );
                break;

            case AstNodeType::AGGREGATE:
                $this->addMethodCall(
                    $node,
                    'aggregate',
                    $this->php->val($node->getAttribute('name')),
                    $this->getReference($node->getChild(0)),
                );
                break;

            case AstNodeType::POPULATE_LITERAL:
                $this->addMethodCall(
                    $node,
                    'populateLiteral',
                    $this->getReference($node->getChild(0)),
                    $this->getReference($node->getChild(1))
                );
                break;

            case AstNodeType::POPULATE_LITERAL_ARRAY:
                $this->addMethodCall(
                    $node,
                    'populateLiteralArray',
                    $this->getReference($node->getChild(0)),
                    new Arg(
                        $this->getReference($node->getChild(1)),
                        false,
                        true
                    )
                );
                break;

            case AstNodeType::POPULATE_INDEX_LIST:
                $this->addMethodCall(
                    $node,
                    'populateIndexList',
                    $this->getReference($node->getChild(0)),
                    ...array_map(
                        [$this->php, 'val'],
                        $node->getAttribute('indexList')
                    )
                );
                break;

            case AstNodeType::POPULATE_INDEX_SLICE:
                $attributes = $node->getAttributeList();
                $this->addMethodCall(
                    $node,
                    'populateIndexSlice',
                    $this->getReference($node->getChild(0)),
                    $this->php->val($attributes['start'] ?? null),
                    $this->php->val($attributes['end'] ?? null),
                    $this->php->val($attributes['step'] ?? null)
                );

                break;

            case AstNodeType::POPULATE_NAME_LIST:
                $this->addMethodCall(
                    $node,
                    'populateNameList',
                    $this->getReference($node->getChild(0)),
                    ...array_map(
                        [$this->php, 'val'],
                        $node->getAttribute('nameList')
                    )
                );
                break;

            case AstNodeType::CREATE_SCALAR:
                $attributes = $node->getAttributeList();
                // TODO: allow accessing null attributes
                $value = $this->php->val($attributes['value'] ?? null);
                $this->addMethodCall(
                    $node,
                    'createScalar',
                    $value
                );
                break;

            case AstNodeType::CREATE_ARRAY:
                // [ X:APPEND_TO_ARRAY ]
                $items = [];
                foreach ($node->getChildList() as $child) {
                    $items[] = $this->getReference($child);
                }
                $this->stmts[] = new Assign(
                    $this->createReference($node),
                    $this->php->val($items)
                );
                break;

            case AstNodeType::APPEND_TO_ARRAY:
                // [ 0:<value> ]
                $this->setReference(
                    $node,
                    $this->getReference($node->getChild(0))
                );
                break;
        }
    }

    private function getVarName(QueryAstNode $node): string
    {
        return "var{$node->getId()}";
    }

    private function createReference(QueryAstNode $node): Expr
    {
        $reference = $this->php->var($this->getVarName($node));
        $this->setReference($node, $reference);

        return $reference;
    }

    private function setReference(QueryAstNode $node, Expr $expr): void
    {
        if (isset($this->references[$node->getId()])) {
            throw new Exception\ReferenceAlreadyExistsException($node->getId());
        }

        $this->references[$node->getId()] = $expr;
    }

    private function hasReference(QueryAstNode $node): bool
    {
        return isset($this->references[$node->getId()]);
    }

    private function getReference(QueryAstNode $node): Expr
    {
        if (!isset($this->references[$node->getId()])) {
            throw new Exception\ReferenceNotFoundException($node->getId());
        }

        return $this->references[$node->getId()];
    }

    private function addMethodCall(QueryAstNode $node, string $method, PhpAstNode ...$args): void
    {
        $methodCall = $this
            ->php
            ->methodCall($this->runtime, $method, $args);
        $this->stmts[] = new Assign($this->createReference($node), $methodCall);
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Remorhaz\JSON\Path\Query;
5
6			use function array_map;
7			use function array_reverse;
8			use PhpParser\BuilderFactory;
9			use PhpParser\Node as PhpAstNode;
10			use PhpParser\Node\Arg;
11			use PhpParser\Node\Expr;
12			use PhpParser\Node\Expr\Assign;
13			use PhpParser\Node\Stmt\Expression;
14			use PhpParser\Node\Stmt\Return_;
15			use PhpParser\PrettyPrinter\Standard;
16			use Remorhaz\JSON\Data\Value\NodeValueInterface;
17			use Remorhaz\JSON\Path\Value\ValueListInterface;
18			use Remorhaz\JSON\Path\Runtime\RuntimeInterface;
19			use Remorhaz\UniLex\AST\AbstractTranslatorListener;
20			use Remorhaz\UniLex\AST\Node as QueryAstNode;
21			use Remorhaz\UniLex\Exception as UniLexException;
22			use Remorhaz\UniLex\Stack\PushInterface;
23
24			final class CallbackBuilder extends AbstractTranslatorListener implements CallbackBuilderInterface
25			{
26
27			private const ARG_RUNTIME = 'runtime';
28
29			private const ARG_INPUT = 'input';
30
31			private $php;
32
33			private $references = [];
34
35			private $runtime;
36
37			private $input;
38
39			private $stmts = [];
40
41			private $queryCallback;
42
43			private $capabilities;
44
45			public function __construct()
46			{
47			$this->php = new BuilderFactory;
48			}
49
50			public function getCallback(): callable
51			{
52			if (isset($this->queryCallback)) {
53			return $this->queryCallback;
54			}
55
56			throw new Exception\QueryCallbackNotFoundException;
57			}
58
59			public function getCapabilities(): CapabilitiesInterface
60			{
61			if (isset($this->capabilities)) {
62			return $this->capabilities;
63			}
64
65			throw new Exception\CapabilitiesNotFoundException;
66			}
67
68			public function onStart(QueryAstNode $node): void
69			{
70			$this->runtime = $this->php->var(self::ARG_RUNTIME);
71			$this->input = $this->php->var(self::ARG_INPUT);
72			}
73
74			public function onFinish(): void
75			{
76			$runtimeParam = $this
77			->php
78			->param(self::ARG_RUNTIME)
79			->setType(RuntimeInterface::class)
80			->getNode();
81			$inputParam = $this
82			->php
83			->param(self::ARG_INPUT)
84			->setType(NodeValueInterface::class)
85			->getNode();
86			$stmts = array_map(
87			function (PhpAstNode $stmt): PhpAstNode {
88			return $stmt instanceof Expr ? new Expression($stmt): $stmt;
89			},
90			$this->stmts
91			);
92
93			$closure = new Expr\Closure(
94			[
95			'stmts' => $stmts,
96			'returnType' => ValueListInterface::class,
97			'params' => [$runtimeParam, $inputParam],
98			]
99			);
100			$return = new Return_($closure);
101
102			$callbackCode = (new Standard)->prettyPrint([$return]);
103			$this->queryCallback = eval($callbackCode);
104			}
105
106			public function onBeginProduction(QueryAstNode $node, PushInterface $stack): void
107			{
108			$stack->push(...array_reverse($node->getChildList()));
109			}
110
111			/**
112			* @param QueryAstNode $node
113			* @throws UniLexException
114			*/
115			public function onFinishProduction(QueryAstNode $node): void
116			{
117			if ($this->hasReference($node)) {
118			return;
119			}
120			switch ($node->getName()) {
121			case AstNodeType::GET_INPUT:
122			$this->addMethodCall(
123			$node,
124			'getInput',
125			$this->input
126			);
127			break;
128
129			case AstNodeType::SET_OUTPUT:
130			$this->capabilities = new Capabilities(
131			$node->getAttribute('is_definite'),
132			$node->getAttribute('is_path')
133			);
134			$this->stmts[] = new Return_($this->getReference($node->getChild(0)));
135			break;
136
137			case AstNodeType::CREATE_FILTER_CONTEXT:
138			$this->addMethodCall(
139			$node,
140			'createFilterContext',
141			$this->getReference($node->getChild(0))
142			);
143			break;
144
145			case AstNodeType::SPLIT:
146			$this->addMethodCall(
147			$node,
148			'split',
149			$this->getReference($node->getChild(0))
150			);
151			break;
152
153			case AstNodeType::EVALUATE:
154			$this->addMethodCall(
155			$node,
156			'evaluate',
157			$this->getReference($node->getChild(0)),
158			$this->getReference($node->getChild(1))
159			);
160			break;
161
162			case AstNodeType::FILTER:
163			$this->addMethodCall(
164			$node,
165			'filter',
166			$this->getReference($node->getChild(0)),
167			$this->getReference($node->getChild(1))
168			);
169			break;
170
171			case AstNodeType::EVALUATE_LOGICAL_OR:
172			$this->addMethodCall(
173			$node,
174			'evaluateLogicalOr',
175			$this->getReference($node->getChild(0)),
176			$this->getReference($node->getChild(1))
177			);
178			break;
179
180			case AstNodeType::EVALUATE_LOGICAL_AND:
181			$this->addMethodCall(
182			$node,
183			'evaluateLogicalAnd',
184			$this->getReference($node->getChild(0)),
185			$this->getReference($node->getChild(1))
186			);
187			break;
188
189			case AstNodeType::EVALUATE_LOGICAL_NOT:
190			$this->addMethodCall(
191			$node,
192			'evaluateLogicalNot',
193			$this->getReference($node->getChild(0))
194			);
195			break;
196
197			case AstNodeType::CALCULATE_IS_EQUAL:
198			$this->addMethodCall(
199			$node,
200			'calculateIsEqual',
201			$this->getReference($node->getChild(0)),
202			$this->getReference($node->getChild(1))
203			);
204			break;
205
206			case AstNodeType::CALCULATE_IS_GREATER:
207			$this->addMethodCall(
208			$node,
209			'calculateIsGreater',
210			$this->getReference($node->getChild(0)),
211			$this->getReference($node->getChild(1))
212			);
213			break;
214
215			case AstNodeType::CALCULATE_IS_REGEXP:
216			$this->addMethodCall(
217			$node,
218			'calculateIsRegExp',
219			$this->php->val($node->getAttribute('pattern')),
220			$this->getReference($node->getChild(0))
221			);
222			break;
223
224			case AstNodeType::FETCH_CHILDREN:
225			$this->addMethodCall(
226			$node,
227			'fetchChildren',
228			$this->getReference($node->getChild(0)),
229			new Arg(
230			$this->getReference($node->getChild(1)),
231			false,
232			true
233			)
234			);
235			break;
236
237			case AstNodeType::FETCH_CHILDREN_DEEP:
238			$this->addMethodCall(
239			$node,
240			'fetchChildrenDeep',
241			$this->getReference($node->getChild(0)),
242			new Arg(
243			$this->getReference($node->getChild(1)),
244			false,
245			true
246			)
247			);
248			break;
249
250			case AstNodeType::MATCH_ANY_CHILD:
251			$this->addMethodCall(
252			$node,
253			'matchAnyChild',
254			$this->getReference($node->getChild(0))
255			);
256			break;
257
258			case AstNodeType::MATCH_PROPERTY_STRICTLY:
259			$this->addMethodCall(
260			$node,
261			'matchPropertyStrictly',
262			$this->getReference($node->getChild(0)),
263			);
264			break;
265
266			case AstNodeType::MATCH_ELEMENT_STRICTLY:
267			$this->addMethodCall(
268			$node,
269			'matchElementStrictly',
270			$this->getReference($node->getChild(0)),
271			);
272			break;
273
274			case AstNodeType::AGGREGATE:
275			$this->addMethodCall(
276			$node,
277			'aggregate',
278			$this->php->val($node->getAttribute('name')),
279			$this->getReference($node->getChild(0)),
280			);
281			break;
282
283			case AstNodeType::POPULATE_LITERAL:
284			$this->addMethodCall(
285			$node,
286			'populateLiteral',
287			$this->getReference($node->getChild(0)),
288			$this->getReference($node->getChild(1))
289			);
290			break;
291
292			case AstNodeType::POPULATE_LITERAL_ARRAY:
293			$this->addMethodCall(
294			$node,
295			'populateLiteralArray',
296			$this->getReference($node->getChild(0)),
297			new Arg(
298			$this->getReference($node->getChild(1)),
299			false,
300			true
301			)
302			);
303			break;
304
305			case AstNodeType::POPULATE_INDEX_LIST:
306			$this->addMethodCall(
307			$node,
308			'populateIndexList',
309			$this->getReference($node->getChild(0)),
310			...array_map(
311			[$this->php, 'val'],
312			$node->getAttribute('indexList')
313			)
314			);
315			break;
316
317			case AstNodeType::POPULATE_INDEX_SLICE:
318			$attributes = $node->getAttributeList();
319			$this->addMethodCall(
320			$node,
321			'populateIndexSlice',
322			$this->getReference($node->getChild(0)),
323			$this->php->val($attributes['start'] ?? null),
324			$this->php->val($attributes['end'] ?? null),
325			$this->php->val($attributes['step'] ?? null)
326			);
327
328			break;
329
330			case AstNodeType::POPULATE_NAME_LIST:
331			$this->addMethodCall(
332			$node,
333			'populateNameList',
334			$this->getReference($node->getChild(0)),
335			...array_map(
336			[$this->php, 'val'],
337			$node->getAttribute('nameList')
338			)
339			);
340			break;
341
342			case AstNodeType::CREATE_SCALAR:
343			$attributes = $node->getAttributeList();
344			// TODO: allow accessing null attributes
345			$value = $this->php->val($attributes['value'] ?? null);
346			$this->addMethodCall(
347			$node,
348			'createScalar',
349			$value
350			);
351			break;
352
353			case AstNodeType::CREATE_ARRAY:
354			// [ X:APPEND_TO_ARRAY ]
355			$items = [];
356			foreach ($node->getChildList() as $child) {
357			$items[] = $this->getReference($child);
358			}
359			$this->stmts[] = new Assign(
360			$this->createReference($node),
361			$this->php->val($items)
362			);
363			break;
364
365			case AstNodeType::APPEND_TO_ARRAY:
366			// [ 0:<value> ]
367			$this->setReference(
368			$node,
369			$this->getReference($node->getChild(0))
370			);
371			break;
372			}
373			}
374
375			private function getVarName(QueryAstNode $node): string
376			{
377			return "var{$node->getId()}";
378			}
379
380			private function createReference(QueryAstNode $node): Expr
381			{
382			$reference = $this->php->var($this->getVarName($node));
383			$this->setReference($node, $reference);
384
385			return $reference;
386			}
387
388			private function setReference(QueryAstNode $node, Expr $expr): void
389			{
390			if (isset($this->references[$node->getId()])) {
391			throw new Exception\ReferenceAlreadyExistsException($node->getId());
392			}
393
394			$this->references[$node->getId()] = $expr;
395			}
396
397			private function hasReference(QueryAstNode $node): bool
398			{
399			return isset($this->references[$node->getId()]);
400			}
401
402			private function getReference(QueryAstNode $node): Expr
403			{
404			if (!isset($this->references[$node->getId()])) {
405			throw new Exception\ReferenceNotFoundException($node->getId());
406			}
407
408			return $this->references[$node->getId()];
409			}
410
411			private function addMethodCall(QueryAstNode $node, string $method, PhpAstNode ...$args): void
412			{
413			$methodCall = $this
414			->php
415			->methodCall($this->runtime, $method, $args);
416			$this->stmts[] = new Assign($this->createReference($node), $methodCall);
417			}
418			}
419

remorhaz / php-json-path

Push — master ( 6413a2...041d4b )

CallbackBuilder B

Complexity

Size/Duplication

Importance

13 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like