wip

Author: pxpm

src/app/Console/Commands/Upgrade/Concerns/ExtractsFirstInteger.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Backpack\CRUD\app\Console\Commands\Upgrade\Concerns;
+
+trait ExtractsFirstInteger
+{
+    /**
+     * Extract the first integer occurrence from the given string.
+     */
+    protected function extractFirstInteger(string $value): ?int
+    {
+        if (preg_match('/(\d+)/', $value, $matches)) {
+            return (int) $matches[1];
+        }
+
+        return null;
+    }
+}

src/app/Console/Commands/Upgrade/Step.php

@@ -2,8 +2,12 @@
 
 namespace Backpack\CRUD\app\Console\Commands\Upgrade;
 
+use Backpack\CRUD\app\Console\Commands\Upgrade\Concerns\ExtractsFirstInteger;
+
 abstract class Step
 {
+    use ExtractsFirstInteger;
+
     public function __construct(protected UpgradeContext $context)
     {
     }

src/app/Console/Commands/Upgrade/UpgradeCommand.php

@@ -3,12 +3,13 @@
 namespace Backpack\CRUD\app\Console\Commands\Upgrade;
 
 use Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+use Backpack\CRUD\app\Console\Commands\Upgrade\Concerns\ExtractsFirstInteger;
 use Illuminate\Console\Command;
 use RuntimeException;
 
 class UpgradeCommand extends Command
 {
-    use PrettyCommandOutput;
+    use PrettyCommandOutput, ExtractsFirstInteger;
 
     protected $signature = 'backpack:upgrade
                                 {version=7 : Target Backpack version to prepare for.}
@@ -114,21 +115,30 @@ public function handle(): int
             }
         }
 
-        return $this->outputSummary($majorVersion, $results);
+        $expectedVersionInstalled = $this->hasExpectedBackpackVersion($context, $config);
+
+        return $this->outputSummary($majorVersion, $results, $expectedVersionInstalled, $config);
     }
 
-    protected function outputSummary(string $majorVersion, array $results): int
+    protected function outputSummary(
+        string $majorVersion,
+        array $results,
+        bool $expectedVersionInstalled = false,
+        ?UpgradeConfigInterface $config = null
+    ): int
     {
         $format = $this->outputFormat();
 
-        $hasFailure = collect($results)->contains(function ($entry) {
+        $resultsCollection = collect($results);
+
+        $hasFailure = $resultsCollection->contains(function ($entry) {
             /** @var StepResult $result */
             $result = $entry['result'];
 
             return $result->status->isFailure();
         });
 
-        $warnings = collect($results)->filter(function ($entry) {
+        $warnings = $resultsCollection->filter(function ($entry) {
             /** @var StepResult $result */
             $result = $entry['result'];
 
@@ -174,6 +184,20 @@ protected function outputSummary(string $majorVersion, array $results): int
             $this->note('All checks passed, you are ready to continue with the manual steps from the upgrade guide.', 'green', 'green');
         }
 
+        $postUpgradeCommands = [];
+
+        if ($config !== null) {
+            $postUpgradeCommands = ($config)::postUpgradeCommands();
+        }
+
+        if ($expectedVersionInstalled && ! $hasFailure && ! empty($postUpgradeCommands)) {
+            $this->note("Now that you have v{$majorVersion} installed, don't forget to run the following commands:", 'green', 'green');
+
+            foreach ($postUpgradeCommands as $command) {
+                $this->note($command);
+            }
+        }
+
         $this->newLine();
 
         return $hasFailure ? Command::FAILURE : Command::SUCCESS;
@@ -267,4 +291,35 @@ protected function extractMajorVersion(string $version): string
 
         return $version;
     }
+
+    protected function hasExpectedBackpackVersion(UpgradeContext $context, UpgradeConfigInterface $config): bool
+    {
+        $targetConstraint = $config::backpackCrudRequirement();
+        $targetMajor = $this->extractFirstInteger($targetConstraint);
+
+        $composerConstraint = $context->composerRequirement('backpack/crud');
+
+        if ($composerConstraint === null) {
+            return false;
+        }
+
+        $composerMajor = $this->extractFirstInteger($composerConstraint);
+
+        if ($targetMajor !== null && ($composerMajor === null || $composerMajor < $targetMajor)) {
+            return false;
+        }
+
+        $installedMajor = $context->packageMajorVersion('backpack/crud');
+
+        if ($installedMajor === null) {
+            return false;
+        }
+
+        if ($targetMajor !== null && $installedMajor < $targetMajor) {
+            return false;
+        }
+
+        return true;
+    }
+
 }

src/app/Console/Commands/Upgrade/UpgradeConfigInterface.php

@@ -15,4 +15,9 @@ public function steps(): array;
     public function addons(): array;
 
     public static function backpackCrudRequirement(): string;
+
+    /**
+     * @return array<int, string>
+     */
+    public static function postUpgradeCommands(): array;
 }

src/app/Console/Commands/Upgrade/v7/Steps/EnsureBackpackCrudRequirementStep.php

@@ -33,10 +33,17 @@ public function run(): StepResult
         }
 
         $requiredMajor = $this->extractFirstInteger($constraint);
-
         $targetConstraint = $this->targetConstraint();
+        $targetMajor = $this->targetMajor();
 
-        if ($requiredMajor === null || $requiredMajor < 7) {
+        if ($requiredMajor === null) {
+            return StepResult::failure(
+                sprintf('Update composer.json to require backpack/crud:%s (or newer).', $targetConstraint),
+                ["Current constraint: {$constraint}"]
+            );
+        }
+
+        if ($targetMajor !== null && $requiredMajor < $targetMajor) {
             return StepResult::failure(
                 sprintf('Update composer.json to require backpack/crud:%s (or newer).', $targetConstraint),
                 ["Current constraint: {$constraint}"]
@@ -46,25 +53,21 @@ public function run(): StepResult
         $installedMajor = $this->context()->packageMajorVersion('backpack/crud');
         $installedPretty = $this->context()->installedPackagePrettyVersion('backpack/crud');
 
-        if ($installedMajor !== null && $installedMajor < 7) {
+        $comparisonMajor = $targetMajor ?? $requiredMajor;
+
+        if ($comparisonMajor !== null && $installedMajor !== null && $installedMajor < $comparisonMajor) {
             return StepResult::warning(
-                'Composer requirement is updated, but Backpack v7 is not installed yet. Run composer update.',
+                sprintf(
+                    'Composer requirement is updated, but a Backpack version satisfying %s is not installed yet. Run composer update.',
+                    $targetConstraint
+                ),
                 ["Installed version: {$installedPretty}"]
             );
         }
 
         return StepResult::success("Composer.json requires backpack/crud {$constraint}.");
     }
 
-    protected function extractFirstInteger(string $value): ?int
-    {
-        if (preg_match('/(\d+)/', $value, $matches)) {
-            return (int) $matches[1];
-        }
-
-        return null;
-    }
-
     public function canFix(StepResult $result): bool
     {
         if ($result->status !== StepStatus::Failed) {
@@ -80,8 +83,13 @@ public function canFix(StepResult $result): bool
         }
 
         $requiredMajor = $this->extractFirstInteger($this->currentConstraint);
+        $targetMajor = $this->targetMajor();
 
-        return $requiredMajor === null || $requiredMajor < 7;
+        if ($targetMajor === null) {
+            return $requiredMajor === null;
+        }
+
+        return $requiredMajor === null || $requiredMajor < $targetMajor;
     }
 
     public function fixMessage(StepResult $result): string
@@ -114,4 +122,15 @@ private function targetConstraint(): string
     {
         return UpgradeCommandConfig::backpackCrudRequirement();
     }
+
+    private function targetMajor(): ?int
+    {
+        $constraintMajor = $this->extractFirstInteger($this->targetConstraint());
+
+        if ($constraintMajor !== null) {
+            return $constraintMajor;
+        }
+
+        return $this->extractFirstInteger($this->context()->targetVersion());
+    }
 }

src/app/Console/Commands/Upgrade/v7/Steps/EnsureFirstPartyAddonsAreCompatibleStep.php

@@ -67,15 +67,6 @@ protected function matchesExpectedConstraint(string $constraint, string $expecte
         return trim($constraint) === trim($expected);
     }
 
-    protected function extractFirstInteger(string $value): ?int
-    {
-        if (preg_match('/(\d+)/', $value, $matches)) {
-            return (int) $matches[1];
-        }
-
-        return null;
-    }
-
     public function canFix(StepResult $result): bool
     {
         return $result->status === StepStatus::Warning && ! empty($this->mismatched);

src/app/Console/Commands/Upgrade/v7/UpgradeCommandConfig.php

@@ -60,4 +60,14 @@ public static function backpackCrudRequirement(): string
     {
         return '^7.0.0-beta';
     }
+
+    public static function postUpgradeCommands(): array
+    {
+        return [
+            'php artisan basset:clear',
+            'php artisan config:clear',
+            'php artisan cache:clear',
+            'php artisan view:clear',
+        ];
+    }
 }