MultipleReturnSniff - Code Metrics - bestit/PHP_CodeSniffer - Measure and Improve Code Quality continuously with Scrutinizer

MultipleReturnSniff A
last analyzed 2020-07-14 06:03 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	70
rs	10
c	0
b	0
f	0
wmc	4
lcom	1
cbo	3

3 Methods

Rating	Name	Size	Complexity
A	areRequirementsMet()	4	1
A	loadReturnsOfThisFunction()	15	1
A	processToken()	16	2

<?php

declare(strict_types=1);

namespace BestIt\Sniffs\Functions;

use BestIt\CodeSniffer\Helper\TokenHelper;
use BestIt\Sniffs\AbstractSniff;
use BestIt\Sniffs\FunctionRegistrationTrait;
use function array_filter;
use function array_shift;
use function array_walk;
use const T_CLOSURE;
use const T_FUNCTION;
use const T_RETURN;

/**
 * Class MultipleReturnSniff.
 *
 * @author Mika Bertels <[email protected]>
 * @package BestIt\Sniffs\Functions
 */
class MultipleReturnSniff extends AbstractSniff
{
    use FunctionRegistrationTrait;

    /**
     * You SHOULD only use a return per method.
     */
    public const CODE_MULTIPLE_RETURNS_FOUND = 'MultipleReturnsFound';

    /**
     * Error message for multiple returns.
     */
    private const WARNING_MULTIPLE_RETURNS_FOUND = 'Multiple returns detected. Did you refactor your method? Please ' .
        'do not use an early return if your method/function still is cluttered.';

    /**
     * Only work on full fledged functions.
     *
     * @return bool True if there is a scope closer for this token.
     */
    protected function areRequirementsMet(): bool
    {
        return (bool) @ $this->token['scope_closer'];
    }

    /**
     * Returns the returns of this function.
     *
     * We check the "token level" to exclude the returns of nested closures.
     *
     * @return int[] The positions of the returns from the same function-scope.
     */
    private function loadReturnsOfThisFunction(): array
    {
        $returnPositions = TokenHelper::findNextAll(
            $this->file,
/** @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);
    }
}
            [T_RETURN],
            $this->stackPos + 1,
            $this->token['scope_closer']
        );

        return array_filter($returnPositions, function (int $returnPos): bool {
            $possibleClosure = $this->file->findPrevious([T_CLOSURE, T_FUNCTION], $returnPos - 1, $this->stackPos);

            return $possibleClosure === $this->stackPos;
        });
    }

    /**
     * Iterates through the returns of this function and registers warnings if there is more then one relevant return.
     *
     * @return void
     */
    protected function processToken(): void
    {
        $returnPositions = $this->loadReturnsOfThisFunction();

        if (count($returnPositions) > 1) {
            array_shift($returnPositions);

            array_walk($returnPositions, function (int $returnPos): void {
                $this->file->addWarning(
                    self::WARNING_MULTIPLE_RETURNS_FOUND,
                    $returnPos,
                    static::CODE_MULTIPLE_RETURNS_FOUND
                );
            });
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace BestIt\Sniffs\Functions;
6
7			use BestIt\CodeSniffer\Helper\TokenHelper;
8			use BestIt\Sniffs\AbstractSniff;
9			use BestIt\Sniffs\FunctionRegistrationTrait;
10			use function array_filter;
11			use function array_shift;
12			use function array_walk;
13			use const T_CLOSURE;
14			use const T_FUNCTION;
15			use const T_RETURN;
16
17			/**
18			* Class MultipleReturnSniff.
19			*
20			* @author Mika Bertels <[email protected]>
21			* @package BestIt\Sniffs\Functions
22			*/
23			class MultipleReturnSniff extends AbstractSniff
24			{
25			use FunctionRegistrationTrait;
26
27			/**
28			* You SHOULD only use a return per method.
29			*/
30			public const CODE_MULTIPLE_RETURNS_FOUND = 'MultipleReturnsFound';
31
32			/**
33			* Error message for multiple returns.
34			*/
35			private const WARNING_MULTIPLE_RETURNS_FOUND = 'Multiple returns detected. Did you refactor your method? Please ' .
36			'do not use an early return if your method/function still is cluttered.';
37
38			/**
39			* Only work on full fledged functions.
40			*
41			* @return bool True if there is a scope closer for this token.
42			*/
43			protected function areRequirementsMet(): bool
44			{
45			return (bool) @ $this->token['scope_closer'];
46			}
47
48			/**
49			* Returns the returns of this function.
50			*
51			* We check the "token level" to exclude the returns of nested closures.
52			*
53			* @return int[] The positions of the returns from the same function-scope.
54			*/
55			private function loadReturnsOfThisFunction(): array
56			{
57			$returnPositions = TokenHelper::findNextAll(
58			$this->file,
			0 ignored issues – show Bug introduced 2020-06-12 10:39 UTC by Report Bug Copy Issue Report It seems like `$this->file` can be `null`; however, `findNextAll()` 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...
59			[T_RETURN],
60			$this->stackPos + 1,
61			$this->token['scope_closer']
62			);
63
64			return array_filter($returnPositions, function (int $returnPos): bool {
65			$possibleClosure = $this->file->findPrevious([T_CLOSURE, T_FUNCTION], $returnPos - 1, $this->stackPos);
66
67			return $possibleClosure === $this->stackPos;
68			});
69			}
70
71			/**
72			* Iterates through the returns of this function and registers warnings if there is more then one relevant return.
73			*
74			* @return void
75			*/
76			protected function processToken(): void
77			{
78			$returnPositions = $this->loadReturnsOfThisFunction();
79
80			if (count($returnPositions) > 1) {
81			array_shift($returnPositions);
82
83			array_walk($returnPositions, function (int $returnPos): void {
84			$this->file->addWarning(
85			self::WARNING_MULTIPLE_RETURNS_FOUND,
86			$returnPos,
87			static::CODE_MULTIPLE_RETURNS_FOUND
88			);
89			});
90			}
91			}
92			}
93

bestit / PHP_CodeSniffer

MultipleReturnSniff A last analyzed 2020-07-14 06:03 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like

MultipleReturnSniff A
last analyzed 2020-07-14 06:03 UTC