exceptions improved

src/Dash.php

@@ -4,7 +4,7 @@
 
 namespace Dakujem\Toru;
 
-use BadMethodCallException;
+use Dakujem\Toru\Exceptions\BadMethodCallException;
 use IteratorAggregate;
 use Traversable;
 

src/Exceptions/BadMethodCallException.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dakujem\Toru\Exceptions;
+
+/**
+ * A call to a method that does not exist or is not supported.
+ *
+ * @author Andrej Rypak <xrypak@gmail.com>
+ */
+class BadMethodCallException extends \BadMethodCallException implements IndicatesUnintendedToruUsage
+{
+}

src/Exceptions/EmptyCollectionException.php

@@ -10,7 +10,7 @@
 /**
  * @author Andrej Rypák (dakujem) <xrypak@gmail.com>
  */
-final class EmptyCollectionException extends RuntimeException
+final class EmptyCollectionException extends RuntimeException implements IndicatesExceptionalCase
 {
     public iterable $input;
 

src/Exceptions/IndicatesExceptionalCase.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dakujem\Toru\Exceptions;
+
+/**
+ * Interface for exceptional cases encountered.
+ *
+ * @author Andrej Rypak <xrypak@gmail.com>
+ */
+interface IndicatesExceptionalCase extends ToruException
+{
+}

src/Exceptions/IndicatesUnintendedToruUsage.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dakujem\Toru\Exceptions;
+
+/**
+ * Interface for exceptions indicating invalid use of Toru.
+ *
+ * @author Andrej Rypak <xrypak@gmail.com>
+ */
+interface IndicatesUnintendedToruUsage extends ToruException
+{
+}

src/Exceptions/NoMatchingElementFound.php

@@ -10,7 +10,7 @@
 /**
  * @author Andrej Rypák (dakujem) <xrypak@gmail.com>
  */
-final class NoMatchingElementFound extends RuntimeException
+final class NoMatchingElementFound extends RuntimeException implements IndicatesExceptionalCase
 {
     public iterable $input;
     /** @var callable */

src/Exceptions/ToruException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dakujem\Toru\Exceptions;
+
+use Throwable;
+
+/**
+ * Base interface for all exceptions thrown by Toru.
+ *
+ * @author Andrej Rypak <xrypak@gmail.com>
+ */
+interface ToruException extends Throwable
+{
+}

src/Exceptions/UnexpectedValueException.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dakujem\Toru\Exceptions;
+
+/**
+ * A callable provided a value that is out of range or of invalid type.
+ *
+ * @author Andrej Rypak <xrypak@gmail.com>
+ */
+class UnexpectedValueException extends \UnexpectedValueException implements IndicatesUnintendedToruUsage
+{
+}

src/IteraFn.php

@@ -4,7 +4,7 @@
 
 namespace Dakujem\Toru;
 
-use BadMethodCallException;
+use Dakujem\Toru\Exceptions\BadMethodCallException;
 
 /**
  * Static factory for partially applied variants of iteration primitives and utilities.

src/Regenerator.php

@@ -5,8 +5,8 @@
 namespace Dakujem\Toru;
 
 use Closure;
+use Dakujem\Toru\Exceptions\UnexpectedValueException;
 use IteratorAggregate;
-use LogicException;
 use Traversable;
 
 /**
@@ -34,7 +34,7 @@ public function getIterator(): Traversable
     {
         $collection = ($this->callable)();
         if (!is_iterable($collection)) {
-            throw new LogicException('The value returned by the provider callable is not an iterable collection.');
+            throw new UnexpectedValueException('The value returned by the provider callable is not an iterable collection.');
         }
         return Itera::ensureTraversable(
             input: $collection

tests/regenerator.phpt

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Dakujem\Toru\Exceptions\UnexpectedValueException;
 use Dakujem\Toru\Itera;
 use Dakujem\Toru\Regenerator;
 use Tester\Assert;
@@ -60,5 +61,5 @@ require_once __DIR__ . '/../vendor/autoload.php';
     $faulty = new Regenerator(fn() => 'foo');
     Assert::throws(function () use ($faulty) {
         iterator_to_array($faulty);
-    }, LogicException::class, 'The value returned by the provider callable is not an iterable collection.');
+    }, UnexpectedValueException::class, 'The value returned by the provider callable is not an iterable collection.');
 })();