CheckCommand::execute() - Code Metrics - Inspection of "Allow analyzers to be configured" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#139)

by Kévin

created 2016-10-11 08:23 UTC

CheckCommand::execute() D

↳ Parent: CheckCommand

Complexity

Conditions	13
Paths	96

Size

Total Lines	107
Code Lines	56

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	182

Importance

Changes

Metric	Value
cc	13
eloc	56
nc	96
nop	2
dl	0
loc	107
ccs	0
cts	69
cp	0
crap	182
rs	4.9922
c	0
b	0
f	0

How to fix Long Method Complexity

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

namespace PHPSA\Command;

use PhpParser\ParserFactory;
use PHPSA\Analyzer;
use PHPSA\Application;
use PHPSA\Compiler;
use PHPSA\Configuration;
use PHPSA\ConfigurationLoader;
use PHPSA\Context;
use PHPSA\Definition\FileParser;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use SplFileInfo;
use FilesystemIterator;
use Symfony\Component\Config\FileLocator;
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
{

    /**
     * Configures the command.
     */
    protected function configure()
    {
        $this
            ->setName('check')
            ->setDescription('SPA')
            ->addOption('blame', null, InputOption::VALUE_NONE, 'Git blame author for bad code ;)')
            ->addOption('config-file', null, InputOption::VALUE_REQUIRED, 'Path to the configuration file.')
            ->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'
            );
    }

    /**
     * Executes the command.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     */
    protected function execute(InputInterface $input, OutputInterface $output)

    {
        $output->writeln('');

        if (extension_loaded('xdebug')) {
            /**
             * This will disable only showing stack traces on error conditions.
             */
            if (function_exists('xdebug_disable')) {
                xdebug_disable();
            }

            $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([
            'usedAttributes' => [
                'comments',
                'startLine',
                'endLine',
                'startTokenPos',
                'endTokenPos'
            ]
        ]));

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

        $configFile = $input->getOption('config-file') ?: '.phpsa.yml';
        $configDir = realpath($input->getArgument('path'));
        $application->configuration = $this->loadConfiguration($configFile, $configDir);

        $em = EventManager::getInstance();

        Analyzer\Factory::factory($em, $application->configuration);
        $context = new Context($output, $application, $em);

        /**
         * Store option's in application's configuration
         */
        if ($input->getOption('blame')) {
            $application->configuration->setValue('blame', true);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $fileParser = new FileParser(
            $parser,
            $this->getCompiler()
        );

        $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;
                }

                $fileParser->parserFile($file->getPathname(), $context);
            }
        } elseif (is_file($path)) {
            $fileParser->parserFile($path, $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 $configFile
     * @param string $configurationDirectory
     *
     * @return Configuration
     */
    protected function loadConfiguration($configFile, $configurationDirectory)

    {
        $loader = new ConfigurationLoader(new FileLocator([
            getcwd(),
            $configurationDirectory
        ]));

        return new Configuration(
            $loader->load($configFile),
            Analyzer\Factory::getPassesConfigurations()
        );
    }
}


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA\Command;
7
8		use PhpParser\ParserFactory;
9		use PHPSA\Analyzer;
10		use PHPSA\Application;
11		use PHPSA\Compiler;
12		use PHPSA\Configuration;
13		use PHPSA\ConfigurationLoader;
14		use PHPSA\Context;
15		use PHPSA\Definition\FileParser;
16		use RecursiveDirectoryIterator;
17		use RecursiveIteratorIterator;
18		use SplFileInfo;
19		use FilesystemIterator;
20		use Symfony\Component\Config\FileLocator;
21		use Symfony\Component\Console\Command\Command;
22		use Symfony\Component\Console\Input\InputArgument;
23		use Symfony\Component\Console\Input\InputInterface;
24		use Symfony\Component\Console\Input\InputOption;
25		use Symfony\Component\Console\Output\OutputInterface;
26		use Webiny\Component\EventManager\EventManager;
27		use PHPSA\Analyzer\Pass as AnalyzerPass;
28
29		/**
30		* Class CheckCommand
31		* @package PHPSA\Command
32		*
33		* @method Application getApplication();
34		*/
35		class CheckCommand extends Command
36		{
37
38		/**
39		* Configures the command.
40		*/
41	866	protected function configure()
42		{
43	866	$this
44	866	->setName('check')
45	866	->setDescription('SPA')
46	866	->addOption('blame', null, InputOption::VALUE_NONE, 'Git blame author for bad code ;)')
47	866	->addOption('config-file', null, InputOption::VALUE_REQUIRED, 'Path to the configuration file.')
48	866	->addArgument('path', InputArgument::OPTIONAL, 'Path to check file or directory', '.')
49	866	->addOption(
50	866	'report-json',
51	866	null,
52	866	InputOption::VALUE_REQUIRED,
53		'Path to save detailed report in JSON format. Example: /tmp/report.json'
54	866	);
55	866	}
56
57		/**
58		* Executes the command.
59		*
60		* @param InputInterface $input
61		* @param OutputInterface $output
62		*/
63		protected function execute(InputInterface $input, OutputInterface $output)
		0 ignored issues – show Complexity introduced 2016-05-24 01:41 UTC by Report Bug Copy Issue Report This operation has 1200 execution paths which exceeds the configured maximum of 200. A high number of execution paths generally suggests many nested conditional statements and make the code less readible. This can usually be fixed by splitting the method into several smaller methods. You can also find more information in the “Code” section of your repository. Loading history...
64		{
65		$output->writeln('');
66
67		if (extension_loaded('xdebug')) {
68		/**
69		* This will disable only showing stack traces on error conditions.
70		*/
71		if (function_exists('xdebug_disable')) {
72		xdebug_disable();
73		}
74
75		$output->writeln('<error>It is highly recommended to disable the XDebug extension before invoking this command.</error>');
76		}
77
78		$parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7, new \PhpParser\Lexer\Emulative([
79		'usedAttributes' => [
80		'comments',
81		'startLine',
82		'endLine',
83		'startTokenPos',
84		'endTokenPos'
85		]
86		]));
87
88		/** @var Application $application */
89		$application = $this->getApplication();
90		$application->compiler = new Compiler();
91
92		$configFile = $input->getOption('config-file') ?: '.phpsa.yml';
93		$configDir = realpath($input->getArgument('path'));
94		$application->configuration = $this->loadConfiguration($configFile, $configDir);
95
96		$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...
97		Analyzer\Factory::factory($em, $application->configuration);
98		$context = new Context($output, $application, $em);
99
100		/**
101		* Store option's in application's configuration
102		*/
103		if ($input->getOption('blame')) {
104		$application->configuration->setValue('blame', true);
		0 ignored issues – show Documentation introduced 2016-09-26 18:56 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `string`. 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...
105		}
106
107		$fileParser = new FileParser(
108		$parser,
109		$this->getCompiler()
110		);
111
112		$path = $input->getArgument('path');
113		if (is_dir($path)) {
114		$directoryIterator = new RecursiveIteratorIterator(
115		new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS)
116		);
117		$output->writeln('Scanning directory <info>' . $path . '</info>');
118
119		$count = 0;
120
121		/** @var SplFileInfo $file */
122		foreach ($directoryIterator as $file) {
123		if ($file->getExtension() !== 'php') {
124		continue;
125		}
126
127		$context->debug($file->getPathname());
128		$count++;
129		}
130
131		$output->writeln("Found <info>{$count} files</info>");
132
133		if ($count > 100) {
134		$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>');
135		}
136
137		$output->writeln('');
138
139		/** @var SplFileInfo $file */
140		foreach ($directoryIterator as $file) {
141		if ($file->getExtension() !== 'php') {
142		continue;
143		}
144
145		$fileParser->parserFile($file->getPathname(), $context);
146		}
147		} elseif (is_file($path)) {
148		$fileParser->parserFile($path, $context);
149		}
150
151
152		/**
153		* Step 2 Recursive check ...
154		*/
155		$application->compiler->compile($context);
156
157		$jsonReport = $input->getOption('report-json');
158		if ($jsonReport) {
159		file_put_contents(
160		$jsonReport,
161		json_encode(
162		$this->getApplication()->getIssuesCollector()->getIssues()
163		)
164		);
165		}
166
167		$output->writeln('');
168		$output->writeln('Memory usage: ' . $this->getMemoryUsage(false) . ' (peak: ' . $this->getMemoryUsage(true) . ') MB');
169		}
170
171		/**
172		* @param boolean $type
173		* @return float
174		*/
175		protected function getMemoryUsage($type)
176		{
177		return round(memory_get_usage($type) / 1024 / 1024, 2);
178		}
179
180		/**
181		* @return Compiler
182		*/
183		protected function getCompiler()
184		{
185		return $this->getApplication()->compiler;
186		}
187
188		/**
189		* @param string $configFile
190		* @param string $configurationDirectory
191		*
192		* @return Configuration
193		*/
194		protected function loadConfiguration($configFile, $configurationDirectory)
		0 ignored issues – show Comprehensibility Naming introduced 2016-09-26 18:56 UTC by Report Bug Copy Issue Report The variable name `$configurationDirectory` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
195		{
196		$loader = new ConfigurationLoader(new FileLocator([
197		getcwd(),
198		$configurationDirectory
199		]));
200
201		return new Configuration(
202		$loader->load($configFile),
203		Analyzer\Factory::getPassesConfigurations()
204		);
205		}
206		}
207

ovr / phpsa

Pull Request — master (#139)

CheckCommand::execute() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like