Spinner::erase() - Code Metrics - Inspection of "wp 122" - alecrabbit/php-console-spinner - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 80875d...eb7214 )

by Alec

created 2019-08-31 14:55 UTC

Spinner::erase() A

↳ Parent: Spinner

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	5
c	1
b	0
f	0
dl	0
loc	8
ccs	6
cts	6
cp	1
rs	10
cc	2
nc	2
nop	0
crap	2

<?php declare(strict_types=1);

namespace AlecRabbit\Spinner\Core;

use AlecRabbit\Cli\Tools\Cursor;
use AlecRabbit\Spinner\Core\Coloring\Colors;
use AlecRabbit\Spinner\Core\Contracts\SpinnerInterface;
use AlecRabbit\Spinner\Core\Contracts\OutputInterface;
use AlecRabbit\Spinner\Core\Jugglers\Contracts\JugglerInterface;
use AlecRabbit\Spinner\Core\Jugglers\FrameJuggler;
use AlecRabbit\Spinner\Core\Jugglers\MessageJuggler;
use AlecRabbit\Spinner\Core\Jugglers\ProgressJuggler;
use AlecRabbit\Spinner\Settings\Contracts\Defaults;
use AlecRabbit\Spinner\Settings\Settings;
use function AlecRabbit\typeOf;
use const AlecRabbit\ESC;

abstract class Spinner extends SpinnerCore
{
    /** @var Settings */
    protected $settings;
    /** @var bool */
    protected $inline = false;
    /** @var float */
    protected $interval;
    /** @var null|MessageJuggler */
    protected $messageJuggler;
    /** @var null|FrameJuggler */
    protected $frameJuggler;
    /** @var null|ProgressJuggler */
    protected $progressJuggler;
    /** @var string */
    protected $moveCursorBackSequence = '';
    /** @var string */
    protected $eraseBySpacesSequence = '';
    /** @var int */
    protected $previousErasingLength = 0;
    /** @var string */
    protected $spacer = Defaults::EMPTY_STRING;
    /** @var Colors */
    protected $coloring;
    /** @var null[]|JugglerInterface[] */
    protected $jugglers = [];
    /** @var string */
    protected $lastSpinnerString = '';

    /**
     * Spinner constructor.
     *
     * @param null|string|Settings $messageOrSettings
     * @param null|false|OutputInterface $output
     * @param null|int $color
     */
    public function __construct($messageOrSettings = null, $output = null, ?int $color = null)
    {
        $this->output = $this->refineOutput($output);
        $this->settings = $this->refineSettings($messageOrSettings);
        $this->interval = $this->settings->getInterval();
        $this->coloring = new Colors($this->settings->getStyles(), $color);
        $this->initJugglers();
        $this->jugglers = [
            &$this->frameJuggler,
            &$this->messageJuggler,
            &$this->progressJuggler,
        ];
    }


    /**
     * @param null|string|Settings $settings
     * @return Settings
     */
    protected function refineSettings($settings): Settings
    {
        $this->assertSettings($settings);
        if (\is_string($settings)) {
            return
                $this->defaultSettings()->setMessage($settings);
        }
        if ($settings instanceof Settings) {
            return $this->defaultSettings()->merge($settings);
        }
        return
            $this->defaultSettings();
    }

    /**
     * @param mixed $settings
     */
    protected function assertSettings($settings): void
    {
        if (null !== $settings && !\is_string($settings) && !$settings instanceof Settings) {
            throw new \InvalidArgumentException(
                'Instance of [' . Settings::class . '] or string expected ' . typeOf($settings) . ' given.'
            );
        }
    }

    /**
     * @return Settings
     */
    protected function defaultSettings(): Settings
    {
        return
            (new Settings())
                ->setInterval(static::INTERVAL)
                ->setFrames(static::FRAMES)
                ->setStyles(static::STYLES);
    }

    protected function initJugglers(): void
    {
        $frames = $this->settings->getFrames();
        if (!empty($frames)) {
            $this->frameJuggler =
                new FrameJuggler($this->settings, $this->coloring->getFrameStyles());
        }

        $message = $this->settings->getMessage();
        if (Defaults::EMPTY_STRING !== $message) {
            $this->setMessage($message, $this->settings->getMessageErasingLength());
        }
    }

    /**
     * @param null|string $message
     * @param null|int $erasingLength
     */
    protected function setMessage(?string $message, ?int $erasingLength = null): void
    {
        $this->settings->setMessage($message, $erasingLength);

        if ($this->messageJuggler instanceof MessageJuggler) {
            if (null === $message) {
                $this->messageJuggler = null;
            } else {
                $this->messageJuggler->setMessage($message, $erasingLength);
            }
        } else {
            $this->messageJuggler =
                null === $message ?
                    null :
                    new MessageJuggler($this->settings, $this->coloring->getMessageStyles());
        }
    }

    /** {@inheritDoc} */
    public function end(): string
    {
        if ($this->output instanceof OutputInterface) {
            $this->erase();
            $this->output->write(Cursor::show());
            return self::EMPTY_STRING;
        }
        return $this->erase() . Cursor::show();
    }

    /** {@inheritDoc} */
    public function erase(): string
    {
        $str = $this->eraseBySpacesSequence . $this->moveCursorBackSequence;
        if ($this->output instanceof OutputInterface) {
            $this->output->write($str);
            return self::EMPTY_STRING;
        }
        return $str;
    }

    /** {@inheritDoc} */
    public function getOutput(): ?OutputInterface
    {
        return $this->output;
    }

    public function inline(bool $inline): SpinnerInterface
    {
        $this->inline = $inline;
        $this->spacer = $this->inline ? Defaults::ONE_SPACE_SYMBOL : Defaults::EMPTY_STRING;
        return $this;
    }

    public function interval(): float
    {
        return $this->interval;
    }

    /** {@inheritDoc} */
    public function message(?string $message = null, ?int $erasingLength = null): self
    {
        $this->setMessage($message, $erasingLength);
        return $this;
    }

    public function progress(?float $percent): self
    {
        $this->setProgress($percent);
        return $this;
    }

    /**
     * @param null|float $percent
     */
    protected function setProgress(?float $percent = null): void
    {
        $this->settings->setInitialPercent($percent);
        if ($this->progressJuggler instanceof ProgressJuggler) {
            if (null === $percent) {
                $this->progressJuggler = null;
            } else {
                $this->progressJuggler->setProgress($percent);
            }
        } else {
            $this->progressJuggler =
                null === $percent ? null : new ProgressJuggler($this->settings, $this->coloring->getProgressStyles());
        }
    }

    /** {@inheritDoc} */
    public function begin(?float $percent = null): string
    {
        if (null === $percent) {
            $this->progressJuggler = null;
        } else {
            $this->setProgress($percent);
        }
        if ($this->output instanceof OutputInterface) {
            $this->output->write(Cursor::hide());
            $this->spin();
            return self::EMPTY_STRING;
        }
        return Cursor::hide() . $this->spin();
    }

    /** {@inheritDoc} */
    public function spin(): string
    {
        $this->lastSpinnerString = $this->preparedStr();
        return
            $this->last();
    }

    /** {@inheritDoc} */
    public function last(): string
    {
        if ($this->output instanceof OutputInterface) {
            $this->output->write($this->lastSpinnerString);
            return self::EMPTY_STRING;
        }
        return
            $this->lastSpinnerString;
    }

    protected function preparedStr(): string
    {
//        $start = hrtime(true);
        $str = '';
        $erasingLength = 0;
        $eraseTailBySpacesSequence = '';
        foreach ($this->jugglers as $juggler) {
            if ($juggler instanceof JugglerInterface) {
                $str .= $juggler->getStyledFrame();
                $erasingLength += $juggler->getFrameErasingLength();
            }
        }
        $erasingLength += $this->inline ? 1 : 0;
        $erasingLengthDelta = $this->previousErasingLength - $erasingLength;
        $this->previousErasingLength = $erasingLength;

        if ($erasingLengthDelta > 0) {
            $erasingLength += $erasingLengthDelta;
            $eraseTailBySpacesSequence = str_repeat(Defaults::ONE_SPACE_SYMBOL, $erasingLengthDelta);
        }
        $this->moveCursorBackSequence = ESC . "[{$erasingLength}D";
        $this->eraseBySpacesSequence = str_repeat(Defaults::ONE_SPACE_SYMBOL, $erasingLength);

        $str = $this->spacer . $str . $eraseTailBySpacesSequence . $this->moveCursorBackSequence;
//        dump(hrtime(true) - $start);
        return $str;
    }
}


1		<?php declare(strict_types=1);
2
3		namespace AlecRabbit\Spinner\Core;
4
5		use AlecRabbit\Cli\Tools\Cursor;
6		use AlecRabbit\Spinner\Core\Coloring\Colors;
7		use AlecRabbit\Spinner\Core\Contracts\SpinnerInterface;
8		use AlecRabbit\Spinner\Core\Contracts\OutputInterface;
9		use AlecRabbit\Spinner\Core\Jugglers\Contracts\JugglerInterface;
10		use AlecRabbit\Spinner\Core\Jugglers\FrameJuggler;
11		use AlecRabbit\Spinner\Core\Jugglers\MessageJuggler;
12		use AlecRabbit\Spinner\Core\Jugglers\ProgressJuggler;
13		use AlecRabbit\Spinner\Settings\Contracts\Defaults;
14		use AlecRabbit\Spinner\Settings\Settings;
15		use function AlecRabbit\typeOf;
16		use const AlecRabbit\ESC;
17
18		abstract class Spinner extends SpinnerCore
19		{
20		/** @var Settings */
21		protected $settings;
22		/** @var bool */
23		protected $inline = false;
24		/** @var float */
25		protected $interval;
26		/** @var null\|MessageJuggler */
27		protected $messageJuggler;
28		/** @var null\|FrameJuggler */
29		protected $frameJuggler;
30		/** @var null\|ProgressJuggler */
31		protected $progressJuggler;
32		/** @var string */
33		protected $moveCursorBackSequence = '';
34		/** @var string */
35		protected $eraseBySpacesSequence = '';
36		/** @var int */
37		protected $previousErasingLength = 0;
38		/** @var string */
39		protected $spacer = Defaults::EMPTY_STRING;
40		/** @var Colors */
41		protected $coloring;
42		/** @var null[]\|JugglerInterface[] */
43		protected $jugglers = [];
44		/** @var string */
45		protected $lastSpinnerString = '';
46
47		/**
48		* Spinner constructor.
49		*
50		* @param null\|string\|Settings $messageOrSettings
51		* @param null\|false\|OutputInterface $output
52		* @param null\|int $color
53		*/
54	28	public function __construct($messageOrSettings = null, $output = null, ?int $color = null)
55		{
56	28	$this->output = $this->refineOutput($output);
57	26	$this->settings = $this->refineSettings($messageOrSettings);
58	25	$this->interval = $this->settings->getInterval();
59	25	$this->coloring = new Colors($this->settings->getStyles(), $color);
60	25	$this->initJugglers();
61	25	$this->jugglers = [
62	25	&$this->frameJuggler,
63	25	&$this->messageJuggler,
64	25	&$this->progressJuggler,
65		];
66	25	}
67
68
69		/**
70		* @param null\|string\|Settings $settings
71		* @return Settings
72		*/
73	26	protected function refineSettings($settings): Settings
74		{
75	26	$this->assertSettings($settings);
76	25	if (\is_string($settings)) {
77		return
78	18	$this->defaultSettings()->setMessage($settings);
79		}
80	7	if ($settings instanceof Settings) {
81	4	return $this->defaultSettings()->merge($settings);
82		}
83		return
84	3	$this->defaultSettings();
85		}
86
87		/**
88		* @param mixed $settings
89		*/
90	26	protected function assertSettings($settings): void
91		{
92	26	if (null !== $settings && !\is_string($settings) && !$settings instanceof Settings) {
93	1	throw new \InvalidArgumentException(
94	1	'Instance of [' . Settings::class . '] or string expected ' . typeOf($settings) . ' given.'
95		);
96		}
97	25	}
98
99		/**
100		* @return Settings
101		*/
102	25	protected function defaultSettings(): Settings
103		{
104		return
105	25	(new Settings())
106	25	->setInterval(static::INTERVAL)
107	25	->setFrames(static::FRAMES)
108	25	->setStyles(static::STYLES);
109		}
110
111	25	protected function initJugglers(): void
112		{
113	25	$frames = $this->settings->getFrames();
114	25	if (!empty($frames)) {
115	19	$this->frameJuggler =
116	19	new FrameJuggler($this->settings, $this->coloring->getFrameStyles());
117		}
118
119	25	$message = $this->settings->getMessage();
120	25	if (Defaults::EMPTY_STRING !== $message) {
121	21	$this->setMessage($message, $this->settings->getMessageErasingLength());
122		}
123	25	}
124
125		/**
126		* @param null\|string $message
127		* @param null\|int $erasingLength
128		*/
129	22	protected function setMessage(?string $message, ?int $erasingLength = null): void
130		{
131	22	$this->settings->setMessage($message, $erasingLength);
132
133	22	if ($this->messageJuggler instanceof MessageJuggler) {
134	5	if (null === $message) {
135	2	$this->messageJuggler = null;
136		} else {
137	5	$this->messageJuggler->setMessage($message, $erasingLength);
138		}
139		} else {
140	22	$this->messageJuggler =
141	22	null === $message ?
142	1	null :
143	22	new MessageJuggler($this->settings, $this->coloring->getMessageStyles());
144		}
145	22	}
146
147		/** {@inheritDoc} */
148	21	public function end(): string
149		{
150	21	if ($this->output instanceof OutputInterface) {
151	3	$this->erase();
152	3	$this->output->write(Cursor::show());
153	3	return self::EMPTY_STRING;
154		}
155	18	return $this->erase() . Cursor::show();
156		}
157
158		/** {@inheritDoc} */
159	21	public function erase(): string
160		{
161	21	$str = $this->eraseBySpacesSequence . $this->moveCursorBackSequence;
162	21	if ($this->output instanceof OutputInterface) {
163	3	$this->output->write($str);
164	3	return self::EMPTY_STRING;
165		}
166	18	return $str;
167		}
168
169		/** {@inheritDoc} */
170	3	public function getOutput(): ?OutputInterface
171		{
172	3	return $this->output;
173		}
174
175	8	public function inline(bool $inline): SpinnerInterface
176		{
177	8	$this->inline = $inline;
178	8	$this->spacer = $this->inline ? Defaults::ONE_SPACE_SYMBOL : Defaults::EMPTY_STRING;
179	8	return $this;
180		}
181
182	5	public function interval(): float
183		{
184	5	return $this->interval;
185		}
186
187		/** {@inheritDoc} */
188	5	public function message(?string $message = null, ?int $erasingLength = null): self
189		{
190	5	$this->setMessage($message, $erasingLength);
191	5	return $this;
192		}
193
194	10	public function progress(?float $percent): self
195		{
196	10	$this->setProgress($percent);
197	10	return $this;
198		}
199
200		/**
201		* @param null\|float $percent
202		*/
203	11	protected function setProgress(?float $percent = null): void
204		{
205	11	$this->settings->setInitialPercent($percent);
206	11	if ($this->progressJuggler instanceof ProgressJuggler) {
207	10	if (null === $percent) {
208	1	$this->progressJuggler = null;
209		} else {
210	10	$this->progressJuggler->setProgress($percent);
211		}
212		} else {
213	11	$this->progressJuggler =
214	11	null === $percent ? null : new ProgressJuggler($this->settings, $this->coloring->getProgressStyles());
215		}
216	11	}
217
218		/** {@inheritDoc} */
219	24	public function begin(?float $percent = null): string
220		{
221	24	if (null === $percent) {
222	20	$this->progressJuggler = null;
223		} else {
224	5	$this->setProgress($percent);
225		}
226	24	if ($this->output instanceof OutputInterface) {
227	3	$this->output->write(Cursor::hide());
228	3	$this->spin();
229	3	return self::EMPTY_STRING;
230		}
231	21	return Cursor::hide() . $this->spin();
232		}
233
234		/** {@inheritDoc} */
235	24	public function spin(): string
236		{
237	24	$this->lastSpinnerString = $this->preparedStr();
238		return
239	24	$this->last();
240		}
241
242		/** {@inheritDoc} */
243	24	public function last(): string
244		{
245	24	if ($this->output instanceof OutputInterface) {
246	3	$this->output->write($this->lastSpinnerString);
247	3	return self::EMPTY_STRING;
248		}
249		return
250	21	$this->lastSpinnerString;
251		}
252
253	24	protected function preparedStr(): string
254		{
255		// $start = hrtime(true);
256	24	$str = '';
257	24	$erasingLength = 0;
258	24	$eraseTailBySpacesSequence = '';
259	24	foreach ($this->jugglers as $juggler) {
260	24	if ($juggler instanceof JugglerInterface) {
261	23	$str .= $juggler->getStyledFrame();
262	23	$erasingLength += $juggler->getFrameErasingLength();
263		}
264		}
265	24	$erasingLength += $this->inline ? 1 : 0;
266	24	$erasingLengthDelta = $this->previousErasingLength - $erasingLength;
267	24	$this->previousErasingLength = $erasingLength;
268
269	24	if ($erasingLengthDelta > 0) {
270	6	$erasingLength += $erasingLengthDelta;
271	6	$eraseTailBySpacesSequence = str_repeat(Defaults::ONE_SPACE_SYMBOL, $erasingLengthDelta);
272		}
273	24	$this->moveCursorBackSequence = ESC . "[{$erasingLength}D";
274	24	$this->eraseBySpacesSequence = str_repeat(Defaults::ONE_SPACE_SYMBOL, $erasingLength);
275
276	24	$str = $this->spacer . $str . $eraseTailBySpacesSequence . $this->moveCursorBackSequence;
277		// dump(hrtime(true) - $start);
278	24	return $str;
279		}
280		}
281

alecrabbit / php-console-spinner

Push — master ( 80875d...eb7214 )

Spinner::erase() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like