Validator - Code Metrics - Inspection of "v. 1.6.0 released" - bartko-s/stefano-tree - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2e5d0e...583994 )

by Bartko

created 2016-06-01 15:21 UTC

Validator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

98.8%

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	26
c	1
b	0
f	1
lcom	1
cbo	2
dl	0
loc	185
ccs	82
cts	83
cp	0.988
rs	10

8 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	_getAdapter()	4	1
A	isValid()	16	1
A	_buildFlatTree()	13	2
A	_validateLevels()	20	3
B	_validateLeftIndexes()	28	5
C	_validateRightIndexes()	41	8
B	rebuild()	17	5

<?php
namespace StefanoTree\NestedSet\Validator;

use StefanoTree\NestedSet\Adapter\AdapterInterface;
use StefanoTree\NestedSet\NodeInfo;

class Validator
    implements ValidatorInterface

{
    private $rootId = null;

    private $isValid = true;

    private $tree = array();

    private $adapter = null;

    /**
     * @param AdapterInterface $adapter
     */
    public function __construct(AdapterInterface $adapter)
    {
        $this->adapter = $adapter;
    }

    /**
     * @return AdapterInterface
     */
    private function _getAdapter()
    {
        return $this->adapter;
    }

    /**
     * @param NodeInfo $nodeInfo
     * @param array $_tree
     * @return array
     */
    private function _buildFlatTree(NodeInfo $nodeInfo, $_tree = array())
    {
        $children = $this->_getAdapter()
                         ->getChildrenNodeInfo($nodeInfo->getId());

        $_tree[] = $nodeInfo;

        foreach ($children as $child) {
            $_tree = $this->_buildFlatTree($child, $_tree);
        }

        return $_tree;
    }

    /**
     * @param array $tree
     * @return array
     */
    private function _validateLevels(array $tree)
    {
        $nodeIdVsLevel = array(0 => -1);

        foreach ($tree as &$nodeInfo) {
            $nodeIdVsLevel[$nodeInfo->getId()] = $nodeIdVsLevel[$nodeInfo->getParentId()] + 1;

            $currentLevel = $nodeInfo->getLevel();
            $expectedLevel = $nodeIdVsLevel[$nodeInfo->getParentId()] + 1;

            if ($currentLevel != $expectedLevel) {
                $nodeInfo->setLevel($expectedLevel);
                $nodeInfo->setNeedUpdate(true);

                $this->isValid = false;
            }
        }

        return $tree;
    }

    /**
     * @param array $tree
     * @return array
     */
    private function _validateLeftIndexes(array $tree)
    {
        $expectedLeftIdx = -1;
        $prevLevel = 0;

        foreach ($tree as &$nodeInfo) {
            $currentLeftIdx = $nodeInfo->getLeft();

            if ($nodeInfo->getLevel() == $prevLevel) {
                $expectedLeftIdx += 2;
            } elseif ($nodeInfo->getLevel() > $prevLevel) {
                $expectedLeftIdx += 1;
            } else {
                $expectedLeftIdx += $prevLevel - $nodeInfo->getLevel() + 2;
            }

            if ($currentLeftIdx != $expectedLeftIdx) {
                $nodeInfo->setLeft($expectedLeftIdx);
                $nodeInfo->setNeedUpdate(true);

                $this->isValid = false;
            }

            $prevLevel = $nodeInfo->getLevel();
        }

        return $tree;
    }

    /**
     * @param array $tree
     * @return array
     */
    private function _validateRightIndexes(array $tree)
    {
        $prevLevel = -1;
        $endNodes = array();

        for ($x = count($tree); $x > 0; $x--) {
            $nodeInfo = $tree[$x - 1];
            if (-1 == $prevLevel || $prevLevel == $nodeInfo->getLevel()) {
                $expectedRightIdx = $nodeInfo->getLeft() + 1;
            } elseif ($prevLevel > $nodeInfo->getLevel()) {
                $currentLevel = $nodeInfo->getLevel();

                if (array_key_exists($currentLevel + 1, $endNodes)) {
                    $expectedRightIdx = $endNodes[$currentLevel + 1] + 1;
                    unset($endNodes[$currentLevel + 1]);
                } else {
                    $expectedRightIdx = $tree[$x]->getRight() + 1;
                }
            } else {
                $expectedRightIdx = $nodeInfo->getLeft() + 1;
            }

            $currentRightIdx = $nodeInfo->getRight();

            if ($currentRightIdx != $expectedRightIdx) {
                $nodeInfo->setRight($expectedRightIdx);
                $nodeInfo->setNeedUpdate(true);
                $tree[$x - 1] = $nodeInfo;

                $this->isValid = false;
            }

            if (!array_key_exists($nodeInfo->getLevel(), $endNodes)) {
                $endNodes[$nodeInfo->getLevel()] = $nodeInfo->getRight();
            }

            $prevLevel = $nodeInfo->getLevel();
        }

        return $tree;
    }

    public function isValid($rootNodeId)
    {
        $this->isValid = True;
        $this->rootId = $rootNodeId;

        $rootNodeInfo = $this->_getAdapter()->getNodeInfo($rootNodeId);
        $tree = $this->_buildFlatTree($rootNodeInfo);
/** @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);
    }
}

        $tree = $this->_validateLevels($tree);
        $tree = $this->_validateLeftIndexes($tree);
        $tree = $this->_validateRightIndexes($tree);

        $this->tree = $tree;

        return $this->isValid;
    }

    public function rebuild($rootNodeId)
    {
        if ($this->rootId != $rootNodeId) {
            $this->isValid($rootNodeId);
        }

        if ($this->isValid) {
            return;
        }

        foreach ($this->tree as $nodeInfo) {
            if ($nodeInfo->needUpdate()) {
                $this->_getAdapter()
                     ->updateNodeMetadata($nodeInfo);
            }
        }
    }
}


1		<?php
2		namespace StefanoTree\NestedSet\Validator;
3
4		use StefanoTree\NestedSet\Adapter\AdapterInterface;
5		use StefanoTree\NestedSet\NodeInfo;
6
7		class Validator
8		implements ValidatorInterface
		0 ignored issues – show Coding Style introduced 2016-06-01 10:09 UTC by Report Bug Copy Issue Report The implements keyword must be on the same line as the class name Loading history...
9		{
10		private $rootId = null;
11
12		private $isValid = true;
13
14		private $tree = array();
15
16		private $adapter = null;
17
18		/**
19		* @param AdapterInterface $adapter
20		*/
21	9	public function __construct(AdapterInterface $adapter)
22		{
23	9	$this->adapter = $adapter;
24	9	}
25
26		/**
27		* @return AdapterInterface
28		*/
29	9	private function _getAdapter()
30		{
31	9	return $this->adapter;
32		}
33
34		/**
35		* @param NodeInfo $nodeInfo
36		* @param array $_tree
37		* @return array
38		*/
39	9	private function _buildFlatTree(NodeInfo $nodeInfo, $_tree = array())
40		{
41	9	$children = $this->_getAdapter()
42	9	->getChildrenNodeInfo($nodeInfo->getId());
43
44	9	$_tree[] = $nodeInfo;
45
46	9	foreach ($children as $child) {
47	9	$_tree = $this->_buildFlatTree($child, $_tree);
48		}
49
50	9	return $_tree;
51		}
52
53		/**
54		* @param array $tree
55		* @return array
56		*/
57	9	private function _validateLevels(array $tree)
58		{
59	9	$nodeIdVsLevel = array(0 => -1);
60
61	9	foreach ($tree as &$nodeInfo) {
62	9	$nodeIdVsLevel[$nodeInfo->getId()] = $nodeIdVsLevel[$nodeInfo->getParentId()] + 1;
63
64	9	$currentLevel = $nodeInfo->getLevel();
65	9	$expectedLevel = $nodeIdVsLevel[$nodeInfo->getParentId()] + 1;
66
67	9	if ($currentLevel != $expectedLevel) {
68	6	$nodeInfo->setLevel($expectedLevel);
69	6	$nodeInfo->setNeedUpdate(true);
70
71	9	$this->isValid = false;
72		}
73		}
74
75	9	return $tree;
76		}
77
78		/**
79		* @param array $tree
80		* @return array
81		*/
82	9	private function _validateLeftIndexes(array $tree)
83		{
84	9	$expectedLeftIdx = -1;
85	9	$prevLevel = 0;
86
87	9	foreach ($tree as &$nodeInfo) {
88	9	$currentLeftIdx = $nodeInfo->getLeft();
89
90	9	if ($nodeInfo->getLevel() == $prevLevel) {
91	9	$expectedLeftIdx += 2;
92	9	} elseif ($nodeInfo->getLevel() > $prevLevel) {
93	9	$expectedLeftIdx += 1;
94		} else {
95	6	$expectedLeftIdx += $prevLevel - $nodeInfo->getLevel() + 2;
96		}
97
98	9	if ($currentLeftIdx != $expectedLeftIdx) {
99	6	$nodeInfo->setLeft($expectedLeftIdx);
100	6	$nodeInfo->setNeedUpdate(true);
101
102	6	$this->isValid = false;
103		}
104
105	9	$prevLevel = $nodeInfo->getLevel();
106		}
107
108	9	return $tree;
109		}
110
111		/**
112		* @param array $tree
113		* @return array
114		*/
115	9	private function _validateRightIndexes(array $tree)
116		{
117	9	$prevLevel = -1;
118	9	$endNodes = array();
119
120	9	for ($x = count($tree); $x > 0; $x--) {
121	9	$nodeInfo = $tree[$x - 1];
122	9	if (-1 == $prevLevel \|\| $prevLevel == $nodeInfo->getLevel()) {
123	9	$expectedRightIdx = $nodeInfo->getLeft() + 1;
124	9	} elseif ($prevLevel > $nodeInfo->getLevel()) {
125	9	$currentLevel = $nodeInfo->getLevel();
126
127	9	if (array_key_exists($currentLevel + 1, $endNodes)) {
128	9	$expectedRightIdx = $endNodes[$currentLevel + 1] + 1;
129	9	unset($endNodes[$currentLevel + 1]);
130		} else {
131	9	$expectedRightIdx = $tree[$x]->getRight() + 1;
132		}
133		} else {
134	6	$expectedRightIdx = $nodeInfo->getLeft() + 1;
135		}
136
137	9	$currentRightIdx = $nodeInfo->getRight();
138
139	9	if ($currentRightIdx != $expectedRightIdx) {
140	6	$nodeInfo->setRight($expectedRightIdx);
141	6	$nodeInfo->setNeedUpdate(true);
142	6	$tree[$x - 1] = $nodeInfo;
143
144	6	$this->isValid = false;
145		}
146
147	9	if (!array_key_exists($nodeInfo->getLevel(), $endNodes)) {
148	9	$endNodes[$nodeInfo->getLevel()] = $nodeInfo->getRight();
149		}
150
151	9	$prevLevel = $nodeInfo->getLevel();
152		}
153
154	9	return $tree;
155		}
156
157	9	public function isValid($rootNodeId)
158		{
159	9	$this->isValid = True;
160	9	$this->rootId = $rootNodeId;
161
162	9	$rootNodeInfo = $this->_getAdapter()->getNodeInfo($rootNodeId);
163	9	$tree = $this->_buildFlatTree($rootNodeInfo);
		0 ignored issues – show Bug introduced 2016-06-01 10:09 UTC by Report Bug Copy Issue Report It seems like `$rootNodeInfo` defined by `$this->_getAdapter()->getNodeInfo($rootNodeId)` on line `162` can be `null`; however, `StefanoTree\NestedSet\Va...dator::_buildFlatTree()` 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...
164
165	9	$tree = $this->_validateLevels($tree);
166	9	$tree = $this->_validateLeftIndexes($tree);
167	9	$tree = $this->_validateRightIndexes($tree);
168
169	9	$this->tree = $tree;
170
171	9	return $this->isValid;
172		}
173
174	3	public function rebuild($rootNodeId)
175		{
176	3	if ($this->rootId != $rootNodeId) {
177	3	$this->isValid($rootNodeId);
178		}
179
180	3	if ($this->isValid) {
181		return;
182		}
183
184	3	foreach ($this->tree as $nodeInfo) {
185	3	if ($nodeInfo->needUpdate()) {
186	3	$this->_getAdapter()
187	3	->updateNodeMetadata($nodeInfo);
188		}
189		}
190	3	}
191		}
192

bartko-s / stefano-tree

Push — master ( 2e5d0e...583994 )

Validator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like