MaintainabilityIndexVisitor - Code Metrics - Inspection of "forced version of phar" - phpmetrics/PhpMetrics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bdaaad...4f4372 )

by personal

created 2017-01-30 05:16 UTC

MaintainabilityIndexVisitor A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	76
Duplicated Lines	7.89 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	6
loc	76
rs	10
c	0
b	0
f	0
wmc	11
lcom	1
cbo	3

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
C	leaveNode()	6	55	10

How to fix Duplicated Code

<?php
namespace Hal\Metric\Class_\Component;

use Hal\Metric\FunctionMetric;
use Hal\Metric\Metrics;
use Hoa\Ruler\Model\Bag\Scalar;
use PhpParser\Node;
use PhpParser\Node\Stmt;
use PhpParser\NodeVisitorAbstract;

/**
 * Calculates Maintainability Index
 *
 *      According to Wikipedia, "Maintainability Index is a software metric which measures how maintainable (easy to
 *      support and change) the source code is. The maintainability index is calculated as a factored formula consisting
 *      of Lines Of Code, Cyclomatic Complexity and Halstead volume."
 *
 *      MIwoc: Maintainability Index without comments
 *      MIcw: Maintainability Index comment weight
 *      MI: Maintainability Index = MIwoc + MIcw
 *
 *      MIwoc = 171 - 5.2 * ln(aveV) -0.23 * aveG -16.2 * ln(aveLOC)
 *      MIcw = 50 * sin(sqrt(2.4 * perCM))
 *      MI = MIwoc + MIcw
 *
 * @author Jean-François Lépine <https://twitter.com/Halleck45>
 */
class MaintainabilityIndexVisitor extends NodeVisitorAbstract
{

    /**
     * @var Metrics
     */
    private $metrics;

    /**
     * ClassEnumVisitor constructor.
     * @param Metrics $metrics
     */
    public function __construct(Metrics $metrics)
    {
        $this->metrics = $metrics;
    }

    /**
     * @inheritdoc
     */
    public function leaveNode(Node $node)
    {
        if ($node instanceof Stmt\Class_) {

            if ($node instanceof Stmt\Class_) {

                $classOrFunction = $this->metrics->get($node->namespacedName->toString());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            } else {
                $classOrFunction = new FunctionMetric($node->name);
                $this->metrics->attach($classOrFunction);
            }
            if (null === $lloc = $classOrFunction->get('lloc')) {
                throw new \LogicException('please enable length (lloc) visitor first');
            }
            if (null === $cloc = $classOrFunction->get('cloc')) {
                throw new \LogicException('please enable length (cloc) visitor first');
            }
            if (null === $loc = $classOrFunction->get('loc')) {
                throw new \LogicException('please enable length (loc) visitor first');
            }
            if (null === $ccn = $classOrFunction->get('ccn')) {
                throw new \LogicException('please enable McCabe visitor first');
            }
            if (null === $volume = $classOrFunction->get('volume')) {
                throw new \LogicException('please enable Halstead visitor first');
            }

            // maintainability index without comment
            $MIwoC = max(
                (171
                    - (5.2 * \log($volume))
                    - (0.23 * $ccn)
                    - (16.2 * \log($lloc))
                ) * 100 / 171
                , 0);
            if (is_infinite($MIwoC)) {
                $MIwoC = 171;
            }

            // comment weight
            if ($loc > 0) {
                $CM = $cloc / $loc;
                $commentWeight = 50 * sin(sqrt(2.4 * $CM));
            }

            // maintainability index
            $mi = $MIwoC + $commentWeight;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

            // save result
            $classOrFunction
                ->set('mi', round($mi, 2))
                ->set('mIwoC', round($MIwoC, 2))
                ->set('commentWeight', round($commentWeight, 2));
            $this->metrics->attach($classOrFunction);
        }
    }
}


1		<?php
2		namespace Hal\Metric\Class_\Component;
3
4		use Hal\Metric\FunctionMetric;
5		use Hal\Metric\Metrics;
6		use Hoa\Ruler\Model\Bag\Scalar;
7		use PhpParser\Node;
8		use PhpParser\Node\Stmt;
9		use PhpParser\NodeVisitorAbstract;
10
11		/**
12		* Calculates Maintainability Index
13		*
14		* According to Wikipedia, "Maintainability Index is a software metric which measures how maintainable (easy to
15		* support and change) the source code is. The maintainability index is calculated as a factored formula consisting
16		* of Lines Of Code, Cyclomatic Complexity and Halstead volume."
17		*
18		* MIwoc: Maintainability Index without comments
19		* MIcw: Maintainability Index comment weight
20		* MI: Maintainability Index = MIwoc + MIcw
21		*
22		* MIwoc = 171 - 5.2 * ln(aveV) -0.23 * aveG -16.2 * ln(aveLOC)
23		* MIcw = 50 * sin(sqrt(2.4 * perCM))
24		* MI = MIwoc + MIcw
25		*
26		* @author Jean-François Lépine <https://twitter.com/Halleck45>
27		*/
28		class MaintainabilityIndexVisitor extends NodeVisitorAbstract
29		{
30
31		/**
32		* @var Metrics
33		*/
34		private $metrics;
35
36		/**
37		* ClassEnumVisitor constructor.
38		* @param Metrics $metrics
39		*/
40		public function __construct(Metrics $metrics)
41		{
42		$this->metrics = $metrics;
43		}
44
45		/**
46		* @inheritdoc
47		*/
48		public function leaveNode(Node $node)
49		{
50		if ($node instanceof Stmt\Class_) {
51
52	View Code Duplication	if ($node instanceof Stmt\Class_) {
		0 ignored issues – show Duplication introduced 2017-01-30 05:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
53		$classOrFunction = $this->metrics->get($node->namespacedName->toString());
		0 ignored issues – show Bug introduced 2017-01-30 05:20 UTC by Report Bug Copy Issue Report The property `namespacedName` does not seem to exist in `PhpParser\Node\Stmt\Class_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Bug introduced 2017-01-30 05:20 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$classOrFunction` is correct as `$this->metrics->get($nod...spacedName->toString())` (which targets `Hal\Metric\Metrics::get()`) 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...
54		} else {
55		$classOrFunction = new FunctionMetric($node->name);
56		$this->metrics->attach($classOrFunction);
57		}
58		if (null === $lloc = $classOrFunction->get('lloc')) {
59		throw new \LogicException('please enable length (lloc) visitor first');
60		}
61		if (null === $cloc = $classOrFunction->get('cloc')) {
62		throw new \LogicException('please enable length (cloc) visitor first');
63		}
64		if (null === $loc = $classOrFunction->get('loc')) {
65		throw new \LogicException('please enable length (loc) visitor first');
66		}
67		if (null === $ccn = $classOrFunction->get('ccn')) {
68		throw new \LogicException('please enable McCabe visitor first');
69		}
70		if (null === $volume = $classOrFunction->get('volume')) {
71		throw new \LogicException('please enable Halstead visitor first');
72		}
73
74		// maintainability index without comment
75		$MIwoC = max(
76		(171
77		- (5.2 * \log($volume))
78		- (0.23 * $ccn)
79		- (16.2 * \log($lloc))
80		) * 100 / 171
81		, 0);
82		if (is_infinite($MIwoC)) {
83		$MIwoC = 171;
84		}
85
86		// comment weight
87		if ($loc > 0) {
88		$CM = $cloc / $loc;
89		$commentWeight = 50 * sin(sqrt(2.4 * $CM));
90		}
91
92		// maintainability index
93		$mi = $MIwoC + $commentWeight;
		0 ignored issues – show Bug introduced 2017-01-30 05:20 UTC by Report Bug Copy Issue Report The variable `$commentWeight` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
94
95		// save result
96		$classOrFunction
97		->set('mi', round($mi, 2))
98		->set('mIwoC', round($MIwoC, 2))
99		->set('commentWeight', round($commentWeight, 2));
100		$this->metrics->attach($classOrFunction);
101		}
102		}
103		}
104

phpmetrics / PhpMetrics

Push — master ( bdaaad...4f4372 )

MaintainabilityIndexVisitor A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like