Output::setSleepModeStateInProgressBar() - Code Metrics - Inspection of "Refactor SleepModeState" - tequilarapido/consolify - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 17f495...b9e7ef )

by Nassif

created 2018-03-16 10:54 UTC

Output::setSleepModeStateInProgressBar() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Tequilarapido\Consolify\Output;

use Tequilarapido\Consolify\Progress\Progress;
use Tequilarapido\Consolify\Progress\ProgressHelper;
use Symfony\Component\Console\Output\OutputInterface;
use Tequilarapido\Consolify\Progress\SleepModeState;

/**
 * Console trait helpers.
 *
 * Brings the console methods to any service worker class.
 */
trait Output
{
    /**
     * Output interface.
     *
     * @var OutputInterface
     */
    protected $output;

    /**
     * Progress handler.
     *
     * @var Progress
     */
    protected $progress;

    /**
     * Set output interface.
     *
     * @param OutputInterface $output
     *
     * @return $this
     */
    public function setOutput(OutputInterface $output)
    {
        $this->output = $output;

        return $this;
    }

    public function createProgress($max, $uid, $advance = 0)
    {
        $this->progress = ProgressHelper::newProgressInstance($max, $uid, $this->output);

        $this->progress->setFormat(' %current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s% %memory:6s% -- %message%');
        $this->progress->setRedrawFrequency(1);
        $this->progress->setMessage('');
        $this->progress->start();
        $this->progress->advance($advance);
    }

    public function advanceProgress($step = 1)
    {
        if (!$this->progress) {
            throw new \Exception('No progress was created.');
        }

        $this->progress->advance($step);
    }

    public function setProgressMessage($message)
    {
        $this->progress->setMessage($message);
                         setMessage($message);
    }

    public function finishProgress()
    {
        $this->progress->finish();
                         finish();
    }

    /**
     * Write a string as information output.
     *
     * @param string $string
     */
    public function info($string)
    {
        if (!$this->output) {
            return;
        }

        $this->output->writeln("<info>$string</info>");
    }

    /**
     * Write a string as standard output.
     *
     * @param string $string
     */
    public function line($string)
    {
        if (!$this->output) {
            return;
        }

        $this->output->writeln($string);
    }

    /**
     * Write a string as comment output.
     *
     * @param string $string
     */
    public function comment($string)
    {
        if (!$this->output) {
            return;
        }

        $this->output->writeln("<comment>$string</comment>");
    }

    /**
     * Write a string as error output.
     *
     * @param string $string
     */
    public function error($string)
    {
        if (!$this->output) {
            return;
        }

        $this->output->writeln("<error>$string</error>");
    }

    /**
     * Write a string prefixed by a check mark.
     *
     * @param   $string
     */
    public function done($string)
    {
        if (!$this->output) {
            return;
        }

        $this->output->writeln("\n\n<info>✔</info> $string");
    }

    /**
     * Simple table.
     *
     * @param $headers
     * @param $rows
     */
    public function table($headers, $rows)
    {
        $this->output->table($headers, $rows);
                       table($headers, $rows);
    }

    /**
     * Overwrite previous line.
     *
     * @param $string
     */
    public function overwrite($string)
    {
        $this->overwriteLine(1);
        $this->line($string);
    }

    /**
     * Overwrite line (or lines).
     *
     * @param int $numberLines
     */
    public function overwriteLine($numberLines = 1)
    {
        $this->output->write(sprintf("\033[%dA", $numberLines));
    }

    protected function sleepFor($seconds, $cycle = 1)
    {
        $this->progress->setSleepModeState($state = SleepModeState::entering());
        $this->line($state->getMessage());

        $remaining = $seconds;
        while ($remaining > $cycle) {
            $remaining -= $cycle;

            $this->progress->setSleepModeState($state = SleepModeState::remaining($remaining));
            $this->line($state->getMessage());

            sleep($cycle);
        }

        $this->progress->setSleepModeState($state = SleepModeState::leaving());
        $this->line($state->getMessage());
    }


    /** @return Progress */
    protected function createProgressInstance($max, $uid)
    {
        if (!class_exists($progressClass = config('consolify.progress.concrete_class'))) {
            throw new \LogicException("Cannot find progress class [$progressClass]");
        }

        return new $progressClass($this->output->createProgressBar($max), $uid);
        return new $progressClass($this->output->/** @scrutinizer ignore-call */ createProgressBar($max), $uid);
    }
}


tequilarapido / consolify

Push — master ( 17f495...b9e7ef )

Output::setSleepModeStateInProgressBar() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like