Improve Exception handling

Author: nyamsprod

CHANGELOG.md

@@ -8,13 +8,16 @@ All Notable changes to `bakame/stackwatch` will be documented in this file.
 
 - `PerformanceAssertions` to align with `AggregatedMetrics` usage and generation.
 - `Report::iterations()` method is added.
+- `StackWatchException`
+- `NoMetricSelected` exceptions
 
 ### Fixed
 
 - **BC BREAK:**  improve `Report` generation validation and adds missing `Report::iterations()` method 
 - `AggregatedMetrics::dd` and `Statistics::dd` improved implementation
 - **BC BREAK:** global functions are namespaced
-- Improve github actions
+- Improve Github actions
+- **BC BREAK:** exceptions are now all inheriting from a base `StackWatchException`
 
 ### Deprecated
 

docs/1.0/command.md

@@ -41,11 +41,9 @@ trait TimerTrait {
     }
 }
 
-enum Foobar
+class Foobar
 {
     use TimerTrait;
-
-    case Foobar;
 }
 
 #[Profile(iterations: 20, warmup: 2)]

src/InvalidArgument.php

@@ -4,8 +4,6 @@
 
 namespace Bakame\Stackwatch;
 
-use InvalidArgumentException;
-
-final class InvalidArgument extends InvalidArgumentException implements ProfilingException
+class InvalidArgument extends StackWatchException
 {
 }

src/ProfilingException.php src/StackWatchException.phpsrc/ProfilingException.php renamed to src/StackWatchException.php

@@ -4,8 +4,8 @@
 
 namespace Bakame\Stackwatch;
 
-use Throwable;
+use Exception;
 
-interface ProfilingException extends Throwable
+class StackWatchException extends Exception
 {
 }

src/Test/MetricNotSelected.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bakame\Stackwatch\Test;
+
+use Bakame\Stackwatch\StackWatchException;
+
+class MetricNotSelected extends StackWatchException
+{
+}

src/Test/MetricsAssert.php

@@ -8,7 +8,6 @@
 use Bakame\Stackwatch\DurationUnit;
 use Bakame\Stackwatch\MemoryUnit;
 use Bakame\Stackwatch\Metrics;
-use LogicException;
 use PHPUnit\Framework\Assert;
 use ValueError;
 
@@ -47,7 +46,7 @@ public function __call(string $name, array $args = []): self
 
     private function getValue(): float|int
     {
-        null !== $this->current || throw new LogicException('No metric selected before assertion.');
+        null !== $this->current || throw new MetricNotSelected('No metric selected before assertion.');
 
         return $this->metrics->{$this->current}; /* @phpstan-ignore-line */
     }

src/UnableToProfile.php

@@ -4,8 +4,6 @@
 
 namespace Bakame\Stackwatch;
 
-use LogicException;
-
-class UnableToProfile extends LogicException implements ProfilingException
+class UnableToProfile extends StackWatchException
 {
 }