Add rule to convert phpunit methods to snake case

Author: Xammie

rules-tests/CodeQuality/Rector/ClassMethod/PreferTestsWithSnakeCaseRector/Fixture/rename.php.inc

@@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\PreferTestsWithSnakeCaseRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class RenameTest extends TestCase
+{
+    public function testMe()
+    {
+    }
+
+    public function testThisIsALongTestCase()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\PreferTestsWithSnakeCaseRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class RenameTest extends TestCase
+{
+    public function test_me()
+    {
+    }
+
+    public function test_this_is_a_long_test_case()
+    {
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/PreferTestsWithSnakeCaseRector/PreferTestsWithSnakeCaseRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\PreferTestsWithSnakeCaseRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class PreferTestsWithSnakeCaseRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/PreferTestsWithSnakeCaseRector/config/configured_rule.php

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

rules/CodeQuality/Rector/ClassMethod/PreferTestsWithSnakeCaseRector.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\PreferTestsWithSnakeCaseRector\PreferTestsWithSnakeCaseRectorTest
+ */
+final class PreferTestsWithSnakeCaseRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Changes PHPUnit tests methods to snake case', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeClass extends TestCase
+{
+    public function testSomething()
+    {
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeClass extends TestCase
+{
+    public function test_something()
+    {
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        if (! $this->testsNodeAnalyzer->isTestClassMethod($node)) {
+            return null;
+        }
+
+        $currentName = $node->name->toString();
+        $newName = $this->toSnakeCase($currentName);
+
+        if ($currentName === $newName) {
+            return null;
+        }
+
+        $node->name = new Node\Identifier($newName);
+
+        return $node;
+    }
+
+    public function toSnakeCase(string $value): string
+    {
+        if (ctype_lower($value)) {
+            return $value;
+        }
+
+        $value = (string) preg_replace('/\s+/u', '', ucwords($value));
+        $value = (string) preg_replace('/(.)(?=[A-Z])/u', '$1_', $value);
+
+        return strtolower($value);
+    }
+}