ResponseTrait -> HandlerTrait and ResponseTrait

Signed-off-by: alexmerlin <[email protected]>

phpunit.xml

@@ -2,6 +2,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
+         stopOnError="true"
          stopOnFailure="true"
          colors="true">
     <testsuites>

psalm-baseline.xml

@@ -27,4 +27,10 @@
             <code>matching</code>
         </UndefinedInterfaceMethod>
     </file>
+    <file src="src/App/src/Handler/ResponseTrait.php">
+        <UndefinedThisPropertyFetch>
+            <code>$this->responseFactory</code>
+            <code>$this->resourceGenerator</code>
+        </UndefinedThisPropertyFetch>
+    </file>
 </files>

src/Admin/src/Entity/Admin.php

@@ -28,16 +28,16 @@ class Admin extends AbstractEntity implements UserEntityInterface
     ];
 
     #[ORM\Column(name: "identity", type: "string", length: 100, unique: true)]
-    protected string $identity;
+    protected string $identity = '';
 
     #[ORM\Column(name: "firstName", type: "string", length: 255)]
-    protected string $firstName;
+    protected string $firstName = '';
 
     #[ORM\Column(name: "lastName", type: "string", length: 255)]
-    protected string $lastName;
+    protected string $lastName = '';
 
     #[ORM\Column(name: "password", type: "string", length: 100)]
-    protected string $password;
+    protected string $password = '';
 
     #[ORM\Column(name: "status", type: "string", length: 20)]
     protected string $status = self::STATUS_ACTIVE;

src/Admin/src/Entity/AdminRole.php

@@ -22,7 +22,7 @@ class AdminRole extends AbstractEntity implements RoleInterface
     ];
 
     #[ORM\Column(name: "name", type: "string", length: 30, unique: true)]
-    protected string $name;
+    protected string $name = '';
 
     public function getName(): string
     {

src/Admin/src/Handler/AdminAccountHandler.php

@@ -10,7 +10,7 @@
 use Api\App\Exception\BadRequestException;
 use Api\App\Exception\ConflictException;
 use Api\App\Exception\NotFoundException;
-use Api\App\Handler\ResponseTrait;
+use Api\App\Handler\HandlerTrait;
 use Dot\AnnotatedServices\Annotation\Inject;
 use Mezzio\Hal\HalResponseFactory;
 use Mezzio\Hal\ResourceGenerator;
@@ -20,7 +20,7 @@
 
 class AdminAccountHandler implements RequestHandlerInterface
 {
-    use ResponseTrait;
+    use HandlerTrait;
 
     /**
      * @Inject({
@@ -50,7 +50,7 @@ public function get(ServerRequestInterface $request): ResponseInterface
      */
     public function patch(ServerRequestInterface $request): ResponseInterface
     {
-        $inputFilter = (new UpdateAdminInputFilter())->setData($request->getParsedBody());
+        $inputFilter = (new UpdateAdminInputFilter())->setData((array) $request->getParsedBody());
         if (! $inputFilter->isValid()) {
             throw (new BadRequestException())->setMessages($inputFilter->getMessages());
         }

src/Admin/src/Handler/AdminHandler.php

@@ -11,7 +11,7 @@
 use Api\App\Exception\BadRequestException;
 use Api\App\Exception\ConflictException;
 use Api\App\Exception\NotFoundException;
-use Api\App\Handler\ResponseTrait;
+use Api\App\Handler\HandlerTrait;
 use Api\App\Message;
 use Dot\AnnotatedServices\Annotation\Inject;
 use Mezzio\Hal\HalResponseFactory;
@@ -24,7 +24,7 @@
 
 class AdminHandler implements RequestHandlerInterface
 {
-    use ResponseTrait;
+    use HandlerTrait;
 
     /**
      * @Inject({
@@ -86,7 +86,7 @@ public function getCollection(ServerRequestInterface $request): ResponseInterfac
      */
     public function patch(ServerRequestInterface $request): ResponseInterface
     {
-        $inputFilter = (new UpdateAdminInputFilter())->setData($request->getParsedBody());
+        $inputFilter = (new UpdateAdminInputFilter())->setData((array) $request->getParsedBody());
         if (! $inputFilter->isValid()) {
             throw (new BadRequestException())->setMessages($inputFilter->getMessages());
         }
@@ -109,7 +109,7 @@ public function patch(ServerRequestInterface $request): ResponseInterface
      */
     public function post(ServerRequestInterface $request): ResponseInterface
     {
-        $inputFilter = (new CreateAdminInputFilter())->setData($request->getParsedBody());
+        $inputFilter = (new CreateAdminInputFilter())->setData((array) $request->getParsedBody());
         if (! $inputFilter->isValid()) {
             throw (new BadRequestException())->setMessages($inputFilter->getMessages());
         }

src/Admin/src/Handler/AdminRoleHandler.php

@@ -7,7 +7,7 @@
 use Api\Admin\Entity\AdminRole;
 use Api\Admin\Service\AdminRoleServiceInterface;
 use Api\App\Exception\NotFoundException;
-use Api\App\Handler\ResponseTrait;
+use Api\App\Handler\HandlerTrait;
 use Api\App\Message;
 use Dot\AnnotatedServices\Annotation\Inject;
 use Mezzio\Hal\HalResponseFactory;
@@ -20,7 +20,7 @@
 
 class AdminRoleHandler implements RequestHandlerInterface
 {
-    use ResponseTrait;
+    use HandlerTrait;
 
     /**
      * @Inject({

src/App/src/Handler/ErrorReportHandler.php

@@ -22,7 +22,7 @@
  */
 class ErrorReportHandler implements RequestHandlerInterface
 {
-    use ResponseTrait;
+    use HandlerTrait;
 
     /**
      * @Inject({

src/App/src/Handler/HandlerTrait.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Api\App\Handler;
+
+use Api\App\Exception\BadRequestException;
+use Api\App\Exception\ConflictException;
+use Api\App\Exception\ExpiredException;
+use Api\App\Exception\ForbiddenException;
+use Api\App\Exception\MethodNotAllowedException;
+use Api\App\Exception\NotFoundException;
+use Api\App\Exception\UnauthorizedException;
+use Dot\Mail\Exception\MailException;
+use Exception;
+use Fig\Http\Message\RequestMethodInterface;
+use Fig\Http\Message\StatusCodeInterface;
+use Mezzio\Hal\Metadata\MetadataMap;
+use Mezzio\Hal\Metadata\RouteBasedCollectionMetadata;
+use Mezzio\Hal\ResourceGenerator\Exception\OutOfBoundsException;
+use Mezzio\Router\RouteResult;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use RuntimeException;
+
+use function array_key_exists;
+use function is_array;
+use function method_exists;
+use function sprintf;
+use function strtolower;
+
+trait HandlerTrait
+{
+    use ResponseTrait;
+
+    /**
+     * @throws Exception
+     */
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        try {
+            $method = strtolower($request->getMethod());
+            if ($this->isGetCollectionRequest($request, $this->config)) {
+                $method = 'getCollection';
+            }
+
+            if (! method_exists($this, $method)) {
+                throw new MethodNotAllowedException(
+                    sprintf('Method %s is not implemented for the requested resource.', $method)
+                );
+            }
+
+            return $this->$method($request);
+        } catch (ConflictException $exception) {
+            return $this->errorResponse($exception->getMessage(), StatusCodeInterface::STATUS_CONFLICT);
+        } catch (ForbiddenException $exception) {
+            return $this->errorResponse($exception->getMessage(), StatusCodeInterface::STATUS_FORBIDDEN);
+        } catch (ExpiredException $exception) {
+            return $this->errorResponse($exception->getMessage(), StatusCodeInterface::STATUS_GONE);
+        } catch (OutOfBoundsException | NotFoundException $exception) {
+            return $this->errorResponse($exception->getMessage(), StatusCodeInterface::STATUS_NOT_FOUND);
+        } catch (UnauthorizedException $exception) {
+            return $this->errorResponse($exception->getMessage(), StatusCodeInterface::STATUS_UNAUTHORIZED);
+        } catch (MethodNotAllowedException $exception) {
+            return $this->errorResponse($exception->getMessage(), StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED);
+        } catch (BadRequestException $exception) {
+            return $this->errorResponse($exception->getMessages(), StatusCodeInterface::STATUS_BAD_REQUEST);
+        } catch (MailException | RuntimeException | Exception $exception) {
+            return $this->errorResponse($exception->getMessage());
+        }
+    }
+
+    /**
+     * @throws RuntimeException
+     */
+    private function isGetCollectionRequest(ServerRequestInterface $request, array $config): bool
+    {
+        if ($request->getMethod() !== RequestMethodInterface::METHOD_GET) {
+            return false;
+        }
+
+        if (! array_key_exists(MetadataMap::class, $config)) {
+            throw new RuntimeException(
+                sprintf('Unable to load %s from config.', MetadataMap::class)
+            );
+        }
+
+        /** @var RouteResult $routeResult */
+        $routeResult = $request->getAttribute(RouteResult::class);
+        $routeName   = $routeResult->getMatchedRouteName();
+
+        $halConfig = null;
+        foreach ($config[MetadataMap::class] as $cfg) {
+            if ($cfg['route'] === $routeName) {
+                $halConfig = $cfg;
+                break;
+            }
+        }
+
+        return is_array($halConfig)
+            && array_key_exists('__class__', $halConfig)
+            && $halConfig['__class__'] === RouteBasedCollectionMetadata::class;
+    }
+}

src/App/src/Handler/HomeHandler.php

@@ -8,12 +8,11 @@
 use Mezzio\Hal\HalResponseFactory;
 use Mezzio\Hal\ResourceGenerator;
 use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
 class HomeHandler implements RequestHandlerInterface
 {
-    use ResponseTrait;
+    use HandlerTrait;
 
     /**
      * @Inject({
@@ -29,7 +28,7 @@ public function __construct(
     ) {
     }
 
-    public function get(ServerRequestInterface $request): ResponseInterface
+    public function get(): ResponseInterface
     {
         return $this->jsonResponse(['message' => 'Welcome to DotKernel API!']);
     }

src/App/src/Handler/NotFoundHandler.php

@@ -10,7 +10,7 @@
 
 class NotFoundHandler implements RequestHandlerInterface
 {
-    use ResponseTrait;
+    use HandlerTrait;
 
     public function handle(ServerRequestInterface $request): ResponseInterface
     {