rector/vendor/rector/rector-laravel/src/Rector/MethodCall/RemoveAllOnDispatchingMethodsWithJobChainingRector.php

<?php

declare (strict_types=1);
namespace Rector\Laravel\Rector\MethodCall;

use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Identifier;
use PHPStan\Type\ObjectType;
use Rector\Core\Rector\AbstractRector;
use Rector\Defluent\NodeAnalyzer\FluentChainMethodCallNodeAnalyzer;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
 * @see \Rector\Laravel\Tests\Rector\MethodCall\RemoveAllOnDispatchingMethodsWithJobChainingRector\RemoveAllOnDispatchingMethodsWithJobChainingRectorTest
 */
final class RemoveAllOnDispatchingMethodsWithJobChainingRector extends AbstractRector
{
    /**
     * @var string
     */
    private const DISPATCH = 'dispatch';
    /**
     * @var array<string, string>
     */
    private const SWAPPED_METHODS = ['allOnQueue' => 'onQueue', 'allOnConnection' => 'onConnection'];
    /**
     * @readonly
     * @var \Rector\Defluent\NodeAnalyzer\FluentChainMethodCallNodeAnalyzer
     */
    private $fluentChainMethodCallNodeAnalyzer;
    public function __construct(FluentChainMethodCallNodeAnalyzer $fluentChainMethodCallNodeAnalyzer)
    {
        $this->fluentChainMethodCallNodeAnalyzer = $fluentChainMethodCallNodeAnalyzer;
    }
    public function getRuleDefinition() : RuleDefinition
    {
        return new RuleDefinition('Remove allOnQueue() and allOnConnection() methods used with job chaining, use the onQueue() and onConnection() methods instead.', [new CodeSample(<<<'CODE_SAMPLE'
Job::withChain([
    new ChainJob(),
])
    ->dispatch()
    ->allOnConnection('redis')
    ->allOnQueue('podcasts');
CODE_SAMPLE
, <<<'CODE_SAMPLE'
Job::withChain([
    new ChainJob(),
])
    ->onQueue('podcasts')
    ->onConnection('redis')
    ->dispatch();
CODE_SAMPLE
)]);
    }
    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes() : array
    {
        return [MethodCall::class];
    }
    /**
     * @param MethodCall $node
     */
    public function refactor(Node $node) : ?Node
    {
        if (!$this->isNames($node->name, \array_keys(self::SWAPPED_METHODS))) {
            return null;
        }
        $rootExpr = $this->fluentChainMethodCallNodeAnalyzer->resolveRootExpr($node);
        if (!$this->isObjectType($rootExpr, new ObjectType('Illuminate\\Foundation\\Bus\\Dispatchable'))) {
            return null;
        }
        // Note that this change only affects code using the withChain method.
        $callerNode = $rootExpr->getAttribute(AttributeKey::PARENT_NODE);
        if (!$callerNode instanceof StaticCall) {
            return null;
        }
        if (!$this->isName($callerNode->name, 'withChain')) {
            return null;
        }
        $names = $this->fluentChainMethodCallNodeAnalyzer->collectMethodCallNamesInChain($node);
        if (!\in_array(self::DISPATCH, $names, \true)) {
            return null;
        }
        // These methods should be called before calling the dispatch method.
        $end = $node->var;
        $current = $node->var;
        while ($current instanceof MethodCall) {
            if ($this->isName($current->name, self::DISPATCH)) {
                $var = $current->var;
                $current->var = $node;
                $node->name = new Identifier(self::SWAPPED_METHODS[$this->getName($node->name)]);
                $node->var = $var;
                break;
            }
            $current = $current->var;
        }
        return $end;
    }
}