AlecRabbit\Tools\AbstractCounter

Complexity

Total Complexity

12

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	buildReport()	0	3	1
A	setInitialValue()	0	8	2
A	assertStep()	0	7	2
A	__construct()	0	6	1
A	assertTimes()	0	8	2
A	bump()	0	10	2
A	setStep()	0	9	2

<?php declare(strict_types=1);

namespace AlecRabbit\Tools;

use AlecRabbit\Tools\Contracts\CounterInterface;
use AlecRabbit\Tools\Contracts\Strings;
use AlecRabbit\Tools\Reports\Contracts\ReportableInterface;
use AlecRabbit\Tools\Reports\SimpleCounterReport;
use AlecRabbit\Tools\Reports\Traits\HasReport;
use AlecRabbit\Tools\Traits\SimpleCounterFields;

abstract class AbstractCounter implements CounterInterface, ReportableInterface
{
    use SimpleCounterFields, HasReport;


    protected const DEFAULT_STEP = 1;

    /**
     * Counter constructor
     * @param null|string $name
     * @param null|int $step
     * @param int $initialValue
     * @throws \Exception
     */
    public function __construct(?string $name = null, ?int $step = null, int $initialValue = 0)
    {
        $this->name = $this->defaultName($name);
        $this->setInitialValue($initialValue);
        $this->setStep($step);
        $this->buildReport();
    }

    /**
     * @throws \Exception
     */
    protected function buildReport(): void
    {
        $this->report = (new SimpleCounterReport())->buildOn($this);
    }

    /**
     * @param int $initialValue
     * @return AbstractCounter
     */
    public function setInitialValue(int $initialValue): AbstractCounter
    {
        if (false === $this->isStarted()) {
            $this->value = $this->initialValue = $initialValue;
        } else {
            throw new \RuntimeException('You can\'t set counter initial value, it has been bumped already.');
        }
        return $this;
    }

    /**
     * @param null|int $step
     * @return AbstractCounter
     */
    public function setStep(?int $step = null): AbstractCounter
    {
        $step = $this->assertStep($step);
        if (false === $this->isStarted()) {
            $this->step = $step;
        } else {
            throw new \RuntimeException('You can\'t set counter step value, it has been bumped already.');
        }
        return $this;
    }

    /**
     * @param null|int $step
     * @return int
     */
    protected function assertStep(?int $step = null): int
    {
        $step = $step ?? self::DEFAULT_STEP;
        if ($step === 0) {
            throw new \RuntimeException('Counter step should be non-zero integer.');
        }
        return $step;
    }

    /**
     * @param int $times
     * @return int
     */
    public function bump(int $times = 1): int
    {
        $times = $this->assertTimes($times);
        if ($this->isNotStarted()) {
            $this->start();
        }
        $this->value += $times * $this->step;
        $this->bumped++;
        return
            $this->value;
    }

    protected function assertTimes(int $times): int
    {
        if ($times < 1) {
            throw new \RuntimeException(
                'Parameter 0 for bump() or bumpBack() should be positive non-zero integer.'
            );
        }
        return $times;
    }
}