Spinner::setMessage() - Code Metrics - Inspection of "Feature/status messages" - alecrabbit/php-cli-snake - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

unknown

created 2021-01-25 19:44 UTC

Spinner::setMessage() A

↳ Parent: Spinner

Complexity

Conditions	3
Paths	4

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
eloc	7
c	2
b	0
f	1
dl	0
loc	14
ccs	0
cts	0
cp	0
rs	10
cc	3
nc	4
nop	1
crap	12

<?php

declare(strict_types=1);

namespace AlecRabbit\Snake;

use AlecRabbit\Snake\Contracts\Color;
use AlecRabbit\Snake\Contracts\SpinnerInterface;
use AlecRabbit\Snake\Core\Driver;

class Spinner implements SpinnerInterface
{
    private const CHARS = ['⠏', '⠛', '⠹', '⢸', '⣰', '⣤', '⣆', '⡇'];
    private const COLORS = [
        196,
        196,
        202,
        202,
        208,
        208,
        214,
        214,
        220,
        220,
        226,
        226,
        190,
        190,
        154,
        154,
        118,
        118,
        82,
        82,
        46,
        46,
        47,
        47,
        48,
        48,
        49,
        49,
        50,
        50,
        51,
        51,
        45,
        45,
        39,
        39,
        33,
        33,
        27,
        27,
        56,
        56,
        57,
        57,
        93,
        93,
        129,
        129,
        165,
        165,
        201,
        201,
        200,
        200,
        199,
        199,
        198,
        198,
        197,
        197,
    ];

    /** @var Driver */
    private $driver;
    /** @var int */
    private $currentCharIdx = 0;
    /** @var int */
    private $currentColorIdx = 0;
    /** @var int */
    private $framesCount;
    /** @var int */
    private $colorCount;
    /** @var string|null */
    protected $message;
    /** @var int */
    protected $terminalCols;
    /** @var float */
    protected $lastFrameTimestamp = 0;

    public function __construct(int $colorLevel = Color::COLOR_256)
    {
        $this->driver = new Driver($colorLevel);
        $this->framesCount = count(self::CHARS);
        $this->colorCount = count(self::COLORS);
        $this->terminalCols = (int) (exec('tput cols') ?? 80);
    }

    public function spin(): void
    {
        $message = is_string($this->message) && !empty($this->message)
            ? ' '.$this->message

            : '';

        $output =
            $this->driver->eraseSequence()
            . $this->driver->frameSequence(
                self::COLORS[$this->currentColorIdx],
                self::CHARS[$this->currentCharIdx]
            )
            . $message;

        $spaces = $this->terminalCols - mb_strlen($output);
        $output = $output . str_repeat(' ', max(0, $spaces));

        $this->driver->write(
            $output,
            "\r"
        );
        $this->update();
    }

    private function update(): void
    {
        $now = microtime(true);
        if ($now >= $this->lastFrameTimestamp + $this->interval()) {
            $this->lastFrameTimestamp = $now;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

            if (++$this->currentCharIdx === $this->framesCount) {
                $this->currentCharIdx = 0;
            }
            if (++$this->currentColorIdx === $this->colorCount) {
                $this->currentColorIdx = 0;
            }
        }
    }

    /** @inheritDoc */
    public function interval(): float
    {
        return 0.1;
    }

    public function begin(): void
    {
        $this->driver->hideCursor();
    }

    public function end(): void
    {
        $this->erase();
        $this->driver->showCursor();
    }

    public function erase(): void
    {
        $this->driver->write(
            $this->driver->eraseSequence()
        );
    }

    public function useStdOut(): void
    {
        $this->driver->useStdOut();
    }

    /** @inheritDoc */
    public function setMessage(?string $message): void
    {
        if ($message === null) {
            $this->message = null;
        }

        $message = mb_substr($message, 0, $this->terminalCols-10);
        $message = mb_substr(/** @scrutinizer ignore-type */ $message, 0, $this->terminalCols-10);
        $breakPosition = mb_strpos($message, "\n");

        if ($breakPosition !== false) {
            $message = mb_substr($message, 0, $breakPosition);
        }

        $this->message = trim($message);
    }
}


alecrabbit / php-cli-snake

Pull Request — master (#4)

Spinner::setMessage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like