PHPSA\Analyzer\Pass\Statement\MissingBreakStatement

Complexity

Total Complexity

10

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	6

Test Coverage

Coverage

83.87%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	pass()	0	11	3
A	getConfiguration()	0	9	1
A	getRegister()	0	6	1
B	checkCaseStatement()	0	32	5

<?php
/**
 * @author Kévin Gomez https://github.com/K-Phoen <contact@kevingomez.fr>
 */

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt;
use PHPSA\Analyzer\Pass;
use PHPSA\Context;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

class MissingBreakStatement implements Pass\ConfigurablePassInterface, Pass\AnalyzerPassInterface
{
    /**
     * @param Stmt\Switch_ $switchStmt
     * @param Context $context
     * @return bool
     */
    public function pass(Stmt\Switch_ $switchStmt, Context $context)
    {
        $result = false;

        /** @var Stmt\Case_ $case */
        foreach ($switchStmt->cases as $case) {
            $result = $this->checkCaseStatement($case, $context) || $result;
        }

        return $result;
    }

    /**
     * @return TreeBuilder
     */
    public function getConfiguration()
    {
        $treeBuilder = new TreeBuilder();
        $treeBuilder->root('missing_break_statement')
            ->canBeDisabled()
        ;

        return $treeBuilder;
    }

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

    /**
     * @param Stmt\Case_ $case
     * @param Context $context
     * @return bool
     */
    private function checkCaseStatement(Stmt\Case_ $case, Context $context)
    {
        foreach ($case->stmts as $node) {
            // look for a break statement
            if ($node instanceof Stmt\Break_) {
                return false;
            }

            // or for a return
            if ($node instanceof Stmt\Return_) {
                // but emit a notice if it's empty.
                if (!$node->expr) {
                    $context->notice(
                        'missing_break_statement',
                        'Empty return in "case" statement',
                        $node
                    );
                    return true;
                }

                return false;
            }
        }

        $context->notice(
            'missing_break_statement',
            'Missing "break" statement',
            $case
        );

        return true;
    }
}