ReturnAndYieldInOneMethod::pass() - Code Metrics - Inspection of "Analyzer return and yield in one method, #185" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#263)

by Дмитрий

created 2016-10-31 16:51 UTC

ReturnAndYieldInOneMethod::pass() A

↳ Parent: ReturnAndYieldInOneMethod

Complexity

Conditions	4
Paths	4

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	8
c	1
b	0
f	0
nc	4
nop	2
dl	0
loc	15
ccs	9
cts	9
cp	1
crap	4
rs	9.2

<?php

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt;
use PHPSA\Analyzer\Helper\DefaultMetadataPassTrait;
use PHPSA\Analyzer\Helper\ResolveExpressionTrait;
use PHPSA\Analyzer\Pass;
use PhpParser\Node\Expr;
use PHPSA\Context;

class ReturnAndYieldInOneMethod implements Pass\AnalyzerPassInterface
{
    const DESCRIPTION = 'Checks for using return and yield statements in a one method and discourages it.';

    use DefaultMetadataPassTrait;
    use ResolveExpressionTrait;

    /**
     * @param Stmt $stmt
     * @param Context $context
     * @return bool
     */
    public function pass(Stmt $stmt, Context $context)
    {
        $yieldExists = $this->findYieldExpression([$stmt])->current();
        if (!$yieldExists) {
            // YieldFrom is another expression
            $yieldExists = $this->findNode([$stmt], Expr\YieldFrom::class)->current();
        }

        if ($yieldExists && $this->findReturnStatement([$stmt])->current()) {
            $context->notice('return_and_yield_in_one_method', 'Do not use return and yield in a one method', $stmt);
            return true;
        }

        return false;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            Stmt\ClassMethod::class,
        ];
    }
}


1		<?php
2
3		namespace PHPSA\Analyzer\Pass\Statement;
4
5		use PhpParser\Node\Stmt;
6		use PHPSA\Analyzer\Helper\DefaultMetadataPassTrait;
7		use PHPSA\Analyzer\Helper\ResolveExpressionTrait;
8		use PHPSA\Analyzer\Pass;
9		use PhpParser\Node\Expr;
10		use PHPSA\Context;
11
12		class ReturnAndYieldInOneMethod implements Pass\AnalyzerPassInterface
13		{
14		const DESCRIPTION = 'Checks for using return and yield statements in a one method and discourages it.';
15
16		use DefaultMetadataPassTrait;
17		use ResolveExpressionTrait;
18
19		/**
20		* @param Stmt $stmt
21		* @param Context $context
22		* @return bool
23		*/
24	5	public function pass(Stmt $stmt, Context $context)
25		{
26	5	$yieldExists = $this->findYieldExpression([$stmt])->current();
27	5	if (!$yieldExists) {
28		// YieldFrom is another expression
29	5	$yieldExists = $this->findNode([$stmt], Expr\YieldFrom::class)->current();
30	5	}
31
32	5	if ($yieldExists && $this->findReturnStatement([$stmt])->current()) {
33	1	$context->notice('return_and_yield_in_one_method', 'Do not use return and yield in a one method', $stmt);
34	1	return true;
35		}
36
37	5	return false;
38		}
39
40		/**
41		* @return array
42		*/
43	1	public function getRegister()
44		{
45		return [
46	1	Stmt\ClassMethod::class,
47	1	];
48		}
49		}
50

ovr / phpsa

Pull Request — master (#263)

ReturnAndYieldInOneMethod::pass() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like