AlecRabbit\Spinner\Core\AbstractSpinner

Complexity

Total Complexity

17

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Test Coverage

Coverage

94.23%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	erase()	0	3	1
A	inline()	0	6	2
A	begin()	0	3	1
A	end()	0	3	1
A	getStyles()	0	22	3
A	refineMessage()	0	6	2
A	setFields()	0	5	1
A	spin()	0	3	1
A	work()	0	3	1
A	getStyle()	0	18	3

<?php declare(strict_types=1);

namespace AlecRabbit\Spinner\Core;

use AlecRabbit\Accessories\Circular;
use AlecRabbit\ConsoleColour\ConsoleColor;
use AlecRabbit\ConsoleColour\Terminal;
use AlecRabbit\Spinner\Contracts\SpinnerInterface;

abstract class AbstractSpinner implements SpinnerInterface
{
    protected const ESC = ConsoleColor::ESC_CHAR;
    protected const ERASING_SHIFT = 1;

    /** @var Circular */
    protected $spinnerSymbols;
    /** @var null|Circular */
    protected $styles;
    /** @var string */
    protected $message;
    /** @var string */
    protected $moveBackStr;
    /** @var \Closure */
    protected $style;
    /** @var string */
    protected $paddingStr;
    /** @var string */
    protected $eraseBySpacesStr;


    public function __construct(
        ?string $message = null,
        ?string $prefix = null,
        ?string $suffix = null,
        ?string $paddingStr = null
    ) {
        $this->spinnerSymbols = $this->getSymbols();
        $this->styles = $this->getStyles();
        $this->paddingStr = $paddingStr ?? SpinnerInterface::PADDING_NEXT_LINE;
        $this->message = $this->refineMessage($message, $prefix, $suffix);
        $this->setFields();
        $this->style = $this->getStyle();
    }

    /**
     * @return Circular
     */
    abstract protected function getSymbols(): Circular;

    protected function getStyles(): ?Circular
    {
        $terminal = new Terminal();
        if ($terminal->supports256Color()) {
            return new Circular([
                '38;5;197',
                '38;5;198',
                '38;5;199',
                '38;5;200',
                '38;5;201',
                '38;5;202',
                '38;5;203',
                '38;5;204',
                '38;5;205',
            ]);
        }
        if ($terminal->supportsColor()) {
            return new Circular([
                '96',
            ]);
        }
        return null;
    }

    /**
     * @param null|string $message
     * @param null|string $prefix
     * @param null|string $suffix
     * @return string
     */
    protected function refineMessage(?string $message, ?string $prefix, ?string $suffix): string
    {
        $message = ucfirst($message ?? SpinnerInterface::DEFAULT_MESSAGE);
        $prefix = $prefix ?? SpinnerInterface::DEFAULT_PREFIX;
        $suffix = $suffix ?? (empty($message) ? '' : SpinnerInterface::DEFAULT_SUFFIX);
        return $prefix . $message . $suffix;
    }

    /**
     * @return \Closure
     */
    protected function getStyle(): \Closure
    {
        if (null === $this->styles) {
            return
                function (): string {
                    $value = (string)$this->spinnerSymbols->value();
                    return $this->paddingStr . $value;
                };
        }
        return
            function (): string {
                $symbol = (string)$this->spinnerSymbols->value();
                $style = $this->styles ? (string)$this->styles->value() : '';
                return
                    $this->paddingStr .
                    self::ESC .
                    "[{$style}m{$symbol}" .
                    self::ESC . '[0m';
            };
    }

    public function inline(bool $inline): SpinnerInterface
    {
        $this->paddingStr = $inline ? SpinnerInterface::PADDING_INLINE : SpinnerInterface::PADDING_NEXT_LINE;
        $this->setFields();

        return $this;
    }

    /** {@inheritDoc} */
    public function begin(): string
    {
        return $this->spin();
    }

    protected function work(): string
    {
        return ($this->style)() . $this->message;
    }

    /** {@inheritDoc} */
    public function spin(): string
    {
        return $this->work() . $this->moveBackStr;
    }

    /** {@inheritDoc} */
    public function end(): string
    {
        return $this->erase();
//        return self::ESC . '[K';
    }

    /** {@inheritDoc} */
    public function erase(): string
    {
        return $this->eraseBySpacesStr . $this->moveBackStr;
    }

    protected function setFields(): void
    {
        $strLen = strlen($this->message . $this->paddingStr) + static::ERASING_SHIFT;
        $this->moveBackStr = self::ESC . "[{$strLen}D";
        $this->eraseBySpacesStr = str_repeat(' ', $strLen);
    }
}