Merge pull request #104 from TheDragonCode/4.x

Add SilentProgressBar implementation and integrate progress bar toggle in ViewService

Author: andrey-helldar

src/Benchmark.php

@@ -5,6 +5,7 @@
 namespace DragonCode\Benchmark;
 
 use Closure;
+use DragonCode\Benchmark\Contracts\ProgressBar;
 use DragonCode\Benchmark\Exceptions\NoComparisonsException;
 use DragonCode\Benchmark\Services\AssertService;
 use DragonCode\Benchmark\Services\CallbacksService;
@@ -14,7 +15,6 @@
 use DragonCode\Benchmark\Services\RunnerService;
 use DragonCode\Benchmark\Services\ViewService;
 use DragonCode\Benchmark\Transformers\ResultTransformer;
-use DragonCode\Benchmark\View\ProgressBarView;
 
 use function abs;
 use function count;
@@ -48,6 +48,7 @@ public static function make(): static
      * Sets a callback to be executed before all iterations for each comparison.
      *
      * @param  Closure(int|string $name): mixed  $callback
+     *
      * @return $this
      */
     public function before(Closure $callback): static
@@ -61,6 +62,7 @@ public function before(Closure $callback): static
      * Sets a callback to be executed before each iteration.
      *
      * @param  Closure(int|string $name, int<1, max> $iteration): mixed  $callback
+     *
      * @return $this
      */
     public function beforeEach(Closure $callback): static
@@ -74,6 +76,7 @@ public function beforeEach(Closure $callback): static
      * Sets a callback to be executed after all iterations for each comparison.
      *
      * @param  Closure(int|string $name): mixed  $callback
+     *
      * @return $this
      */
     public function after(Closure $callback): static
@@ -87,6 +90,7 @@ public function after(Closure $callback): static
      * Sets a callback to be executed after each iteration.
      *
      * @param  Closure(int|string $name, int<1, max> $iteration, float $time, float $memory): mixed  $callback
+     *
      * @return $this
      */
     public function afterEach(Closure $callback): static
@@ -100,6 +104,7 @@ public function afterEach(Closure $callback): static
      * Sets the number of iterations for each comparison.
      *
      * @param  int<1, max>  $count
+     *
      * @return $this
      */
     public function iterations(int $count): static
@@ -113,6 +118,7 @@ public function iterations(int $count): static
      * Enables deviation calculation and sets the number of runs.
      *
      * @param  int<2, max>  $count
+     *
      * @return $this
      */
     public function deviations(int $count = 2): static
@@ -128,6 +134,7 @@ public function deviations(int $count = 2): static
      * Sets the rounding precision for time values.
      *
      * @param  int<0, max>|null  $precision  The number of decimal places. Null means no rounding.
+     *
      * @return $this
      */
     public function round(?int $precision): static
@@ -144,7 +151,7 @@ public function round(?int $precision): static
      */
     public function disableProgressBar(): static
     {
-        $this->view->progressBar()->disable();
+        $this->view->disable();
 
         return $this;
     }
@@ -153,6 +160,7 @@ public function disableProgressBar(): static
      * Registers callback functions for comparison.
      *
      * @param  array|Closure  ...$callbacks  Callback functions or an array of callback functions for comparison.
+     *
      * @return $this
      */
     public function compare(array|Closure ...$callbacks): static
@@ -234,7 +242,7 @@ protected function performCompare(): void
         $callbacks = $this->callbacks->compare;
 
         $this->withProgress(
-            callback: fn (ProgressBarView $bar) => $this->chunks($callbacks, $bar),
+            callback: fn (ProgressBar $bar) => $this->chunks($callbacks, $bar),
             total   : $this->steps($callbacks)
         );
     }
@@ -248,7 +256,7 @@ protected function performDeviation(): void
 
         $callbacks = $this->callbacks->compare;
 
-        $this->withProgress(function (ProgressBarView $bar) use (&$results, $callbacks) {
+        $this->withProgress(function (ProgressBar $bar) use (&$results, $callbacks) {
             for ($i = 1; $i <= $this->deviations; $i++) {
                 $this->clear();
 
@@ -298,9 +306,9 @@ protected function steps(array $callbacks, int $multiplier = 1): int
      * Executes all callback functions with before/after hooks.
      *
      * @param  array  $callbacks  An array of callback functions.
-     * @param  ProgressBarView  $progressBar  The progress bar.
+     * @param  ProgressBar  $progressBar  The progress bar.
      */
-    protected function chunks(array $callbacks, ProgressBarView $progressBar): void
+    protected function chunks(array $callbacks, ProgressBar $progressBar): void
     {
         foreach ($callbacks as $name => $callback) {
             $this->callbacks->performBefore($name);
@@ -316,9 +324,9 @@ protected function chunks(array $callbacks, ProgressBarView $progressBar): void
      *
      * @param  mixed  $name  The callback name.
      * @param  Closure  $callback  The callback function to execute.
-     * @param  ProgressBarView  $progressBar  The progress bar.
+     * @param  ProgressBar  $progressBar  The progress bar.
      */
-    protected function run(mixed $name, Closure $callback, ProgressBarView $progressBar): void
+    protected function run(mixed $name, Closure $callback, ProgressBar $progressBar): void
     {
         for ($i = 1; $i <= $this->iterations; $i++) {
             $result = $this->callbacks->performBeforeEach($name, $i);
@@ -338,6 +346,7 @@ protected function run(mixed $name, Closure $callback, ProgressBarView $progress
      *
      * @param  Closure  $callback  The callback function to execute.
      * @param  array  $parameters  Parameters to pass to the callback.
+     *
      * @return array An array [time in milliseconds, memory in bytes].
      */
     protected function call(Closure $callback, array $parameters = []): array

src/Contracts/ProgressBar.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\Benchmark\Contracts;
+
+interface ProgressBar
+{
+    public function create(int $total): static;
+
+    public function advance(int $step = 1): void;
+
+    public function finish(): void;
+}

src/Services/ViewService.php

@@ -4,18 +4,33 @@
 
 namespace DragonCode\Benchmark\Services;
 
+use DragonCode\Benchmark\Contracts\ProgressBar;
 use DragonCode\Benchmark\View\LineView;
 use DragonCode\Benchmark\View\ProgressBarView;
+use DragonCode\Benchmark\View\SilentProgressBarView;
 use DragonCode\Benchmark\View\TableView;
 
 class ViewService
 {
+    protected bool $enabled = true;
+
     public function __construct(
         protected TableView $table = new TableView,
-        protected ProgressBarView $progressBar = new ProgressBarView,
         protected LineView $line = new LineView,
+        protected ProgressBarView $progressBar = new ProgressBarView,
+        protected SilentProgressBarView $silentProgressBar = new SilentProgressBarView,
     ) {}
 
+    /**
+     * @return $this
+     */
+    public function disable(): static
+    {
+        $this->enabled = false;
+
+        return $this;
+    }
+
     /**
      * Displays a table with benchmark results.
      *
@@ -29,9 +44,11 @@ public function table(array $data): void
     /**
      * Returns the progress bar instance.
      */
-    public function progressBar(): ProgressBarView
+    public function progressBar(): ProgressBar
     {
-        return $this->progressBar;
+        return $this->enabled
+            ? $this->progressBar
+            : $this->silentProgressBar;
     }
 
     /**
@@ -41,7 +58,9 @@ public function progressBar(): ProgressBarView
      */
     public function line(string $text): void
     {
-        $this->line->line($text);
+        if ($this->enabled) {
+            $this->line->line($text);
+        }
     }
 
     /**
@@ -51,6 +70,8 @@ public function line(string $text): void
      */
     public function emptyLine(int $count = 1): void
     {
-        $this->line->newLine($count);
+        if ($this->enabled) {
+            $this->line->newLine($count);
+        }
     }
 }

src/View/ProgressBarView.php

@@ -4,36 +4,25 @@
 
 namespace DragonCode\Benchmark\View;
 
+use DragonCode\Benchmark\Contracts\ProgressBar;
+
 use function floor;
 use function max;
 use function str_repeat;
 
-class ProgressBarView extends View
+class ProgressBarView extends View implements ProgressBar
 {
-    protected bool $enabled = true;
-
     protected int $current = 0;
 
     protected int $barWidth = 28;
 
     protected int $total = 100;
 
-    /**
-     * Disables the progress bar display.
-     *
-     * @return $this
-     */
-    public function disable(): static
-    {
-        $this->enabled = false;
-
-        return $this;
-    }
-
     /**
      * Creates a progress bar with the specified total number of steps.
      *
      * @param  int  $total  The total number of steps.
+     *
      * @return $this
      */
     public function create(int $total): static
@@ -66,20 +55,14 @@ public function finish(): void
 
         $this->display();
 
-        if ($this->enabled) {
-            $this->write(PHP_EOL);
-        }
+        $this->write(PHP_EOL);
     }
 
     /**
      * Renders the current state of the progress bar.
      */
     protected function display(): void
     {
-        if (! $this->enabled) {
-            return;
-        }
-
         $percent  = $this->current / $this->total;
         $filled   = (int) floor($percent * $this->barWidth);
         $empty    = $this->barWidth - $filled;

src/View/SilentProgressBarView.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\Benchmark\View;
+
+use DragonCode\Benchmark\Contracts\ProgressBar;
+
+class SilentProgressBarView extends View implements ProgressBar
+{
+    public function create(int $total): static
+    {
+        return $this;
+    }
+
+    public function advance(int $step = 1): void {}
+
+    public function finish(): void {}
+}

tests/.pest/snapshots/Unit/Fails/WithoutComparisonsTest/_without_comparisons__→_toConsole.snap

@@ -1,5 +0,0 @@
-
- 0/1 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░] 0% 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
-
-
-[INFO] No comparisons were made.

tests/.pest/snapshots/Unit/Result/DisabledProgressBar/to_assert.snap

@@ -1,14 +1,10 @@
-
- 0/1 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░] 0% 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
-
-
-+-------+-------------------------------+------------------------------+
-| #     | 0                             | 1                            |
-+-------+-------------------------------+------------------------------+
-| min   | 15.67890123 ms - 202 bytes    | 2.3456789 ms - 102 bytes     |
-| max   | 112.78901234 ms - 209 bytes   | 9.75678901 ms - 109 bytes    |
-| avg   | 53.02524845125 ms - 205 bytes | 5.94290024625 ms - 105 bytes |
-| total | 424.20198761 ms - 1.61 KB     | 47.54320197 ms - 844 bytes   |
-+-------+-------------------------------+------------------------------+
-| order | 2                             | 1                            |
-+-------+-------------------------------+------------------------------+
++-------+-------------------------------+------------------------------+
+| #     | 0                             | 1                            |
++-------+-------------------------------+------------------------------+
+| min   | 15.67890123 ms - 202 bytes    | 2.3456789 ms - 102 bytes     |
+| max   | 112.78901234 ms - 209 bytes   | 9.75678901 ms - 109 bytes    |
+| avg   | 53.02524845125 ms - 205 bytes | 5.94290024625 ms - 105 bytes |
+| total | 424.20198761 ms - 1.61 KB     | 47.54320197 ms - 844 bytes   |
++-------+-------------------------------+------------------------------+
+| order | 2                             | 1                            |
++-------+-------------------------------+------------------------------+