add custom Rector to rename Id to PrimaryKey

Author: Treggats

composer.json

@@ -143,7 +143,9 @@
             "Tempest\\Support\\": "packages/support/src",
             "Tempest\\Validation\\": "packages/validation/src",
             "Tempest\\View\\": "packages/view/src",
-            "Tempest\\Vite\\": "packages/vite/src"
+            "Tempest\\Vite\\": "packages/vite/src",
+            "Utils\\Rector\\Rector\\": "utils/rector/src/Rector",
+            "Utils\\Rector\\Tests\\Rector\\": "utils/rector/tests/Rector/"
         },
         "files": [
             "packages/clock/src/functions.php",
@@ -177,7 +179,8 @@
             "packages/support/src/Str/functions.php",
             "packages/support/src/functions.php",
             "packages/view/src/functions.php",
-            "packages/vite/src/functions.php"
+            "packages/vite/src/functions.php",
+            "vendor/rector/rector/preload.php"
         ]
     },
     "autoload-dev": {

phpunit.xml.dist

@@ -17,6 +17,9 @@
     <testsuite name="Unit">
       <directory suffix="Test.php">packages/**/tests</directory>
     </testsuite>
+      <testsuite name="Rector">
+          <directory suffix="Test.php">utils/rector/tests</directory>
+      </testsuite>
   </testsuites>
   <coverage />
   <source>

rector.php

@@ -5,7 +5,6 @@
 use Rector\Arguments\Rector\ClassMethod\ArgumentAdderRector;
 use Rector\Caching\ValueObject\Storage\FileCacheStorage;
 use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
-use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector;
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector;
 use Rector\Php70\Rector\StaticCall\StaticCallOnNonStaticToInstanceCallRector;
@@ -23,6 +22,7 @@
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
 use Rector\TypeDeclaration\Rector\Closure\ClosureReturnTypeRector;
 use Rector\TypeDeclaration\Rector\Empty_\EmptyOnNullableObjectToInstanceOfRector;
+use Utils\Rector\Rector\RenameIdToPrimaryKeyRector;
 
 return RectorConfig::configure()
     ->withCache('./.cache/rector', FileCacheStorage::class)
@@ -38,6 +38,7 @@
     ])
     ->withRules([
         ExplicitNullableParamTypeRector::class,
+        RenameIdToPrimaryKeyRector::class,
     ])
     ->withSkip([
         AddOverrideAttributeToOverriddenMethodsRector::class,

utils/rector/src/Rector/RenameIdToPrimaryKeyRector.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Utils\Rector\Rector;
+
+use Composer\Semver\Semver;
+use PhpParser\Node;
+use PhpParser\Node\Name as NodeName;
+use PhpParser\Node\Name\FullyQualified as FullyQualifiedNodeName;
+use PhpParser\Node\Stmt\Property as PropertyStatement;
+use Rector\Rector\AbstractRector;
+use Tempest\Core\Kernel;
+
+/**
+ * @see \Utils\Rector\Tests\TypeDeclaration\Rector\RenameIdToPrimaryKeyRector\RenameIdToPrimaryKeyRectorTest
+ */
+final class RenameIdToPrimaryKeyRector extends AbstractRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [PropertyStatement::class];
+    }
+
+    /**
+     * @param PropertyStatement $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! Semver::satisfies(Kernel::VERSION, '^2.0.0')) {
+            return null;
+        }
+
+        if ($node->type === null) {
+            return null;
+        }
+
+        if (! ($node->type instanceof NodeName)) {
+            return null;
+        }
+
+        $className = $node->type->toString();
+        if ($className !== 'Tempest\\Database\\Id') {
+            return null;
+        }
+
+        $node->type = new FullyQualifiedNodeName('Tempest\\Database\\PrimaryKey');
+
+        return $node;
+    }
+}

utils/rector/tests/Rector/RenameIdToPrimaryKeyRector/Fixture/some_class.php.inc

@@ -0,0 +1,37 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\RenameIdToPrimaryKeyRector\Fixture;
+
+use Tempest\Database\Id;
+
+final class Publisher
+{
+    use IsDatabaseModel;
+
+    public Id $id;
+
+    public string $name;
+
+    public string $description;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\RenameIdToPrimaryKeyRector\Fixture;
+
+use Tempest\Database\PrimaryKey;
+
+final class Publisher
+{
+    use IsDatabaseModel;
+
+    public PrimaryKey $id;
+
+    public string $name;
+
+    public string $description;
+}
+
+?>

utils/rector/tests/Rector/RenameIdToPrimaryKeyRector/RenameIdToPrimaryKeyRectorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Utils\Rector\Tests\Rector\RenameIdToPrimaryKeyRector;
+
+use Composer\Semver\Semver;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Tempest\Core\Kernel;
+
+final class RenameIdToPrimaryKeyRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        if (! Semver::satisfies(Kernel::VERSION, '^2.0.0')) {
+            $this->markTestSkipped('This test is only relevant for Tempest 2.0.0 and above.');
+        }
+
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): \Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

utils/rector/tests/Rector/RenameIdToPrimaryKeyRector/config/configured_rule.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Utils\Rector\Rector\RenameIdToPrimaryKeyRector;
+
+return RectorConfig::configure()->withRules([
+    RenameIdToPrimaryKeyRector::class,
+])
+    ->withImportNames(
+        importDocBlockNames: false,
+        importShortClasses: false,
+        removeUnusedImports: true
+    );