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

Feature/rework exceptions

Author: jeckel

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/CommandBus/Exception/CommandBusException.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/CommandHandler/CommandHandler.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/CommandDispatcherException.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/Exception/InvalidCommandException.php renamed to src/Core/CommandDispatcher/Exception/InvalidCommandTypeException.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/CommandDispatcher/CommandBus/Exception/NoHandlerDefinedForCommandException.php renamed to src/Core/CommandDispatcher/Exception/NoHandlerDefinedForCommandException.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
 {
 }