Backpack\CRUD\app\Console\Commands\Upgrade\Step

Complexity

Total Complexity

9

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	fixMessage()	0	3	1
A	context()	0	3	1
A	previewList()	0	21	3
A	__construct()	0	2	1
A	description()	0	3	1
A	fix()	0	3	1
A	canFix()	0	3	1

<?php

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)
    {
    }

    abstract public function title(): string;

    public function description(): ?string
    {
        return null;
    }

    abstract public function run(): StepResult;

    protected function context(): UpgradeContext
    {
        return $this->context;
    }

    public function canFix(StepResult $result): bool

The parameter $result is not used and could be removed.

    {
        return false;
    }

    public function fixMessage(StepResult $result): string

The parameter $result is not used and could be removed.

    {
        return 'Apply automatic fix?';
    }

    public function fix(StepResult $result): StepResult

The parameter $result is not used and could be removed.

    {
        return StepResult::skipped('No automatic fix available.');
    }

    /**
     * Build a preview of items with an optional formatter and overflow message.
     *
     * @param  array<int, mixed>  $items
     * @param  callable|null  $formatter
     * @return array<int, string>
     */
    protected function previewList(
        array $items,
        int $limit = 10,
        ?callable $formatter = null,
        ?string $overflowMessage = null
    ): array {
        if (empty($items)) {
            return [];
        }

        $formatter ??= static fn ($item): string => '- '.(string) $item;
        $preview = array_slice($items, 0, $limit);
        $details = array_map($formatter, $preview);

        $remaining = count($items) - count($preview);

        if ($remaining > 0) {
            $details[] = sprintf($overflowMessage ?? '... %d more item(s) omitted.', $remaining);
        }

        return $details;
    }
}