rector/rules/early-return/src/Rector/Return_/PreparedValueToEarlyReturnRector.php

<?php

declare(strict_types=1);

namespace Rector\EarlyReturn\Rector\Return_;

use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\If_;
use PhpParser\Node\Stmt\Return_;
use Rector\Core\NodeManipulator\IfManipulator;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Rector\EarlyReturn\Tests\Rector\Return_\PreparedValueToEarlyReturnRector\PreparedValueToEarlyReturnRectorTest
 */
final class PreparedValueToEarlyReturnRector extends AbstractRector
{
    /**
     * @var IfManipulator
     */
    private $ifManipulator;

    public function __construct(IfManipulator $ifManipulator)
    {
        $this->ifManipulator = $ifManipulator;
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Return early prepared value in ifs', [
            new CodeSample(
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function run()
    {
        $var = null;

        if (rand(0,1)) {
            $var = 1;
        }

        if (rand(0,1)) {
            $var = 2;
        }

        return $var;
    }
}
CODE_SAMPLE

                ,
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function run()
    {
        if (rand(0,1)) {
            return 1;
        }

        if (rand(0,1)) {
            return 2;
        }

        return null;
    }
}
CODE_SAMPLE
            ),
        ]);
    }

    /**
     * @return string[]
     */
    public function getNodeTypes(): array
    {
        return [Return_::class];
    }

    /**
     * @param Return_ $node
     */
    public function refactor(Node $node): ?Node
    {
        $ifsBefore = $this->getIfsBefore($node);

        if ($this->shouldSkip($ifsBefore, $node->expr)) {
            return null;
        }

        if ($this->isAssignVarUsedInIfCond($ifsBefore, $node->expr)) {
            return null;
        }

        /** @var Expr $returnExpr */
        $returnExpr = $node->expr;
        /** @var Expression $previousFirstExpression */
        $previousFirstExpression = $this->getPreviousIfLinearEquals($ifsBefore[0], $returnExpr);
        /** @var Assign $previousAssign */
        $previousAssign = $previousFirstExpression->expr;

        if ($this->isPreviousVarUsedInAssignExpr($ifsBefore, $previousAssign->var)) {
            return null;
        }

        foreach ($ifsBefore as $ifBefore) {
            /** @var Expression $expressionIf */
            $expressionIf = $ifBefore->stmts[0];
            /** @var Assign $assignIf */
            $assignIf = $expressionIf->expr;

            $ifBefore->stmts[0] = new Return_($assignIf->expr);
        }

        /** @var Assign $assignPrevious */
        $assignPrevious = $previousFirstExpression->expr;
        $node->expr = $assignPrevious->expr;
        $this->removeNode($previousFirstExpression);

        return $node;
    }

    /**
     * @param If_[] $ifsBefore
     */
    private function isAssignVarUsedInIfCond(array $ifsBefore, ?Expr $expr): bool
    {
        foreach ($ifsBefore as $ifBefore) {
            $isUsedInIfCond = (bool) $this->betterNodeFinder->findFirst($ifBefore->cond, function (Node $node) use (
                $expr
            ): bool {
                return $this->nodeComparator->areNodesEqual($node, $expr);
            });

            if ($isUsedInIfCond) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param If_[] $ifsBefore
     */
    private function isPreviousVarUsedInAssignExpr(array $ifsBefore, Expr $expr): bool
    {
        foreach ($ifsBefore as $ifBefore) {
            /** @var Expression $expression */
            $expression = $ifBefore->stmts[0];
            /** @var Assign $assign */
            $assign = $expression->expr;

            $isUsedInAssignExpr = (bool) $this->betterNodeFinder->findFirst($assign->expr, function (Node $node) use (
                $expr
            ): bool {
                return $this->nodeComparator->areNodesEqual($node, $expr);
            });

            if ($isUsedInAssignExpr) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param If_[] $ifsBefore
     */
    private function shouldSkip(array $ifsBefore, ?Expr $returnExpr): bool
    {
        if ($ifsBefore === []) {
            return true;
        }

        return ! (bool) $this->getPreviousIfLinearEquals($ifsBefore[0], $returnExpr);
    }

    private function getPreviousIfLinearEquals(?Node $node, ?Expr $expr): ?Expression
    {
        if (! $node instanceof Node) {
            return null;
        }

        if (! $expr instanceof Expr) {
            return null;
        }

        $previous = $node->getAttribute(AttributeKey::PREVIOUS_NODE);
        if (! $previous instanceof Expression) {
            return $this->getPreviousIfLinearEquals($previous, $expr);
        }

        if (! $previous->expr instanceof Assign) {
            return null;
        }

        if ($this->nodeComparator->areNodesEqual($previous->expr->var, $expr)) {
            return $previous;
        }

        return null;
    }

    /**
     * @return If_[]
     */
    private function getIfsBefore(Return_ $return): array
    {
        $parent = $return->getAttribute(AttributeKey::PARENT_NODE);
        if (! $parent instanceof FunctionLike && ! $parent instanceof If_) {
            return [];
        }

        if (! (property_exists($parent, 'stmts') && $parent->stmts !== null)) {
            return [];
        }

        if ($parent->stmts[(is_countable($parent->stmts) ? count($parent->stmts) : 0) - 1] !== $return) {
            return [];
        }

        return $this->collectIfs($parent->stmts, $return);
    }

    /**
     * @param If_[] $stmts
     * @return If_[]
     */
    private function collectIfs(array $stmts, Return_ $return): array
    {
        /** @va If_[] $ifs */
        $ifs = $this->betterNodeFinder->findInstanceOf($stmts, If_::class);

        /** Skip entirely if found skipped ifs */
        foreach ($ifs as $if) {
            /** @var If_ $if */
            if (! $this->ifManipulator->isIfWithoutElseAndElseIfs($if)) {
                return [];
            }

            $stmts = $if->stmts;
            if (count($stmts) !== 1) {
                return [];
            }

            $expression = $stmts[0];
            if (! $expression instanceof Expression) {
                return [];
            }

            if (! $expression->expr instanceof Assign) {
                return [];
            }

            $assign = $expression->expr;
            if (! $this->nodeComparator->areNodesEqual($assign->var, $return->expr)) {
                return [];
            }
        }

        return $ifs;
    }
}