Refactor UserService, UserPropertiesRepository, and workflows: enhance field mapping error handling, add type assertions, improve compatibility, and update dependencies and documentation for PHP 8.3+.

Author: byjg

.github/workflows/phpunit.yml

@@ -18,15 +18,44 @@ jobs:
     strategy:
       matrix:
         php-version:
+          - "8.5"
           - "8.4"
           - "8.3"
-          - "8.2"
 
     steps:
       - uses: actions/checkout@v5
       - run: composer install
-      - run: ./vendor/bin/psalm
-      - run: ./vendor/bin/phpunit --stderr
+      - run: composer test
+
+  Psalm:
+    name: Psalm Static Analyzer
+    runs-on: ubuntu-latest
+    permissions:
+      # for github/codeql-action/upload-sarif to upload SARIF results
+      security-events: write
+    container:
+      image: byjg/php:8.4-cli
+      options: --user root --privileged
+
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+
+      - name: Composer
+        run: composer install
+
+      - name: Psalm
+        # Note: Ignoring error code 2, which just signals that some
+        # flaws were found, not that Psalm itself failed to run.
+        run: ./vendor/bin/psalm
+          --show-info=true
+          --report=psalm-results.sarif || [ $? = 2 ]
+
+      - name: Upload Analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v4
+        if: github.ref == 'refs/heads/master'
+        with:
+          sarif_file: psalm-results.sarif
 
   Documentation:
     if: github.ref == 'refs/heads/master'

README.md

@@ -1,5 +1,6 @@
-# Auth User PHP
+# User Authentication
 
+[![Sponsor](https://img.shields.io/badge/Sponsor-%23ea4aaa?logo=githubsponsors&logoColor=white&labelColor=0d1117)](https://github.com/sponsors/byjg)
 [![Build Status](https://github.com/byjg/php-authuser/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/php-authuser/actions/workflows/phpunit.yml)
 [![Opensource ByJG](https://img.shields.io/badge/opensource-byjg-success.svg)](http://opensource.byjg.com)
 [![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/php-authuser/)

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "byjg/authuser",
-  "description": "A simple and customizable class for enable user authentication inside your application. It is available on XML files and Relational Databases.",
+  "description": "A simple and customizable library for user authentication in PHP applications using a clean repository and service layer architecture.",
   "autoload": {
     "psr-4": {
       "ByJG\\Authenticate\\": "src/"
@@ -14,18 +14,18 @@
   "minimum-stability": "dev",
   "prefer-stable": true,
   "require": {
-    "php": ">=8.2 <8.5",
+    "php": ">=8.3 <8.6",
     "byjg/micro-orm": "^6.0",
     "byjg/cache-engine": "^6.0",
     "byjg/jwt-wrapper": "^6.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^10|^11",
-    "vimeo/psalm": "^5.9|^6.12"
+    "phpunit/phpunit": "^10.5|^11.5",
+    "vimeo/psalm": "^5.9|^6.13"
   },
   "scripts": {
     "test": "vendor/bin/phpunit",
-    "psalm": "vendor/bin/psalm"
+    "psalm": "vendor/bin/psalm --threads=1"
   },
   "license": "MIT"
 }

docs/installation.md

@@ -7,7 +7,7 @@ title: Installation
 
 ## Requirements
 
-- PHP 8.2 or higher
+- PHP 8.3 or higher
 - Composer
 
 ## Install via Composer
@@ -20,10 +20,8 @@ composer require byjg/authuser
 
 ## Running Tests
 
-Because this project uses PHP Session, you need to run the unit tests with the `--stderr` flag:
-
 ```bash
-./vendor/bin/phpunit --stderr
+composer test
 ```
 
 ## Next Steps

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="4"
+    errorLevel="3"
     resolveFromConfigFile="true"
     findUnusedBaselineEntry="true"
     findUnusedCode="false"
@@ -11,7 +11,6 @@
 >
     <projectFiles>
         <directory name="src" />
-        <directory name="tests" />
         <ignoreFiles>
             <directory name="vendor" />
         </ignoreFiles>

src/Definition/PasswordDefinition.php

@@ -185,7 +185,10 @@ public function generatePassword(int $extendSize = 0): string
                     $isRepeated = ($char == $previousChar);
                     $previousChar = strtoupper($previousChar);
                     $upperChar = strtoupper($char);
-                    $isSequential = ($upperChar == chr(ord($previousChar) + 1)) || ($upperChar == chr(ord($previousChar) - 1));
+                    $prevOrd = ord($previousChar);
+                    $nextOrd = ($prevOrd + 1) % 256;
+                    $prevPrevOrd = ($prevOrd - 1 + 256) % 256;
+                    $isSequential = ($upperChar == chr($nextOrd)) || ($upperChar == chr($prevPrevOrd));
                     if (!$isRepeated && !$isSequential) {
                         break;
                     }

src/MapperFunctions/UserIdGeneratorMapper.php

@@ -21,7 +21,10 @@ public function processedValue(mixed $value, mixed $instance, ?DatabaseExecutor
 
         // Generate from username if instance is UserModel
         if ($instance instanceof UserModel) {
-            return preg_replace('/(?:([\w])|([\W]))/', '\1', strtolower($instance->getUsername()));
+            $username = $instance->getUsername();
+            if ($username !== null) {
+                return preg_replace('/(?:([\w])|([\W]))/', '\1', strtolower($username));
+            }
         }
 
         return $value;

src/Model/UserModel.php

@@ -180,7 +180,7 @@ public function set(string $name, string|null $value): void
         if (empty($property)) {
             $property = new UserPropertiesModel($name, $value);
             $this->addProperty($property);
-        } else {
+        } elseif ($property instanceof UserPropertiesModel) {
             $property->setValue($value);
         }
     }

src/Repository/UserPropertiesRepository.php

@@ -79,6 +79,9 @@ public function save(UserPropertiesModel $model): UserPropertiesModel
     public function getByUserId(string|Literal|int $userid): array
     {
         $userIdMapping = $this->mapper->getFieldMap(UserPropertyField::Userid->value);
+        if ($userIdMapping === null) {
+            throw new \InvalidArgumentException('User ID field mapping not found');
+        }
         $userIdField = $userIdMapping->getFieldName();
         $query = Query::getInstance()
             ->table($this->mapper->getTable())
@@ -104,6 +107,10 @@ public function getByUserIdAndName(string|Literal|int $userid, string $propertyN
         $userIdMapping = $this->mapper->getFieldMap(UserPropertyField::Userid->value);
         $nameMapping = $this->mapper->getFieldMap(UserPropertyField::Name->value);
 
+        if ($userIdMapping === null || $nameMapping === null) {
+            throw new \InvalidArgumentException('Required field mapping not found');
+        }
+
         $userIdField = $userIdMapping->getFieldName();
         $nameField = $nameMapping->getFieldName();
 
@@ -128,6 +135,9 @@ public function getByUserIdAndName(string|Literal|int $userid, string $propertyN
     public function deleteByUserId(string|Literal|int $userid): void
     {
         $userIdMapping = $this->mapper->getFieldMap(UserPropertyField::Userid->value);
+        if ($userIdMapping === null) {
+            throw new \InvalidArgumentException('User ID field mapping not found');
+        }
         $userIdField = $userIdMapping->getFieldName();
 
         $deleteQuery = DeleteQuery::getInstance()
@@ -151,9 +161,16 @@ public function deleteByUserId(string|Literal|int $userid): void
     public function deleteByUserIdAndName(string|Literal|int $userid, string $propertyName, ?string $value = null): void
     {
         $userIdMapping = $this->mapper->getFieldMap(UserPropertyField::Userid->value);
+        $nameMapping = $this->mapper->getFieldMap(UserPropertyField::Name->value);
+        $valueMapping = $this->mapper->getFieldMap(UserPropertyField::Value->value);
+
+        if ($userIdMapping === null || $nameMapping === null || $valueMapping === null) {
+            throw new \InvalidArgumentException('Required field mapping not found');
+        }
+
         $userIdField = $userIdMapping->getFieldName();
-        $nameField = $this->mapper->getFieldMap(UserPropertyField::Name->value)->getFieldName();
-        $valueField = $this->mapper->getFieldMap(UserPropertyField::Value->value)->getFieldName();
+        $nameField = $nameMapping->getFieldName();
+        $valueField = $valueMapping->getFieldName();
 
         $deleteQuery = DeleteQuery::getInstance()
             ->table($this->mapper->getTable())
@@ -179,8 +196,15 @@ public function deleteByUserIdAndName(string|Literal|int $userid, string $proper
      */
     public function deleteByName(string $propertyName, ?string $value = null): void
     {
-        $nameField = $this->mapper->getFieldMap(UserPropertyField::Name->value)->getFieldName();
-        $valueField = $this->mapper->getFieldMap(UserPropertyField::Value->value)->getFieldName();
+        $nameMapping = $this->mapper->getFieldMap(UserPropertyField::Name->value);
+        $valueMapping = $this->mapper->getFieldMap(UserPropertyField::Value->value);
+
+        if ($nameMapping === null || $valueMapping === null) {
+            throw new \InvalidArgumentException('Required field mapping not found');
+        }
+
+        $nameField = $nameMapping->getFieldName();
+        $valueField = $valueMapping->getFieldName();
 
         $deleteQuery = DeleteQuery::getInstance()
             ->table($this->mapper->getTable())