Hal\Component\Ast\NodeTraverser

Complexity

Total Complexity

3

Size/Duplication

Total Lines	21
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	5	5	1
A	traverseNode()	4	4	1
A	traverseArray()	4	4	1

<?php

/*
 * (c) Jean-François Lépine <https://twitter.com/Halleck45>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Hal\Component\Ast;

use PhpParser\Node;
use PhpParser\NodeTraverser as Mother;
use PhpParser\NodeVisitor;

/**
 * Custom Ast Traverser
 *
 * @author Jean-François Lépine <https://twitter.com/Halleck45>
 * @internal
 */
class Traverser
{
    protected $stopCondition;

    /** @var NodeTraverser */
    private $traverser;

    public function __construct(Mother $traverser, $stopCondition = null)
    {
        if(null === $stopCondition) {
            $stopCondition = function($node) {
                if($node instanceof Node\Stmt\Class_ || $node instanceof Node\Stmt\Interface_) {
                    return false;
                }

                return true;
            };
        }

        $this->stopCondition = $stopCondition;
        $this->traverser = $traverser;

$traverser is of type object<PhpParser\NodeTraverser>, but the property $traverser was declared to be of type object<Hal\Component\Ast\NodeTraverser>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

    /**
     * @param array $nodes
     * @param array|NodeVisitor[] $visitors
     * @return array
     */
    public function traverseArray(array $nodes, array $visitors) {
        $doNodes = array();

        foreach ($nodes as $i => &$node) {
            if (is_array($node)) {
                $node = $this->traverseArray($node, $visitors);
            } elseif ($node instanceof Node) {
                $traverseChildren = call_user_func($this->stopCondition, $node);

                foreach ($visitors as $visitor) {
                    $return = $visitor->enterNode($node);
                    if (Mother::DONT_TRAVERSE_CHILDREN === $return) {
                        $traverseChildren = false;
                    } else if (null !== $return) {
                        $node = $return;
                    }
                }

                if ($traverseChildren) {
                    $node = $this->traverser->traverseNode($node);
                }

                foreach ($visitors as $visitor) {
                    $return = $visitor->leaveNode($node);

                    if (Mother::REMOVE_NODE === $return) {
                        $doNodes[] = array($i, array());
                        break;
                    } elseif (is_array($return)) {
                        $doNodes[] = array($i, $return);
                        break;
                    } elseif (null !== $return) {
                        $node = $return;
                    }
                }
            }
        }

        if (!empty($doNodes)) {
            while (list($i, $replace) = array_pop($doNodes)) {
                array_splice($nodes, $i, 1, $replace);
            }
        }

        return $nodes;
    }
}

if (PHP_VERSION_ID >= 70000) {
    class NodeTraverser extends Mother

This class seems to be duplicated in your project.

PSR1 recommends that each class should be in its own file to aid autoloaders.

    {
        /** @var Traverser */
        private $traverser;

        public function __construct($cloneNodes = false, $stopCondition = null)

The parameter $cloneNodes is not used and could be removed.

        {
            parent::__construct();
            $this->traverser = new Traverser($this, $stopCondition);
        }

        public function traverseNode(Node $node): Node
        {
            return parent::traverseNode($node);
        }

        protected function traverseArray(array $nodes): array
        {
            return $this->traverser->traverseArray($nodes, $this->visitors);
        }
    }
} else {
    class NodeTraverser extends Mother

The type Hal\Component\Ast\NodeTraverser has been defined more than once; this definition is ignored, only the first definition in this file (L99-119) is considered.

This class seems to be duplicated in your project.

PSR1 recommends that each class should be in its own file to aid autoloaders.

    {
        /** @var Traverser */
        private $traverser;

        public function __construct($cloneNodes = false, $stopCondition = null)

The parameter $cloneNodes is not used and could be removed.

        {
            parent::__construct();
            $this->traverser = new Traverser($this, $stopCondition);
        }

        public function traverseNode(Node $node)
        {
            return parent::traverseNode($node);
        }

        protected function traverseArray(array $nodes)
        {
            return $this->traverser->traverseArray($nodes, $this->visitors);
        }
    }
}