Dumper - Code Metrics - Inspection of "__debugInfo" - spiral/components - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 439122...918b18 )

by Anton

created 2016-01-31 15:17 UTC

Dumper B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	325
Duplicated Lines	5.23 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
wmc	46
c	4
b	0
f	0
lcom	1
cbo	5
dl	17
loc	325
rs	8.3999

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	setStyle()	0	6	1
D	dump()	0	42	10
C	dumpValue()	0	63	11
B	dumpArray()	9	33	6
C	dumpObject()	8	47	8
B	dumpProperty()	0	30	5
A	getAccess()	0	10	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Dumper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Dumper, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\Debug;

use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Spiral\Core\Component;
use Spiral\Core\Container\SingletonInterface;
use Spiral\Debug\Dumper\Style;
use Spiral\Debug\Traits\BenchmarkTrait;
use Spiral\Debug\Traits\LoggerTrait;

/**
 * One of the oldest spiral parts, used to dump variables content in user friendly way.
 */
class Dumper extends Component implements SingletonInterface, LoggerAwareInterface
{
    use LoggerTrait, BenchmarkTrait;

    /**
     * Options for dump() function to specify output.
     */
    const OUTPUT_ECHO     = 0;
    const OUTPUT_RETURN   = 1;
    const OUTPUT_LOG      = 2;
    const OUTPUT_LOG_NICE = 3;

    /**
     * Deepest level to be dumped.
     *
     * @var int
     */
    private $maxLevel = 10;

    /**
     * @invisible
     * @var Style
     */
    private $style = null;

    /**
     * @param int             $maxLevel
     * @param Style           $styler Light styler to be used by default.
     * @param LoggerInterface $logger
     */
    public function __construct(
        $maxLevel = 10,
        Style $styler = null,
        LoggerInterface $logger = null
    ) {
        $this->maxLevel = $maxLevel;
        $this->style = !empty($styler) ? $styler : new Style();
        $this->logger = $logger;
    }

    /**
     * Set dump styler.
     *
     * @param Style $style
     * @return $this
     */
    public function setStyle(Style $style)
    {
        $this->style = $style;

        return $this;
    }

    /**
     * Dump specified value.
     *
     * @param mixed $value
     * @param int   $output
     * @return null|string
     */
    public function dump($value, $output = self::OUTPUT_ECHO)
    {
        if (php_sapi_name() === 'cli' && $output == self::OUTPUT_ECHO) {
            if (is_object($value) && method_exists($value, '__debugInfo')) {
                $value = $value->__debugInfo();
            }

            print_r($value);
            if (is_scalar($value)) {
                echo "\n";
            }

            return null;
        }

        //Dumping is pretty slow operation, let's record it so we can exclude dump time from application
        //timeline
        $benchmark = $this->benchmark('dump');
        try {
            switch ($output) {
                case self::OUTPUT_ECHO:
                    echo $this->style->mountContainer($this->dumpValue($value, '', 0));
                    break;

                case self::OUTPUT_RETURN:
                    return $this->style->mountContainer($this->dumpValue($value, '', 0));
                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

                case self::OUTPUT_LOG:
                    $this->logger()->debug(print_r($value, true));
                    break;

                case self::OUTPUT_LOG_NICE:
                    $this->logger()->debug($this->dump($value, self::OUTPUT_RETURN));
                    break;
            }

            return null;
        } finally {
            $this->benchmark($benchmark);
        }
    }

    /**
     * Variable dumper. This is the oldest spiral function originally written in 2007. :)
     *
     * @param mixed  $value
     * @param string $name       Variable name, internal.
     * @param int    $level      Dumping level, internal.
     * @param bool   $hideHeader Hide array/object header, internal.
     * @return string
     */
    private function dumpValue($value, $name = '', $level = 0, $hideHeader = false)
    {
        //Any dump starts with initial indent (level based)
        $indent = $this->style->indent($level);

        if (!$hideHeader && !empty($name)) {
            //Showing element name (if any provided)
            $header = $indent . $this->style->style($name, "name");

            //Showing equal sing
            $header .= $this->style->style(" = ", "syntax", "=");
        } else {
            $header = $indent;
        }

        if ($level > $this->maxLevel) {
            //Dumper is not reference based, we can't dump too deep values
            return $indent . $this->style->style('-too deep-', 'maxLevel') . "\n";
        }

        $type = strtolower(gettype($value));

        if ($type == 'array') {
            return $header . $this->dumpArray($value, $level, $hideHeader);
        }

        if ($type == 'object') {
            return $header . $this->dumpObject($value, $level, $hideHeader);
        }

        if ($type == 'resource') {
            //No need to dump resource value
            $element = get_resource_type($value) . " resource ";

            return $header . $this->style->style($element, "type", "resource") . "\n";
        }

        //Value length
        $length = strlen($value);

        //Including type size
        $header .= $this->style->style("{$type}({$length})", "type", $type);

        $element = null;
        switch ($type) {
            case "string":
                $element = htmlspecialchars($value);
                break;

            case "boolean":
                $element = ($value ? "true" : "false");
                break;

            default:
                if ($value !== null) {
                    //Not showing null value, type is enough
                    $element = var_export($value, true);
                }
        }

        //Including value
        return $header . " " . $this->style->style($element, "value", $type) . "\n";
    }

    /**
     * @param array $array
     * @param int   $level
     * @param bool  $hideHeader
     * @return string
     */
    private function dumpArray(array $array, $level, $hideHeader = false)
    {
        $indent = $this->style->indent($level);

        if (!$hideHeader) {

            $count = count($array);

            //Array size and scope
            $output = $this->style->style("array({$count})", "type", "array") . "\n";
            $output .= $indent . $this->style->style("[", "syntax", "[") . "\n";
        } else {
            $output = '';
        }

        foreach ($array as $key => $value) {
            if (!is_numeric($key)) {
                if (is_string($key)) {
                    $key = htmlspecialchars($key);
                }

                $key = "'{$key}'";
            }

            $output .= $this->dumpValue($value, "[{$key}]", $level + 1);
        }

        if (!$hideHeader) {
            //Closing array scope
            $output .= $indent . $this->style->style("]", "syntax", "]") . "\n";
        }

        return $output;
    }

    /**
     * @param object $object
     * @param int    $level
     * @param bool   $hideHeader
     * @param string $class
     * @return string
     */
    private function dumpObject($object, $level, $hideHeader = false, $class = '')
    {
        $indent = $this->style->indent($level);

        if (!$hideHeader) {

            $type = ($class ?: get_class($object)) . " object ";

            $header = $this->style->style($type, "type", "object") . "\n";
            $header .= $indent . $this->style->style("(", "syntax", "(") . "\n";
        } else {
            $header = '';
        }

        //Let's use method specifically created for dumping
        if (method_exists($object, '__debugInfo')) {
            $debugInfo = $object->__debugInfo();

            if (is_array($debugInfo)) {
                //Pretty view
                $debugInfo = (object)$debugInfo;
            }

            if (is_object($debugInfo)) {
                //We are not including syntax elements here
                return $this->dumpObject($debugInfo, $level, false, get_class($object));
            }

            return $header
            . $this->dumpValue($debugInfo, '', $level + (is_scalar($object)), true)
            . $indent . $this->style->style(")", "syntax", ")") . "\n";
        }

        if ($object instanceof \Closure) {
            //todo: dump source code of closure
            $output = '';
        } else {
            $refection = new \ReflectionObject($object);

            $output = '';
            foreach ($refection->getProperties() as $property) {
                $output .= $this->dumpProperty($object, $property, $level);
            }
        }

        //Header, content, footer
        return $header . $output . $indent . $this->style->style(")", "syntax", ")") . "\n";
    }

    /**
     * @param object              $object
     * @param \ReflectionProperty $property
     * @param int                 $level
     * @return string
     */
    private function dumpProperty($object, \ReflectionProperty $property, $level)
    {
        if ($property->isStatic()) {
            return '';
        }

        if (
            !($object instanceof \stdClass)
            && strpos($property->getDocComment(), '@invisible') !== false
        ) {
            //Memory loop while reading doc comment for stdClass variables?
            //Report a PHP bug about treating comment INSIDE property declaration as doc comment.
            return '';
        }

        //Property access level
        $access = $this->getAccess($property);

        //To read private and protected properties
        $property->setAccessible(true);

        if ($object instanceof \stdClass) {
            $access = 'dynamic';
        }

        //Property name includes access level
        $name = $property->getName() . $this->style->style(":" . $access, "access", $access);

        return $this->dumpValue($property->getValue($object), $name, $level + 1);
    }

    /**
     * Property access level label.
     *
     * @param \ReflectionProperty $property
     * @return string
     */
    private function getAccess(\ReflectionProperty $property)
    {
        if ($property->isPrivate()) {
            return 'private';
        } elseif ($property->isProtected()) {
            return 'protected';
        }

        return 'public';
    }
}

1		<?php
2		/**
3		* Spiral Framework.
4		*
5		* @license MIT
6		* @author Anton Titov (Wolfy-J)
7		*/
8		namespace Spiral\Debug;
9
10		use Psr\Log\LoggerAwareInterface;
11		use Psr\Log\LoggerInterface;
12		use Spiral\Core\Component;
13		use Spiral\Core\Container\SingletonInterface;
14		use Spiral\Debug\Dumper\Style;
15		use Spiral\Debug\Traits\BenchmarkTrait;
16		use Spiral\Debug\Traits\LoggerTrait;
17
18		/**
19		* One of the oldest spiral parts, used to dump variables content in user friendly way.
20		*/
21		class Dumper extends Component implements SingletonInterface, LoggerAwareInterface
22		{
23		use LoggerTrait, BenchmarkTrait;
24
25		/**
26		* Options for dump() function to specify output.
27		*/
28		const OUTPUT_ECHO = 0;
29		const OUTPUT_RETURN = 1;
30		const OUTPUT_LOG = 2;
31		const OUTPUT_LOG_NICE = 3;
32
33		/**
34		* Deepest level to be dumped.
35		*
36		* @var int
37		*/
38		private $maxLevel = 10;
39
40		/**
41		* @invisible
42		* @var Style
43		*/
44		private $style = null;
45
46		/**
47		* @param int $maxLevel
48		* @param Style $styler Light styler to be used by default.
49		* @param LoggerInterface $logger
50		*/
51		public function __construct(
52		$maxLevel = 10,
53		Style $styler = null,
54		LoggerInterface $logger = null
55		) {
56		$this->maxLevel = $maxLevel;
57		$this->style = !empty($styler) ? $styler : new Style();
58		$this->logger = $logger;
59		}
60
61		/**
62		* Set dump styler.
63		*
64		* @param Style $style
65		* @return $this
66		*/
67		public function setStyle(Style $style)
68		{
69		$this->style = $style;
70
71		return $this;
72		}
73
74		/**
75		* Dump specified value.
76		*
77		* @param mixed $value
78		* @param int $output
79		* @return null\|string
80		*/
81		public function dump($value, $output = self::OUTPUT_ECHO)
82		{
83		if (php_sapi_name() === 'cli' && $output == self::OUTPUT_ECHO) {
84		if (is_object($value) && method_exists($value, '__debugInfo')) {
85		$value = $value->__debugInfo();
86		}
87
88		print_r($value);
89		if (is_scalar($value)) {
90		echo "\n";
91		}
92
93		return null;
94		}
95
96		//Dumping is pretty slow operation, let's record it so we can exclude dump time from application
97		//timeline
98		$benchmark = $this->benchmark('dump');
99		try {
100		switch ($output) {
101		case self::OUTPUT_ECHO:
102		echo $this->style->mountContainer($this->dumpValue($value, '', 0));
103		break;
104
105		case self::OUTPUT_RETURN:
106		return $this->style->mountContainer($this->dumpValue($value, '', 0));
107		break;
		0 ignored issues – show Unused Code introduced 2015-11-21 12:38 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
108
109		case self::OUTPUT_LOG:
110		$this->logger()->debug(print_r($value, true));
111		break;
112
113		case self::OUTPUT_LOG_NICE:
114		$this->logger()->debug($this->dump($value, self::OUTPUT_RETURN));
115		break;
116		}
117
118		return null;
119		} finally {
120		$this->benchmark($benchmark);
121		}
122		}
123
124		/**
125		* Variable dumper. This is the oldest spiral function originally written in 2007. :)
126		*
127		* @param mixed $value
128		* @param string $name Variable name, internal.
129		* @param int $level Dumping level, internal.
130		* @param bool $hideHeader Hide array/object header, internal.
131		* @return string
132		*/
133		private function dumpValue($value, $name = '', $level = 0, $hideHeader = false)
134		{
135		//Any dump starts with initial indent (level based)
136		$indent = $this->style->indent($level);
137
138		if (!$hideHeader && !empty($name)) {
139		//Showing element name (if any provided)
140		$header = $indent . $this->style->style($name, "name");
141
142		//Showing equal sing
143		$header .= $this->style->style(" = ", "syntax", "=");
144		} else {
145		$header = $indent;
146		}
147
148		if ($level > $this->maxLevel) {
149		//Dumper is not reference based, we can't dump too deep values
150		return $indent . $this->style->style('-too deep-', 'maxLevel') . "\n";
151		}
152
153		$type = strtolower(gettype($value));
154
155		if ($type == 'array') {
156		return $header . $this->dumpArray($value, $level, $hideHeader);
157		}
158
159		if ($type == 'object') {
160		return $header . $this->dumpObject($value, $level, $hideHeader);
161		}
162
163		if ($type == 'resource') {
164		//No need to dump resource value
165		$element = get_resource_type($value) . " resource ";
166
167		return $header . $this->style->style($element, "type", "resource") . "\n";
168		}
169
170		//Value length
171		$length = strlen($value);
172
173		//Including type size
174		$header .= $this->style->style("{$type}({$length})", "type", $type);
175
176		$element = null;
177		switch ($type) {
178		case "string":
179		$element = htmlspecialchars($value);
180		break;
181
182		case "boolean":
183		$element = ($value ? "true" : "false");
184		break;
185
186		default:
187		if ($value !== null) {
188		//Not showing null value, type is enough
189		$element = var_export($value, true);
190		}
191		}
192
193		//Including value
194		return $header . " " . $this->style->style($element, "value", $type) . "\n";
195		}
196
197		/**
198		* @param array $array
199		* @param int $level
200		* @param bool $hideHeader
201		* @return string
202		*/
203		private function dumpArray(array $array, $level, $hideHeader = false)
204		{
205		$indent = $this->style->indent($level);
206
207	View Code Duplication	if (!$hideHeader) {
		0 ignored issues – show Duplication introduced 2015-11-21 12:38 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...
208		$count = count($array);
209
210		//Array size and scope
211		$output = $this->style->style("array({$count})", "type", "array") . "\n";
212		$output .= $indent . $this->style->style("[", "syntax", "[") . "\n";
213		} else {
214		$output = '';
215		}
216
217		foreach ($array as $key => $value) {
218		if (!is_numeric($key)) {
219		if (is_string($key)) {
220		$key = htmlspecialchars($key);
221		}
222
223		$key = "'{$key}'";
224		}
225
226		$output .= $this->dumpValue($value, "[{$key}]", $level + 1);
227		}
228
229		if (!$hideHeader) {
230		//Closing array scope
231		$output .= $indent . $this->style->style("]", "syntax", "]") . "\n";
232		}
233
234		return $output;
235		}
236
237		/**
238		* @param object $object
239		* @param int $level
240		* @param bool $hideHeader
241		* @param string $class
242		* @return string
243		*/
244		private function dumpObject($object, $level, $hideHeader = false, $class = '')
245		{
246		$indent = $this->style->indent($level);
247
248	View Code Duplication	if (!$hideHeader) {
		0 ignored issues – show Duplication introduced 2015-11-21 12:38 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...
249		$type = ($class ?: get_class($object)) . " object ";
250
251		$header = $this->style->style($type, "type", "object") . "\n";
252		$header .= $indent . $this->style->style("(", "syntax", "(") . "\n";
253		} else {
254		$header = '';
255		}
256
257		//Let's use method specifically created for dumping
258		if (method_exists($object, '__debugInfo')) {
259		$debugInfo = $object->__debugInfo();
260
261		if (is_array($debugInfo)) {
262		//Pretty view
263		$debugInfo = (object)$debugInfo;
264		}
265
266		if (is_object($debugInfo)) {
267		//We are not including syntax elements here
268		return $this->dumpObject($debugInfo, $level, false, get_class($object));
269		}
270
271		return $header
272		. $this->dumpValue($debugInfo, '', $level + (is_scalar($object)), true)
273		. $indent . $this->style->style(")", "syntax", ")") . "\n";
274		}
275
276		if ($object instanceof \Closure) {
277		//todo: dump source code of closure
278		$output = '';
279		} else {
280		$refection = new \ReflectionObject($object);
281
282		$output = '';
283		foreach ($refection->getProperties() as $property) {
284		$output .= $this->dumpProperty($object, $property, $level);
285		}
286		}
287
288		//Header, content, footer
289		return $header . $output . $indent . $this->style->style(")", "syntax", ")") . "\n";
290		}
291
292		/**
293		* @param object $object
294		* @param \ReflectionProperty $property
295		* @param int $level
296		* @return string
297		*/
298		private function dumpProperty($object, \ReflectionProperty $property, $level)
299		{
300		if ($property->isStatic()) {
301		return '';
302		}
303
304		if (
305		!($object instanceof \stdClass)
306		&& strpos($property->getDocComment(), '@invisible') !== false
307		) {
308		//Memory loop while reading doc comment for stdClass variables?
309		//Report a PHP bug about treating comment INSIDE property declaration as doc comment.
310		return '';
311		}
312
313		//Property access level
314		$access = $this->getAccess($property);
315
316		//To read private and protected properties
317		$property->setAccessible(true);
318
319		if ($object instanceof \stdClass) {
320		$access = 'dynamic';
321		}
322
323		//Property name includes access level
324		$name = $property->getName() . $this->style->style(":" . $access, "access", $access);
325
326		return $this->dumpValue($property->getValue($object), $name, $level + 1);
327		}
328
329		/**
330		* Property access level label.
331		*
332		* @param \ReflectionProperty $property
333		* @return string
334		*/
335		private function getAccess(\ReflectionProperty $property)
336		{
337		if ($property->isPrivate()) {
338		return 'private';
339		} elseif ($property->isProtected()) {
340		return 'protected';
341		}
342
343		return 'public';
344		}
345		}

spiral / components