Merge pull request #100 from TheDragonCode/4.x

Add `disableProgressBar` method to suppress progress bar display in console

Author: andrey-helldar

README.md

@@ -686,6 +686,20 @@ new Benchmark()
     ->toBeTotalMemory(till: 4096); // the memory footprint should not exceed 4096 bytes
 ```
 
+### Disable Progress Bar
+
+In some cases, it is necessary to disable the progressbar so that it does not interfere in the console.
+
+To do this, use the `disableProgressBar` method:
+
+```PHP
+use DragonCode\Benchmark\Benchmark;
+
+new Benchmark()
+    ->disableProgressBar()
+    // ...
+```
+
 ## License
 
 This package is licensed under the [MIT License](LICENSE).

src/Benchmark.php

@@ -113,6 +113,13 @@ public function round(?int $precision): static
         return $this;
     }
 
+    public function disableProgressBar(): static
+    {
+        $this->view->progressBar()->disable();
+
+        return $this;
+    }
+
     public function compare(array|Closure ...$callbacks): static
     {
         $this->clear();

src/View/ProgressBarView.php

@@ -10,12 +10,21 @@
 
 class ProgressBarView extends View
 {
+    protected bool $enabled = true;
+
     protected int $current = 0;
 
     protected int $barWidth = 28;
 
     protected int $total = 100;
 
+    public function disable(): static
+    {
+        $this->enabled = false;
+
+        return $this;
+    }
+
     public function create(int $total): static
     {
         $this->total = max(1, $total);
@@ -38,11 +47,17 @@ public function finish(): void
 
         $this->display();
 
-        $this->write(PHP_EOL);
+        if ($this->enabled) {
+            $this->write(PHP_EOL);
+        }
     }
 
     protected function display(): void
     {
+        if (! $this->enabled) {
+            return;
+        }
+
         $percent  = $this->current / $this->total;
         $filled   = (int) floor($percent * $this->barWidth);
         $empty    = $this->barWidth - $filled;

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

@@ -0,0 +1,3 @@
+
+
+

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

@@ -0,0 +1,13 @@
+
+
+
++-------+-------------------------------+------------------------------+
+| #     | 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                            |
++-------+-------------------------------+------------------------------+

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

@@ -0,0 +1,3 @@
+
+
+

tests/Unit/Result/DisabledProgressBar.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+test('to console', function () {
+    benchmark()
+        ->disableProgressBar()
+        ->toConsole();
+
+    expectOutputToMatchSnapshot();
+});
+
+test('to data', function () {
+    benchmark()
+        ->disableProgressBar()
+        ->toData();
+
+    expectOutputToMatchSnapshot();
+});
+
+test('to assert', function () {
+    benchmark()
+        ->disableProgressBar()
+        ->toAssert();
+
+    expectOutputToMatchSnapshot();
+});