More adjustents

Author: byjg

.github/workflows/build-app-image.yml

@@ -57,18 +57,18 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       # Login against a Docker registry to pull the GHCR image
       # https://github.com/docker/login-action
       - name: Log into registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -85,7 +85,7 @@ jobs:
       # Build image locally to enable to run the test
       # https://github.com/docker/build-push-action
       - name: Build Docker image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: docker/Dockerfile

builder/BaseScripts.php

@@ -14,7 +14,7 @@
 
 class BaseScripts
 {
-    protected $workdir;
+    protected string|false $workdir;
     protected string $systemOs;
 
     public function __construct()
@@ -47,9 +47,9 @@ public function fixDir($command)
     /**
      * Execute the given command by displaying console output live to the user.
      *
-     * @param string|array $cmd :  command to be executed
-     * @return array   exit_status  :  exit status of the executed command
-     *                  output       :  console output of the executed command
+     * @param array|string $cmd :  command to be executed
+     * @return array|null exit_status  :  exit status of the executed command
+     *                    output       :  console output of the executed command
      * @throws ConfigException
      * @throws ConfigNotFoundException
      * @throws DependencyInjectionException
@@ -58,7 +58,7 @@ public function fixDir($command)
      * @throws KeyNotFoundException
      * @throws ReflectionException
      */
-    protected function liveExecuteCommand($cmd): ?array
+    protected function liveExecuteCommand(array|string $cmd): ?array
     {
         // while (@ ob_end_flush()); // end all output buffers if any
 

builder/PostCreateScript.php

@@ -6,16 +6,17 @@
 use ByJG\JwtWrapper\JwtWrapper;
 use ByJG\Util\Uri;
 use Composer\Script\Event;
+use Exception;
 use RecursiveCallbackFilterIterator;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
 
 class PostCreateScript
 {
-    public function execute($workdir, $namespace, $composerName, $phpVersion, $mysqlConnection, $timezone)
+    public function execute($workdir, $namespace, $composerName, $phpVersion, $mysqlConnection, $timezone): void
     {
         // ------------------------------------------------
-        // Defining function to interatively walking through the directories
+        // Defining function to interactively walking through the directories
         $directory = new RecursiveDirectoryIterator($workdir);
         $filter = new RecursiveCallbackFilterIterator($directory, function ($current/*, $key, $iterator*/) {
             // Skip hidden files and directories.
@@ -88,12 +89,12 @@ public function execute($workdir, $namespace, $composerName, $phpVersion, $mysql
         $objects = new RecursiveIteratorIterator($filter);
         foreach ($objects as $name => $object) {
             $contents = file_get_contents($name);
-            if (strpos($contents, 'RestReferenceArchitecture') !== false) {
+            if (str_contains($contents, 'RestReferenceArchitecture')) {
                 echo "$name\n";
 
                 // Replace inside Quotes
                 $contents = preg_replace(
-                    "/([\'\"])RestReferenceArchitecture(.*?[\'\"])/",
+                    "/(['\"])RestReferenceArchitecture(.*?['\"])/",
                     '$1' . str_replace('\\', '\\\\\\\\', $namespace) . '$2',
                     $contents
                 );
@@ -117,6 +118,11 @@ public function execute($workdir, $namespace, $composerName, $phpVersion, $mysql
         }
     }
 
+    /**
+     * @param Event $event
+     * @return void
+     * @throws Exception
+     */
     public static function run(Event $event)
     {
         $workdir = realpath(__DIR__ . '/..');
@@ -129,35 +135,35 @@ public static function run(Event $event)
             if (in_array($arg, $validPHPVersions)) {
                 return $arg;
             }
-            throw new \Exception('Only the PHP versions ' . implode(', ', $validPHPVersions) . ' are supported');
+            throw new Exception('Only the PHP versions ' . implode(', ', $validPHPVersions) . ' are supported');
         };
 
         $validateNamespace = function ($arg) {
             if (empty($arg) || !preg_match('/^[A-Z][a-zA-Z0-9]*$/', $arg)) {
-                throw new \Exception('Namespace must be one word in CamelCase');
+                throw new Exception('Namespace must be one word in CamelCase');
             }
             return $arg;
         };
 
         $validateComposer = function ($arg) {
             if (empty($arg) || !preg_match('/^[a-z0-9-]+\/[a-z0-9-]+$/', $arg)) {
-                throw new \Exception('Invalid Composer name');
+                throw new Exception('Invalid Composer name');
             }
             return $arg;
         };
 
         $validateURI = function ($arg) {
             $uri = new Uri($arg);
             if (empty($uri->getScheme())) {
-                throw new \Exception('Invalid URI');
+                throw new Exception('Invalid URI');
             }
             Factory::getRegisteredDrivers($uri->getScheme());
             return $arg;
         };
 
         $validateTimeZone = function ($arg) {
             if (empty($arg) || !in_array($arg, timezone_identifiers_list())) {
-                throw new \Exception('Invalid Timezone');
+                throw new Exception('Invalid Timezone');
             }
             return $arg;
         };

builder/Scripts.php

@@ -11,6 +11,7 @@
 use ByJG\DbMigration\Database\MySqlDatabase;
 use ByJG\DbMigration\Exception\InvalidMigrationFile;
 use ByJG\DbMigration\Migration;
+use ByJG\JinjaPhp\Exception\TemplateParseException;
 use ByJG\JinjaPhp\Loader\FileSystemLoader;
 use ByJG\Util\Uri;
 use Composer\Script\Event;
@@ -39,7 +40,7 @@ public function __construct()
      * @throws KeyNotFoundException
      * @throws ReflectionException
      */
-    public static function migrate(Event $event)
+    public static function migrate(Event $event): void
     {
         $migrate = new Scripts();
         $migrate->runMigrate($event->getArguments());
@@ -53,7 +54,7 @@ public static function migrate(Event $event)
      * @throws KeyNotFoundException
      * @throws ReflectionException
      */
-    public static function genOpenApiDocs(Event $event)
+    public static function genOpenApiDocs(Event $event): void
     {
         $build = new Scripts();
         $build->runGenOpenApiDocs($event->getArguments());
@@ -62,14 +63,16 @@ public static function genOpenApiDocs(Event $event)
     /**
      * @param Event $event
      * @return void
+     * @throws ConfigException
      * @throws ConfigNotFoundException
      * @throws DependencyInjectionException
      * @throws InvalidArgumentException
+     * @throws InvalidDateException
      * @throws KeyNotFoundException
      * @throws ReflectionException
-     * @throws \ByJG\Serializer\Exception\InvalidArgumentException
+     * @throws TemplateParseException
      */
-    public static function codeGenerator(Event $event)
+    public static function codeGenerator(Event $event): void
     {
         $build = new Scripts();
         $build->runCodeGenerator($event->getArguments());
@@ -86,6 +89,7 @@ public static function codeGenerator(Event $event)
      * @throws ReflectionException
      * @throws ConfigException
      * @throws InvalidDateException
+     * @throws Exception
      */
     public function runMigrate($arguments): void
     {
@@ -179,12 +183,14 @@ public function runGenOpenApiDocs(array $arguments): void
     /**
      * @param array $arguments
      * @return void
+     * @throws ConfigException
      * @throws ConfigNotFoundException
      * @throws DependencyInjectionException
      * @throws InvalidArgumentException
+     * @throws InvalidDateException
      * @throws KeyNotFoundException
      * @throws ReflectionException
-     * @throws \ByJG\Serializer\Exception\InvalidArgumentException
+     * @throws TemplateParseException
      * @throws Exception
      */
     public function runCodeGenerator(array $arguments): void

composer.json

@@ -36,7 +36,7 @@
     "migrate": "Builder\\Scripts::migrate",
     "codegen": "Builder\\Scripts::codeGenerator",
     "openapi": "Builder\\Scripts::genOpenApiDocs",
-    "compile": "composer run openapi && composer run test",
+    "compile": "git pull && composer run openapi && composer run test",
     "up-local-dev": "docker compose -f docker-compose-dev.yml up -d",
     "down-local-dev": "docker compose -f docker-compose-dev.yml down",
     "post-create-project-cmd": "Builder\\PostCreateScript::run"

config/config-dev.env

@@ -5,5 +5,5 @@ API_SERVER=localhost
 API_SCHEMA=http
 DBDRIVER_CONNECTION=mysql://root:mysqlp455w0rd@mysql-container/mydb
 EMAIL_CONNECTION=smtp://username:password@mail.example.com
-EMAIL_TRANSACTIONAL_FROM=No Reply <noreply@kexample.com>
+EMAIL_TRANSACTIONAL_FROM='No Reply <noreply@kexample.com>'
 CORS_SERVERS=.*

config/config-prod.php

@@ -1,10 +1,11 @@
 <?php
 
 use ByJG\Config\DependencyInjection as DI;
+use ByJG\JwtWrapper\JwtHashHmacSecret;
 use ByJG\JwtWrapper\JwtKeyInterface;
 
 return [
-    JwtKeyInterface::class => DI::bind(\ByJG\JwtWrapper\JwtHashHmacSecret::class)
+    JwtKeyInterface::class => DI::bind(JwtHashHmacSecret::class)
         ->withConstructorArgs(['jwt_super_secret_key'])
         ->toSingleton(),
 ];

config/config-staging.php

@@ -3,13 +3,14 @@
 use ByJG\Cache\Psr16\BaseCacheEngine;
 use ByJG\Cache\Psr16\FileSystemCacheEngine;
 use ByJG\Config\DependencyInjection as DI;
+use ByJG\JwtWrapper\JwtHashHmacSecret;
 use ByJG\JwtWrapper\JwtKeyInterface;
 
 return [
 
     BaseCacheEngine::class => DI::bind(FileSystemCacheEngine::class)->toSingleton(),
 
-    JwtKeyInterface::class => DI::bind(\ByJG\JwtWrapper\JwtHashHmacSecret::class)
+    JwtKeyInterface::class => DI::bind(JwtHashHmacSecret::class)
         ->withConstructorArgs(['jwt_super_secret_key'])
         ->toSingleton(),
 

config/config-test.php

@@ -1,10 +1,11 @@
 <?php
 
 use ByJG\Config\DependencyInjection as DI;
+use ByJG\JwtWrapper\JwtHashHmacSecret;
 use ByJG\JwtWrapper\JwtKeyInterface;
 
 return [
-    JwtKeyInterface::class => DI::bind(\ByJG\JwtWrapper\JwtHashHmacSecret::class)
+    JwtKeyInterface::class => DI::bind(JwtHashHmacSecret::class)
         ->withConstructorArgs(['jwt_super_secret_key'])
         ->toSingleton(),
 ];

docker/fpm/php/custom.ini

@@ -1,3 +1,5 @@
+expose_php = off
+
 date.timezone = UTC
 max_execution_time = 300
 

src/Model/User.php

@@ -2,12 +2,17 @@
 
 namespace RestReferenceArchitecture\Model;
 
+use ByJG\Authenticate\Definition\PasswordDefinition;
 use ByJG\Authenticate\Model\UserModel;
 use ByJG\Authenticate\Model\UserPropertiesModel;
+use ByJG\MicroOrm\Attributes\TableAttribute;
 use ByJG\MicroOrm\Literal\HexUuidLiteral;
+use Exception;
 use InvalidArgumentException;
 use OpenApi\Attributes as OA;
+use RestReferenceArchitecture\Psr11;
 
+#[TableAttribute("users")]
 #[OA\Schema(required: ["email"], type: "object", xml: new OA\Xml(name: "User"))]
 class User extends UserModel
 {
@@ -89,10 +94,13 @@ class User extends UserModel
      * @param string $username
      * @param string $password
      * @param string $admin
+     * @throws Exception
      */
     public function __construct(string $name = "", string $email = "", string $username = "", string $password = "", string $admin = "no")
     {
         parent::__construct($name, $email, $username, $password, $admin);
+
+        $this->withPasswordDefinition(Psr11::container()->get(PasswordDefinition::class));
     }
 
 
@@ -173,9 +181,11 @@ public function getPassword(): ?string
      */
     public function setPassword(?string $password): void
     {
-        // Password len equals to 40 means that the password is already encrypted with sha1
-        if (!empty($password) && strlen($password) != 40 && !empty($this->passwordDefinition) && !$this->passwordDefinition->matchPassword($password)) {
-            throw new InvalidArgumentException("Password does not match the password definition");
+        if (!empty($this->passwordDefinition) && !empty($password) && strlen($password) != 40) {
+            $result = $this->passwordDefinition->matchPassword($password);
+            if ($result != PasswordDefinition::SUCCESS) {
+                throw new InvalidArgumentException("Password does not match the password definition [{$result}]");
+            }
         }
         $this->password = $password;
     }

src/OpenApiSpec.php

@@ -25,12 +25,15 @@
 #[OA\Schema(
     schema: 'error',
     properties: [
-        new OA\Property('error', properties: [
-            new OA\Property(property: 'type', description: 'A class de Exceção', type: 'string'),
-            new OA\Property(property: 'message', description: 'A mensagem de erro', type: 'string'),
-            new OA\Property(property: 'file', description: 'O arquivo que gerou o erro', type: 'string'),
-            new OA\Property(property: 'line', description: 'A linha do erro', type: 'integer'),
-        ])
+        new OA\Property(
+            'error',
+            properties: [
+                new OA\Property(property: 'type', description: 'A class de Exceção', type: 'string'),
+                new OA\Property(property: 'message', description: 'A mensagem de erro', type: 'string'),
+                new OA\Property(property: 'file', description: 'O arquivo que gerou o erro', type: 'string'),
+                new OA\Property(property: 'line', description: 'A linha do erro', type: 'integer'),
+            ]
+        )
     ],
     type: 'object'
 )]

src/Psr11.php

@@ -8,7 +8,6 @@
 use ByJG\Config\Environment;
 use ByJG\Config\Exception\ConfigException;
 use ByJG\Config\Exception\ConfigNotFoundException;
-use ByJG\Config\Exception\InvalidDateException;
 use Psr\SimpleCache\InvalidArgumentException;
 
 class Psr11
@@ -18,11 +17,10 @@ class Psr11
 
     /**
      * @param string|null $env
-     * @return Container
+     * @return Container|null
      * @throws ConfigException
      * @throws ConfigNotFoundException
      * @throws InvalidArgumentException
-     * @throws InvalidDateException
      */
     public static function container(?string $env = null): ?Container
     {
@@ -53,7 +51,12 @@ public static function environment(): ?Definition
                 ->addEnvironment($test)
                 ->addEnvironment($staging)
                 ->addEnvironment($prod)
-            ;
+                ->withOSEnvironment(
+                    [
+                    'TAG_VERSION',
+                    'TAG_COMMIT',
+                    ]
+                );
         }
 
         return self::$definition;