Rector rule to remove ray() before push to production

[sinnbeck]

I personally only use ray() to debug locally. I therefor think it would be nice with a simple rector rule to remove it from the codebase.

I have made a proof of concept but it might need some more work. This is my first rector rule, and the documentation is sparse.

<?php

declare(strict_types=1);

namespace App\Rector;

use PhpParser\Node;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Stmt\Expression;
use PhpParser\NodeTraverser;
use Rector\Core\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

final class RemoveRayCallRector extends AbstractRector
{

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition('Remove usages of ray() and any chained methods on it', [
            new CodeSample(
                <<<'CODE_SAMPLE'
ray()->method();
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
- ray()->method();
CODE_SAMPLE
            ),
        ]);
    }

    public function getNodeTypes(): array
    {
        return [Expression::class, MethodCall::class];
    }

    public function refactor(Node $node): int|Node|array|null
    {
        if (!$node->expr instanceof FuncCall && !$node instanceof MethodCall) {
            return null;
        }

        if ($node->expr instanceof FuncCall && $this->isNames($node->expr->name, ['ray', 'rd'])) {
            return NodeTraverser::REMOVE_NODE;
        }

        if ($node instanceof MethodCall && $this->isNames($node->var, ['ray', 'rd'])) {
            if ($this->isName($node->name, 'pass')) {
                return $node->args[0];
            }
            //This seems hacky as it just adds an empty ray() function
            // which is then removed by the first if check
            return $this->nodeFactory->createFuncCall('ray');

        }

        return null;
    }

}

It might be nice to add this into this repo so I can just load it in my rector config directly.

[sinnbeck]

A preview of a dry-run

[freekmurze]

Looks neat, have fun working on this!

[sinnbeck]

Thanks Freek. It seems that there isn't much excitement from people, so I wont make a PR. I might make a package instead once I am done :)