AlecRabbit\Tools\BenchmarkSymfonyProgressBar

Complexity

Total Complexity

7

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Test Coverage

Coverage

77.78%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	29	1
A	getOutput()	0	3	1
A	refineProgressBarWidth()	0	7	1
A	getProgressBar()	0	3	1
A	sectionSeparator()	0	7	1
A	showComment()	0	3	1
A	createProgressBar()	0	16	1

<?php declare(strict_types=1);

namespace AlecRabbit\Tools;

use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Output\ConsoleOutput;
use function AlecRabbit\Helpers\bounds;

class BenchmarkSymfonyProgressBar extends Benchmark
{
    public const DEFAULT_PROGRESSBAR_FORMAT = ' %percent:3s%% [%bar%] %elapsed:6s%/%estimated:-6s%';
    public const PROGRESS_BAR_MIN_WIDTH = 60;
    public const PROGRESS_BAR_MAX_WIDTH = 80;

    /** @var ConsoleOutput */
    protected $output;

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

    public function __construct(
        int $iterations = 1000,
        ?int $progressBarMax = null,
        ?ConsoleOutput $output = null,
        ?ProgressBar $progressBar = null
    ) {
        parent::__construct($iterations);
        $this->output = $output ?? new ConsoleOutput();
        $this->advanceSteps = $progressBarMax ?? $this->advanceSteps;

        $this->progressBar = $progressBar ?? $this->createProgressBar();

        $progressStart =
            function (): void {
                $this->progressBar->start();
            };

        $progressAdvance =
            function (): void {
                $this->progressBar->advance();
            };

        $progressFinish =
            function (): void {
                $this->progressBar->finish();
                $this->progressBar->clear();
            };

        $this->showProgressBy($progressStart, $progressAdvance, $progressFinish);
    }

    /**
     * @return ProgressBar
     */
    protected function createProgressBar(): ProgressBar
    {
        $progressBar = new ProgressBar($this->output, $this->advanceSteps);
        $progressBar->setBarWidth($this->terminalWidth());
        $progressBar->setFormat(static::DEFAULT_PROGRESSBAR_FORMAT);

        // the finished part of the bar
        $progressBar->setBarCharacter('█');

        // the unfinished part of the bar
        $progressBar->setEmptyBarCharacter('░'); // ░ ▒ ▓

        // the progress character
        $progressBar->setProgressCharacter('');

        return $progressBar;
    }

    /**
     * @param null|int $progressBarWidth
     * @return int
     */
    protected function refineProgressBarWidth(?int $progressBarWidth): int
    {
        return
            (int)bounds(
                $progressBarWidth ?? $this->terminalWidth,
                static::PROGRESS_BAR_MIN_WIDTH,
                static::PROGRESS_BAR_MAX_WIDTH
            );
    }

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

    /**
     * @return ProgressBar
     */
    public function getProgressBar(): ProgressBar
    {
        return $this->progressBar;
    }

    protected function showComment(string $comment = ''): void
    {
        $this->output->writeln('<comment>' . $comment . '</>');
    }

    protected function sectionSeparator(?string $char): string
    {
        return
            ' ' . str_repeat(
                $char ?? static::DEFAULT_SEPARATOR_CHAR,
                $this->terminalWidth - 2
            ) . ' ' . PHP_EOL . PHP_EOL;
    }
}