Backpack\CRUD\app\Console\Commands\Upgrade\v7\Steps\EnsureBackpackCrudRequirementStep

Complexity

Total Complexity

21

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	title()	0	3	1
A	canFix()	0	22	6
A	targetMajor()	0	9	2
A	targetConstraint()	0	3	1
B	run()	0	48	8
A	fix()	0	16	2
A	fixMessage()	0	5	1

<?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;
use Backpack\CRUD\app\Console\Commands\Upgrade\v7\UpgradeCommandConfig;

class EnsureBackpackCrudRequirementStep extends Step
{
    private ?string $currentConstraint = null;

    private bool $missingRequirement = false;

    public function title(): string
    {
        return 'Update composer requirement for backpack/crud';
    }

    public function run(): StepResult
    {
        $this->currentConstraint = null;
        $this->missingRequirement = false;

        $constraint = $this->context()->composerRequirement('backpack/crud');
        $this->currentConstraint = $constraint;

        if ($constraint === null) {
            $this->missingRequirement = true;

            return StepResult::failure('The composer.json file does not declare backpack/crud.');
        }

        $requiredMajor = $this->extractFirstInteger($constraint);
        $targetConstraint = $this->targetConstraint();
        $targetMajor = $this->targetMajor();

        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}"]
            );
        }

        $installedMajor = $this->context()->packageMajorVersion('backpack/crud');
        $installedPretty = $this->context()->installedPackagePrettyVersion('backpack/crud');

        $comparisonMajor = $targetMajor ?? $requiredMajor;

        if ($comparisonMajor !== null && $installedMajor !== null && $installedMajor < $comparisonMajor) {
            return StepResult::warning(
                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}.");
    }

    public function canFix(StepResult $result): bool
    {
        if ($result->status !== StepStatus::Failed) {
            return false;
        }

        if ($this->missingRequirement) {
            return true;
        }

        if ($this->currentConstraint === null) {
            return false;
        }

        $requiredMajor = $this->extractFirstInteger($this->currentConstraint);
        $targetMajor = $this->targetMajor();

        if ($targetMajor === null) {
            return $requiredMajor === null;
        }

        return $requiredMajor === null || $requiredMajor < $targetMajor;
    }

    public function fixMessage(StepResult $result): string
    {
        return sprintf(
            'We can update composer.json to require backpack/crud:%s automatically. Apply this change now?',
            $this->targetConstraint()
        );
    }

    public function fix(StepResult $result): StepResult
    {
        $targetConstraint = $this->targetConstraint();

        $section = $this->context()->composerRequirementSection('backpack/crud') ?? 'require';

        $updated = $this->context()->updateComposerJson(function (array &$composer) use ($section, $targetConstraint) {
            $composer[$section] = $composer[$section] ?? [];
            $composer[$section]['backpack/crud'] = $targetConstraint;
        });

        if (! $updated) {
            return StepResult::failure('Could not update composer.json automatically.');
        }

        return StepResult::success("Set backpack/crud requirement to {$targetConstraint} in composer.json.");
    }

    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());
    }
}