add command to upgrade using Rector

Author: Treggats

rector.php

@@ -5,20 +5,19 @@
 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;
 use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
 use Rector\Php74\Rector\Property\RestoreDefaultNullToNullableTypePropertyRector;
-use Rector\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector;
 use Rector\Php81\Rector\Array_\FirstClassCallableRector;
 use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
 use Rector\Php81\Rector\Property\ReadOnlyPropertyRector;
 use Rector\Php82\Rector\Class_\ReadOnlyClassRector;
 use Rector\Php82\Rector\Param\AddSensitiveParameterAttributeRector;
 use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
 use Rector\Php84\Rector\Param\ExplicitNullableParamTypeRector;
+use Rector\Renaming\Rector\Name\RenameClassRector;
 use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
 use Rector\TypeDeclaration\Rector\Closure\ClosureReturnTypeRector;
@@ -36,6 +35,9 @@
             'secret',
         ],
     ])
+    ->withConfiguredRule(RenameClassRector::class, [
+        'Tempest\\Database\\Id' => 'Tempest\\Database\\PrimaryKey',
+    ])
     ->withRules([
         ExplicitNullableParamTypeRector::class,
     ])

src/Tempest/Framework/Commands/UpgradeCommand.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Framework\Commands;
+
+use Composer\Semver\Semver;
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Process;
+use Tempest\Console\Console;
+use Tempest\Console\ConsoleArgument;
+use Tempest\Console\ConsoleCommand;
+use Tempest\Console\ExitCode;
+use Tempest\Container\Singleton;
+use Tempest\Core\Kernel;
+
+#[Singleton]
+final readonly class UpgradeCommand
+{
+    public function __construct(
+        private Console $console,
+    ) {}
+
+    #[ConsoleCommand(
+        name: 'upgrade:tempest',
+        description: 'Upgrades the application to the latest version',
+    )]
+    public function __invoke(
+        #[ConsoleArgument(description: 'Upgrade to a specific version', help: 'If not specified, the latest version is used')]
+        string $version = Kernel::VERSION,
+        #[ConsoleArgument(description: 'Dry run the upgrade')]
+        bool $dryRun = false,
+        #[ConsoleArgument(description: 'Verbose output')]
+        bool $_verbose = false,
+    ): ExitCode {
+        $command = 'vendor/bin/rector --no-ansi --no-progress-bar --no-diffs';
+        if ($dryRun) {
+            $this->console->info('Dry run enabled');
+            $command .= ' --dry-run';
+        }
+
+        $rectors = $this->getRectorsForVersion($version);
+        if (! $rectors->valid()) {
+            $this->console->info('No rectors found for this version');
+
+            return ExitCode::SUCCESS;
+        }
+
+        foreach ($rectors as $rule) {
+            $command .= " --only=\"{$rule}\"";
+        }
+
+        $this->console->info("Running <code>{$command}</code>");
+        try {
+            $processed = Process::fromShellCommandline($command)->mustRun();
+        } catch (ProcessFailedException $e) {
+            $this->console->error($e->getProcess()->getErrorOutput());
+
+            return ExitCode::ERROR;
+        }
+
+        $this->console->info(trim($processed->getOutput()));
+
+        return ExitCode::SUCCESS;
+    }
+
+    private function getRectorsForVersion(string $version): \Generator
+    {
+        return match (true) {
+            Semver::satisfies($version, '^1.0.0') => [
+            ],
+            Semver::satisfies($version, '^2.0.0') => [
+                yield 'Rector\Renaming\Rector\Name\RenameClassRector',
+            ],
+            default => [],
+        };
+    }
+}

tests/Integration/Console/Commands/UpgradeCommandTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Integration\Console\Commands;
+
+use PHPUnit\Framework\Attributes\Test;
+use Tempest\Console\ExitCode;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+class UpgradeCommandTest extends FrameworkIntegrationTestCase
+{
+    #[Test]
+    public function no_upgrades_for_v1(): void
+    {
+        $this->console
+            ->call('upgrade:tempest', ['version' => 'v1.0.0', 'dry-run' => true])
+            ->assertContains(' No rectors found for this version')
+            ->assertExitCode(ExitCode::SUCCESS);
+
+    }
+
+    #[Test]
+    public function upgrade_to_v2(): void
+    {
+        $this->console
+            ->call('upgrade:tempest', ['version' => 'v2.0.0', 'dry-run' => true])
+            ->assertContains('vendor/bin/rector --no-ansi --no-progress-bar --no-diffs --dry-run --only="Rector\Renaming\Rector\Name\RenameClassRector"')
+            ->assertContains('[OK] Rector is done!')
+            ->dump()
+            ->assertExitCode(ExitCode::SUCCESS);
+    }
+}