Merge pull request #97 from TheDragonCode/4.x

Handle cases with no comparisons: throw `NoComparisonsException` for `toAssert` and log info message for `toConsole`.

Author: andrey-helldar

src/Benchmark.php

@@ -5,6 +5,7 @@
 namespace DragonCode\Benchmark;
 
 use Closure;
+use DragonCode\Benchmark\Exceptions\NoComparisonsException;
 use DragonCode\Benchmark\Services\AssertService;
 use DragonCode\Benchmark\Services\CallbacksService;
 use DragonCode\Benchmark\Services\CollectorService;
@@ -133,22 +134,26 @@ public function toData(): array
         return $this->mapResult();
     }
 
-    public function toConsole(): static
+    public function toConsole(): void
     {
-        $table = $this->transformer->toTable(
-            $this->toData()
-        );
+        if (! $data = $this->toData()) {
+            $this->view->line('[INFO] No comparisons were made.');
 
-        $this->view->table($table);
+            return;
+        }
 
-        return $this;
+        $this->view->table(
+            $this->transformer->toTable($data)
+        );
     }
 
     public function toAssert(): AssertService
     {
-        return new AssertService(
-            $this->toData()
-        );
+        if (! $data = $this->toData()) {
+            throw new NoComparisonsException;
+        }
+
+        return new AssertService($data);
     }
 
     protected function perform(): void

src/Exceptions/NoComparisonsException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\Benchmark\Exceptions;
+
+use RuntimeException;
+
+class NoComparisonsException extends RuntimeException
+{
+    public function __construct()
+    {
+        parent::__construct('Method "compare" was not called. No comparisons were made.');
+    }
+}

src/Services/ViewService.php

@@ -26,6 +26,11 @@ public function progressBar(): ProgressBarView
         return $this->progressBar;
     }
 
+    public function line(string $text): void
+    {
+        $this->line->line($text);
+    }
+
     public function emptyLine(int $count = 1): void
     {
         $this->line->newLine($count);

src/View/LineView.php

@@ -6,6 +6,11 @@
 
 class LineView extends View
 {
+    public function line(string $text): void
+    {
+        $this->writeLine($text);
+    }
+
     public function newLine(int $count = 1): void
     {
         for ($i = 0; $i < $count; $i++) {

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

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

tests/.pest/snapshots/Unit/Round/RoundTest/round_with_data_set___0____0_.snap

@@ -0,0 +1,14 @@
+
+ 0/1 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░] 0% 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
+
+
+┌───────┬────────────────────┬───────────────────┐
+│ #     │ 0                  │ 1                 │
+├───────┼────────────────────┼───────────────────┤
+│ min   │ 16 ms - 202 bytes  │ 2 ms - 102 bytes  │
+│ max   │ 113 ms - 209 bytes │ 10 ms - 109 bytes │
+│ avg   │ 53 ms - 205 bytes  │ 6 ms - 105 bytes  │
+│ total │ 424 ms - 1.61 KB   │ 48 ms - 844 bytes │
+├───────┼────────────────────┼───────────────────┤
+│ order │ 2                  │ 1                 │
+└───────┴────────────────────┴───────────────────┘

tests/.pest/snapshots/Unit/Round/RoundTest/round_with_data_set___2____2_.snap

@@ -0,0 +1,14 @@
+
+ 0/1 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░] 0% 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
+
+
+┌───────┬───────────────────────┬──────────────────────┐
+│ #     │ 0                     │ 1                    │
+├───────┼───────────────────────┼──────────────────────┤
+│ min   │ 15.68 ms - 202 bytes  │ 2.35 ms - 102 bytes  │
+│ max   │ 112.79 ms - 209 bytes │ 9.76 ms - 109 bytes  │
+│ avg   │ 53.03 ms - 205 bytes  │ 5.94 ms - 105 bytes  │
+│ total │ 424.2 ms - 1.61 KB    │ 47.54 ms - 844 bytes │
+├───────┼───────────────────────┼──────────────────────┤
+│ order │ 2                     │ 1                    │
+└───────┴───────────────────────┴──────────────────────┘

tests/.pest/snapshots/Unit/Round/RoundTest/round_with_data_set___5____5_.snap

@@ -0,0 +1,14 @@
+
+ 0/1 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░] 0% 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
+
+
+┌───────┬──────────────────────────┬────────────────────────┐
+│ #     │ 0                        │ 1                      │
+├───────┼──────────────────────────┼────────────────────────┤
+│ min   │ 15.6789 ms - 202 bytes   │ 2.34568 ms - 102 bytes │
+│ max   │ 112.78901 ms - 209 bytes │ 9.75679 ms - 109 bytes │
+│ avg   │ 53.02525 ms - 205 bytes  │ 5.9429 ms - 105 bytes  │
+│ total │ 424.20199 ms - 1.61 KB   │ 47.5432 ms - 844 bytes │
+├───────┼──────────────────────────┼────────────────────────┤
+│ order │ 2                        │ 1                      │
+└───────┴──────────────────────────┴────────────────────────┘

tests/Unit/Fails/FailureTest.php …s/Unit/Fails/IncorrectParametersTest.phptests/Unit/Fails/FailureTest.php renamed to tests/Unit/Fails/IncorrectParametersTest.php tests/Unit/Fails/FailureTest.php renamed to tests/Unit/Fails/IncorrectParametersTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\Benchmark\Exceptions\NoComparisonsException;
+
+describe('without comparisons', function () {
+    test('toData', function () {
+        $result = benchmark(false)->toData();
+
+        expect($result)->toBeEmpty();
+    });
+
+    test('toConsole', function () {
+        benchmark(false)->toConsole();
+
+        expectOutputToMatchSnapshot();
+    });
+
+    test('toAssert', function () {
+        benchmark(false)->toAssert();
+    })->throws(NoComparisonsException::class);
+});