Merge branch 'develop' into 4.7

Author: paulbalandan

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,16 +5,17 @@ Each pull request should address a single issue and have a meaningful title.
 - PR title must include the type (feat, fix, chore, docs, perf, refactor, style, test) of the commit per Conventional Commits specification. See https://www.conventionalcommits.org/en/v1.0.0/ for the discussion.
 - Pull requests must be in English.
 - If a pull request fixes an issue, reference the issue with a suitable keyword (e.g., Fixes <issue number>).
+- Your branch name and the target name should be different.
 - All bug fixes should be sent to the __"develop"__ branch, this is where the next bug fix version will be developed.
-- PRs with any enhancement should be sent to the next minor version branch, e.g. __"4.5"__
+- PRs with any enhancement should be sent to the next minor version branch, e.g. __"4.7"__
 
 -->
 **Description**
 Explain what you have changed, and why.
 
 **Checklist:**
 - [ ] Securely signed commits
-- [ ] Component(s) with PHPDoc blocks, only if necessary or adds value
+- [ ] Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
 - [ ] Unit testing, with >80% coverage
 - [ ] User guide updated
 - [ ] Conforms to style guide

.github/workflows/deploy-distributables.yml

@@ -66,7 +66,7 @@ jobs:
         run: ./source/.github/scripts/deploy-framework ${GITHUB_WORKSPACE}/source ${GITHUB_WORKSPACE}/framework ${GITHUB_REF##*/}
 
       - name: Release
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         with:
           github-token: ${{secrets.ACCESS_TOKEN}}
           script: |
@@ -116,7 +116,7 @@ jobs:
         run: ./source/.github/scripts/deploy-appstarter ${GITHUB_WORKSPACE}/source ${GITHUB_WORKSPACE}/appstarter ${GITHUB_REF##*/}
 
       - name: Release
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         with:
           github-token: ${{secrets.ACCESS_TOKEN}}
           script: |
@@ -160,7 +160,7 @@ jobs:
           path: userguide
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
 
@@ -176,7 +176,7 @@ jobs:
         run: ./source/.github/scripts/deploy-userguide ${GITHUB_WORKSPACE}/source ${GITHUB_WORKSPACE}/userguide ${GITHUB_REF##*/}
 
       - name: Release
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         with:
           github-token: ${{secrets.ACCESS_TOKEN}}
           script: |

.github/workflows/deploy-userguide-latest.yml

@@ -34,7 +34,7 @@ jobs:
           coverage: none
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
 

.github/workflows/test-deptrac.yml

@@ -80,7 +80,7 @@ jobs:
 
       - name: Run architectural inspection
         run: |
-            composer require --dev qossmic/deptrac-shim
+            composer require --dev deptrac/deptrac
             vendor/bin/deptrac analyze --cache-file=build/deptrac.cache
         env:
           GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-userguide.yml

@@ -27,7 +27,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
 

app/Config/Database.php

@@ -182,6 +182,7 @@ class Database extends Config
         'port'        => 3306,
         'foreignKeys' => true,
         'busyTimeout' => 1000,
+        'synchronous' => null,
         'dateFormat'  => [
             'date'     => 'Y-m-d',
             'datetime' => 'Y-m-d H:i:s',

composer.json

@@ -28,7 +28,7 @@
         "phpunit/phpcov": "^9.0.2 || ^10.0",
         "phpunit/phpunit": "^10.5.16 || ^11.2",
         "predis/predis": "^3.0",
-        "rector/rector": "2.1.5",
+        "rector/rector": "2.1.7",
         "shipmonk/phpstan-baseline-per-identifier": "^2.0"
     },
     "replace": {

contributing/pull_request.md

@@ -96,7 +96,7 @@ implementation comments to explain potentially confusing sections of
 code, and documentation comments before each public or protected
 class/interface/trait, method, and variable.
 
-Do not add PHPDoc comments that are superficial, duplicated, or stating the obvious.
+Do not add PHPDoc comments that are superficial, duplicated, or stating the obvious. It is not recommended to reuse comments if the parent class or interface already contains a description of the child element.
 
 See the following for more information.
 

contributing/styleguide.md

@@ -241,6 +241,7 @@ of the classes they declare.
 - */
   public function analyse(string $data): void {};
 ```
+- SHOULD NOT duplicate comments from the parent class or interface.
 
 ### PHPUnit Assertions
 

deptrac.yaml

@@ -8,7 +8,7 @@
 #   - Exception
 #   - Service
 #   - Validation\FormatRules
-parameters:
+deptrac:
   paths:
     - ./app
     - ./system
@@ -17,148 +17,149 @@ parameters:
   layers:
     - name: API
       collectors:
-        - type: className
-          regex: ^Codeigniter\\API\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\API\\.*$/'
     - name: Cache
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Cache\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Cache\\.*$/'
     - name: Controller
       collectors:
-        - type: className
-          regex: ^CodeIgniter\\Controller$
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Controller$/'
     - name: Cookie
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Cookie\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Cookie\\.*$/'
     - name: Database
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Database\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Database\\.*$/'
     - name: DataCaster
       collectors:
-        - type: className
-          regex: ^Codeigniter\\DataCaster\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\DataCaster\\.*$/'
     - name: DataConverter
       collectors:
-        - type: className
-          regex: ^Codeigniter\\DataConverter\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\DataConverter\\.*$/'
     - name: Email
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Email\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Email\\.*$/'
     - name: Encryption
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Encryption\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Encryption\\.*$/'
     - name: Entity
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Entity\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Entity\\.*$/'
     - name: Events
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Events\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Events\\.*$/'
     - name: Files
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Files\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Files\\.*$/'
     - name: Filters
       collectors:
         - type: bool
           must:
-          - type: className
-            regex: ^Codeigniter\\Filters\\Filter.*
+          - type: classNameRegex
+            value: '/^CodeIgniter\\Filters\\Filter.*$/'
     - name: Format
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Format\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Format\\.*$/'
     - name: Honeypot
       collectors:
-        - type: className
-          regex: ^Codeigniter\\.*Honeypot.* # includes the Filter
+        - type: classNameRegex
+          # includes the Filter
+          value: '/^CodeIgniter\\.*Honeypot.*$/'
     - name: HTTP
       collectors:
         - type: bool
           must:
-          - type: className
-            regex: ^Codeigniter\\HTTP\\.*
+          - type: classNameRegex
+            value: '/^CodeIgniter\\HTTP\\.*$/'
           must_not:
-          - type: className
-            regex: (Exception|URI)
+          - type: classNameRegex
+            value: '(Exception|URI)'
     - name: I18n
       collectors:
-        - type: className
-          regex: ^Codeigniter\\I18n\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\I18n\\.*$/'
     - name: Images
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Images\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Images\\.*$/'
     - name: Language
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Language\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Language\\.*$/'
     - name: Log
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Log\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Log\\.*$/'
     - name: Model
       collectors:
-        - type: className
-          regex: ^Codeigniter\\.*Model$
+        - type: classNameRegex
+          value: '/^CodeIgniter\\.*Model$/'
     - name: Modules
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Modules\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Modules\\.*$/'
     - name: Pager
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Pager\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Pager\\.*$/'
     - name: Publisher
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Publisher\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Publisher\\.*$/'
     - name: RESTful
       collectors:
-        - type: className
-          regex: ^Codeigniter\\RESTful\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\RESTful\\.*$/'
     - name: Router
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Router\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Router\\.*$/'
     - name: Security
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Security\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Security\\.*$/'
     - name: Session
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Session\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Session\\.*$/'
     - name: Throttle
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Throttle\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Throttle\\.*$/'
     - name: Typography
       collectors:
-        - type: className
-          regex: ^Codeigniter\\Typography\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\Typography\\.*$/'
     - name: URI
       collectors:
-        - type: className
-          regex: ^CodeIgniter\\HTTP\\URI$
+        - type: classNameRegex
+          value: '/^CodeIgniter\\HTTP\\URI$/'
     - name: Validation
       collectors:
         - type: bool
           must:
-          - type: className
-            regex: ^Codeigniter\\Validation\\.*
+          - type: classNameRegex
+            value: '/^CodeIgniter\\Validation\\.*$/'
           must_not:
-          - type: className
-            regex: ^Codeigniter\\Validation\\FormatRules$
+          - type: classNameRegex
+            value: '/^CodeIgniter\\Validation\\FormatRules$/'
     - name: View
       collectors:
-        - type: className
-          regex: ^Codeigniter\\View\\.*
+        - type: classNameRegex
+          value: '/^CodeIgniter\\View\\.*$/'
   ruleset:
     API:
       - Format