Getting class or namespace error when creating custom rector using the nesbot/carbon library

[aprat84]

Hi!

Just created my first custom rector. It works!
But I wanted to make things right, so followed the guide in the website, and structured the utils/rector directory, with my rector and tests.

What I don't understand is the error I get from 2 out of 3 fixtures.
All fixtures load some Carbon classes:

• one loads Carbon: no error at all
• one loads CarbonImmutable: throws error
• one loads both Carbon and CarbonImmutable: complains only about Carbon (the first in use order?)

Fixture example:

<?php

namespace Utils\Rector\Tests\Rector\EnsureCarbonTestNowIsReleasedRector\Fixture;

use Carbon\CarbonImmutable;
use PHPUnit\Framework\TestCase;

class ReleaseCarbonImmutable extends TestCase
{
    public function testSomeFunctionality()
    {
        CarbonImmutable::setTestNow('now');

        // Some code
    }
}

?>
-----
<?php

namespace Utils\Rector\Tests\Rector\EnsureCarbonTestNowIsReleasedRector\Fixture;

use Carbon\CarbonImmutable;
use PHPUnit\Framework\TestCase;

class ReleaseCarbonImmutable extends TestCase
{
    public function testSomeFunctionality()
    {
        CarbonImmutable::setTestNow('now');

        // Some code

        CarbonImmutable::setTestNow();
    }
}

?>

Error:

Utils\Rector\Tests\Rector\EnsureCarbonTestNowIsReleasedRector\EnsureCarbonTestNowIsReleasedRectorTest::test@/var/www/html/utils/rector/tests/Rector/EnsureCarbonTestNowIsReleasedRector/Fixture/release_carbon_immutable.php.inc with data ('/var/www/html/utils/rector/te...hp.inc')
RuntimeException: The autoloader expected class "Carbon\CarbonImmutable" to be defined in file
"/var/www/html/vendor/composer/../nesbot/carbon/src/Carbon/CarbonImmutable.php". 
The file was found but the class was not in it, the class name or namespace probably has a typo.

Obviously, the file exists and has the CarbonImmutable class in it!

[samsonasik]

Could you sure the EnsureCarbonTestNowIsReleasedRector code? Also, you probably have some autoload juggling issue, which usually resolved by register it https://getrector.com/documentation/static-reflection-and-autoload

[aprat84]

Sure!

I'm aware that this approach is too simplistic, and it probably has room for improvement, but it works for our tests.

Also, I have 3 "skip" fixtures that work well.

# utils/rector/src/Rector/EnsureCarbonTestNowIsReleasedRector.php

namespace Utils\Rector\Rector;

use Carbon\Carbon;
use Carbon\CarbonImmutable;
use PhpParser\Node;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Nop;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Rector\AbstractRector;

final class EnsureCarbonTestNowIsReleasedRector extends AbstractRector
{
    public function __construct(
        private readonly BetterNodeFinder $betterNodeFinder,
        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
    ) {
    }

    public function getNodeTypes(): array
    {
        return [ClassMethod::class];
    }

    /**
     * @param ClassMethod $node
     */
    public function refactor(Node $node): ?Node
    {
        if (null === $node->stmts || [] === $node->stmts) {
            return null;
        }

        if (!str_starts_with($this->getName($node->name) ?? '', 'test')) {
            return null;
        }

        if (!$this->testsNodeAnalyzer->isTestClassMethod($node)) {
            return null;
        }

        /** @var StaticCall|null $lastStaticCall */
        $lastStaticCall = null;

        $staticCalls = $this->betterNodeFinder->findInstanceOf($node->stmts, StaticCall::class);

        foreach ($staticCalls as $staticCall) {
            if (
                !$this->isName($staticCall->name, 'setTestNow') ||
                !$this->isNames($staticCall->class, [Carbon::class, CarbonImmutable::class])
            ) {
                continue;
            }

            $lastStaticCall = [] !== $staticCall->args ? $staticCall : null;
        }

        if (null === $lastStaticCall) {
            return null;
        }

        $node->stmts[] = new Nop();
        $node->stmts[] = new Expression(new StaticCall(clone $lastStaticCall->class, new Identifier('setTestNow')));

        return $node;
    }
}

[samsonasik]

Looking at the error, it seems came from Symfony's DebugClassLoader. Ensure nesbot/carbon CarbonImmutable is loaded early, probably something like this in composer.json

https://github.com/samsonasik/ErrorHeroModule/blob/ab7fc83da7072d9446f562503ad20644b059e04d/composer.json#L112-L114

[aprat84]

True, this looks like not a rector problem, but a symfony DebuClassLoader problem.

Indeed, if I disable the Symfony\Bridge\PhpUnit\SymfonyExtension phpunit extension, everything works!

Maybe I'll report this at the symfony repo..

Thanks!