rector/packages/Php/src/Rector/Each/ListEachRector.php

<?php declare(strict_types=1);

namespace Rector\Php\Rector\Each;

use PhpParser\Node;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\List_;
use PhpParser\Node\Stmt\Do_;
use PhpParser\Node\Stmt\Expression;
use Rector\NodeTypeResolver\Node\Attribute;
use Rector\Rector\AbstractRector;
use Rector\RectorDefinition\CodeSample;
use Rector\RectorDefinition\RectorDefinition;

/**
 * @source https://wiki.php.net/rfc/deprecations_php_7_2#each
 */
final class ListEachRector extends AbstractRector
{
    public function getDefinition(): RectorDefinition
    {
        return new RectorDefinition(
            'each() function is deprecated, use foreach() instead.',
            [
                new CodeSample(
                    <<<'CODE_SAMPLE'
list($key, $callback) = each($callbacks);
CODE_SAMPLE
                    ,
                    <<<'CODE_SAMPLE'
$key = key($opt->option);
$val = current($opt->option);
CODE_SAMPLE
                ),
            ]
        );
    }

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

    /**
     * @param Assign $node
     */
    public function refactor(Node $node): ?Node
    {
        if ($this->shouldSkip($node)) {
            return null;
        }

        /** @var List_ $listNode */
        $listNode = $node->var;

        /** @var FuncCall $eachFuncCall */
        $eachFuncCall = $node->expr;

        // only key: list($key, ) = each($values);
        if ($listNode->items[0] && $listNode->items[1] === null) {
            $keyFuncCall = $this->createFunction('key', $eachFuncCall->args);
            return new Assign($listNode->items[0]->value, $keyFuncCall);
        }

        // only value: list(, $value) = each($values);
        if ($listNode->items[1] && $listNode->items[0] === null) {
            $nextFuncCall = $this->createFunction('next', $eachFuncCall->args);
            $this->addNodeAfterNode($nextFuncCall, $node);

            $currentFuncCall = $this->createFunction('current', $eachFuncCall->args);
            return new Assign($listNode->items[1]->value, $currentFuncCall);
        }

        // both: list($key, $value) = each($values);
        // ↓
        // $key = key($values);
        // $value = current($values);
        // next($values); - only inside a loop
        $currentFuncCall = $this->createFunction('current', $eachFuncCall->args);
        $assignCurrentNode = new Assign($listNode->items[1]->value, $currentFuncCall);
        $this->addNodeAfterNode($assignCurrentNode, $node);

        if ($this->isInsideDoWhile($node)) {
            $nextFuncCall = $this->createFunction('next', $eachFuncCall->args);
            $this->addNodeAfterNode($nextFuncCall, $node);
        }

        $keyFuncCall = $this->createFunction('key', $eachFuncCall->args);
        return new Assign($listNode->items[0]->value, $keyFuncCall);
    }

    private function shouldSkip(Assign $assignNode): bool
    {
        if (! $this->isListToEachAssign($assignNode)) {
            return true;
        }

        // assign should be top level, e.g. not in a while loop
        if (! $assignNode->getAttribute(Attribute::PARENT_NODE) instanceof Expression) {
            return true;
        }

        /** @var List_ $listNode */
        $listNode = $assignNode->var;

        if (count($listNode->items) !== 2) {
            return true;
        }

        // empty list → cannot handle
        return $listNode->items[0] === null && $listNode->items[1] === null;
    }

    /**
     * Is inside the "do {} while ();" loop → need to add "next()"
     */
    private function isInsideDoWhile(Node $assignNode): bool
    {
        $parentNode = $assignNode->getAttribute(Attribute::PARENT_NODE);
        if (! $parentNode instanceof Expression) {
            return false;
        }

        $parentParentNode = $parentNode->getAttribute(Attribute::PARENT_NODE);

        return $parentParentNode instanceof Do_;
    }

    private function isListToEachAssign(Assign $assignNode): bool
    {
        if (! $assignNode->var instanceof List_) {
            return false;
        }

        return $assignNode->expr instanceof FuncCall && $this->isName($assignNode->expr, 'each');
    }
}