AlecRabbit\Spinner\Extras\A\AProgressValue

Complexity

Total Complexity

11

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	assert()	0	11	2
A	isFinished()	0	3	1
A	advance()	0	9	2
A	getSteps()	0	3	1
A	finish()	0	4	1
A	autoFinish()	0	4	3
A	__construct()	0	10	1

<?php

declare(strict_types=1);

namespace AlecRabbit\Spinner\Extras\A;

use AlecRabbit\Spinner\Core\A\AFloatValue;
use AlecRabbit\Spinner\Exception\InvalidArgumentException;
use AlecRabbit\Spinner\Extras\Contract\IProgressValue;

abstract class AProgressValue extends AFloatValue implements IProgressValue
{
    protected bool $finished = false;
    protected float $stepValue;

    /**
     * @throws InvalidArgumentException
     */
    public function __construct(
        float $startValue = 0.0,
        float $min = 0.0,
        float $max = 1.0,
        protected readonly int $steps = 100,
        protected readonly bool $autoFinish = true,
    ) {
        parent::__construct($startValue, $min, $max);
        self::assert($this);
        $this->stepValue = ($this->max - $this->min) / $this->steps;
    }

    /**
     * @throws InvalidArgumentException
     */
    private static function assert(AProgressValue $value): void
    {
        match (true) {
            0 > $value->steps || 0 === $value->steps =>
            throw new InvalidArgumentException(
                sprintf(
                    'Steps should be greater than 0. Steps: "%s".',
                    $value->steps,
                )
            ),
            default => null,
        };
    }

    /** @inheritdoc */
    public function advance(int $steps = 1): void
    {
        if ($this->finished) {
            return;
        }

        $this->value += $steps * $this->stepValue;
        $this->checkBounds();
        $this->autoFinish();
    }

    protected function autoFinish(): void
    {
        if ($this->autoFinish && $this->value >= $this->max) {
            $this->finish();
        }
    }

    public function finish(): void
    {
        $this->finished = true;
        $this->value = $this->max;
    }

    public function getSteps(): int
    {
        return $this->steps;
    }

    public function isFinished(): bool
    {
        return $this->finished;
    }
}