RemoveOverrideFinalConstructTestCaseRector.php

<?php

declare(strict_types=1);

namespace Rector\PHPUnit\PHPUnit120\Rector\Class_;

use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Rector\AbstractRector;
use Rector\ValueObject\MethodName;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\RemoveOverrideFinalConstructTestCaseRector\RemoveOverrideFinalConstructTestCaseRectorTest
 */
final class RemoveOverrideFinalConstructTestCaseRector extends AbstractRector
{
    public function __construct(
        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
    ) {
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(
            'Remove override final construct test case',
            [
                new CodeSample(
                    <<<'CODE_SAMPLE'
                    use PHPUnit\Framework\TestCase;

                    final class SomeClass extends TestCase
                    {
                        public function __construct()
                        {
                            parent::__construct(static::class);
                        }
                    }
                    CODE_SAMPLE
                    ,
                    <<<'CODE_SAMPLE'
                    use PHPUnit\Framework\TestCase;

                    final class SomeClass extends TestCase
                    {
                    }
                    CODE_SAMPLE
                    ,
                ),
            ],
        );
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [Class_::class];
    }

    /**
     * @param Class_ $node
     */
    public function refactor(Node $node): Node|null
    {
        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
            return null;
        }

        $constructClassMethod = $node->getMethod(MethodName::CONSTRUCT);

        if ($constructClassMethod instanceof ClassMethod) {
            foreach ($node->stmts as $key => $stmt) {
                if ($stmt instanceof ClassMethod && $this->isName($stmt, MethodName::CONSTRUCT)) {
                    unset($node->stmts[$key]);

                    $node->setAttribute('hasRemovedFinalConstruct', true);
                    return $node;
                }
            }
        }

        return null;
    }
}