Merge pull request #30 from Jeckel-Lab/feature/rework-exceptions

Feature/rework exceptions

README.md

@@ -192,6 +192,21 @@ $speed1 === $speed2; // is true
 
 > See detailed implementation proposal: [jeckel-lab/query-dispatcher](https://github.com/Jeckel-Lab/query-dispatcher)
 
+## Exceptions
+
+Each layer has it's own Exception interface that extends `Throwable`:
+
+- Core: [CoreException](src/Core/Exception/CoreException.php)
+- Domain: [DomainException](src/Domain/Exception/DomainException.php)
+- Infrastructure: [InfrastructureException](src/Infrastructure/Exception/InfrastructureException.php)
+- Presentation: [PresentationException](src/Presentation/Exception/PresentationException.php)
+
+In each layer, when we need to throw an Exception, we create a new class corresponding to the type of Exception. This class must:
+
+- extends one of the [SPL exception](https://www.php.net/manual/en/spl.exceptions.php) or another (more generic) exception from the same namespace.
+- implements the exception interface of the current layer.
+
+
 ## Old Documentation
 
 ### Core

src/Core/CommandDispatcher/CommandBus/CommandBus.php

@@ -9,6 +9,7 @@
 
 use JeckelLab\Contract\Core\CommandDispatcher\Command\Command;
 use JeckelLab\Contract\Core\CommandDispatcher\CommandResponse\CommandResponse;
+use JeckelLab\Contract\Core\CommandDispatcher\Exception\NoHandlerDefinedForCommandException;
 
 /**
  * Interface CommandBus
@@ -19,6 +20,7 @@ interface CommandBus
     /**
      * @param Command $command
      * @return CommandResponse
+     * @throws NoHandlerDefinedForCommandException
      */
     public function dispatch(Command $command): CommandResponse;
 }

src/Core/CommandDispatcher/CommandHandler/CommandHandler.php

@@ -9,7 +9,7 @@
 
 use JeckelLab\Contract\Core\CommandDispatcher\Command\Command;
 use JeckelLab\Contract\Core\CommandDispatcher\CommandResponse\CommandResponse;
-use JeckelLab\Contract\Core\CommandDispatcher\Exception\InvalidCommandException;
+use JeckelLab\Contract\Core\CommandDispatcher\Exception\InvalidCommandTypeException;
 
 /**
  * Interface CommandHandler
@@ -27,7 +27,7 @@ public static function getHandledCommands(): array;
     /**
      * @param CommandType $command
      * @return CommandResponse
-     * @throws InvalidCommandException
+     * @throws InvalidCommandTypeException
      */
     public function __invoke(Command $command): CommandResponse;
 }

src/Core/CommandDispatcher/Exception/CommandDispatcherException.php

@@ -7,13 +7,13 @@
 
 namespace JeckelLab\Contract\Core\CommandDispatcher\Exception;
 
-use JeckelLab\Contract\Core\Exception\CoreMainException;
+use JeckelLab\Contract\Core\Exception\CoreException;
 
 /**
  * Interface CommandDispatcherException
  * @package JeckelLab\Contract\Core\CommandDispatcher\Exception
  * @psalm-immutable
  */
-interface CommandDispatcherException extends CoreMainException
+interface CommandDispatcherException extends CoreException
 {
 }

src/Core/CommandDispatcher/Exception/InvalidCommandException.php → src/Core/CommandDispatcher/Exception/InvalidCommandTypeException.php

@@ -9,13 +9,14 @@
 
 namespace JeckelLab\Contract\Core\CommandDispatcher\Exception;
 
-use JeckelLab\Contract\Core\Exception\RuntimeException;
+use LogicException;
 
 /**
  * Class InvalidCommandException
  * @package JeckelLab\Contract\Core\CommandDispatcher\Exception
  * @psalm-immutable
+ * @psalm-suppress MutableDependency
  */
-class InvalidCommandException extends RuntimeException implements CommandDispatcherException
+class InvalidCommandTypeException extends LogicException implements CommandDispatcherException
 {
 }

src/Core/CommandDispatcher/CommandBus/Exception/NoHandlerDefinedForCommandException.php → src/Core/CommandDispatcher/Exception/NoHandlerDefinedForCommandException.php

@@ -7,17 +7,18 @@
 
 declare(strict_types=1);
 
-namespace JeckelLab\Contract\Core\CommandDispatcher\CommandBus\Exception;
+namespace JeckelLab\Contract\Core\CommandDispatcher\Exception;
 
 use JeckelLab\Contract\Core\CommandDispatcher\Command\Command;
-use JeckelLab\Contract\Core\Exception\LogicException;
+use LogicException;
 
 /**
  * Class NoHandlerDefinedForCommandException
- * @package JeckelLab\Contract\Core\CommandDispatcher\CommandBus\Exception
+ * @package JeckelLab\Contract\Core\CommandDispatcher\Exception
  * @psalm-immutable
+ * @psalm-suppress MutableDependency
  */
-class NoHandlerDefinedForCommandException extends LogicException implements CommandBusException
+class NoHandlerDefinedForCommandException extends LogicException implements CommandDispatcherException
 {
     /**
      * @param Command $command

src/Core/Exception/CoreMainException.php → src/Core/Exception/CoreException.php

@@ -7,13 +7,13 @@
 
 namespace JeckelLab\Contract\Core\Exception;
 
-use JeckelLab\Contract\Exception\MainException;
+use Throwable;
 
 /**
  * Interface CoreMainException
  * @package JeckelLab\Contract\Core\Exception
  * @psalm-immutable
  */
-interface CoreMainException extends MainException
+interface CoreException extends Throwable
 {
 }

src/Core/QueryDispatcher/Exception/InvalidQueryException.php → src/Core/QueryDispatcher/Exception/InvalidQueryTypeException.php

@@ -9,14 +9,14 @@
 
 namespace JeckelLab\Contract\Core\QueryDispatcher\Exception;
 
-use JeckelLab\Contract\Core\Exception\RuntimeException;
+use LogicException;
 
 /**
  * Class InvalidQueryException
  * @package JeckelLab\Contract\Core\QueryDispatcher\Exception
  * @psalm-immutable
  * @psalm-suppress MutableDependency
  */
-class InvalidQueryException extends RuntimeException implements QueryDispatcherException
+class InvalidQueryTypeException extends LogicException implements QueryDispatcherException
 {
 }

src/Core/QueryDispatcher/QueryBus/Exception/NoHandlerDefinedForQueryException.php → src/Core/QueryDispatcher/Exception/NoHandlerDefinedForQueryException.php

@@ -7,18 +7,18 @@
 
 declare(strict_types=1);
 
-namespace JeckelLab\Contract\Core\QueryDispatcher\QueryBus\Exception;
+namespace JeckelLab\Contract\Core\QueryDispatcher\Exception;
 
-use JeckelLab\Contract\Core\Exception\LogicException;
 use JeckelLab\Contract\Core\QueryDispatcher\Query\Query;
+use LogicException;
 
 /**
  * Class NoHandlerDefinedForQueryException
- * @package JeckelLab\Contract\Core\QueryDispatcher\QueryBus\Exception
+ * @package JeckelLab\Contract\Core\QueryDispatcher\Exception
  * @psalm-immutable
  * @psalm-suppress MutableDependency
  */
-class NoHandlerDefinedForQueryException extends LogicException implements QueryBusException
+class NoHandlerDefinedForQueryException extends LogicException implements QueryDispatcherException
 {
     /**
      * @param Query $query

src/Core/QueryDispatcher/Exception/QueryDispatcherException.php

@@ -7,13 +7,13 @@
 
 namespace JeckelLab\Contract\Core\QueryDispatcher\Exception;
 
-use JeckelLab\Contract\Core\Exception\CoreMainException;
+use JeckelLab\Contract\Core\Exception\CoreException;
 
 /**
  * Interface QueryDispatcherException
  * @package JeckelLab\Contract\Core\QueryDispatcher\Exception
  * @psalm-immutable
  */
-interface QueryDispatcherException extends CoreMainException
+interface QueryDispatcherException extends CoreException
 {
 }

src/Core/QueryDispatcher/QueryBus/QueryBus.php

@@ -7,6 +7,7 @@
 
 namespace JeckelLab\Contract\Core\QueryDispatcher\QueryBus;
 
+use JeckelLab\Contract\Core\QueryDispatcher\Exception\NoHandlerDefinedForQueryException;
 use JeckelLab\Contract\Core\QueryDispatcher\Query\Query;
 use JeckelLab\Contract\Core\QueryDispatcher\ViewModel\ViewModel;
 
@@ -15,6 +16,7 @@ interface QueryBus
     /**
      * @param Query $query
      * @return ViewModel
+     * @throws NoHandlerDefinedForQueryException
      */
     public function dispatch(Query $query): ViewModel;
 }

src/Core/QueryDispatcher/QueryHandler/QueryHandler.php

@@ -7,7 +7,7 @@
 
 namespace JeckelLab\Contract\Core\QueryDispatcher\QueryHandler;
 
-use JeckelLab\Contract\Core\QueryDispatcher\Exception\InvalidQueryException;
+use JeckelLab\Contract\Core\QueryDispatcher\Exception\InvalidQueryTypeException;
 use JeckelLab\Contract\Core\QueryDispatcher\Query\Query;
 use JeckelLab\Contract\Core\QueryDispatcher\ViewModel\ViewModel;
 
@@ -22,7 +22,7 @@ public static function getHandledQueries(): array;
     /**
      * @param Query $query
      * @return ViewModel
-     * @throws InvalidQueryException
+     * @throws InvalidQueryTypeException
      */
     public function __invoke(Query $query): ViewModel;
 }

src/Domain/Identity/Exception/InvalidIdException.php

@@ -9,7 +9,7 @@
 
 namespace JeckelLab\Contract\Domain\Identity\Exception;
 
-use JeckelLab\Contract\Domain\Exception\InvalidArgumentException;
+use InvalidArgumentException;
 
 /**
  * Class InvalidIdException
@@ -18,6 +18,7 @@
  *
  * @package JeckelLab\Contract\Domain\Identity\Exception
  * @psalm-immutable
+ * @psalm-suppress MutableDependency
  */
 class InvalidIdException extends InvalidArgumentException implements IdentityException
 {

src/Domain/ValueObject/Exception/InvalidArgumentException.php

@@ -9,13 +9,14 @@
 
 namespace JeckelLab\Contract\Domain\ValueObject\Exception;
 
-use JeckelLab\Contract\Domain\Exception\InvalidArgumentException as DomainInvalidArgumentException;
+use InvalidArgumentException as InvalidArgumentExceptionCore;
 
 /**
  * Class InvalidArgumentException
  * @package ValueObject\Exception
  * @psalm-immutable
+ * @psalm-suppress MutableDependency
  */
-class InvalidArgumentException extends DomainInvalidArgumentException implements ValueObjectException
+class InvalidArgumentException extends InvalidArgumentExceptionCore implements ValueObjectException
 {
 }