Merge pull request #53 from yceruto/cqs_improvements

Improve CQS System
mtarld · Dec 27, 2023 · e3a90e1 · e3a90e1
2 parents 97fee96 + 4df5705
commit e3a90e1
Show file tree

Hide file tree

Showing 39 changed files with 121 additions and 50 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -19,6 +19,9 @@
         ],
         'declare_strict_types' => true,
         'nullable_type_declaration_for_default_null_value' => false,
+        'phpdoc_to_comment' => [
+            'ignored_tags' => ['var'],
+        ],
     ])
     ->setRiskyAllowed(true)
     ->setFinder($finder)

diff --git a/config/packages/framework.php b/config/packages/framework.php
@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use App\BookStore\Domain\Exception\MissingBookException;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
@@ -20,6 +21,11 @@
             'php_errors' => [
                 'log' => 4096,
             ],
+            'exceptions' => [
+                MissingBookException::class => [
+                    'status_code' => 404,
+                ],
+            ],
         ],
     );
     if ('test' === $containerConfigurator->env()) {

diff --git a/src/BookStore/Application/Command/AnonymizeBooksCommand.php b/src/BookStore/Application/Command/AnonymizeBooksCommand.php
@@ -6,6 +6,9 @@
 
 use App\Shared\Application\Command\CommandInterface;
 
+/**
+ * @implements CommandInterface<void>
+ */
 final readonly class AnonymizeBooksCommand implements CommandInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Command/AnonymizeBooksCommandHandler.php b/src/BookStore/Application/Command/AnonymizeBooksCommandHandler.php
@@ -6,9 +6,10 @@
 
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
 use App\BookStore\Domain\ValueObject\Author;
-use App\Shared\Application\Command\CommandHandlerInterface;
+use App\Shared\Application\Command\AsCommandHandler;
 
-final readonly class AnonymizeBooksCommandHandler implements CommandHandlerInterface
+#[AsCommandHandler]
+final readonly class AnonymizeBooksCommandHandler
 {
     public function __construct(private BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Application/Command/CreateBookCommand.php b/src/BookStore/Application/Command/CreateBookCommand.php
@@ -4,13 +4,17 @@
 
 namespace App\BookStore\Application\Command;
 
+use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\Author;
 use App\BookStore\Domain\ValueObject\BookContent;
 use App\BookStore\Domain\ValueObject\BookDescription;
 use App\BookStore\Domain\ValueObject\BookName;
 use App\BookStore\Domain\ValueObject\Price;
 use App\Shared\Application\Command\CommandInterface;
 
+/**
+ * @implements CommandInterface<Book>
+ */
 final readonly class CreateBookCommand implements CommandInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Command/CreateBookCommandHandler.php b/src/BookStore/Application/Command/CreateBookCommandHandler.php
@@ -6,9 +6,10 @@
 
 use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Command\CommandHandlerInterface;
+use App\Shared\Application\Command\AsCommandHandler;
 
-final readonly class CreateBookCommandHandler implements CommandHandlerInterface
+#[AsCommandHandler]
+final readonly class CreateBookCommandHandler
 {
     public function __construct(private readonly BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Application/Command/DeleteBookCommand.php b/src/BookStore/Application/Command/DeleteBookCommand.php
@@ -7,6 +7,9 @@
 use App\BookStore\Domain\ValueObject\BookId;
 use App\Shared\Application\Command\CommandInterface;
 
+/**
+ * @implements CommandInterface<void>
+ */
 final readonly class DeleteBookCommand implements CommandInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Command/DeleteBookCommandHandler.php b/src/BookStore/Application/Command/DeleteBookCommandHandler.php
@@ -5,9 +5,10 @@
 namespace App\BookStore\Application\Command;
 
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Command\CommandHandlerInterface;
+use App\Shared\Application\Command\AsCommandHandler;
 
-final readonly class DeleteBookCommandHandler implements CommandHandlerInterface
+#[AsCommandHandler]
+final readonly class DeleteBookCommandHandler
 {
     public function __construct(private BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Application/Command/DiscountBookCommand.php b/src/BookStore/Application/Command/DiscountBookCommand.php
@@ -8,6 +8,9 @@
 use App\BookStore\Domain\ValueObject\Discount;
 use App\Shared\Application\Command\CommandInterface;
 
+/**
+ * @implements CommandInterface<void>
+ */
 final readonly class DiscountBookCommand implements CommandInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Command/DiscountBookCommandHandler.php b/src/BookStore/Application/Command/DiscountBookCommandHandler.php
@@ -6,9 +6,10 @@
 
 use App\BookStore\Domain\Exception\MissingBookException;
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Command\CommandHandlerInterface;
+use App\Shared\Application\Command\AsCommandHandler;
 
-final readonly class DiscountBookCommandHandler implements CommandHandlerInterface
+#[AsCommandHandler]
+final readonly class DiscountBookCommandHandler
 {
     public function __construct(private BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Application/Command/UpdateBookCommand.php b/src/BookStore/Application/Command/UpdateBookCommand.php
@@ -4,6 +4,7 @@
 
 namespace App\BookStore\Application\Command;
 
+use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\Author;
 use App\BookStore\Domain\ValueObject\BookContent;
 use App\BookStore\Domain\ValueObject\BookDescription;
@@ -12,6 +13,9 @@
 use App\BookStore\Domain\ValueObject\Price;
 use App\Shared\Application\Command\CommandInterface;
 
+/**
+ * @implements CommandInterface<Book>
+ */
 final readonly class UpdateBookCommand implements CommandInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Command/UpdateBookCommandHandler.php b/src/BookStore/Application/Command/UpdateBookCommandHandler.php
@@ -7,9 +7,10 @@
 use App\BookStore\Domain\Exception\MissingBookException;
 use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Command\CommandHandlerInterface;
+use App\Shared\Application\Command\AsCommandHandler;
 
-final readonly class UpdateBookCommandHandler implements CommandHandlerInterface
+#[AsCommandHandler]
+final readonly class UpdateBookCommandHandler
 {
     public function __construct(private BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Application/Query/FindBookQuery.php b/src/BookStore/Application/Query/FindBookQuery.php
@@ -4,9 +4,13 @@
 
 namespace App\BookStore\Application\Query;
 
+use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\BookId;
 use App\Shared\Application\Query\QueryInterface;
 
+/**
+ * @implements QueryInterface<Book>
+ */
 final readonly class FindBookQuery implements QueryInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Query/FindBookQueryHandler.php b/src/BookStore/Application/Query/FindBookQueryHandler.php
@@ -4,18 +4,25 @@
 
 namespace App\BookStore\Application\Query;
 
+use App\BookStore\Domain\Exception\MissingBookException;
 use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Query\QueryHandlerInterface;
+use App\Shared\Application\Query\AsQueryHandler;
 
-final readonly class FindBookQueryHandler implements QueryHandlerInterface
+#[AsQueryHandler]
+final readonly class FindBookQueryHandler
 {
     public function __construct(private BookRepositoryInterface $repository)
     {
     }
 
-    public function __invoke(FindBookQuery $query): ?Book
+    public function __invoke(FindBookQuery $query): Book
     {
-        return $this->repository->ofId($query->id);
+        $book = $this->repository->ofId($query->id);
+        if (null === $book) {
+            throw new MissingBookException($query->id);
+        }
+
+        return $book;
     }
 }
diff --git a/src/BookStore/Application/Query/FindBooksQuery.php b/src/BookStore/Application/Query/FindBooksQuery.php
@@ -4,9 +4,13 @@
 
 namespace App\BookStore\Application\Query;
 
+use App\BookStore\Domain\Repository\BookRepositoryInterface;
 use App\BookStore\Domain\ValueObject\Author;
 use App\Shared\Application\Query\QueryInterface;
 
+/**
+ * @implements QueryInterface<BookRepositoryInterface>
+ */
 final readonly class FindBooksQuery implements QueryInterface
 {
     public function __construct(

diff --git a/src/BookStore/Application/Query/FindBooksQueryHandler.php b/src/BookStore/Application/Query/FindBooksQueryHandler.php
@@ -5,9 +5,10 @@
 namespace App\BookStore\Application\Query;
 
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Query\QueryHandlerInterface;
+use App\Shared\Application\Query\AsQueryHandler;
 
-final readonly class FindBooksQueryHandler implements QueryHandlerInterface
+#[AsQueryHandler]
+final readonly class FindBooksQueryHandler
 {
     public function __construct(private BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Application/Query/FindCheapestBooksQuery.php b/src/BookStore/Application/Query/FindCheapestBooksQuery.php
@@ -4,8 +4,12 @@
 
 namespace App\BookStore\Application\Query;
 
+use App\BookStore\Domain\Repository\BookRepositoryInterface;
 use App\Shared\Application\Query\QueryInterface;
 
+/**
+ * @implements QueryInterface<BookRepositoryInterface>
+ */
 final readonly class FindCheapestBooksQuery implements QueryInterface
 {
     public function __construct(public int $size = 10)

diff --git a/src/BookStore/Application/Query/FindCheapestBooksQueryHandler.php b/src/BookStore/Application/Query/FindCheapestBooksQueryHandler.php
@@ -5,9 +5,10 @@
 namespace App\BookStore\Application\Query;
 
 use App\BookStore\Domain\Repository\BookRepositoryInterface;
-use App\Shared\Application\Query\QueryHandlerInterface;
+use App\Shared\Application\Query\AsQueryHandler;
 
-final readonly class FindCheapestBooksQueryHandler implements QueryHandlerInterface
+#[AsQueryHandler]
+final readonly class FindCheapestBooksQueryHandler
 {
     public function __construct(private BookRepositoryInterface $bookRepository)
     {

diff --git a/src/BookStore/Infrastructure/ApiPlatform/Resource/BookResource.php b/src/BookStore/Infrastructure/ApiPlatform/Resource/BookResource.php
@@ -110,7 +110,7 @@ public function __construct(
     ) {
     }
 
-    public static function fromModel(Book $book): static
+    public static function fromModel(Book $book): self
     {
         return new self(
             $book->id()->value,

diff --git a/src/BookStore/Infrastructure/ApiPlatform/State/Processor/CreateBookProcessor.php b/src/BookStore/Infrastructure/ApiPlatform/State/Processor/CreateBookProcessor.php
@@ -7,7 +7,6 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProcessorInterface;
 use App\BookStore\Application\Command\CreateBookCommand;
-use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\Author;
 use App\BookStore\Domain\ValueObject\BookContent;
 use App\BookStore\Domain\ValueObject\BookDescription;
@@ -45,7 +44,6 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
             new Price($data->price),
         );
 
-        /** @var Book $model */
         $model = $this->commandBus->dispatch($command);
 
         return BookResource::fromModel($model);

diff --git a/src/BookStore/Infrastructure/ApiPlatform/State/Processor/DiscountBookProcessor.php b/src/BookStore/Infrastructure/ApiPlatform/State/Processor/DiscountBookProcessor.php
@@ -8,7 +8,6 @@
 use ApiPlatform\State\ProcessorInterface;
 use App\BookStore\Application\Command\DiscountBookCommand;
 use App\BookStore\Application\Query\FindBookQuery;
-use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\BookId;
 use App\BookStore\Domain\ValueObject\Discount;
 use App\BookStore\Infrastructure\ApiPlatform\Payload\DiscountBookPayload;
@@ -42,7 +41,6 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
 
         $this->commandBus->dispatch($command);
 
-        /** @var Book $model */
         $model = $this->queryBus->ask(new FindBookQuery($command->id));
 
         return BookResource::fromModel($model);

diff --git a/src/BookStore/Infrastructure/ApiPlatform/State/Processor/UpdateBookProcessor.php b/src/BookStore/Infrastructure/ApiPlatform/State/Processor/UpdateBookProcessor.php
@@ -7,7 +7,6 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProcessorInterface;
 use App\BookStore\Application\Command\UpdateBookCommand;
-use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\Author;
 use App\BookStore\Domain\ValueObject\BookContent;
 use App\BookStore\Domain\ValueObject\BookDescription;
@@ -44,7 +43,6 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
             null !== $data->price ? new Price($data->price) : null,
         );
 
-        /** @var Book $model */
         $model = $this->commandBus->dispatch($command);
 
         return BookResource::fromModel($model);

diff --git a/src/BookStore/Infrastructure/ApiPlatform/State/Provider/BookCollectionProvider.php b/src/BookStore/Infrastructure/ApiPlatform/State/Provider/BookCollectionProvider.php
@@ -8,7 +8,6 @@
 use ApiPlatform\State\Pagination\Pagination;
 use ApiPlatform\State\ProviderInterface;
 use App\BookStore\Application\Query\FindBooksQuery;
-use App\BookStore\Domain\Repository\BookRepositoryInterface;
 use App\BookStore\Domain\ValueObject\Author;
 use App\BookStore\Infrastructure\ApiPlatform\Resource\BookResource;
 use App\Shared\Application\Query\QueryBusInterface;
@@ -39,7 +38,6 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             $limit = $this->pagination->getLimit($operation, $context);
         }
 
-        /** @var BookRepositoryInterface $models */
         $models = $this->queryBus->ask(new FindBooksQuery(null !== $author ? new Author($author) : null, $offset, $limit));
 
         $resources = [];

diff --git a/src/BookStore/Infrastructure/ApiPlatform/State/Provider/BookItemProvider.php b/src/BookStore/Infrastructure/ApiPlatform/State/Provider/BookItemProvider.php
@@ -7,7 +7,6 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
 use App\BookStore\Application\Query\FindBookQuery;
-use App\BookStore\Domain\Model\Book;
 use App\BookStore\Domain\ValueObject\BookId;
 use App\BookStore\Infrastructure\ApiPlatform\Resource\BookResource;
 use App\Shared\Application\Query\QueryBusInterface;
@@ -28,9 +27,8 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
         /** @var string $id */
         $id = $uriVariables['id'];
 
-        /** @var Book|null $model */
         $model = $this->queryBus->ask(new FindBookQuery(new BookId(Uuid::fromString($id))));
 
-        return null !== $model ? BookResource::fromModel($model) : null;
+        return BookResource::fromModel($model);
     }
 }
diff --git a/src/BookStore/Infrastructure/ApiPlatform/State/Provider/CheapestBooksProvider.php b/src/BookStore/Infrastructure/ApiPlatform/State/Provider/CheapestBooksProvider.php
@@ -7,7 +7,6 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
 use App\BookStore\Application\Query\FindCheapestBooksQuery;
-use App\BookStore\Domain\Repository\BookRepositoryInterface;
 use App\BookStore\Infrastructure\ApiPlatform\Resource\BookResource;
 use App\Shared\Application\Query\QueryBusInterface;
 
@@ -25,7 +24,6 @@ public function __construct(private QueryBusInterface $queryBus)
      */
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): array
     {
-        /** @var BookRepositoryInterface $models */
         $models = $this->queryBus->ask(new FindCheapestBooksQuery());
 
         $resources = [];

diff --git a/...ation/Command/CommandHandlerInterface.php → .../Application/Command/AsCommandHandler.php b/...ation/Command/CommandHandlerInterface.php → .../Application/Command/AsCommandHandler.php
@@ -4,6 +4,7 @@
 
 namespace App\Shared\Application\Command;
 
-interface CommandHandlerInterface
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class AsCommandHandler
 {
 }
diff --git a/src/Shared/Application/Command/CommandBusInterface.php b/src/Shared/Application/Command/CommandBusInterface.php
@@ -6,5 +6,12 @@
 
 interface CommandBusInterface
 {
+    /**
+     * @template T
+     *
+     * @param CommandInterface<T> $command
+     *
+     * @return T
+     */
     public function dispatch(CommandInterface $command): mixed;
 }
diff --git a/src/Shared/Application/Command/CommandInterface.php b/src/Shared/Application/Command/CommandInterface.php
@@ -4,6 +4,9 @@
 
 namespace App\Shared\Application\Command;
 
+/**
+ * @template T
+ */
 interface CommandInterface
 {
 }