Analyze::run() - Code Metrics - Inspection of "Merge pull request #283 from UFOMelkor/feature/pac..." - phpmetrics/PhpMetrics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e1173d...cdf0e4 )

by Oskar

created 2018-05-08 08:37 UTC

Analyze::run() B

↳ Parent: Analyze

Complexity

Conditions	3
Paths	5

Size

Total Lines	80
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	47
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	80
rs	8.8387

How to fix Long Method

<?php
namespace Hal\Application;

use Hal\Application\Config\Config;
use Hal\Component\Ast\NodeTraverser;
use Hal\Component\Issue\Issuer;
use Hal\Component\Output\Output;
use Hal\Component\Output\ProgressBar;
use Hal\Metric\Class_\ClassEnumVisitor;
use Hal\Metric\Class_\Complexity\CyclomaticComplexityVisitor;
use Hal\Metric\Class_\Complexity\KanDefectVisitor;
use Hal\Metric\Class_\Component\MaintainabilityIndexVisitor;
use Hal\Metric\Class_\Coupling\ExternalsVisitor;
use Hal\Metric\Class_\Structural\LcomVisitor;
use Hal\Metric\Class_\Structural\SystemComplexityVisitor;
use Hal\Metric\Class_\Text\HalsteadVisitor;
use Hal\Metric\Class_\Text\LengthVisitor;
use Hal\Metric\Metrics;
use Hal\Metric\Package\PackageAbstraction;
use Hal\Metric\Package\PackageCollectingVisitor;
use Hal\Metric\Package\PackageDependencies;
use Hal\Metric\Package\PackageDistance;
use Hal\Metric\Package\PackageInstability;
use Hal\Metric\System\Changes\GitChanges;
use Hal\Metric\System\Coupling\Coupling;
use Hal\Metric\System\Coupling\DepthOfInheritanceTree;
use Hal\Metric\System\Coupling\PageRank;
use Hal\Metric\System\Packages\Composer\Composer;
use Hal\Metric\System\UnitTesting\UnitTesting;
use PhpParser\Error;
use PhpParser\ParserFactory;


/**
 * Class Analyze
 * @package Hal\Application
 */
class Analyze
{

    /**
     * @var Output
     */
    private $output;

    /**
     * @var Config
     */
    private $config;

    /**
     * @var Issuer
     */
    private $issuer;

    /**
     * Analyze constructor.
     * @param Output $output
     */
    public function __construct(Config $config, Output $output, Issuer $issuer)
    {
        $this->output = $output;
        $this->config = $config;
        $this->issuer = $issuer;
    }

    /**
     * Runs analyze
     */
    public function run($files)
    {
        // config
        ini_set('xdebug.max_nesting_level', 3000);

        $metrics = new Metrics();

        // traverse all
        $whenToStop = function() {
            return true;
        };

        // prepare parser
        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
        $traverser = new NodeTraverser(false, $whenToStop);
        $traverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver());
        $traverser->addVisitor(new ClassEnumVisitor($metrics));
        $traverser->addVisitor(new CyclomaticComplexityVisitor($metrics));
        $traverser->addVisitor(new ExternalsVisitor($metrics));
        $traverser->addVisitor(new LcomVisitor($metrics));
        $traverser->addVisitor(new HalsteadVisitor($metrics));
        $traverser->addVisitor(new LengthVisitor($metrics));
        $traverser->addVisitor(new CyclomaticComplexityVisitor($metrics));
        $traverser->addVisitor(new MaintainabilityIndexVisitor($metrics));
        $traverser->addVisitor(new KanDefectVisitor($metrics));
        $traverser->addVisitor(new SystemComplexityVisitor($metrics));
        $traverser->addVisitor(new PackageCollectingVisitor($metrics));

        // create a new progress bar (50 units)
        $progress = new ProgressBar($this->output, sizeof($files));
        $progress->start();

        foreach ($files as $file) {
            $progress->advance();
            $code = file_get_contents($file);
            $this->issuer->set('filename', $file);
            try {
                $stmts = $parser->parse($code);
                $this->issuer->set('statements', $stmts);
                $traverser->traverse($stmts);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            } catch (Error $e) {
                $this->output->writeln(sprintf('<error>Cannot parse %s</error>', $file));
            }
            $this->issuer->clear('filename');
            $this->issuer->clear('statements');
        }

        $progress->clear();

        $this->output->write('Executing system analyzes...');

        //
        // System analyses
        (new PageRank())->calculate($metrics);
        (new Coupling())->calculate($metrics);
        (new DepthOfInheritanceTree())->calculate($metrics);

        //
        // Package analyses
        (new PackageDependencies())->calculate($metrics);
        (new PackageAbstraction())->calculate($metrics);
        (new PackageInstability())->calculate($metrics);
        (new PackageDistance())->calculate($metrics);

        //
        // File analyses
        (new GitChanges($this->config, $files))->calculate($metrics);

        //
        // Unit test
        (new UnitTesting($this->config, $files))->calculate($metrics);

        //
        // Composer
        (new Composer($this->config, $files))->calculate($metrics);

        $this->output->clearln();

        return $metrics;
    }
}


1			<?php
2			namespace Hal\Application;
3
4			use Hal\Application\Config\Config;
5			use Hal\Component\Ast\NodeTraverser;
6			use Hal\Component\Issue\Issuer;
7			use Hal\Component\Output\Output;
8			use Hal\Component\Output\ProgressBar;
9			use Hal\Metric\Class_\ClassEnumVisitor;
10			use Hal\Metric\Class_\Complexity\CyclomaticComplexityVisitor;
11			use Hal\Metric\Class_\Complexity\KanDefectVisitor;
12			use Hal\Metric\Class_\Component\MaintainabilityIndexVisitor;
13			use Hal\Metric\Class_\Coupling\ExternalsVisitor;
14			use Hal\Metric\Class_\Structural\LcomVisitor;
15			use Hal\Metric\Class_\Structural\SystemComplexityVisitor;
16			use Hal\Metric\Class_\Text\HalsteadVisitor;
17			use Hal\Metric\Class_\Text\LengthVisitor;
18			use Hal\Metric\Metrics;
19			use Hal\Metric\Package\PackageAbstraction;
20			use Hal\Metric\Package\PackageCollectingVisitor;
21			use Hal\Metric\Package\PackageDependencies;
22			use Hal\Metric\Package\PackageDistance;
23			use Hal\Metric\Package\PackageInstability;
24			use Hal\Metric\System\Changes\GitChanges;
25			use Hal\Metric\System\Coupling\Coupling;
26			use Hal\Metric\System\Coupling\DepthOfInheritanceTree;
27			use Hal\Metric\System\Coupling\PageRank;
28			use Hal\Metric\System\Packages\Composer\Composer;
29			use Hal\Metric\System\UnitTesting\UnitTesting;
30			use PhpParser\Error;
31			use PhpParser\ParserFactory;
32
33
34			/**
35			* Class Analyze
36			* @package Hal\Application
37			*/
38			class Analyze
39			{
40
41			/**
42			* @var Output
43			*/
44			private $output;
45
46			/**
47			* @var Config
48			*/
49			private $config;
50
51			/**
52			* @var Issuer
53			*/
54			private $issuer;
55
56			/**
57			* Analyze constructor.
58			* @param Output $output
59			*/
60			public function __construct(Config $config, Output $output, Issuer $issuer)
61			{
62			$this->output = $output;
63			$this->config = $config;
64			$this->issuer = $issuer;
65			}
66
67			/**
68			* Runs analyze
69			*/
70			public function run($files)
71			{
72			// config
73			ini_set('xdebug.max_nesting_level', 3000);
74
75			$metrics = new Metrics();
76
77			// traverse all
78			$whenToStop = function() {
79			return true;
80			};
81
82			// prepare parser
83			$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
84			$traverser = new NodeTraverser(false, $whenToStop);
85			$traverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver());
86			$traverser->addVisitor(new ClassEnumVisitor($metrics));
87			$traverser->addVisitor(new CyclomaticComplexityVisitor($metrics));
88			$traverser->addVisitor(new ExternalsVisitor($metrics));
89			$traverser->addVisitor(new LcomVisitor($metrics));
90			$traverser->addVisitor(new HalsteadVisitor($metrics));
91			$traverser->addVisitor(new LengthVisitor($metrics));
92			$traverser->addVisitor(new CyclomaticComplexityVisitor($metrics));
93			$traverser->addVisitor(new MaintainabilityIndexVisitor($metrics));
94			$traverser->addVisitor(new KanDefectVisitor($metrics));
95			$traverser->addVisitor(new SystemComplexityVisitor($metrics));
96			$traverser->addVisitor(new PackageCollectingVisitor($metrics));
97
98			// create a new progress bar (50 units)
99			$progress = new ProgressBar($this->output, sizeof($files));
100			$progress->start();
101
102			foreach ($files as $file) {
103			$progress->advance();
104			$code = file_get_contents($file);
105			$this->issuer->set('filename', $file);
106			try {
107			$stmts = $parser->parse($code);
108			$this->issuer->set('statements', $stmts);
109			$traverser->traverse($stmts);
			0 ignored issues – show Bug introduced 2017-01-30 05:20 UTC by Report Bug Copy Issue Report It seems like `$stmts` defined by `$parser->parse($code)` on line `107` 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...
110			} catch (Error $e) {
111			$this->output->writeln(sprintf('<error>Cannot parse %s</error>', $file));
112			}
113			$this->issuer->clear('filename');
114			$this->issuer->clear('statements');
115			}
116
117			$progress->clear();
118
119			$this->output->write('Executing system analyzes...');
120
121			//
122			// System analyses
123			(new PageRank())->calculate($metrics);
124			(new Coupling())->calculate($metrics);
125			(new DepthOfInheritanceTree())->calculate($metrics);
126
127			//
128			// Package analyses
129			(new PackageDependencies())->calculate($metrics);
130			(new PackageAbstraction())->calculate($metrics);
131			(new PackageInstability())->calculate($metrics);
132			(new PackageDistance())->calculate($metrics);
133
134			//
135			// File analyses
136			(new GitChanges($this->config, $files))->calculate($metrics);
137
138			//
139			// Unit test
140			(new UnitTesting($this->config, $files))->calculate($metrics);
141
142			//
143			// Composer
144			(new Composer($this->config, $files))->calculate($metrics);
145
146			$this->output->clearln();
147
148			return $metrics;
149			}
150			}
151

phpmetrics / PhpMetrics

Push — master ( e1173d...cdf0e4 )

Analyze::run() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like