DefinitionVisitor::enterNode() - Code Metrics - Inspection of "Path to v1" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#335)

by Дмитрий

created 2017-08-04 16:39 UTC

DefinitionVisitor::enterNode() A

↳ Parent: DefinitionVisitor

Complexity

Conditions	4
Paths	4

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4.5923

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	4
nop	1
dl	0
loc	10
ccs	6
cts	9
cp	0.6667
crap	4.5923
rs	9.2
c	0
b	0
f	0

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
 */

namespace PHPSA\Compiler;

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
use PhpParser\Node\Stmt;
use PHPSA\Compiler;
use PHPSA\Definition\ClassDefinition;
use PHPSA\Definition\ClassMethod;
use PHPSA\Definition\FunctionDefinition;
use PHPSA\Definition\TraitDefinition;

class DefinitionVisitor extends NodeVisitorAbstract
{
    /**
     * @var Compiler
     */
    protected $compiler;

    /**
     * @var string|null
     */
    protected $filepath;

    public function __construct(Compiler $compiler)
    {
        $this->compiler = $compiler;
    }

    /**
     * @param Node $node
     * @return void
     */
    public function enterNode(Node $node)
    {
        if ($node instanceof Stmt\Class_) {
            $this->prepareClass($node);
        } elseif ($node instanceof Stmt\Function_) {
            $this->prepareFunction($node);
        } elseif ($node instanceof Stmt\Trait_) {
            $this->prepareTrait($node);
        }
    }

    /**
     * @param Stmt\Trait_ $statement
     */
    public function prepareTrait(Stmt\Trait_ $statement)
    {
        $definition = new TraitDefinition($statement->name, $statement);
        $definition->setFilepath($this->filepath);

        if (isset($statement->namespace)) {
            /** @var \PhpParser\Node\Name $namespace */
            $namespace = $statement->namespace;

            $definition->setNamespace($namespace->toString());
        }

        $definition->precompile();
        $this->compiler->addTrait($definition);
    }

    /**
     * @param Stmt\Function_ $statement
     */
    public function prepareFunction(Stmt\Function_ $statement)
    {
        $definition = new FunctionDefinition($statement->name, $statement);
        $definition->setFilepath($this->filepath);

        if (isset($statement->namespace)) {
            /** @var \PhpParser\Node\Name $namespace */
            $namespace = $statement->namespace;

            $definition->setNamespace($namespace->toString());
        }

        $this->compiler->addFunction($definition);
    }

    /**
     * @param Stmt\Class_ $statement
     */
    public function prepareClass(Stmt\Class_ $statement)
    {
        $definition = new ClassDefinition($statement->name, $statement, $statement->flags);
        $definition->setFilepath($this->filepath);

        if (isset($statement->namespace)) {
            /** @var \PhpParser\Node\Name $namespace */
            $namespace = $statement->namespace;

            $definition->setNamespace($namespace->toString());
        }

        if ($statement->extends) {
            $definition->setExtendsClass($statement->extends->toString());
        }

        if ($statement->implements) {

            foreach ($statement->implements as $interface) {
                $definition->addInterface($interface->toString());
            }
        }

        foreach ($statement->stmts as $stmt) {
            if ($stmt instanceof Node\Stmt\ClassMethod) {
                $definition->addMethod(
                    new ClassMethod($stmt->name, $stmt, $stmt->flags)
                );
            } elseif ($stmt instanceof Node\Stmt\Property) {
                $definition->addProperty($stmt);
            } elseif ($stmt instanceof Node\Stmt\TraitUse) {
                foreach ($stmt->traits as $traitPart) {
                    $traitDefinition = $this->compiler->getTrait($traitPart->toString());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                    if (!$traitDefinition && $definition->getNamespace()) {
                        $traitDefinition = $this->compiler->getTrait($definition->getNamespace() . '\\' . $traitPart);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                    }

                    if ($traitDefinition) {
                        $definition->mergeTrait($traitDefinition, $stmt->adaptations);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    }
                }
            } elseif ($stmt instanceof Node\Stmt\ClassConst) {
                $definition->addConst($stmt);
            }
        }

        $this->compiler->addClass($definition);
    }

    /**
     * @param string $filepath
     */
    public function setFilePath($filepath)
    {
        $this->filepath = $filepath;
    }
}


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA\Compiler;
7
8		use PhpParser\Node;
9		use PhpParser\NodeVisitorAbstract;
10		use PhpParser\Node\Stmt;
11		use PHPSA\Compiler;
12		use PHPSA\Definition\ClassDefinition;
13		use PHPSA\Definition\ClassMethod;
14		use PHPSA\Definition\FunctionDefinition;
15		use PHPSA\Definition\TraitDefinition;
16
17		class DefinitionVisitor extends NodeVisitorAbstract
18		{
19		/**
20		* @var Compiler
21		*/
22		protected $compiler;
23
24		/**
25		* @var string\|null
26		*/
27		protected $filepath;
28
29	1	public function __construct(Compiler $compiler)
30		{
31	1	$this->compiler = $compiler;
32	1	}
33
34		/**
35		* @param Node $node
36		* @return void
37		*/
38	1	public function enterNode(Node $node)
39		{
40	1	if ($node instanceof Stmt\Class_) {
41	1	$this->prepareClass($node);
42	1	} elseif ($node instanceof Stmt\Function_) {
43		$this->prepareFunction($node);
44	1	} elseif ($node instanceof Stmt\Trait_) {
45		$this->prepareTrait($node);
46		}
47	1	}
48
49		/**
50		* @param Stmt\Trait_ $statement
51		*/
52		public function prepareTrait(Stmt\Trait_ $statement)
53		{
54		$definition = new TraitDefinition($statement->name, $statement);
55		$definition->setFilepath($this->filepath);
56
57		if (isset($statement->namespace)) {
58		/** @var \PhpParser\Node\Name $namespace */
59		$namespace = $statement->namespace;
		0 ignored issues – show Bug introduced 2017-01-31 12:38 UTC by Report Bug Copy Issue Report The property `namespace` does not seem to exist in `PhpParser\Node\Stmt\Trait_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
60		$definition->setNamespace($namespace->toString());
61		}
62
63		$definition->precompile();
64		$this->compiler->addTrait($definition);
65		}
66
67		/**
68		* @param Stmt\Function_ $statement
69		*/
70		public function prepareFunction(Stmt\Function_ $statement)
71		{
72		$definition = new FunctionDefinition($statement->name, $statement);
73		$definition->setFilepath($this->filepath);
74
75		if (isset($statement->namespace)) {
76		/** @var \PhpParser\Node\Name $namespace */
77		$namespace = $statement->namespace;
		0 ignored issues – show Bug introduced 2017-01-31 12:38 UTC by Report Bug Copy Issue Report The property `namespace` does not seem to exist in `PhpParser\Node\Stmt\Function_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
78		$definition->setNamespace($namespace->toString());
79		}
80
81		$this->compiler->addFunction($definition);
82		}
83
84		/**
85		* @param Stmt\Class_ $statement
86		*/
87	1	public function prepareClass(Stmt\Class_ $statement)
88		{
89	1	$definition = new ClassDefinition($statement->name, $statement, $statement->flags);
90	1	$definition->setFilepath($this->filepath);
91
92	1	if (isset($statement->namespace)) {
93		/** @var \PhpParser\Node\Name $namespace */
94	1	$namespace = $statement->namespace;
		0 ignored issues – show Bug introduced 2017-01-31 12:38 UTC by Report Bug Copy Issue Report The property `namespace` does not seem to exist in `PhpParser\Node\Stmt\Class_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
95	1	$definition->setNamespace($namespace->toString());
96	1	}
97
98	1	if ($statement->extends) {
99		$definition->setExtendsClass($statement->extends->toString());
100		}
101
102	1	if ($statement->implements) {
		0 ignored issues – show Bug Best Practice introduced 2017-01-07 12:39 UTC by Report Bug Copy Issue Report The expression `$statement->implements` of type `PhpParser\Node\Name[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
103		foreach ($statement->implements as $interface) {
104		$definition->addInterface($interface->toString());
105		}
106		}
107
108	1	foreach ($statement->stmts as $stmt) {
109	1	if ($stmt instanceof Node\Stmt\ClassMethod) {
110	1	$definition->addMethod(
111	1	new ClassMethod($stmt->name, $stmt, $stmt->flags)
112	1	);
113	1	} elseif ($stmt instanceof Node\Stmt\Property) {
114		$definition->addProperty($stmt);
115		} elseif ($stmt instanceof Node\Stmt\TraitUse) {
116		foreach ($stmt->traits as $traitPart) {
117		$traitDefinition = $this->compiler->getTrait($traitPart->toString());
		0 ignored issues – show Bug introduced 2017-01-07 12:39 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$traitDefinition` is correct as `$this->compiler->getTrait($traitPart->toString())` (which targets `PHPSA\Compiler::getTrait()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
118		if (!$traitDefinition && $definition->getNamespace()) {
119		$traitDefinition = $this->compiler->getTrait($definition->getNamespace() . '\\' . $traitPart);
		0 ignored issues – show Bug introduced 2017-01-31 12:38 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$traitDefinition` is correct as `$this->compiler->getTrai...() . '\\' . $traitPart)` (which targets `PHPSA\Compiler::getTrait()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
120		}
121
122		if ($traitDefinition) {
123		$definition->mergeTrait($traitDefinition, $stmt->adaptations);
		0 ignored issues – show Documentation introduced 2017-01-07 12:39 UTC by Report Bug Copy Issue Report `$stmt->adaptations` is of type `array<integer,object<Php...mt\TraitUseAdaptation>>`, but the function expects a `array<integer,object<Php...itUseAdaptation\Alias>>`. 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...
124		}
125		}
126		} elseif ($stmt instanceof Node\Stmt\ClassConst) {
127		$definition->addConst($stmt);
128		}
129	1	}
130
131	1	$this->compiler->addClass($definition);
132	1	}
133
134		/**
135		* @param string $filepath
136		*/
137	1	public function setFilePath($filepath)
138		{
139	1	$this->filepath = $filepath;
140	1	}
141		}
142

ovr / phpsa

Pull Request — master (#335)

DefinitionVisitor::enterNode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like