AlecRabbit\Spinner\Core\SpinnerCore

Complexity

Total Complexity

5

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	disable()	0	4	1
A	refineOutput()	0	7	2
A	enable()	0	4	1
A	isActive()	0	3	1

<?php declare(strict_types=1);

namespace AlecRabbit\Spinner\Core;

use AlecRabbit\Spinner\Core\Adapters\EchoOutputAdapter;
use AlecRabbit\Spinner\Core\Contracts\Frames;
use AlecRabbit\Spinner\Core\Contracts\SpinnerInterface;
use AlecRabbit\Spinner\Core\Contracts\OutputInterface;
use AlecRabbit\Spinner\Core\Contracts\Styles;
use AlecRabbit\Spinner\Settings\Contracts\Defaults;
use function AlecRabbit\typeOf;

abstract class SpinnerCore implements SpinnerInterface
{
    protected const EMPTY_STRING = Defaults::EMPTY_STRING;

    protected const INTERVAL = Defaults::DEFAULT_INTERVAL;
    protected const FRAMES = Frames::BASE;
    protected const STYLES = Styles::STYLING_DISABLED;

    /** @var null|OutputInterface */
    protected $output;
    /** @var bool */
    protected $enabled;

    /**
     * @param null|false|OutputInterface $output
     * @return null|OutputInterface
     */
    protected function refineOutput($output): ?OutputInterface
    {
        Sentinel::assertOutput($output);
        if (false === $output) {
            return null;
        }
        return $output ?? new EchoOutputAdapter();
    }

    /** {@inheritDoc} */
    public function disable(): SpinnerInterface
    {
        $this->enabled = false;
        return $this;
    }

    /** {@inheritDoc} */
    public function enable(): SpinnerInterface
    {
        $this->enabled = true;
        return $this;
    }

    /** {@inheritDoc} */
    public function isActive(): bool
    {
        return $this->enabled;
    }
}