HalsteadVisitor::__construct() - Code Metrics - Inspection of "Apply PSR-2 codestyle" - phpmetrics/PhpMetrics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#389)

unknown

created 2019-12-02 19:25 UTC

HalsteadVisitor::__construct() A

↳ Parent: HalsteadVisitor

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Hal\Metric\Class_\Text;

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 Halstead complexity
 *
 *      According Wikipedia, "Halstead complexity measures are software metrics introduced by Maurice Howard Halstead in
 *      1977 as part of his treatise on establishing an empirical science of software development.
 *      Halstead makes the observation that metrics of the software should reflect the implementation or
 *      expression of algorithms in different languages, but be independent of their execution on a specific platform.
 *      These metrics are therefore computed statically from the code."
 *
 * @author Jean-François Lépine <https://twitter.com/Halleck45>
 * Class HalsteadVisitor
 * @package Hal\Metric\Class_\Coupling
 */
class HalsteadVisitor 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_ || $node instanceof Stmt\Function_ || $node instanceof Stmt\Trait_) {
            if ($node instanceof Stmt\Class_ || $node instanceof Stmt\Trait_) {

                $name = (string) (isset($node->namespacedName) ? $node->namespacedName : 'anonymous@'.spl_object_hash($node));
                $classOrFunction = $this->metrics->get($name);
            } else {
                $classOrFunction = new FunctionMetric((string) $node->name);
                $this->metrics->attach($classOrFunction);
            }

            // search for operands and operators
            $operands = [];
            $operators = [];

            iterate_over_node($node, function ($node) use (&$operators, &$operands) {

                if ($node instanceof Node\Expr\BinaryOp
                    || $node instanceof Node\Expr\AssignOp
                    || $node instanceof Stmt\If_
                    || $node instanceof Stmt\For_
                    || $node instanceof Stmt\Switch_
                    || $node instanceof Stmt\Catch_
                    || $node instanceof Stmt\Return_
                    || $node instanceof Stmt\While_
                    || $node instanceof Node\Expr\Assign
                ) {
                    // operators
                    array_push($operators, get_class($node));
                }

                // nicik/php-parser:^4
                if ($node instanceof Node\Param
                    && isset($node->var)
                    && $node->var instanceof Node\Expr\Variable
                ) {
                    return;
                }

                if ($node instanceof Node\Expr\Cast
                    || $node instanceof Node\Expr\Variable
                    || $node instanceof Node\Param
                    || $node instanceof Node\Scalar
                ) {
                    // operands
                    if (isset($node->value)) {
                        $name = $node->value;
                    } elseif (isset($node->name)) {
                        $name = $node->name;
                    } else {
                        $name = get_class($node);
                    }
                    array_push($operands, $name);
                }
            });

            // calculate halstead metrics
            $uniqueOperators = array_map('unserialize', array_unique(array_map('serialize', $operators)));
            $uniqueOperands = array_map('unserialize', array_unique(array_map('serialize', $operands)));

            $n1 = count($uniqueOperators, COUNT_NORMAL);
            $n2 = count($uniqueOperands, COUNT_NORMAL);
            $N1 = count($operators, COUNT_NORMAL);
            $N2 = count($operands, COUNT_NORMAL);

            if (($n2 == 0) || ($N2 == 0)) {
                // files without operators
                $V = $n1 = $n2 = $N1 = $N2 = $E = $D = $B = $T = $I = $L = 0;
            } else {
                $devAbility = 3000;
                $N = $N1 + $N2;
                $n = $n1 + $n2;
                $V = $N * log($n, 2);
                $L = (2 / max(1, $n1)) * ($n2 / $N2);
                $D = ($n1 / 2) * ($N2 / $n2);
                $E = $V * $D;
                $B = $V / $devAbility;
                $T = $E / 18;
                $I = $L * $V;
            }

            // save result
            $classOrFunction
                ->set('length', $N1 + $N2)
                ->set('vocabulary', $n1 + $n2)
                ->set('volume', round($V, 2))
                ->set('difficulty', round($D, 2))
                ->set('effort', round($E, 2))
                ->set('level', round($L, 2))
                ->set('bugs', round($B, 2))
                ->set('time', round($T))
                ->set('intelligentContent', round($I, 2))
                ->set('number_operators', $N1)
                ->set('number_operands', $N2)
                ->set('number_operators_unique', $n1)
                ->set('number_operands_unique', $n2);
            $this->metrics->attach($classOrFunction);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }
    }
}


1		<?php
2
3		namespace Hal\Metric\Class_\Text;
4
5		use Hal\Metric\FunctionMetric;
6		use Hal\Metric\Metrics;
7		use Hoa\Ruler\Model\Bag\Scalar;
8		use PhpParser\Node;
9		use PhpParser\Node\Stmt;
10		use PhpParser\NodeVisitorAbstract;
11
12		/**
13		* Calculates Halstead complexity
14		*
15		* According Wikipedia, "Halstead complexity measures are software metrics introduced by Maurice Howard Halstead in
16		* 1977 as part of his treatise on establishing an empirical science of software development.
17		* Halstead makes the observation that metrics of the software should reflect the implementation or
18		* expression of algorithms in different languages, but be independent of their execution on a specific platform.
19		* These metrics are therefore computed statically from the code."
20		*
21		* @author Jean-François Lépine <https://twitter.com/Halleck45>
22		* Class HalsteadVisitor
23		* @package Hal\Metric\Class_\Coupling
24		*/
25		class HalsteadVisitor extends NodeVisitorAbstract
26		{
27
28		/**
29		* @var Metrics
30		*/
31		private $metrics;
32
33		/**
34		* ClassEnumVisitor constructor.
35		* @param Metrics $metrics
36		*/
37		public function __construct(Metrics $metrics)
38		{
39		$this->metrics = $metrics;
40		}
41
42		/**
43		* @inheritdoc
44		*/
45		public function leaveNode(Node $node)
46		{
47		if ($node instanceof Stmt\Class_ \|\| $node instanceof Stmt\Function_ \|\| $node instanceof Stmt\Trait_) {
48	View Code Duplication	if ($node instanceof Stmt\Class_ \|\| $node instanceof Stmt\Trait_) {
		0 ignored issues – show Duplication introduced 2017-09-19 15:41 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...
49		$name = (string) (isset($node->namespacedName) ? $node->namespacedName : 'anonymous@'.spl_object_hash($node));
50		$classOrFunction = $this->metrics->get($name);
51		} else {
52		$classOrFunction = new FunctionMetric((string) $node->name);
53		$this->metrics->attach($classOrFunction);
54		}
55
56		// search for operands and operators
57		$operands = [];
58		$operators = [];
59
60		iterate_over_node($node, function ($node) use (&$operators, &$operands) {
61
62		if ($node instanceof Node\Expr\BinaryOp
63		\|\| $node instanceof Node\Expr\AssignOp
64		\|\| $node instanceof Stmt\If_
65		\|\| $node instanceof Stmt\For_
66		\|\| $node instanceof Stmt\Switch_
67		\|\| $node instanceof Stmt\Catch_
68		\|\| $node instanceof Stmt\Return_
69		\|\| $node instanceof Stmt\While_
70		\|\| $node instanceof Node\Expr\Assign
71		) {
72		// operators
73		array_push($operators, get_class($node));
74		}
75
76		// nicik/php-parser:^4
77		if ($node instanceof Node\Param
78		&& isset($node->var)
79		&& $node->var instanceof Node\Expr\Variable
80		) {
81		return;
82		}
83
84		if ($node instanceof Node\Expr\Cast
85		\|\| $node instanceof Node\Expr\Variable
86		\|\| $node instanceof Node\Param
87		\|\| $node instanceof Node\Scalar
88		) {
89		// operands
90		if (isset($node->value)) {
91		$name = $node->value;
92		} elseif (isset($node->name)) {
93		$name = $node->name;
94		} else {
95		$name = get_class($node);
96		}
97		array_push($operands, $name);
98		}
99		});
100
101		// calculate halstead metrics
102		$uniqueOperators = array_map('unserialize', array_unique(array_map('serialize', $operators)));
103		$uniqueOperands = array_map('unserialize', array_unique(array_map('serialize', $operands)));
104
105		$n1 = count($uniqueOperators, COUNT_NORMAL);
106		$n2 = count($uniqueOperands, COUNT_NORMAL);
107		$N1 = count($operators, COUNT_NORMAL);
108		$N2 = count($operands, COUNT_NORMAL);
109
110		if (($n2 == 0) \|\| ($N2 == 0)) {
111		// files without operators
112		$V = $n1 = $n2 = $N1 = $N2 = $E = $D = $B = $T = $I = $L = 0;
113		} else {
114		$devAbility = 3000;
115		$N = $N1 + $N2;
116		$n = $n1 + $n2;
117		$V = $N * log($n, 2);
118		$L = (2 / max(1, $n1)) * ($n2 / $N2);
119		$D = ($n1 / 2) * ($N2 / $n2);
120		$E = $V * $D;
121		$B = $V / $devAbility;
122		$T = $E / 18;
123		$I = $L * $V;
124		}
125
126		// save result
127		$classOrFunction
128		->set('length', $N1 + $N2)
129		->set('vocabulary', $n1 + $n2)
130		->set('volume', round($V, 2))
131		->set('difficulty', round($D, 2))
132		->set('effort', round($E, 2))
133		->set('level', round($L, 2))
134		->set('bugs', round($B, 2))
135		->set('time', round($T))
136		->set('intelligentContent', round($I, 2))
137		->set('number_operators', $N1)
138		->set('number_operands', $N2)
139		->set('number_operators_unique', $n1)
140		->set('number_operands_unique', $n2);
141		$this->metrics->attach($classOrFunction);
		0 ignored issues – show Bug introduced 2017-09-20 10:15 UTC by Report Bug Copy Issue Report It seems like `$classOrFunction` defined by `$this->metrics->get($name)` on line `50` can be `null`; however, `Hal\Metric\Metrics::attach()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
142		}
143		}
144		}
145

phpmetrics / PhpMetrics

Pull Request — master (#389)

HalsteadVisitor::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like