DefaultApplyingNodeVisitor::doEnterNode() - Code Metrics - Inspection of "Merge pull request #347 from odolbeau/update-comma..." - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a9938...f96c7c )

by Mathieu

created 2019-11-25 08:59 UTC

DefaultApplyingNodeVisitor::doEnterNode() C

↳ Parent: DefaultApplyingNodeVisitor

Complexity

Conditions	11
Paths	12

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	28
CRAP Score	13.7164

Importance

Changes

Metric	Value
dl	0
loc	72
ccs	28
cts	39
cp	0.7179
rs	6.4642
c	0
b	0
f	0
cc	11
nc	12
nop	2
crap	13.7164

How to fix Long Method Complexity

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Twig\Visitor;

use Translation\Bundle\Twig\Node\Transchoice;
use Twig\Environment;
use Twig\Node\Expression\ArrayExpression;
use Twig\Node\Expression\Binary\EqualBinary;
use Twig\Node\Expression\ConditionalExpression;
use Twig\Node\Expression\ConstantExpression;
use Twig\Node\Expression\FilterExpression;
use Twig\Node\Node;
use Twig\NodeVisitor\AbstractNodeVisitor;

/**
 * Applies the value of the "desc" filter if the "trans" filter has no
 * translations.
 *
 * This is only active in your development environment.
 *
 * @author Johannes M. Schmitt <[email protected]>
 */
final class DefaultApplyingNodeVisitor extends AbstractNodeVisitor
{
    /**
     * @var bool
     */
    private $enabled = true;

    /**
     * @param $bool
     */
    public function setEnabled($bool)
    {
        $this->enabled = (bool) $bool;
    }

    /**
     * @return Node
     */
    public function doEnterNode(Node $node, Environment $env)
    {
        if (!$this->enabled) {
            return $node;
        }

        if (!($node instanceof FilterExpression && 'desc' === $node->getNode('filter')->getAttribute('value'))) {
            return $node;
        }

        $transNode = $node->getNode('node');
        while ($transNode instanceof FilterExpression
                   && 'trans' !== $transNode->getNode('filter')->getAttribute('value')
                   && 'transchoice' !== $transNode->getNode('filter')->getAttribute('value')) {
            $transNode = $transNode->getNode('node');
        }

        if (!$transNode instanceof FilterExpression) {
            throw new \RuntimeException(\sprintf('The "desc" filter must be applied after a "trans", or "transchoice" filter.'));
        }

        $wrappingNode = $node->getNode('node');
        $testNode = clone $wrappingNode;
        $defaultNode = $node->getNode('arguments')->getNode(0);

        // if the |transchoice filter is used, delegate the call to the TranslationExtension
        // so that we can catch a possible exception when the default translation has not yet
        // been extracted
        if ('transchoice' === $transNode->getNode('filter')->getAttribute('value')) {
            $transchoiceArguments = new ArrayExpression([], $transNode->getTemplateLine());
            $transchoiceArguments->addElement($wrappingNode->getNode('node'));

            $transchoiceArguments->addElement($defaultNode);

            foreach ($wrappingNode->getNode('arguments') as $arg) {
                $transchoiceArguments->addElement($arg);
            }

            $transchoiceNode = new Transchoice($transchoiceArguments, $transNode->getTemplateLine());
            $node->setNode('node', $transchoiceNode);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            return $node;
        }

        // if the |trans filter has replacements parameters
        // (e.g. |trans({'%foo%': 'bar'}))
        if ($wrappingNode->getNode('arguments')->hasNode(0)) {
            $lineno = $wrappingNode->getTemplateLine();

            // remove the replacements from the test node
            $testNode->setNode('arguments', clone $testNode->getNode('arguments'));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $testNode->getNode('arguments')->setNode(0, new ArrayExpression([], $lineno));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            // wrap the default node in a |replace filter
            $defaultNode = new FilterExpression(
                clone $node->getNode('arguments')->getNode(0),
                new ConstantExpression('replace', $lineno),
                new Node([
                    clone $wrappingNode->getNode('arguments')->getNode(0),
                ]),
                $lineno
            );
        }

        $condition = new ConditionalExpression(
            new EqualBinary($testNode, $transNode->getNode('node'), $wrappingNode->getTemplateLine()),
            $defaultNode,

            clone $wrappingNode,

            $wrappingNode->getTemplateLine()
        );
        $node->setNode('node', $condition);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $node;
    }

    /**
     * @return Node
     */
    public function doLeaveNode(Node $node, Environment $env)
    {
        return $node;
    }

    /**
     * @return int
     */
    public function getPriority()
    {
        return -2;
    }
}


1		<?php
2
3		/*
4		* This file is part of the PHP Translation package.
5		*
6		* (c) PHP Translation team <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Translation\Bundle\Twig\Visitor;
13
14		use Translation\Bundle\Twig\Node\Transchoice;
15		use Twig\Environment;
16		use Twig\Node\Expression\ArrayExpression;
17		use Twig\Node\Expression\Binary\EqualBinary;
18		use Twig\Node\Expression\ConditionalExpression;
19		use Twig\Node\Expression\ConstantExpression;
20		use Twig\Node\Expression\FilterExpression;
21		use Twig\Node\Node;
22		use Twig\NodeVisitor\AbstractNodeVisitor;
23
24		/**
25		* Applies the value of the "desc" filter if the "trans" filter has no
26		* translations.
27		*
28		* This is only active in your development environment.
29		*
30		* @author Johannes M. Schmitt <[email protected]>
31		*/
32		final class DefaultApplyingNodeVisitor extends AbstractNodeVisitor
33		{
34		/**
35		* @var bool
36		*/
37		private $enabled = true;
38
39		/**
40		* @param $bool
41		*/
42		public function setEnabled($bool)
43		{
44		$this->enabled = (bool) $bool;
45		}
46
47		/**
48		* @return Node
49		*/
50	1	public function doEnterNode(Node $node, Environment $env)
51		{
52	1	if (!$this->enabled) {
53		return $node;
54		}
55
56	1	if (!($node instanceof FilterExpression && 'desc' === $node->getNode('filter')->getAttribute('value'))) {
57	1	return $node;
58		}
59
60	1	$transNode = $node->getNode('node');
61	1	while ($transNode instanceof FilterExpression
62	1	&& 'trans' !== $transNode->getNode('filter')->getAttribute('value')
63	1	&& 'transchoice' !== $transNode->getNode('filter')->getAttribute('value')) {
64		$transNode = $transNode->getNode('node');
65		}
66
67	1	if (!$transNode instanceof FilterExpression) {
68		throw new \RuntimeException(\sprintf('The "desc" filter must be applied after a "trans", or "transchoice" filter.'));
69		}
70
71	1	$wrappingNode = $node->getNode('node');
72	1	$testNode = clone $wrappingNode;
73	1	$defaultNode = $node->getNode('arguments')->getNode(0);
74
75		// if the \|transchoice filter is used, delegate the call to the TranslationExtension
76		// so that we can catch a possible exception when the default translation has not yet
77		// been extracted
78	1	if ('transchoice' === $transNode->getNode('filter')->getAttribute('value')) {
79		$transchoiceArguments = new ArrayExpression([], $transNode->getTemplateLine());
80		$transchoiceArguments->addElement($wrappingNode->getNode('node'));
		0 ignored issues – show Compatibility introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `$wrappingNode->getNode('node')` of type `object<Twig\Node\Node>` is not a sub-type of `object<Twig\Node\Expression\AbstractExpression>`. It seems like you assume a child class of the class `Twig\Node\Node` 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...
81		$transchoiceArguments->addElement($defaultNode);
		0 ignored issues – show Compatibility introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `$defaultNode` of type `object<Twig\Node\Node>` is not a sub-type of `object<Twig\Node\Expression\AbstractExpression>`. It seems like you assume a child class of the class `Twig\Node\Node` 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...
82		foreach ($wrappingNode->getNode('arguments') as $arg) {
83		$transchoiceArguments->addElement($arg);
84		}
85
86		$transchoiceNode = new Transchoice($transchoiceArguments, $transNode->getTemplateLine());
87		$node->setNode('node', $transchoiceNode);
		0 ignored issues – show Documentation introduced 2018-04-10 19:18 UTC by Report Bug Copy Issue Report `$transchoiceNode` is of type `object<Translation\Bundle\Twig\Node\Transchoice>`, but the function expects a `object<self>`. 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...
88
89		return $node;
90		}
91
92		// if the \|trans filter has replacements parameters
93		// (e.g. \|trans({'%foo%': 'bar'}))
94	1	if ($wrappingNode->getNode('arguments')->hasNode(0)) {
95	1	$lineno = $wrappingNode->getTemplateLine();
96
97		// remove the replacements from the test node
98	1	$testNode->setNode('arguments', clone $testNode->getNode('arguments'));
		0 ignored issues – show Documentation introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `clone $testNode->getNode('arguments')` is of type `object<Twig\Node\Node>`, but the function expects a `object<self>`. 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...
99	1	$testNode->getNode('arguments')->setNode(0, new ArrayExpression([], $lineno));
		0 ignored issues – show Documentation introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `new \Twig\Node\Expressio...ssion(array(), $lineno)` is of type `object<Twig\Node\Expression\ArrayExpression>`, but the function expects a `object<self>`. 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...
100
101		// wrap the default node in a \|replace filter
102	1	$defaultNode = new FilterExpression(
103	1	clone $node->getNode('arguments')->getNode(0),
104	1	new ConstantExpression('replace', $lineno),
105	1	new Node([
106	1	clone $wrappingNode->getNode('arguments')->getNode(0),
107		]),
108		$lineno
109		);
110		}
111
112	1	$condition = new ConditionalExpression(
113	1	new EqualBinary($testNode, $transNode->getNode('node'), $wrappingNode->getTemplateLine()),
114		$defaultNode,
		0 ignored issues – show Compatibility introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `$defaultNode` of type `object<Twig\Node\Node>` is not a sub-type of `object<Twig\Node\Expression\AbstractExpression>`. It seems like you assume a child class of the class `Twig\Node\Node` 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...
115	1	clone $wrappingNode,
		0 ignored issues – show Compatibility introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `clone $wrappingNode` of type `object<Twig\Node\Node>` is not a sub-type of `object<Twig\Node\Expression\AbstractExpression>`. It seems like you assume a child class of the class `Twig\Node\Node` 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...
116	1	$wrappingNode->getTemplateLine()
117		);
118	1	$node->setNode('node', $condition);
		0 ignored issues – show Documentation introduced 2019-07-20 11:03 UTC by Report Bug Copy Issue Report `$condition` is of type `object<Twig\Node\Express...\ConditionalExpression>`, but the function expects a `object<self>`. 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...
119
120	1	return $node;
121		}
122
123		/**
124		* @return Node
125		*/
126	1	public function doLeaveNode(Node $node, Environment $env)
127		{
128	1	return $node;
129		}
130
131		/**
132		* @return int
133		*/
134	1	public function getPriority()
135		{
136	1	return -2;
137		}
138		}
139

php-translation / symfony-bundle

Push — master ( 9a9938...f96c7c )

DefaultApplyingNodeVisitor::doEnterNode() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like