[#.x] - adjusting tests; phpcs; docblocks; minor corrections

niden · niden · commit 16924b61d548 · 2025-11-29T15:32:12.000-06:00
diff --git a/src/Domain/Infrastructure/CommandBus/ContainerHandlerLocator.php b/src/Domain/Infrastructure/CommandBus/ContainerHandlerLocator.php
@@ -35,6 +35,15 @@ public function resolve(CommandInterface $command): HandlerInterface
     {
         $commandClass = get_class($command);
 
+        /**
+         * Phalcon\Api\Domain\Application\User\Command\UserGetCommand
+         *
+         * becomes
+         *
+         * Phalcon\Api\Domain\Application\User\Handler\UserGetHandler
+         *
+         * The location of files DOES matter
+         */
         $handlerClass = str_replace(
             'Command',
             'Handler',
diff --git a/src/Domain/Infrastructure/DataSource/Validation/ValidatorInterface.php b/src/Domain/Infrastructure/DataSource/Validation/ValidatorInterface.php
@@ -16,14 +16,14 @@
 use Phalcon\Api\Domain\Infrastructure\CommandBus\CommandInterface;
 
 /**
- * Validator contract. Accepts a DTO or input and returns a Result.
+ * Validator contract. Accepts a Command and returns a Result.
  */
 interface ValidatorInterface
 {
     /**
-     * Validate a DTO or input structure.
+     * Validate a Command object
      *
-     * @param CommandInterface $command DTO or array
+     * @param CommandInterface $command
      *
      * @return Result
      */
diff --git a/src/Domain/Infrastructure/Enums/Container/AuthDefinitionsEnum.php b/src/Domain/Infrastructure/Enums/Container/AuthDefinitionsEnum.php
@@ -146,7 +146,7 @@ public function isShared(): bool
     }
 
     /**
-     * @param string $className
+     * @param class-string $className
      *
      * @return TService
      */
diff --git a/src/Domain/Infrastructure/Enums/Container/CommonDefinitionsEnum.php b/src/Domain/Infrastructure/Enums/Container/CommonDefinitionsEnum.php
@@ -138,10 +138,6 @@ public function definition(): array
 
     public function isShared(): bool
     {
-        return match ($this) {
-            self::JWTToken,
-            self::JWTTokenCache => false,
-            default             => true,
-        };
+        return true;
     }
 }
diff --git a/src/Domain/Infrastructure/Enums/Container/UserDefinitionsEnum.php b/src/Domain/Infrastructure/Enums/Container/UserDefinitionsEnum.php
@@ -106,56 +106,14 @@ public function definition(): array
                     ],
                 ],
             ],
-            self::UserPostHandler     => [
-                'className' => UserPostHandler::class,
-                'arguments' => [
-                    [
-                        'type' => 'service',
-                        'name' => UserValidator::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => UserMapper::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => UserRepository::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => Registry::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => Security::class,
-                    ],
-                ],
-            ],
-            self::UserPutHandler      => [
-                'className' => UserPutHandler::class,
-                'arguments' => [
-                    [
-                        'type' => 'service',
-                        'name' => UserValidatorUpdate::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => UserMapper::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => UserRepository::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => Registry::class,
-                    ],
-                    [
-                        'type' => 'service',
-                        'name' => Security::class,
-                    ],
-                ],
-            ],
+            self::UserPostHandler     => $this->getServicePutPost(
+                UserPostHandler::class,
+                UserValidator::class
+            ),
+            self::UserPutHandler      => $this->getServicePutPost(
+                UserPutHandler::class,
+                UserValidatorUpdate::class
+            ),
             self::UserMapper          => [
                 'className' => UserMapper::class,
             ],
@@ -209,6 +167,41 @@ private function getService(string $className): array
         ];
     }
 
+    /**
+     * @param class-string $className
+     * @param class-string $validatorName
+     *
+     * @return TService
+     */
+    private function getServicePutPost(string $className, string $validatorName): array
+    {
+        return [
+            'className' => $className,
+            'arguments' => [
+                [
+                    'type' => 'service',
+                    'name' => $validatorName,
+                ],
+                [
+                    'type' => 'service',
+                    'name' => UserMapper::class,
+                ],
+                [
+                    'type' => 'service',
+                    'name' => UserRepository::class,
+                ],
+                [
+                    'type' => 'service',
+                    'name' => Registry::class,
+                ],
+                [
+                    'type' => 'service',
+                    'name' => Security::class,
+                ],
+            ],
+        ];
+    }
+
     /**
      * @param class-string $className
      *
diff --git a/src/Domain/Infrastructure/Enums/Http/RoutesEnum.php b/src/Domain/Infrastructure/Enums/Http/RoutesEnum.php
@@ -44,9 +44,9 @@ enum RoutesEnum: int
      */
     public const EVENT_BEFORE = 'before';
     public const EVENT_FINISH = 'finish';
-    public const GET    = 'get';
-    public const POST   = 'post';
-    public const PUT    = 'put';
+    public const GET          = 'get';
+    public const POST         = 'post';
+    public const PUT          = 'put';
 
     case authLoginPost   = 11;
     case authLogoutPost  = 12;
diff --git a/src/Domain/Infrastructure/Middleware/AbstractMiddleware.php b/src/Domain/Infrastructure/Middleware/AbstractMiddleware.php
@@ -89,7 +89,7 @@ protected function halt(
         /** @var ResponseInterface $response */
         $response = $application->getSharedService(Container::RESPONSE);
         /** @var ResponderInterface $responder */
-        $responder = $application->getService(JsonResponder::class);
+        $responder = $application->getSharedService(JsonResponder::class);
 
         $application->stop();
 
diff --git a/src/Domain/Infrastructure/Middleware/HealthMiddleware.php b/src/Domain/Infrastructure/Middleware/HealthMiddleware.php
@@ -16,7 +16,7 @@
 use Phalcon\Api\Domain\Infrastructure\Container;
 use Phalcon\Api\Domain\Infrastructure\Enums\Http\HttpCodesEnum;
 use Phalcon\Events\Exception as EventsException;
-use Phalcon\Http\Request;
+use Phalcon\Http\RequestInterface;
 use Phalcon\Http\Response\Exception;
 use Phalcon\Mvc\Micro;
 
@@ -31,7 +31,7 @@ final class HealthMiddleware extends AbstractMiddleware
      */
     public function call(Micro $application): bool
     {
-        /** @var Request $request */
+        /** @var RequestInterface $request */
         $request = $application->getSharedService(Container::REQUEST);
 
         if (
diff --git a/src/Domain/Infrastructure/Middleware/ValidateTokenPresenceMiddleware.php b/src/Domain/Infrastructure/Middleware/ValidateTokenPresenceMiddleware.php
@@ -17,7 +17,7 @@
 use Phalcon\Api\Domain\Infrastructure\Enums\Http\HttpCodesEnum;
 use Phalcon\Api\Domain\Infrastructure\Env\EnvManager;
 use Phalcon\Events\Exception as EventsException;
-use Phalcon\Http\Request;
+use Phalcon\Http\RequestInterface;
 use Phalcon\Http\Response\Exception;
 use Phalcon\Mvc\Micro;
 
@@ -32,7 +32,7 @@ final class ValidateTokenPresenceMiddleware extends AbstractMiddleware
      */
     public function call(Micro $application): bool
     {
-        /** @var Request $request */
+        /** @var RequestInterface $request */
         $request = $application->getSharedService(Container::REQUEST);
         /** @var EnvManager $env */
         $env = $application->getSharedService(EnvManager::class);
diff --git a/src/Domain/Infrastructure/Middleware/ValidateTokenStructureMiddleware.php b/src/Domain/Infrastructure/Middleware/ValidateTokenStructureMiddleware.php
@@ -19,7 +19,7 @@
 use Phalcon\Api\Domain\Infrastructure\Enums\Http\HttpCodesEnum;
 use Phalcon\Api\Domain\Infrastructure\Env\EnvManager;
 use Phalcon\Events\Exception as EventsException;
-use Phalcon\Http\Request;
+use Phalcon\Http\RequestInterface;
 use Phalcon\Http\Response\Exception;
 use Phalcon\Mvc\Micro;
 use Phalcon\Support\Registry;
@@ -35,7 +35,7 @@ final class ValidateTokenStructureMiddleware extends AbstractMiddleware
      */
     public function call(Micro $application): bool
     {
-        /** @var Request $request */
+        /** @var RequestInterface $request */
         $request = $application->getSharedService(Container::REQUEST);
         /** @var EnvManager $env */
         $env = $application->getSharedService(EnvManager::class);
diff --git a/src/Domain/Infrastructure/Middleware/ValidateTokenUserMiddleware.php b/src/Domain/Infrastructure/Middleware/ValidateTokenUserMiddleware.php
@@ -14,6 +14,7 @@
 namespace Phalcon\Api\Domain\Infrastructure\Middleware;
 
 use Phalcon\Api\Domain\Infrastructure\DataSource\User\Repository\UserRepository;
+use Phalcon\Api\Domain\Infrastructure\DataSource\User\Repository\UserRepositoryInterface;
 use Phalcon\Api\Domain\Infrastructure\Encryption\TokenManager;
 use Phalcon\Api\Domain\Infrastructure\Encryption\TokenManagerInterface;
 use Phalcon\Api\Domain\Infrastructure\Enums\Http\HttpCodesEnum;
@@ -36,7 +37,7 @@ final class ValidateTokenUserMiddleware extends AbstractMiddleware
      */
     public function call(Micro $application): bool
     {
-        /** @var UserRepository $repository */
+        /** @var UserRepositoryInterface $repository */
         $repository = $application->getSharedService(UserRepository::class);
         /** @var Registry $registry */
         $registry = $application->getSharedService(Registry::class);
diff --git a/tests/Unit/Domain/Application/User/Handler/UserHandlerPutTest.php b/tests/Unit/Domain/Application/User/Handler/UserHandlerPutTest.php
@@ -324,23 +324,23 @@ public function testHandlerSuccess(): void
         $actual = str_starts_with($data['password'], '$argon2i$');
         $this->assertTrue($actual);
 
-        $expected = htmlspecialchars($domainData['namePrefix']);
+        $expected = strip_tags($domainData['namePrefix']);
         $actual   = $data['namePrefix'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameFirst']);
+        $expected = strip_tags($domainData['nameFirst']);
         $actual   = $data['nameFirst'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameMiddle']);
+        $expected = strip_tags($domainData['nameMiddle']);
         $actual   = $data['nameMiddle'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameLast']);
+        $expected = strip_tags($domainData['nameLast']);
         $actual   = $data['nameLast'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameSuffix']);
+        $expected = strip_tags($domainData['nameSuffix']);
         $actual   = $data['nameSuffix'];
         $this->assertSame($expected, $actual);
 
@@ -449,23 +449,23 @@ public function testHandlerSuccessEmptyDates(): void
         $actual = str_starts_with($data['password'], '$argon2i$');
         $this->assertTrue($actual);
 
-        $expected = htmlspecialchars($domainData['namePrefix']);
+        $expected = strip_tags($domainData['namePrefix']);
         $actual   = $data['namePrefix'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameFirst']);
+        $expected = strip_tags($domainData['nameFirst']);
         $actual   = $data['nameFirst'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameMiddle']);
+        $expected = strip_tags($domainData['nameMiddle']);
         $actual   = $data['nameMiddle'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameLast']);
+        $expected = strip_tags($domainData['nameLast']);
         $actual   = $data['nameLast'];
         $this->assertSame($expected, $actual);
 
-        $expected = htmlspecialchars($domainData['nameSuffix']);
+        $expected = strip_tags($domainData['nameSuffix']);
         $actual   = $data['nameSuffix'];
         $this->assertSame($expected, $actual);
 
diff --git a/tests/Unit/Domain/Application/User/Service/UserServiceDispatchTest.php b/tests/Unit/Domain/Application/User/Service/UserServiceDispatchTest.php
@@ -24,6 +24,12 @@
 use Phalcon\Cache\Cache;
 use PHPUnit\Framework\Attributes\BackupGlobals;
 
+use function json_decode;
+use function ob_get_clean;
+use function ob_start;
+use function restore_error_handler;
+use function time;
+
 #[BackupGlobals(true)]
 final class UserServiceDispatchTest extends AbstractUnitTestCase
 {
diff --git a/tests/Unit/Domain/Application/User/Service/UserServiceGetTest.php b/tests/Unit/Domain/Application/User/Service/UserServiceGetTest.php
@@ -18,6 +18,8 @@
 use Phalcon\Api\Tests\AbstractUnitTestCase;
 use Phalcon\Api\Tests\Fixtures\Domain\Migrations\UsersMigration;
 
+use function array_key_first;
+
 final class UserServiceGetTest extends AbstractUnitTestCase
 {
     public function testServiceEmptyUserId(): void
diff --git a/tests/Unit/Domain/Application/User/Service/UserServicePostTest.php b/tests/Unit/Domain/Application/User/Service/UserServicePostTest.php
@@ -22,6 +22,8 @@
 use Phalcon\Api\Tests\AbstractUnitTestCase;
 use Phalcon\Support\Registry;
 
+use function array_key_first;
+use function str_starts_with;
 use function strip_tags;
 
 final class UserServicePostTest extends AbstractUnitTestCase
diff --git a/tests/Unit/Domain/Application/User/Service/UserServicePutTest.php b/tests/Unit/Domain/Application/User/Service/UserServicePutTest.php

Original file line number	Diff line number	Diff line change
`@@ -16,14 +16,14 @@`
`16`	`16`	`use Phalcon\Api\Domain\Infrastructure\CommandBus\CommandInterface;`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Validator contract. Accepts a DTO or input and returns a Result.`
	`19`	`+ * Validator contract. Accepts a Command and returns a Result.`
`20`	`20`	`*/`
`21`	`21`	`interface ValidatorInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * Validate a DTO or input structure.`
	`24`	`+ * Validate a Command object`
`25`	`25`	`*`
`26`		`- * @param CommandInterface $command DTO or array`
	`26`	`+ * @param CommandInterface $command`
`27`	`27`	`*`
`28`	`28`	`* @return Result`
`29`	`29`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ public function isShared(): bool`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`/**`
`149`		`- * @param string $className`
	`149`	`+ * @param class-string $className`
`150`	`150`	`*`
`151`	`151`	`* @return TService`
`152`	`152`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -138,10 +138,6 @@ public function definition(): array`
`138`	`138`
`139`	`139`	`public function isShared(): bool`
`140`	`140`	`{`
`141`		`- return match ($this) {`
`142`		`- self::JWTToken,`
`143`		`- self::JWTTokenCache => false,`
`144`		`- default => true,`
`145`		`- };`
	`141`	`+ return true;`
`146`	`142`	`}`
`147`	`143`	`}`