wip

Author: pxpm

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

@@ -27,6 +27,11 @@ public function canFix(StepResult $result): bool
         return false;
     }
 
+    public function fixMessage(StepResult $result): string
+    {
+        return 'Apply automatic fix?';
+    }
+
     public function fix(StepResult $result): StepResult
     {
         return StepResult::skipped('No automatic fix available.');

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

@@ -4,6 +4,7 @@
 
 use Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
 use Illuminate\Console\Command;
+use RuntimeException;
 
 class UpgradeCommand extends Command
 {
@@ -30,15 +31,22 @@ public function handle(): int
         $version = (string) $this->argument('version');
         $majorVersion = $this->extractMajorVersion($version);
 
-        $stepClasses = $this->resolveStepsForMajor($majorVersion);
+        try {
+            $config = $this->resolveConfigForMajor($majorVersion);
+        } catch (RuntimeException $exception) {
+            $this->errorBlock($exception->getMessage());
 
-        if (empty($stepClasses)) {
+            return Command::INVALID;
+        }
+
+        $stepClasses = $config->steps();
+            if (empty($stepClasses)) {
             $this->errorBlock("No automated checks registered for Backpack v{$majorVersion}.");
 
             return Command::INVALID;
         }
 
-        $context = new UpgradeContext($majorVersion);
+            $context = new UpgradeContext($majorVersion, addons: $config->addons());
 
         $this->infoBlock("Backpack v{$majorVersion} upgrade assistant", 'upgrade');
 
@@ -66,7 +74,9 @@ public function handle(): int
             $this->printResultDetails($result);
 
             if ($this->shouldOfferFix($step, $result)) {
-                $applyFix = $this->confirm('  Apply automatic fix?', false);
+                $question = trim($step->fixMessage($result));
+                $question = $question !== '' ? $question : 'Apply automatic fix?';
+                $applyFix = $this->confirm('  '.$question, false);
 
                 if ($applyFix) {
                     $this->progressBlock('Applying automatic fix');
@@ -213,22 +223,40 @@ protected function outputFormat(): string
         return $format !== '' ? $format : 'cli';
     }
 
-    protected function resolveStepsForMajor(string $majorVersion): array
+    protected function resolveConfigForMajor(string $majorVersion): UpgradeConfigInterface
     {
-        return match ($majorVersion) {
-            '7' => [
-                v7\Steps\EnsureLaravelVersionStep::class,
-                v7\Steps\EnsureBackpackCrudRequirementStep::class,
-                v7\Steps\EnsureMinimumStabilityStep::class,
-                v7\Steps\EnsureFirstPartyAddonsAreCompatibleStep::class,
-                v7\Steps\CheckShowOperationComponentStep::class,
-                v7\Steps\CheckOperationConfigFilesStep::class,
-                v7\Steps\CheckThemeTablerConfigStep::class,
-                v7\Steps\DetectDeprecatedWysiwygUsageStep::class,
-                v7\Steps\DetectEditorAddonRequirementsStep::class,
-            ],
-            default => [],
-        };
+        $configProviderClass = sprintf('%s\\v%s\\UpgradeCommandConfig', __NAMESPACE__, $majorVersion);
+
+        if (! class_exists($configProviderClass)) {
+            throw new RuntimeException(sprintf(
+                'Missing upgrade config provider for Backpack v%s. Please create %s.',
+                $majorVersion,
+                $configProviderClass
+            ));
+        }
+
+        $provider = $this->laravel
+            ? $this->laravel->make($configProviderClass)
+            : new $configProviderClass();
+
+        if (! $provider instanceof UpgradeConfigInterface) {
+            throw new RuntimeException(sprintf(
+                'Upgrade config provider [%s] must implement %s.',
+                $configProviderClass,
+                UpgradeConfigInterface::class
+            ));
+        }
+
+        $steps = $provider->steps();
+
+        if (! is_array($steps)) {
+            throw new RuntimeException(sprintf(
+                'Upgrade config provider [%s] must return an array of step class names.',
+                $configProviderClass
+            ));
+        }
+
+        return $provider;
     }
 
     protected function extractMajorVersion(string $version): string

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

@@ -0,0 +1,18 @@
+<?php
+
+namespace Backpack\CRUD\app\Console\Commands\Upgrade;
+
+interface UpgradeConfigInterface
+{
+    /**
+     * @return array<class-string<\Backpack\CRUD\app\Console\Commands\Upgrade\Step>>
+     */
+    public function steps(): array;
+
+    /**
+     * @return array<string, string>
+     */
+    public function addons(): array;
+
+    public static function backpackCrudRequirement(): string;
+}

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

@@ -30,20 +30,29 @@ class UpgradeContext
 
     protected array $searchableExtensions = ['php'];
 
+    protected array $addons = [];
+
     public function __construct(
         protected readonly string $targetVersion,
         ?Filesystem $filesystem = null,
-        ?string $basePath = null
+        ?string $basePath = null,
+        array $addons = []
     ) {
         $this->files = $filesystem ?? new Filesystem();
         $this->basePath = $this->normalizePath($basePath ?? $this->defaultBasePath());
+        $this->addons = $addons;
     }
 
     public function targetVersion(): string
     {
         return $this->targetVersion;
     }
 
+    public function addons(): array
+    {
+        return $this->addons;
+    }
+
     public function basePath(string $path = ''): string
     {
         $path = ltrim($path, '/\\');
@@ -234,6 +243,28 @@ public function writeFile(string $relativePath, string $contents): bool
         }
     }
 
+    public function deleteFile(string $relativePath): bool
+    {
+        $fullPath = $this->basePath($relativePath);
+
+        try {
+            if (! $this->files->exists($fullPath)) {
+                return true;
+            }
+
+            $this->files->delete($fullPath);
+            unset($this->fileCache[$relativePath]);
+
+            if ($relativePath === 'composer.json') {
+                $this->composerJson = [];
+            }
+
+            return true;
+        } catch (\Throwable $exception) {
+            return false;
+        }
+    }
+
     public function updateComposerJson(callable $callback): bool
     {
         $composer = $this->composerJson();

src/app/Console/Commands/Upgrade/v7/Concerns/InteractsWithCrudControllers.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Backpack\CRUD\app\Console\Commands\Upgrade\v7\Concerns;
+
+use Backpack\CRUD\app\Console\Commands\Upgrade\UpgradeContext;
+
+/**
+ * @mixin \Backpack\CRUD\app\Console\Commands\Upgrade\Step
+ */
+trait InteractsWithCrudControllers
+{
+    /**
+     * Filter a list of file paths to those that look like CrudControllers and optionally validate contents.
+     */
+    protected function filterCrudControllerPaths(array $paths, ?callable $contentsValidator = null): array
+    {
+        if (empty($paths)) {
+            return [];
+        }
+
+        $filtered = [];
+
+        foreach ($paths as $path) {
+            if (! $this->isCrudControllerPath($path)) {
+                continue;
+            }
+
+            $contents = $this->context()->readFile($path);
+
+            if ($contents === null) {
+                continue;
+            }
+
+            if ($contentsValidator !== null && $contentsValidator($contents, $path) !== true) {
+                continue;
+            }
+
+            $filtered[] = $path;
+        }
+
+        return $filtered;
+    }
+
+    /**
+     * Build a short list of preview lines for the provided paths.
+     */
+    protected function previewLines(array $paths, int $limit = 10, ?callable $formatter = null): array
+    {
+        if (empty($paths)) {
+            return [];
+        }
+
+        $formatter ??= static fn (string $path): string => "- {$path}";
+
+        $preview = array_slice($paths, 0, $limit);
+        $details = array_map($formatter, $preview);
+
+        $remaining = count($paths) - count($preview);
+
+        if ($remaining > 0) {
+            $details[] = sprintf('… %d more occurrence(s) omitted.', $remaining);
+        }
+
+        return $details;
+    }
+
+    protected function isCrudControllerPath(string $path): bool
+    {
+        return str_contains($path, 'CrudController');
+    }
+
+    abstract protected function context(): UpgradeContext;
+}

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

@@ -0,0 +1,52 @@
+<?php
+
+namespace Backpack\CRUD\app\Console\Commands\Upgrade\v7\Steps;
+
+use Backpack\CRUD\app\Console\Commands\Upgrade\Step;
+use Backpack\CRUD\app\Console\Commands\Upgrade\StepResult;
+use Backpack\CRUD\app\Console\Commands\Upgrade\StepStatus;
+
+class CheckListOperationViewPublishedStep extends Step
+{
+    protected string $relativePath = 'resources/views/vendor/backpack/crud/list.blade.php';
+
+    public function title(): string
+    {
+        return 'Published list operation view';
+    }
+
+    public function run(): StepResult
+    {
+        if (! $this->context()->fileExists($this->relativePath)) {
+            return StepResult::success('List operation view is not published, package default will be used.');
+        }
+
+        return StepResult::warning(
+            'A published list.blade.php was found. The bundled view received significant updates; delete the published copy to use the latest Backpack version.',
+            ["Published view: {$this->relativePath}"]
+        );
+    }
+
+    public function canFix(StepResult $result): bool
+    {
+        return $result->status === StepStatus::Warning && $this->context()->fileExists($this->relativePath);
+    }
+
+    public function fixMessage(StepResult $result): string
+    {
+        return 'We can delete the published list.blade.php so Backpack uses the updated bundled view. Proceed?';
+    }
+
+    public function fix(StepResult $result): StepResult
+    {
+        if (! $this->context()->fileExists($this->relativePath)) {
+            return StepResult::skipped('Published list.blade.php was already removed.');
+        }
+
+        if (! $this->context()->deleteFile($this->relativePath)) {
+            return StepResult::failure("Could not delete {$this->relativePath} automatically.");
+        }
+
+        return StepResult::success('Removed the published list.blade.php so the package view is used.');
+    }
+}