CheckCommand::getCompiler() - Code Metrics - Inspection of "Welcome to new Analyzer Pass by Event Manager on B..." - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c349c3...6c3584 )

by Дмитрий

created 2016-05-14 23:07 UTC

CheckCommand::getCompiler() A

↳ Parent: CheckCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

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

namespace PHPSA\Command;

use PhpParser\NodeTraverser;
use PhpParser\ParserFactory;
use PHPSA\AliasManager;
use PHPSA\Analyzer\EventListener\ExpressionListener;
use PHPSA\Application;
use PHPSA\Compiler;
use PHPSA\Context;
use PHPSA\Definition\ClassDefinition;
use PHPSA\Definition\ClassMethod;
use PHPSA\Definition\FunctionDefinition;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RuntimeException;
use SplFileInfo;
use Exception;
use FilesystemIterator;
use PhpParser\Node;
use PhpParser\Parser;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Webiny\Component\EventManager\EventManager;
use PHPSA\Analyzer\Pass as AnalyzerPass;

/**
 * Class CheckCommand
 * @package PHPSA\Command
 *
 * @method Application getApplication();
 */
class CheckCommand extends Command
{
    protected function configure()
    {
        $this
            ->setName('check')
            ->setDescription('SPA')
            ->addOption('blame', null, InputOption::VALUE_OPTIONAL, 'Git blame author for bad code ;)', false)
            ->addArgument('path', InputArgument::OPTIONAL, 'Path to check file or directory', '.')
            ->addOption(
                'report-json',
                null,
                InputOption::VALUE_REQUIRED,
                'Path to save detailed report in JSON format. Example: /tmp/report.json'
            );
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('');

        if (extension_loaded('xdebug')) {
            $output->writeln('<error>It is highly recommended to disable the XDebug extension before invoking this command.</error>');
        }

        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7, new \PhpParser\Lexer\Emulative(
            array(
                'usedAttributes' => array(
                    'comments',
                    'startLine',
                    'endLine',
                    'startTokenPos',
                    'endTokenPos'
                )
            )
        ));

        /** @var Application $application */
        $application = $this->getApplication();
        $application->compiler = new Compiler();

        $em = EventManager::getInstance();

        $em->listen(Compiler\Event\ExpressionBeforeCompile::EVENT_NAME)
            ->handler(
                new ExpressionListener(
                    [
                        new AnalyzerPass\FunctionCall\AliasCheck(),
                        new AnalyzerPass\FunctionCall\ArrayShortDefinition(),
                        new AnalyzerPass\FunctionCall\DebugCode(),
                        new AnalyzerPass\FunctionCall\RandomApiMigration(),
                        new AnalyzerPass\FunctionCall\UseCast(),
                    ]
                )
            )
            ->method('beforeCompile');

        $context = new Context($output, $application, $em);

        /**
         * Store option's in application's configuration
         */
        $application->getConfiguration()->setValue('blame', $input->getOption('blame'));

        $astTraverser = new \PhpParser\NodeTraverser();
        $astTraverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver);

        $path = $input->getArgument('path');
        if (is_dir($path)) {
            $directoryIterator = new RecursiveIteratorIterator(
                new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS)
            );
            $output->writeln('Scanning directory <info>' . $path . '</info>');

            $count = 0;

            /** @var SplFileInfo $file */
            foreach ($directoryIterator as $file) {
                if ($file->getExtension() != 'php') {
                    continue;
                }

                $context->debug($file->getPathname());
                $count++;
            }

            $output->writeln("Found <info>{$count} files</info>");

            if ($count > 100) {
                $output->writeln('<comment>Caution: You are trying to scan a lot of files; this might be slow. For bigger libraries, consider setting up a dedicated platform or using ci.lowl.io.</comment>');
            }

            $output->writeln('');

            /** @var SplFileInfo $file */
            foreach ($directoryIterator as $file) {
                if ($file->getExtension() != 'php') {
                    continue;
                }

                $this->parserFile($file->getPathname(), $parser, $astTraverser, $context);
            }
        } elseif (is_file($path)) {
            $this->parserFile($path, $parser, $astTraverser, $context);
        }


        /**
         * Step 2 Recursive check ...
         */
        $application->compiler->compile($context);

        $jsonReport = $input->getOption('report-json');
        if ($jsonReport) {
            file_put_contents(
                $jsonReport,
                json_encode(
                    $this->getApplication()->getIssuesCollector()->getIssues()
                )
            );
        }

        $output->writeln('');
        $output->writeln('Memory usage: ' . $this->getMemoryUsage(false) . ' (peak: ' . $this->getMemoryUsage(true) . ') MB');
    }

    /**
     * @param boolean $type
     * @return float
     */
    protected function getMemoryUsage($type)
    {
        return round(memory_get_usage($type) / 1024 / 1024, 2);
    }

    /**
     * @return Compiler
     */
    protected function getCompiler()
    {
        return $this->getApplication()->compiler;
    }

    /**
     * @param string $filepath
     * @param Parser $parser
     * @param NodeTraverser $nodeTraverser
     * @param Context $context
     */
    protected function parserFile($filepath, Parser $parser, NodeTraverser $nodeTraverser, 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 = $parser->parse($code);

            $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 {
                    $this->parseTopDefinitions($topStatement, $context->aliasManager, $filepath);
                }
            }
            
            $context->clear();
        } catch (\PhpParser\Error $e) {
            $context->sytaxError($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->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->getCompiler()->addClass($definition);
            } elseif ($statement instanceof Node\Stmt\Function_) {
                $definition = new FunctionDefinition($statement->name, $statement);
                $definition->setFilepath($filepath);
                $definition->setNamespace($aliasManager->getNamespace());

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


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA\Command;
7
8		use PhpParser\NodeTraverser;
9		use PhpParser\ParserFactory;
10		use PHPSA\AliasManager;
11		use PHPSA\Analyzer\EventListener\ExpressionListener;
12		use PHPSA\Application;
13		use PHPSA\Compiler;
14		use PHPSA\Context;
15		use PHPSA\Definition\ClassDefinition;
16		use PHPSA\Definition\ClassMethod;
17		use PHPSA\Definition\FunctionDefinition;
18		use RecursiveDirectoryIterator;
19		use RecursiveIteratorIterator;
20		use RuntimeException;
21		use SplFileInfo;
22		use Exception;
23		use FilesystemIterator;
24		use PhpParser\Node;
25		use PhpParser\Parser;
26		use Symfony\Component\Console\Command\Command;
27		use Symfony\Component\Console\Input\InputArgument;
28		use Symfony\Component\Console\Input\InputInterface;
29		use Symfony\Component\Console\Input\InputOption;
30		use Symfony\Component\Console\Output\OutputInterface;
31		use Webiny\Component\EventManager\EventManager;
32		use PHPSA\Analyzer\Pass as AnalyzerPass;
33
34		/**
35		* Class CheckCommand
36		* @package PHPSA\Command
37		*
38		* @method Application getApplication();
39		*/
40		class CheckCommand extends Command
41		{
42	1	protected function configure()
43		{
44	1	$this
45	1	->setName('check')
46	1	->setDescription('SPA')
47	1	->addOption('blame', null, InputOption::VALUE_OPTIONAL, 'Git blame author for bad code ;)', false)
48	1	->addArgument('path', InputArgument::OPTIONAL, 'Path to check file or directory', '.')
49	1	->addOption(
50	1	'report-json',
51	1	null,
52	1	InputOption::VALUE_REQUIRED,
53		'Path to save detailed report in JSON format. Example: /tmp/report.json'
54	1	);
55	1	}
56
57		protected function execute(InputInterface $input, OutputInterface $output)
58		{
59		$output->writeln('');
60
61		if (extension_loaded('xdebug')) {
62		$output->writeln('<error>It is highly recommended to disable the XDebug extension before invoking this command.</error>');
63		}
64
65		$parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7, new \PhpParser\Lexer\Emulative(
66		array(
67		'usedAttributes' => array(
68		'comments',
69		'startLine',
70		'endLine',
71		'startTokenPos',
72		'endTokenPos'
73		)
74		)
75		));
76
77		/** @var Application $application */
78		$application = $this->getApplication();
79		$application->compiler = new Compiler();
80
81		$em = EventManager::getInstance();
		0 ignored issues – show Comprehensibility introduced 2016-05-14 22:24 UTC by Report Bug Copy Issue Report Avoid variables with short names like $em. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
82		$em->listen(Compiler\Event\ExpressionBeforeCompile::EVENT_NAME)
83		->handler(
84		new ExpressionListener(
85		[
86		new AnalyzerPass\FunctionCall\AliasCheck(),
87		new AnalyzerPass\FunctionCall\ArrayShortDefinition(),
88		new AnalyzerPass\FunctionCall\DebugCode(),
89		new AnalyzerPass\FunctionCall\RandomApiMigration(),
90		new AnalyzerPass\FunctionCall\UseCast(),
91		]
92		)
93		)
94		->method('beforeCompile');
95
96		$context = new Context($output, $application, $em);
97
98		/**
99		* Store option's in application's configuration
100		*/
101		$application->getConfiguration()->setValue('blame', $input->getOption('blame'));
102
103		$astTraverser = new \PhpParser\NodeTraverser();
104		$astTraverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver);
105
106		$path = $input->getArgument('path');
107		if (is_dir($path)) {
108		$directoryIterator = new RecursiveIteratorIterator(
109		new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS)
110		);
111		$output->writeln('Scanning directory <info>' . $path . '</info>');
112
113		$count = 0;
114
115		/** @var SplFileInfo $file */
116		foreach ($directoryIterator as $file) {
117		if ($file->getExtension() != 'php') {
118		continue;
119		}
120
121		$context->debug($file->getPathname());
122		$count++;
123		}
124
125		$output->writeln("Found <info>{$count} files</info>");
126
127		if ($count > 100) {
128		$output->writeln('<comment>Caution: You are trying to scan a lot of files; this might be slow. For bigger libraries, consider setting up a dedicated platform or using ci.lowl.io.</comment>');
129		}
130
131		$output->writeln('');
132
133		/** @var SplFileInfo $file */
134		foreach ($directoryIterator as $file) {
135		if ($file->getExtension() != 'php') {
136		continue;
137		}
138
139		$this->parserFile($file->getPathname(), $parser, $astTraverser, $context);
140		}
141		} elseif (is_file($path)) {
142		$this->parserFile($path, $parser, $astTraverser, $context);
143		}
144
145
146		/**
147		* Step 2 Recursive check ...
148		*/
149		$application->compiler->compile($context);
150
151		$jsonReport = $input->getOption('report-json');
152		if ($jsonReport) {
153		file_put_contents(
154		$jsonReport,
155		json_encode(
156		$this->getApplication()->getIssuesCollector()->getIssues()
157		)
158		);
159		}
160
161		$output->writeln('');
162		$output->writeln('Memory usage: ' . $this->getMemoryUsage(false) . ' (peak: ' . $this->getMemoryUsage(true) . ') MB');
163		}
164
165		/**
166		* @param boolean $type
167		* @return float
168		*/
169		protected function getMemoryUsage($type)
170		{
171		return round(memory_get_usage($type) / 1024 / 1024, 2);
172		}
173
174		/**
175		* @return Compiler
176		*/
177		protected function getCompiler()
178		{
179		return $this->getApplication()->compiler;
180		}
181
182		/**
183		* @param string $filepath
184		* @param Parser $parser
185		* @param NodeTraverser $nodeTraverser
186		* @param Context $context
187		*/
188		protected function parserFile($filepath, Parser $parser, NodeTraverser $nodeTraverser, Context $context)
189		{
190		$context->setFilepath($filepath);
191
192		try {
193		if (!is_readable($filepath)) {
194		throw new RuntimeException('File ' . $filepath . ' is not readable');
195		}
196
197		$context->debug('<comment>Precompile: ' . $filepath . '.</comment>');
198
199		$code = file_get_contents($filepath);
200		$astTree = $parser->parse($code);
201
202		$nodeTraverser->traverse($astTree);
		0 ignored issues – show Bug introduced 2016-02-06 15:22 UTC by Report Bug Copy Issue Report It seems like `$astTree` defined by `$parser->parse($code)` on line `200` 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...
203
204		$context->aliasManager = new AliasManager();
205		$namespace = null;
206
207		/**
208		* Step 1 Precompile
209		*/
210		foreach ($astTree as $topStatement) {
		0 ignored issues – show Bug introduced 2015-11-22 15:25 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...
211		if ($topStatement instanceof Node\Stmt\Namespace_) {
212		/**
213		* Namespace block can be created without NS name
214		*/
215		if ($topStatement->name) {
216		$namespace = $topStatement->name->toString();
217		$context->aliasManager->setNamespace($namespace);
218		}
219
220		if ($topStatement->stmts) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-22 15:25 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...
221		$this->parseTopDefinitions($topStatement->stmts, $context->aliasManager, $filepath);
		0 ignored issues – show Documentation introduced 2015-11-22 15:25 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...
222		}
223		} else {
224		$this->parseTopDefinitions($topStatement, $context->aliasManager, $filepath);
225		}
226		}
227
228		$context->clear();
229		} catch (\PhpParser\Error $e) {
230		$context->sytaxError($e, $filepath);
231		} catch (Exception $e) {
232		$context->output->writeln("<error>{$e->getMessage()}</error>");
233		}
234		}
235
236		/**
237		* @param Node\Stmt $topStatement
238		* @param AliasManager $aliasManager
239		* @param string $filepath
240		*/
241		protected function parseTopDefinitions($topStatement, AliasManager $aliasManager, $filepath)
242		{
243		foreach ($topStatement as $statement) {
		0 ignored issues – show Bug introduced 2015-11-22 15:25 UTC by Report Bug Copy Issue Report The expression `$topStatement` of type `object<PhpParser\Node\Stmt>` is not traversable. Loading history...
244		if ($statement instanceof Node\Stmt\Use_) {
245		if (count($statement->uses) > 0) {
246		foreach ($statement->uses as $use) {
247		$aliasManager->add($use->name->parts);
248		}
249		}
250		} elseif ($statement instanceof Node\Stmt\Class_) {
251		$definition = new ClassDefinition($statement->name, $statement->type);
252		$definition->setFilepath($filepath);
253		$definition->setNamespace($aliasManager->getNamespace());
254
255		if ($statement->extends) {
256		$definition->setExtendsClass($statement->extends->toString());
257		}
258
259		if ($statement->implements) {
260		foreach ($statement->implements as $interface) {
261		$definition->addInterface($interface->toString());
262		}
263		}
264
265		foreach ($statement->stmts as $stmt) {
266		if ($stmt instanceof Node\Stmt\ClassMethod) {
267		$method = new ClassMethod($stmt->name, $stmt, $stmt->type);
268
269		$definition->addMethod($method);
270		} elseif ($stmt instanceof Node\Stmt\Property) {
271		$definition->addProperty($stmt);
272		} elseif ($stmt instanceof Node\Stmt\ClassConst) {
273		$definition->addConst($stmt);
274		}
275		}
276
277		$this->getCompiler()->addClass($definition);
278		} elseif ($statement instanceof Node\Stmt\Function_) {
279		$definition = new FunctionDefinition($statement->name, $statement);
280		$definition->setFilepath($filepath);
281		$definition->setNamespace($aliasManager->getNamespace());
282
283		$this->getCompiler()->addFunction($definition);
284		}
285		}
286		}
287		}
288

ovr / phpsa

Push — master ( c349c3...6c3584 )

CheckCommand::getCompiler() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like