[RemoveTestSuffixFromAbstractTestClassesRector] Add new rule (#132)

src/Rector/ClassLike/RemoveTestSuffixFromAbstractTestClassesRector.php

@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Rector\ClassLike;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassLike;
+use Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see Rector\PHPUnit\Tests\Rector\ClassLike\RemoveTestSuffixFromAbstractTestClassesRector\RemoveTestSuffixFromAbstractTestClassesRectorTest
+ */
+final class RemoveTestSuffixFromAbstractTestClassesRector extends AbstractRector
+{
+    public function __construct(
+        private readonly RemovedAndAddedFilesCollector $removedAndAddedFilesCollector,
+    )
+    {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Rename Suffix for abstract test class as it may not end with directory suffix (default is Test)', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+// app/ReplaceAbstractClassWithSuffixTest.php
+abstract class ReplaceAbstractClassWithSuffixTest
+{
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+// app/ReplaceAbstractClassWithSuffixTestCase.php
+abstract class ReplaceAbstractClassWithSuffixTestCase
+{
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassLike::class];
+    }
+
+    /**
+     * @param ClassLike $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (!$node->isAbstract()) {
+            return null;
+        }
+        $directorySuffix = $this->getPhpUnitDirectorySuffix();
+
+        $filePath = $this->file->getFilePath();
+        $basename = pathinfo($filePath, PATHINFO_FILENAME);
+
+        if (!str_ends_with($basename, $directorySuffix)) {
+            return null;
+        }
+
+        $className = $this->getName($node);
+        if ($className === null) {
+            return null;
+        }
+
+        $classShortName = $this->nodeNameResolver->getShortName($className);
+        // no match → rename file
+        $newFileLocation = dirname($filePath) . DIRECTORY_SEPARATOR . $classShortName . 'Case.php';
+        $this->removedAndAddedFilesCollector->addMovedFile($this->file, $newFileLocation);
+
+
+        return null;
+    }
+
+    private function getPhpUnitDirectorySuffix(): string
+    {
+        // TODO check in phpunit config if this is different.
+        return 'Test';
+    }
+}

tests/Rector/ClassLike/RemoveTestSuffixFromAbstractTestClassesRector/Fixture/replace_abstract_class_with_suffix_test.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+namespace Rector\PHPUnit\Tests\Rector\ClassLike\RemoveTestSuffixFromAbstractTestClassesRector\Fixture;
+
+abstract class ReplaceAbstractClassWithSuffixTest
+{
+}

tests/Rector/ClassLike/RemoveTestSuffixFromAbstractTestClassesRector/Fixture/skip_abstract_class_without_suffix.php.inc

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+namespace Rector\PHPUnit\Tests\Rector\ClassLike\RemoveTestSuffixFromAbstractTestClassesRector\Fixture;
+
+abstract class SkipAbstractClassWithoutSuffix
+{
+}

tests/Rector/ClassLike/RemoveTestSuffixFromAbstractTestClassesRector/RemoveTestSuffixFromAbstractTestClassesRectorTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\Rector\ClassLike\RemoveTestSuffixFromAbstractTestClassesRector;
+
+use Iterator;
+use Nette\Utils\FileSystem;
+use Rector\FileSystemRector\ValueObject\AddedFileWithContent;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Webmozart\Assert\Assert;
+
+final class RemoveTestSuffixFromAbstractTestClassesRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+
+        Assert::string($this->originalTempFilePath);
+        $originalDirectory = dirname($this->originalTempFilePath);
+
+        $expectedAddedFileWithContent = new AddedFileWithContent(
+            $originalDirectory . '/ReplaceAbstractClassWithSuffixTestCase.php',
+            FileSystem::read(__DIR__ . '/Fixture/replace_abstract_class_with_suffix_test.php.inc')
+        );
+        $this->assertFileWasAdded($expectedAddedFileWithContent);
+
+//        $expectedAddedFileWithContent = new AddedFileWithContent(
+//            $originalDirectory . '/SkipAbstractClassWithoutSuffix.php',
+//            FileSystem::read(__DIR__ . '/Fixture/skip_abstract_class_without_suffix.php.inc')
+//        );
+//        $this->assertFileWasAdded($expectedAddedFileWithContent);
+    }
+
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/Rector/ClassLike/RemoveTestSuffixFromAbstractTestClassesRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\Rector\ClassLike\RemoveTestSuffixFromAbstractTestClassesRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(RemoveTestSuffixFromAbstractTestClassesRector::class);
+};