TokenContainer::clean() - Code Metrics - Inspection of "Separating the process of type and element blackli..." - kevintweber/Groundskeeper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 62c01b...6e9edd )

by Kevin

created 2016-04-28 02:00 UTC

TokenContainer::clean() B

↳ Parent: TokenContainer

Complexity

Conditions	5
Paths	5

Size

Total Lines	17
Code Lines	8

Duplication

Lines	8
Ratio	47.06 %

Code Coverage

Tests	9
CRAP Score	5.1502

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	8
loc	17
ccs	9
cts	11
cp	0.8182
rs	8.8571
cc	5
eloc	8
nc	5
nop	1
crap	5.1502

<?php

namespace Groundskeeper\Tokens;

use Groundskeeper\Configuration;
use Groundskeeper\Exceptions\ValidationException;
use Groundskeeper\Tokens\Elements\Element;
use Psr\Log\LoggerInterface;

class TokenContainer implements Cleanable, ContainsChildren, Removable
{
    /** @var array[Token] */
    private $children;

    /** @var Configuration */
    private $configuration;

    /**
     * Constructor
     */
    public function __construct(Configuration $configuration)
    {
        $this->children = array();
        $this->configuration = $configuration;
    }

    /**
     * Required by ContainsChildren interface.
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * Required by ContainsChildren interface.
     */
    public function hasChild(Token $token)
    {
        return array_search($token, $this->children) !== false;
    }

    /**
     * Required by ContainsChildren interface.
     */
    public function addChild(Token $token)
    {
        $this->children[] = $token;

        return $this;
    }

    /**
     * Required by ContainsChildren interface.
     */
    public function removeChild(Token $token)

    {
        $key = array_search($token, $this->children);
        if ($key !== false) {
            unset($this->children[$key]);

            return true;
        }

        return false;
    }

    /**
     * Required by Cleanable interface.
     */
    public function clean(LoggerInterface $logger = null)
    {
        if ($this->configuration->get('clean-strategy') == Configuration::CLEAN_STRATEGY_NONE) {
            return true;
        }

        foreach ($this->children as $child) {

            if ($child instanceof Cleanable) {
                $isClean = $child->clean($logger);
                if (!$isClean) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                    /// @todo
                }
            }
        }

        return true;
    }

    /**
     * Required by the Removable interface.
     */
    public function remove(LoggerInterface $logger = null)

    {
        $hasRemovableTypes = $this->configuration->get('type-blacklist') !==
            Configuration::TYPE_BLACKLIST_NONE;
        $hasRemovableElements = $this->configuration->get('element-blacklist') !==
            Configuration::ELEMENT_BLACKLIST_NONE;
        foreach ($this->children as $key => $child) {
            // Check types.
            if ($hasRemovableTypes &&
                !$this->configuration->isAllowedType($child->getType())) {
                unset($this->children[$key]);
                if ($logger !== null) {
                    $logger->debug('Removing token of type: ' . $child->getType());
                }

                continue;
            }

            // Check elements.
            if ($hasRemovableElements &&
                $child instanceof Element &&
                !$this->configuration->isAllowedElement($child->getName())) {
                unset($this->children[$key]);
                if ($logger !== null) {
                    $logger->debug('Removing element of type: ' . $child->getName());
                }

                continue;
            }

            // Check children.
            if ($child instanceof Removable) {
                $child->remove($logger);
            }
        }
    }
}


1			<?php
2
3			namespace Groundskeeper\Tokens;
4
5			use Groundskeeper\Configuration;
6			use Groundskeeper\Exceptions\ValidationException;
7			use Groundskeeper\Tokens\Elements\Element;
8			use Psr\Log\LoggerInterface;
9
10			class TokenContainer implements Cleanable, ContainsChildren, Removable
11			{
12			/** @var array[Token] */
13			private $children;
14
15			/** @var Configuration */
16			private $configuration;
17
18			/**
19			* Constructor
20			*/
21	35		public function __construct(Configuration $configuration)
22			{
23	35		$this->children = array();
24	35		$this->configuration = $configuration;
25	35		}
26
27			/**
28			* Required by ContainsChildren interface.
29			*/
30	35		public function getChildren()
31			{
32	35		return $this->children;
33			}
34
35			/**
36			* Required by ContainsChildren interface.
37			*/
38			public function hasChild(Token $token)
39			{
40			return array_search($token, $this->children) !== false;
41			}
42
43			/**
44			* Required by ContainsChildren interface.
45			*/
46	35		public function addChild(Token $token)
47			{
48	35		$this->children[] = $token;
49
50	35		return $this;
51			}
52
53			/**
54			* Required by ContainsChildren interface.
55			*/
56		View Code Duplication	public function removeChild(Token $token)
			0 ignored issues – show Duplication introduced 2016-04-24 23:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
57			{
58			$key = array_search($token, $this->children);
59			if ($key !== false) {
60			unset($this->children[$key]);
61
62			return true;
63			}
64
65			return false;
66			}
67
68			/**
69			* Required by Cleanable interface.
70			*/
71	29		public function clean(LoggerInterface $logger = null)
72			{
73	29		if ($this->configuration->get('clean-strategy') == Configuration::CLEAN_STRATEGY_NONE) {
74			return true;
75			}
76
77	29	View Code Duplication	foreach ($this->children as $child) {
			0 ignored issues – show Duplication introduced 2016-04-28 02:03 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...
78	23		if ($child instanceof Cleanable) {
79	17		$isClean = $child->clean($logger);
80	17		if (!$isClean) {
			0 ignored issues – show Unused Code introduced 2016-04-28 02:03 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
81			/// @todo
82			}
83	17		}
84	29		}
85
86	29		return true;
87			}
88
89			/**
90			* Required by the Removable interface.
91			*/
92	29	View Code Duplication	public function remove(LoggerInterface $logger = null)
			0 ignored issues – show Duplication introduced 2016-04-28 02:03 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
93			{
94	29		$hasRemovableTypes = $this->configuration->get('type-blacklist') !==
95	29		Configuration::TYPE_BLACKLIST_NONE;
96	29		$hasRemovableElements = $this->configuration->get('element-blacklist') !==
97	29		Configuration::ELEMENT_BLACKLIST_NONE;
98	29		foreach ($this->children as $key => $child) {
99			// Check types.
100	29		if ($hasRemovableTypes &&
101	29		!$this->configuration->isAllowedType($child->getType())) {
102	5		unset($this->children[$key]);
103	5		if ($logger !== null) {
104	5		$logger->debug('Removing token of type: ' . $child->getType());
105	5		}
106
107	5		continue;
108			}
109
110			// Check elements.
111	24		if ($hasRemovableElements &&
112	24		$child instanceof Element &&
113	24		!$this->configuration->isAllowedElement($child->getName())) {
114	1		unset($this->children[$key]);
115	1		if ($logger !== null) {
116	1		$logger->debug('Removing element of type: ' . $child->getName());
117	1		}
118
119	1		continue;
120			}
121
122			// Check children.
123	23		if ($child instanceof Removable) {
124	15		$child->remove($logger);
125	15		}
126	29		}
127	29		}
128			}
129

kevintweber / Groundskeeper

Push — master ( 62c01b...6e9edd )

TokenContainer::clean() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like