TaskTracker\Subscriber\SymfonyConsoleProgress

Complexity

Total Complexity

13

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getSubscribedEvents()	0	9	1
A	__construct()	0	4	1
A	start()	0	15	3
A	tick()	0	31	4
A	finish()	0	10	2
A	abort()	0	5	2

<?php

/**
 * Tack Tracker - A library for tracking long-running task progress
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/caseyamcl/tasktracker
 * @version 2.0
 * @package caseyamcl/tasktracker
 * @author Casey McLaughlin <caseyamcl@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * ------------------------------------------------------------------
 */

namespace TaskTracker\Subscriber;

use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use TaskTracker\Events;
use TaskTracker\Helper\BytesToHumanTrait;
use TaskTracker\Tick;

/**
 * Symfony Console Progress Bar Task Tracker Subscriber
 *
 * @author Casey McLaughlin <caseyamcl@gmail.com>
 */
class SymfonyConsoleProgress implements EventSubscriberInterface
{
    // Use traits for prettier output
    use BytesToHumanTrait;

    // ---------------------------------------------------------------

    /**
     * @var OutputInterface;
     */
    private $output;

    /**
     * @var ProgressBar|null  Set at runtime
     */
    private $progressBar;

    // --------------------------------------------------------------

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            Events::TRACKER_START  => 'start',
            Events::TRACKER_TICK   => 'tick',
            Events::TRACKER_FINISH => 'finish',
            Events::TRACKER_ABORT  => 'abort'
        ];
    }

    // --------------------------------------------------------------

    /**
     * Constructor
     *
     * @param OutputInterface $output
     */
    public function __construct(OutputInterface $output)
    {
        $this->output = $output;
    }

    // ---------------------------------------------------------------

    /**
     * Start callback
     *
     * @param Tick $tick
     */
    public function start(Tick $tick)
    {
        if ($tick->getMessage()) {
            $this->output->writeln($tick->getMessage());
        }

        $this->progressBar = new ProgressBar(
            $this->output,
            $tick->getReport()->getTotalItemCount() > -1
                ? $tick->getReport()->getTotalItemCount()
                : 0
        );

        $this->progressBar->start();
    }

    // ---------------------------------------------------------------

    /**
     * Tick callback
     *
     * @param Tick $tick
     */
    public function tick(Tick $tick)
    {
        $rpt = $tick->getReport();

        if ( ! $this->progressBar) {
            $this->start($tick);
        }

        $msgSegs = [$tick->getMessage()];

        if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
            $msgSegs[] = sprintf('Processed: <fg=green>%s</fg=green>', number_format($rpt->getNumItemsSuccess(), 0));
            $msgSegs[] = sprintf('Skipped: <fg=yellow>%s</fg=yellow>', number_format($rpt->getNumItemsFail(), 0));
            $msgSegs[] = sprintf('Failed: <fg=red>%s</fg=red>'       , number_format($rpt->getNumItemsSkip(), 0));
        }

        if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE) {

            $msgSegs[] = sprintf("Avg: %s", number_format($rpt->getAvgItemTime(), 2));

            $msgSegs[] = sprintf(
                'Memory: %s/%s',
                $this->bytesToHuman($rpt->getMemUsage(),   2),
                $this->bytesToHuman($rpt->getMemPeakUsage(), 2)
            );
        }

        $this->progressBar->setMessage(implode(' | ', $msgSegs));
        $this->progressBar->setProgress($rpt->getNumItemsProcessed());
        //$this->progressBar->advance($rpt->getTick()->getIncrementBy());
    }

    /**
     * Finish callback
     *
     * @param Tick $tick
     */
    public function finish(Tick $tick)
    {
        $this->progressBar->finish();

        if ($tick->getMessage()) {

            $this->output->writeln(PHP_EOL . $tick->getMessage());
        }

    }

    /**
     * Abort callback
     *
     * @param Tick $tick
     */
    public function abort(Tick $tick)
    {
        $this->progressBar->clear();
        $this->output->writeln($tick->getMessage() ?: 'Aborted');
    }
}