CompleteMissingIfElseBracketRector.php

<?php

declare(strict_types=1);

namespace Rector\CodeQuality\Rector\If_;

use PhpParser\Node;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Else_;
use PhpParser\Node\Stmt\ElseIf_;
use PhpParser\Node\Stmt\If_;
use PhpParser\Token;
use Rector\Contract\Rector\HTMLAverseRectorInterface;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Rector\Tests\CodeQuality\Rector\If_\CompleteMissingIfElseBracketRector\CompleteMissingIfElseBracketRectorTest
 */
final class CompleteMissingIfElseBracketRector extends AbstractRector implements HTMLAverseRectorInterface
{
    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Complete missing if/else brackets', [
            new CodeSample(
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function run($value)
    {
        if ($value)
            return 1;
    }
}
CODE_SAMPLE

                ,
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function run($value)
    {
        if ($value) {
            return 1;
        }
    }
}
CODE_SAMPLE
            ),
        ]);
    }

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

    /**
     * @param If_|ElseIf_|Else_ $node
     */
    public function refactor(Node $node): ?Node
    {
        if ($this->isBareNewNode($node)) {
            return null;
        }

        $oldTokens = $this->file->getOldTokens();

        if ($this->isIfConditionFollowedByOpeningCurlyBracket($node, $oldTokens)) {
            return null;
        }

        // invoke reprint with brackets
        $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);

        return $node;
    }

    /**
     * @param Token[] $oldTokens
     */
    private function isIfConditionFollowedByOpeningCurlyBracket(If_|ElseIf_|Else_ $if, array $oldTokens): bool
    {
        $startStmt = current($if->stmts);
        if (! $startStmt instanceof Stmt) {
            return true;
        }

        $startTokenPos = $if->getStartTokenPos();
        $i = $startStmt->getStartTokenPos() - 1;
        $condEndTokenPos = $if instanceof Else_
            ? $startTokenPos
            : $if->cond->getEndTokenPos();

        while (isset($oldTokens[$i])) {
            if ($i === $condEndTokenPos) {
                return false;
            }

            if (in_array((string) $oldTokens[$i], ['{', ':'], true)) {
                // all good
                return true;
            }

            if ($i === $startTokenPos) {
                return false;
            }

            --$i;
        }

        return false;
    }

    private function isBareNewNode(If_|ElseIf_|Else_ $if): bool
    {
        $originalNode = $if->getAttribute(AttributeKey::ORIGINAL_NODE);
        if (! $originalNode instanceof Node) {
            return true;
        }

        // not defined, probably new if
        return $if->getStartTokenPos() === -1;
    }
}