FileParser::parseTopDefinitions() - Code Metrics - Inspection of "Start to work on interface compilation" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#157)

by Kévin

created 2016-10-02 12:11 UTC

FileParser::parseTopDefinitions() D

↳ Parent: FileParser

Complexity

Conditions	25
Paths	42

Size

Total Lines	84
Code Lines	56

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	33
CRAP Score	127.7978

Importance

Changes

Metric	Value
cc	25
eloc	56
nc	42
nop	3
dl	0
loc	84
ccs	33
cts	73
cp	0.4521
crap	127.7978
rs	4.8006
c	0
b	0
f	0

How to fix Long Method Complexity

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

namespace PHPSA\Definition;

use Exception;
use PHPSA\AliasManager;
use PHPSA\Compiler;
use PHPSA\Context;
use PhpParser\Node;
use RuntimeException;

class FileParser
{
    /**
     * @var \PhpParser\Parser
     */
    protected $parser;

    /**
     * @var \PhpParser\NodeTraverser
     */
    protected $nodeTraverser;

    /**
     * @var Compiler
     */
    protected $compiler;

    /**
     * @param \PhpParser\Parser $parser
     * @param Compiler $compiler
     */
    public function __construct(\PhpParser\Parser $parser, Compiler $compiler)
    {
        $this->nodeTraverser = new \PhpParser\NodeTraverser();
        $this->nodeTraverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver);

        $this->parser = $parser;
        $this->compiler = $compiler;
    }

    /**
     * @param string $filepath
     * @param Context $context
     * @throws RuntimeException when filepath is not readable
     */
    public function parserFile($filepath, Context $context)
    {
        $context->setFilepath($filepath);

        try {
            if (!is_readable($filepath)) {
                throw new RuntimeException('File ' . $filepath . ' is not readable');
            }

            $context->debug('<comment>Precompile: ' . $filepath . '.</comment>');

            $code = file_get_contents($filepath);
            $astTree = $this->parser->parse($code);

            $this->nodeTraverser->traverse($astTree);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

            $context->aliasManager = new AliasManager();
            $namespace = null;

            /**
             * Step 1 Precompile
             */
            foreach ($astTree as $topStatement) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if ($topStatement instanceof Node\Stmt\Namespace_) {
                    /**
                     * Namespace block can be created without NS name
                     */
                    if ($topStatement->name) {
                        $namespace = $topStatement->name->toString();
                        $context->aliasManager->setNamespace($namespace);
                    }

                    if ($topStatement->stmts) {

                        $this->parseTopDefinitions($topStatement->stmts, $context->aliasManager, $filepath);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    }
                } else {
                    if (is_array($topStatement)) {
                        $this->parseTopDefinitions($topStatement, $context->aliasManager, $filepath);
                    } else {
                        $this->parseTopDefinitions($astTree, $context->aliasManager, $filepath);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

            $context->clear();
        } catch (\PhpParser\Error $e) {
            $context->syntaxError($e, $filepath);
        } catch (Exception $e) {
            $context->output->writeln("<error>{$e->getMessage()}</error>");
        }
    }

    /**
     * @param Node\Stmt|Node\Stmt[] $topStatement
     * @param AliasManager $aliasManager
     * @param string $filepath
     */
    protected function parseTopDefinitions($topStatement, AliasManager $aliasManager, $filepath)
    {
        foreach ($topStatement as $statement) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($statement instanceof Node\Stmt\Use_) {
                if (count($statement->uses) > 0) {
                    foreach ($statement->uses as $use) {
                        $aliasManager->add($use->name->parts);
                    }
                }
            } elseif ($statement instanceof Node\Stmt\GroupUse) {
                if (count($statement->uses) > 0) {
                    foreach ($statement->uses as $use) {
                        $aliasManager->add($statement->prefix . $use->name->parts);
                    }
                }
            } elseif ($statement instanceof Node\Stmt\Trait_) {
                $definition = new TraitDefinition($statement->name, $statement);
                $definition->setFilepath($filepath);
                $definition->setNamespace($aliasManager->getNamespace());
                $definition->precompile();

                $this->compiler->addTrait($definition);
            } elseif ($statement instanceof Node\Stmt\Class_) {
                $definition = new ClassDefinition($statement->name, $statement, $statement->type);
                $definition->setFilepath($filepath);
                $definition->setNamespace($aliasManager->getNamespace());

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

                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->type)
                        );
                    } 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->mergeTrait($traitDefinition);
                            }
                        }
                    } elseif ($stmt instanceof Node\Stmt\ClassConst) {
                        $definition->addConst($stmt);
                    }
                }

                $this->compiler->addClass($definition);
            } elseif ($statement instanceof Node\Stmt\Function_) {
                $definition = new FunctionDefinition($statement->name, $statement);
                $definition->setFilepath($filepath);
                $definition->setNamespace($aliasManager->getNamespace());

                $this->compiler->addFunction($definition);
            } elseif ($statement instanceof Node\Stmt\Interface_) {
                $definition = new InterfaceDefinition($statement->name, $statement);
                $definition->setFilepath($filepath);
                $definition->setNamespace($aliasManager->getNamespace());

                foreach ($statement->extends as $interface) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                    $definition->addExtendsInterface($interface->toString());
                }

                foreach ($statement->stmts as $stmt) {
                    if ($stmt instanceof Node\Stmt\ClassMethod) {
                        $method = new ClassMethod($stmt->name, $stmt, $stmt->type | Node\Stmt\Class_::MODIFIER_ABSTRACT);

                        $definition->addMethod($method);
                    } elseif ($stmt instanceof Node\Stmt\ClassConst) {
                        $definition->addConst($stmt);
                    }
                }

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


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA\Definition;
7
8		use Exception;
9		use PHPSA\AliasManager;
10		use PHPSA\Compiler;
11		use PHPSA\Context;
12		use PhpParser\Node;
13		use RuntimeException;
14
15		class FileParser
16		{
17		/**
18		* @var \PhpParser\Parser
19		*/
20		protected $parser;
21
22		/**
23		* @var \PhpParser\NodeTraverser
24		*/
25		protected $nodeTraverser;
26
27		/**
28		* @var Compiler
29		*/
30		protected $compiler;
31
32		/**
33		* @param \PhpParser\Parser $parser
34		* @param Compiler $compiler
35		*/
36	25	public function __construct(\PhpParser\Parser $parser, Compiler $compiler)
37		{
38	25	$this->nodeTraverser = new \PhpParser\NodeTraverser();
39	25	$this->nodeTraverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver);
40
41	25	$this->parser = $parser;
42	25	$this->compiler = $compiler;
43	25	}
44
45		/**
46		* @param string $filepath
47		* @param Context $context
48		* @throws RuntimeException when filepath is not readable
49		*/
50	25	public function parserFile($filepath, Context $context)
51		{
52	25	$context->setFilepath($filepath);
53
54		try {
55	25	if (!is_readable($filepath)) {
56		throw new RuntimeException('File ' . $filepath . ' is not readable');
57		}
58
59	25	$context->debug('<comment>Precompile: ' . $filepath . '.</comment>');
60
61	25	$code = file_get_contents($filepath);
62	25	$astTree = $this->parser->parse($code);
63
64	25	$this->nodeTraverser->traverse($astTree);
		0 ignored issues – show Bug introduced 2016-05-21 07:27 UTC by Report Bug Copy Issue Report It seems like `$astTree` defined by `$this->parser->parse($code)` on line `62` can also be of type `null`; however, `PhpParser\NodeTraverser::traverse()` does only seem to accept `array<integer,object<PhpParser\Node>>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
65
66	25	$context->aliasManager = new AliasManager();
67	25	$namespace = null;
68
69		/**
70		* Step 1 Precompile
71		*/
72	25	foreach ($astTree as $topStatement) {
		0 ignored issues – show Bug introduced 2016-05-21 07:27 UTC by Report Bug Copy Issue Report The expression `$astTree` of type `array<integer,object<PhpParser\Node>>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
73	25	if ($topStatement instanceof Node\Stmt\Namespace_) {
74		/**
75		* Namespace block can be created without NS name
76		*/
77	25	if ($topStatement->name) {
78	25	$namespace = $topStatement->name->toString();
79	25	$context->aliasManager->setNamespace($namespace);
80	25	}
81
82	25	if ($topStatement->stmts) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-21 07:27 UTC by Report Bug Copy Issue Report The expression `$topStatement->stmts` of type `PhpParser\Node[]` 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...
83	25	$this->parseTopDefinitions($topStatement->stmts, $context->aliasManager, $filepath);
		0 ignored issues – show Documentation introduced 2016-09-14 14:22 UTC by Report Bug Copy Issue Report `$topStatement->stmts` is of type `array<integer,object<PhpParser\Node>>`, but the function expects a `object<PhpParser\Node\St...t<PhpParser\Node\Stmt>>`. 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...
84	25	}
85	25	} else {
86		if (is_array($topStatement)) {
87		$this->parseTopDefinitions($topStatement, $context->aliasManager, $filepath);
88		} else {
89		$this->parseTopDefinitions($astTree, $context->aliasManager, $filepath);
		0 ignored issues – show Documentation introduced 2016-09-14 14:22 UTC by Report Bug Copy Issue Report `$astTree` is of type `array<integer,object<PhpParser\Node>>\|null`, but the function expects a `object<PhpParser\Node\St...t<PhpParser\Node\Stmt>>`. 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...
90		}
91		}
92	25	}
93
94	25	$context->clear();
95	25	} catch (\PhpParser\Error $e) {
96		$context->syntaxError($e, $filepath);
97		} catch (Exception $e) {
98		$context->output->writeln("<error>{$e->getMessage()}</error>");
99		}
100	25	}
101
102		/**
103		* @param Node\Stmt\|Node\Stmt[] $topStatement
104		* @param AliasManager $aliasManager
105		* @param string $filepath
106		*/
107	25	protected function parseTopDefinitions($topStatement, AliasManager $aliasManager, $filepath)
108		{
109	25	foreach ($topStatement as $statement) {
		0 ignored issues – show Bug introduced 2016-09-14 14:22 UTC by Report Bug Copy Issue Report The expression `$topStatement` of type `object<PhpParser\Node\St...t<PhpParser\Node\Stmt>>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
110	25	if ($statement instanceof Node\Stmt\Use_) {
111		if (count($statement->uses) > 0) {
112		foreach ($statement->uses as $use) {
113		$aliasManager->add($use->name->parts);
114		}
115		}
116	25	} elseif ($statement instanceof Node\Stmt\GroupUse) {
117		if (count($statement->uses) > 0) {
118		foreach ($statement->uses as $use) {
119		$aliasManager->add($statement->prefix . $use->name->parts);
120		}
121		}
122	25	} elseif ($statement instanceof Node\Stmt\Trait_) {
123		$definition = new TraitDefinition($statement->name, $statement);
124		$definition->setFilepath($filepath);
125		$definition->setNamespace($aliasManager->getNamespace());
126		$definition->precompile();
127
128		$this->compiler->addTrait($definition);
129	25	} elseif ($statement instanceof Node\Stmt\Class_) {
130	25	$definition = new ClassDefinition($statement->name, $statement, $statement->type);
131	25	$definition->setFilepath($filepath);
132	25	$definition->setNamespace($aliasManager->getNamespace());
133
134	25	if ($statement->extends) {
135		$definition->setExtendsClass($statement->extends->toString());
136		}
137
138	25	foreach ($statement->implements as $interface) {
139		$definition->addInterface($interface->toString());
140	25	}
141
142	25	foreach ($statement->stmts as $stmt) {
143	25	if ($stmt instanceof Node\Stmt\ClassMethod) {
144	24	$definition->addMethod(
145	24	new ClassMethod($stmt->name, $stmt, $stmt->type)
146	24	);
147	25	} elseif ($stmt instanceof Node\Stmt\Property) {
148	3	$definition->addProperty($stmt);
149	4	} elseif ($stmt instanceof Node\Stmt\TraitUse) {
150		foreach ($stmt->traits as $traitPart) {
151		$traitDefinition = $this->compiler->getTrait($traitPart->toString());
		0 ignored issues – show Bug introduced 2016-10-02 11:59 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...
152		if ($traitDefinition) {
153		$definition->mergeTrait($traitDefinition);
154		}
155		}
156	1	} elseif ($stmt instanceof Node\Stmt\ClassConst) {
157	1	$definition->addConst($stmt);
158	1	}
159	25	}
160
161	25	$this->compiler->addClass($definition);
162	25	} elseif ($statement instanceof Node\Stmt\Function_) {
163	1	$definition = new FunctionDefinition($statement->name, $statement);
164	1	$definition->setFilepath($filepath);
165	1	$definition->setNamespace($aliasManager->getNamespace());
166
167	1	$this->compiler->addFunction($definition);
168	25	} elseif ($statement instanceof Node\Stmt\Interface_) {
169		$definition = new InterfaceDefinition($statement->name, $statement);
170		$definition->setFilepath($filepath);
171		$definition->setNamespace($aliasManager->getNamespace());
172
173		foreach ($statement->extends as $interface) {
		0 ignored issues – show Bug introduced 2016-10-02 12:14 UTC by Report Bug Copy Issue Report The expression `$statement->extends` of type `object<PhpParser\Node\Name>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
174		$definition->addExtendsInterface($interface->toString());
175		}
176
177		foreach ($statement->stmts as $stmt) {
178		if ($stmt instanceof Node\Stmt\ClassMethod) {
179		$method = new ClassMethod($stmt->name, $stmt, $stmt->type \| Node\Stmt\Class_::MODIFIER_ABSTRACT);
180
181		$definition->addMethod($method);
182		} elseif ($stmt instanceof Node\Stmt\ClassConst) {
183		$definition->addConst($stmt);
184		}
185		}
186
187		$this->compiler->addInterface($definition);
188		}
189	25	}
190	25	}
191		}
192

ovr / phpsa

Pull Request — master (#157)

FileParser::parseTopDefinitions() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like