DebugCode::pass() - Code Metrics - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

DebugCode::pass() A
last analyzed 2019-02-27 06:44 UTC

↳ Parent: DebugCode

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
cc	5
nc	4
nop	2
dl	0
loc	22
ccs	0
cts	13
cp	0
crap	30
rs	9.2568
c	0
b	0
f	0

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
 */

namespace PHPSA\Analyzer\Pass\Expression\FunctionCall;

use phpDocumentor\Reflection\DocBlockFactory;
use PhpParser\Node\Expr\FuncCall;
use PHPSA\Context;

class DebugCode extends AbstractFunctionCallAnalyzer
{
    const DESCRIPTION = 'Checks for use of debug code and suggests to remove it.';

    protected $map = [
        'var_dump' => 'var_dump',
        'var_export' => 'var_export',
        'debug_zval_dump' => 'debug_zval_dump',
        'dd' => 'dd', // Laravel debug function
        'dump' => 'dump' // Symfony debug function
    ];

    /** @var DocBlockFactory */
    protected $docBlockFactory;

    public function __construct()
    {
        $this->docBlockFactory = DocBlockFactory::createInstance();
    }

    public function pass(FuncCall $funcCall, Context $context)
    {
        $functionName = $this->resolveFunctionName($funcCall, $context);
        if (!$functionName || !isset($this->map[$functionName])) {
            return false;
        }

        if ($funcCall->getDocComment()) {
            $phpdoc = $this->docBlockFactory->create($funcCall->getDocComment()->getText());
            if ($phpdoc->hasTag('expected')) {
                return false;
            }
        }

        $context->notice(
            'debug.code',
            sprintf('Function %s() is a debug function, please don`t use it in production.', $functionName),
            $funcCall
        );

        return true;
    }
}


1			<?php
2			/**
3			* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4			*/
5
6			namespace PHPSA\Analyzer\Pass\Expression\FunctionCall;
7
8			use phpDocumentor\Reflection\DocBlockFactory;
9			use PhpParser\Node\Expr\FuncCall;
10			use PHPSA\Context;
11
12			class DebugCode extends AbstractFunctionCallAnalyzer
13			{
14			const DESCRIPTION = 'Checks for use of debug code and suggests to remove it.';
15
16			protected $map = [
17			'var_dump' => 'var_dump',
18			'var_export' => 'var_export',
19			'debug_zval_dump' => 'debug_zval_dump',
20			'dd' => 'dd', // Laravel debug function
21			'dump' => 'dump' // Symfony debug function
22			];
23
24			/** @var DocBlockFactory */
25			protected $docBlockFactory;
26
27			public function __construct()
28			{
29			$this->docBlockFactory = DocBlockFactory::createInstance();
30			}
31
32			public function pass(FuncCall $funcCall, Context $context)
33			{
34			$functionName = $this->resolveFunctionName($funcCall, $context);
35			if (!$functionName \|\| !isset($this->map[$functionName])) {
36			return false;
37			}
38
39			if ($funcCall->getDocComment()) {
40			$phpdoc = $this->docBlockFactory->create($funcCall->getDocComment()->getText());
41			if ($phpdoc->hasTag('expected')) {
42			return false;
43			}
44			}
45
46			$context->notice(
47			'debug.code',
48			sprintf('Function %s() is a debug function, please don`t use it in production.', $functionName),
49			$funcCall
50			);
51
52			return true;
53			}
54			}
55

ovr / phpsa

DebugCode::pass() A last analyzed 2019-02-27 06:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DebugCode::pass() A
last analyzed 2019-02-27 06:44 UTC