Lechimp\Dicto\Indexer\ASTVisitor

Complexity

Total Complexity

26

Size/Duplication

Total Lines	197
Duplicated Lines	27.92 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

94.87%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	call_misc_listener()	13	13	4
A	call_definition_listener()	12	12	4
A	beforeTraverse()	0	4	1
A	afterTraverse()	0	2	1
A	enterNode()	0	21	3
A	enterNamespace()	0	6	1
A	enterClass()	10	10	1
A	enterInterface()	10	10	1
A	enterTrait()	10	10	1
A	enterMethod()	0	10	1
A	enterFunction()	0	9	1
B	leaveNode()	0	10	6

<?php
/******************************************************************************
 * An implementation of dicto (scg.unibe.ch/dicto) in and for PHP.
 *
 * Copyright (c) 2016, 2015 Richard Klees <richard.klees@rwth-aachen.de>
 *
 * This software is licensed under The MIT License. You should have received
 * a copy of the license along with the code.
 */

namespace Lechimp\Dicto\Indexer;

use Lechimp\Dicto\Variables\Variable;
use PhpParser\Node as N;

/**
 * Visitor for the AST used by Indexer.
 */
class ASTVisitor implements \PhpParser\NodeVisitor {
    /**
     * @var LocationImpl
     */
    protected $location;

    /**
     * @var Insert
     */
    protected $insert;

    /**
     * @var array   string => array()
     */
    protected $listeners_enter_definition;

    /**
     * @var array   string => array()
     */
    protected $listeners_enter_misc;

    /**
     * This is used to exit early in enterNode and to break enterNode apart
     * into many methods.
     *
     * @var array<string,string>
     */
    protected $jump_labels;

    public function __construct(LocationImpl $location, Insert $insert, array &$listeners_enter_definition, array &$listeners_enter_misc) {
        $this->location = $location;
        $this->insert = $insert;
        $this->listeners_enter_definition = $listeners_enter_definition;
        $this->listeners_enter_misc = $listeners_enter_misc;
        $this->jump_labels =
            [ N\Stmt\Namespace_::class => "enterNamespace"

It seems like array(\PhpParser\Node\Stmt\Namespace_::class => 'enterNamespace', \PhpParser\Node\Stmt\Class_::class => 'enterClass', \PhpParser\Node\Stmt\Interface_::class => 'enterInterface', \PhpParser\Node\Stmt\Trait_::class => 'enterTrait', \PhpParser\Node\Stmt\ClassMethod::class => 'enterMethod', \PhpParser\Node\Stmt\Function_::class => 'enterFunction') of type array<string|integer,string> is incompatible with the declared type array<string,string> of property $jump_labels.

            , N\Stmt\Class_::class => "enterClass"
            , N\Stmt\Interface_::class => "enterInterface"
            , N\Stmt\Trait_::class => "enterTrait"
            , N\Stmt\ClassMethod::class => "enterMethod"
            , N\Stmt\Function_::class => "enterFunction"
            ];
    }

    // generalizes over calls to misc listeners

    /**
     * @param   string          $which
     */
    protected function call_misc_listener($which) {

This method seems to be duplicated in your project.

        $listeners = &$this->$which;
        $current_node = $this->location->current_node();
        foreach ($listeners[0] as $listener) {
            $listener($this->insert, $this->location, $current_node);
        }
        $cls = get_class($current_node);
        if (array_key_exists($cls, $listeners)) {
            foreach ($listeners[$cls] as $listener) {
                $listener($this->insert, $this->location, $current_node);
            }
        }
    }

    /**
     * @param   string                  $which
     * @param   string                  $type
     * @param   int                     $type
     */
    protected function call_definition_listener($which, $type, $id) {

This method seems to be duplicated in your project.

        $listeners = &$this->$which;
        $current_node = $this->location->current_node();
        foreach ($listeners[0] as $listener) {
            $listener($this->insert, $this->location, $type, $id, $current_node);
        }
        if (array_key_exists($type, $listeners)) {
            foreach ($listeners[$type] as $listener) {
                $listener($this->insert, $this->location, $type, $id, $current_node);
            }
        }
    }

    // from \PhpParser\NodeVisitor

    /**
     * @inheritdoc
     */
    public function beforeTraverse(array $nodes) {
        $handle = $this->insert->_file($this->location->_file_name(), $this->location->_file_content());
        $this->location->push_entity(Variable::FILE_TYPE, $handle);
    }

    /**
     * @inheritdoc
     */
    public function afterTraverse(array $nodes) {
    }

    /**
     * @inheritdoc
     */
    public function enterNode(\PhpParser\Node $node) {
        $this->location->set_current_node($node);

        $cls = get_class($node);
        if (array_key_exists($cls, $this->jump_labels)) {
            $start_line = $node->getAttribute("startLine");
            $end_line = $node->getAttribute("endLine");
            list($type, $handle) = $this->{$this->jump_labels[$cls]}
                                                ($node, $start_line, $end_line);

            if ($type !== Variable::NAMESPACE_TYPE) {
               $this->call_definition_listener("listeners_enter_definition",  $type, $handle);
            }
            $this->location->push_entity($type, $handle);
        }
        else {
            $this->call_misc_listener("listeners_enter_misc");
        }

        $this->location->flush_current_node();
    }

    public function enterNamespace(N\Stmt\Namespace_ $node, $start_line, $end_line) {

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

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

        $handle = $this->insert->_namespace
            ( "".$node->name // force string representation
            );
        return [Variable::NAMESPACE_TYPE, $handle];
    }

    public function enterClass(N\Stmt\Class_ $node, $start_line, $end_line) {

This method seems to be duplicated in your project.

        $handle = $this->insert->_class
            ( $node->name
            , $this->location->_file()
            , $start_line
            , $end_line
            , $this->location->_namespace()
            );
        return [Variable::CLASS_TYPE, $handle];
    }

    public function enterInterface(N\Stmt\Interface_ $node, $start_line, $end_line) {

This method seems to be duplicated in your project.

        $handle = $this->insert->_interface
            ( $node->name
            , $this->location->_file()
            , $start_line
            , $end_line
            , $this->location->_namespace()
            );
        return [Variable::INTERFACE_TYPE, $handle];
    }

    public function enterTrait(N\Stmt\Trait_ $node, $start_line, $end_line) {

This method seems to be duplicated in your project.

        $handle = $this->insert->_trait
            ( $node->name
            , $this->location->_file()
            , $start_line
            , $end_line
            , $this->location->_namespace()
            );
        return [Variable::INTERFACE_TYPE, $handle];
    }

    public function enterMethod(N\Stmt\ClassMethod $node, $start_line, $end_line) {
        $handle = $this->insert->_method
            ( $node->name
            , $this->location->_class_interface_trait()
            , $this->location->_file()
            , $start_line
            , $end_line
            );
        return [Variable::METHOD_TYPE, $handle];
    }

    public function enterFunction(N\Stmt\Function_ $node, $start_line, $end_line) {
        $handle = $this->insert->_function
            ( $node->name
            , $this->location->_file()
            , $start_line
            , $end_line
            );
        return [Variable::FUNCTION_TYPE, $handle];
    }

    /**
     * @inheritdoc
     */
    public function leaveNode(\PhpParser\Node $node) {
        if (  $node instanceof N\Stmt\Namespace_
           || $node instanceof N\Stmt\Class_
           || $node instanceof N\Stmt\Interface_
           || $node instanceof N\Stmt\ClassMethod
           || $node instanceof N\Stmt\Function_) {

            $this->location->pop_entity();
        }
    }
}