FileParser::parseTopDefinitions() - Code Metrics - Inspection of "Add ConstantNaming analyzer" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#132)

by Enrico

created 2016-09-17 10:35 UTC

FileParser::parseTopDefinitions() C

↳ Parent: FileParser

Complexity

Conditions	14
Paths	28

Size

Total Lines	46
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	28
CRAP Score	18.4

Importance

Changes

Metric	Value
cc	14
eloc	29
c	0
b	0
f	0
nc	28
nop	3
dl	0
loc	46
ccs	28
cts	39
cp	0.7179
crap	18.4
rs	5.0744

How to fix 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;

    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
     */
    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);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    } 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 $topStatement
     * @param AliasManager $aliasManager
     * @param string $filepath
     */
    protected function parseTopDefinitions($topStatement, AliasManager $aliasManager, $filepath)
    {
        foreach ($topStatement as $statement) {

            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\Class_) {
                $definition = new ClassDefinition($statement->name, $statement, $statement->type);
                $definition->setFilepath($filepath);
                $definition->setNamespace($aliasManager->getNamespace());

                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) {
                        $method = new ClassMethod($stmt->name, $stmt, $stmt->type);

                        $definition->addMethod($method);
                    } elseif ($stmt instanceof Node\Stmt\Property) {
                        $definition->addProperty($stmt);
                    } 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);
            }
        }
    }
}


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	20	public function __construct(\PhpParser\Parser $parser, Compiler $compiler)
33		{
34	20	$this->nodeTraverser = new \PhpParser\NodeTraverser();
35	20	$this->nodeTraverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver);
36
37	20	$this->parser = $parser;
38	20	$this->compiler = $compiler;
39	20	}
40
41		/**
42		* @param string $filepath
43		* @param Context $context
44		*/
45	20	public function parserFile($filepath, Context $context)
46		{
47	20	$context->setFilepath($filepath);
48
49		try {
50	20	if (!is_readable($filepath)) {
51		throw new RuntimeException('File ' . $filepath . ' is not readable');
52		}
53
54	20	$context->debug('<comment>Precompile: ' . $filepath . '.</comment>');
55
56	20	$code = file_get_contents($filepath);
57	20	$astTree = $this->parser->parse($code);
58
59	20	$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 `57` 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...
60
61	20	$context->aliasManager = new AliasManager();
62	20	$namespace = null;
63
64		/**
65		* Step 1 Precompile
66		*/
67	20	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...
68	20	if ($topStatement instanceof Node\Stmt\Namespace_) {
69		/**
70		* Namespace block can be created without NS name
71		*/
72	20	if ($topStatement->name) {
73	20	$namespace = $topStatement->name->toString();
74	20	$context->aliasManager->setNamespace($namespace);
75	20	}
76
77	20	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...
78	20	$this->parseTopDefinitions($topStatement->stmts, $context->aliasManager, $filepath);
		0 ignored issues – show Documentation introduced 2016-05-21 07:27 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\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...
79	20	}
80	20	} else {
81		if (is_array($topStatement)) {
82		$this->parseTopDefinitions($topStatement, $context->aliasManager, $filepath);
		0 ignored issues – show Documentation introduced 2016-05-21 07:27 UTC by Report Bug Copy Issue Report `$topStatement` is of type `array`, but the function expects a `object<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...
83		} else {
84		$this->parseTopDefinitions($astTree, $context->aliasManager, $filepath);
		0 ignored issues – show Documentation introduced 2016-05-21 07:27 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\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...
85		}
86		}
87	20	}
88
89	20	$context->clear();
90	20	} catch (\PhpParser\Error $e) {
91		$context->syntaxError($e, $filepath);
92		} catch (Exception $e) {
93		$context->output->writeln("<error>{$e->getMessage()}</error>");
94		}
95	20	}
96
97		/**
98		* @param Node\Stmt $topStatement
99		* @param AliasManager $aliasManager
100		* @param string $filepath
101		*/
102	20	protected function parseTopDefinitions($topStatement, AliasManager $aliasManager, $filepath)
103		{
104	20	foreach ($topStatement as $statement) {
		0 ignored issues – show Bug introduced 2016-05-21 07:27 UTC by Report Bug Copy Issue Report The expression `$topStatement` of type `object<PhpParser\Node\Stmt>` is not traversable. Loading history...
105	20	if ($statement instanceof Node\Stmt\Use_) {
106		if (count($statement->uses) > 0) {
107		foreach ($statement->uses as $use) {
108		$aliasManager->add($use->name->parts);
109		}
110		}
111	20	} elseif ($statement instanceof Node\Stmt\Class_) {
112	20	$definition = new ClassDefinition($statement->name, $statement, $statement->type);
113	20	$definition->setFilepath($filepath);
114	20	$definition->setNamespace($aliasManager->getNamespace());
115
116	20	if ($statement->extends) {
117		$definition->setExtendsClass($statement->extends->toString());
118		}
119
120	20	if ($statement->implements) {
121		foreach ($statement->implements as $interface) {
122		$definition->addInterface($interface->toString());
123		}
124		}
125
126	20	foreach ($statement->stmts as $stmt) {
127	20	if ($stmt instanceof Node\Stmt\ClassMethod) {
128	19	$method = new ClassMethod($stmt->name, $stmt, $stmt->type);
129
130	19	$definition->addMethod($method);
131	20	} elseif ($stmt instanceof Node\Stmt\Property) {
132	1	$definition->addProperty($stmt);
133	2	} elseif ($stmt instanceof Node\Stmt\ClassConst) {
134	1	$definition->addConst($stmt);
135	1	}
136	20	}
137
138	20	$this->compiler->addClass($definition);
139	20	} elseif ($statement instanceof Node\Stmt\Function_) {
140	1	$definition = new FunctionDefinition($statement->name, $statement);
141	1	$definition->setFilepath($filepath);
142	1	$definition->setNamespace($aliasManager->getNamespace());
143
144	1	$this->compiler->addFunction($definition);
145	1	}
146	20	}
147	20	}
148		}
149

ovr / phpsa

Pull Request — master (#132)

FileParser::parseTopDefinitions() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like