ForbiddenNestedForeachWithEmptyStatementRule.php

<?php

declare(strict_types=1);

namespace Symplify\PHPStanRules\Rules;

use PhpParser\Node;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Foreach_;
use PhpParser\NodeFinder;
use PHPStan\Analyser\Scope;
use Symplify\Astral\Naming\SimpleNameResolver;
use Symplify\Astral\ValueObject\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Symplify\PHPStanRules\Tests\Rules\ForbiddenNestedForeachWithEmptyStatementRule\ForbiddenNestedForeachWithEmptyStatementRuleTest
 */
final class ForbiddenNestedForeachWithEmptyStatementRule extends AbstractSymplifyRule
{
    /**
     * @var string
     */
    public const ERROR_MESSAGE = 'Nested foreach with empty statement is not allowed';

    public function __construct(
        private NodeFinder $nodeFinder,
        private SimpleNameResolver $simpleNameResolver
    ) {
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [Foreach_::class];
    }

    /**
     * @param Foreach_ $node
     * @return string[]
     */
    public function process(Node $node, Scope $scope): array
    {
        if (! $this->isNextForeachWithEmptyStatement($node)) {
            return [];
        }

        return [self::ERROR_MESSAGE];
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(self::ERROR_MESSAGE, [
            new CodeSample(
                <<<'CODE_SAMPLE'
$collectedFileErrors = [];

foreach ($errors as $fileErrors) {
    foreach ($fileErrors as $fileError) {
        $collectedFileErrors[] = $fileError;
    }
}
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
$collectedFileErrors = [];

foreach ($fileErrors as $fileError) {
    $collectedFileErrors[] = $fileError;
}
CODE_SAMPLE
            ),
        ]);
    }

    private function isNextForeachWithEmptyStatement(Foreach_ $foreach): bool
    {
        $stmts = $this->nodeFinder->findInstanceOf($foreach->stmts, Stmt::class);
        if (! isset($stmts[0])) {
            return false;
        }

        $nestedForeach = $stmts[0];
        if (! $nestedForeach instanceof Foreach_) {
            return false;
        }

        $foreachVariable = $foreach->expr->getAttribute(AttributeKey::NEXT);
        if (! $foreachVariable instanceof Variable) {
            return false;
        }

        $nextForeachVariable = $nestedForeach->expr;
        if (! $nextForeachVariable instanceof Variable) {
            return false;
        }

        return $this->simpleNameResolver->areNamesEqual($foreachVariable, $nextForeachVariable);
    }
}