fab2s\YaEtl\Laravel\Callbacks\ProgressBarSubscriber

Complexity

Total Complexity

15

Size/Duplication

Total Lines	187
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	start()	0	9	1
A	getOutput()	0	7	2
A	setNumRecords()	0	5	1
A	fail()	0	6	1
A	setProgressMod()	0	5	1
A	getSubscribedEvents()	0	7	1
A	setOutput()	0	5	1
A	displayReport()	0	6	1
A	progress()	0	3	1
A	success()	0	13	2
A	__construct()	0	5	2
A	registerFlow()	0	5	1

<?php

/*
 * This file is part of YaEtl.
 *     (c) Fabrice de Stefanis / https://github.com/fab2s/YaEtl
 * This source file is licensed under the MIT license which you will
 * find in the LICENSE file or at https://opensource.org/licenses/MIT
 */

namespace fab2s\YaEtl\Laravel\Callbacks;

use fab2s\NodalFlow\Events\FlowEvent;
use fab2s\NodalFlow\Events\FlowEventInterface;
use fab2s\NodalFlow\Flows\FlowInterface;
use fab2s\YaEtl\YaEtl;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Class ProgressBarSubscriber
 */
class ProgressBarSubscriber implements EventSubscriberInterface
{
    /**
     * The Laravel output object, extracted from the command object
     *
     * @var ConsoleOutputInterface
     */
    protected $output;

    /**
     * The number of records
     *
     * @var int|null
     */
    protected $numRecords;

    /**
     * Progress modulo, should be aligned with YaEtl's one
     *
     * @var int
     */
    protected $progressMod = 1024;

    /**
     * @var ProgressBar
     */
    protected $progressBar;

    /**
     * ProgressBarSubscriber constructor.
     *
     * @param YaEtl|null $flow
     */
    public function __construct(YaEtl $flow = null)
    {
        if ($flow !== null) {
            // auto register
            $this->registerFlow($flow);
        }
    }

    /**
     * @param YaEtl $flow
     *
     * @return $this
     */
    public function registerFlow(YaEtl $flow)
    {
        $flow->getDispatcher()->addSubscriber($this);

        return $this;
    }

    /**
     * @return OutputInterface
     */
    public function getOutput()
    {
        if (!isset($this->output)) {
            $this->output = new ConsoleOutput;
        }

        return $this->output;
    }

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

$output is of type Symfony\Component\Console\Output\OutputInterface, but the property $output was declared to be of type Symfony\Component\Console\Output\ConsoleOutputInterface. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        return $this;
    }

    /**
     * Set progress modulo
     *
     * @param int $progressMod
     *
     * @return $this
     */
    public function setProgressMod($progressMod)
    {
        $this->progressMod = max(1, (int) $progressMod);

        return $this;
    }

    /**
     * Set the total number of records prior to FLow execution
     *
     * @param int $numRecords
     *
     * @return $this
     */
    public function setNumRecords($numRecords)
    {
        $this->numRecords = $numRecords;

        return $this;
    }

    /**
     * Triggered when a Flow starts
     *
     * @param FlowEventInterface $event
     */
    public function start(FlowEventInterface $event)
    {
        /** @var YaEtl $flow */
        $flow = $event->getFlow();
        $this->setProgressMod($flow->getProgressMod())
            ->getOutput()
            ->writeln('<info>[YaEtl] Start</info>');
        $this->progressBar = new ProgressBar($this->output);
        $this->progressBar->start($this->numRecords);
    }

    /**
     * Triggered when a Flow progresses,
     * eg exec once or generates once
     */
    public function progress()
    {
        $this->progressBar->advance($this->progressMod);
    }

    /**
     * Triggered when a Flow succeeds
     *
     * @param FlowEventInterface $event
     */
    public function success(FlowEventInterface $event)
    {
        $this->progressBar->finish();
        $this->output->writeln(PHP_EOL);
        $flow       = $event->getFlow();
        $flowStatus = $flow->getFlowStatus();
        if ($flowStatus->isDirty()) {
            $this->output->writeln('<warn>[YaEtl] Dirty Success</warn>');
        } else {
            $this->output->writeln('<info>[YaEtl] Clean Success</info>');
        }

        $this->displayReport($flow);
    }

    /**
     * Triggered when a Flow fails
     *
     * @param FlowEventInterface $event
     */
    public function fail(FlowEventInterface $event)
    {
        $this->progressBar->finish();
        $this->output->writeln(PHP_EOL);
        $this->output->writeln('<error>[YaEtl] Failed</error>');
        $this->displayReport($event->getFlow());
    }

    /**
     * @return array
     */
    public static function getSubscribedEvents()
    {
        return [
            FlowEvent::FLOW_START    => ['start', 0],
            FlowEvent::FLOW_PROGRESS => ['progress', 0],
            FlowEvent::FLOW_SUCCESS  => ['success', 0],
            FlowEvent::FLOW_FAIL     => ['fail', 0],
        ];
    }

    /**
     * @param FlowInterface $flow
     *
     * @return $this
     */
    protected function displayReport(FlowInterface $flow)
    {
        $flowStats = $flow->getStats();
        $this->output->writeln($flowStats['report']);

        return $this;
    }
}