Merge pull request #194 from kevindecapite/issue-193

Prepare for CakePHP 5.x

Author: ADmad

.github/workflows/ci.yml

@@ -10,15 +10,15 @@ on:
 
 jobs:
   testsuite:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ '7.4', '8.0', '8.1' ]
+        php-version: [ '8.1', '8.2', '8.3', '8.4' ]
         db-type: [ mysql ]
         prefer-lowest: ['']
         include:
-          - php-version: '7.4'
+          - php-version: '8.1'
             db-type: 'mysql'
             prefer-lowest: 'prefer-lowest'
 
@@ -49,7 +49,7 @@ jobs:
         run: echo "::set-output name=date::$(date +'%Y-%m')"
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}
@@ -62,35 +62,22 @@ jobs:
             composer update
           fi
 
-      - name: Configure PHPUnit matcher
-        if: matrix.php-version == '7.4' && matrix.db-type == 'mysql'
-        uses: mheap/phpunit-matcher-action@v1
-
       - name: Run PHPUnit
         run: |
-          if [[ ${{ matrix.db-type }} == 'mysql' && ${{ matrix.php-version }} != '7.2' ]]; then export DB_URL='mysql://root:root@127.0.0.1/cakephp?init[]=SET sql_mode = "STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"'; fi
-          if [[ ${{ matrix.db-type }} == 'mysql' && ${{ matrix.php-version }} == '7.2' ]]; then export DB_URL='mysql://root:root@127.0.0.1/cakephp?encoding=utf8'; fi
-          if [[ ${{ matrix.db-type }} == 'mysql' && ${{ matrix.php-version }} == '7.4' ]]; then
-            vendor/bin/phpunit --coverage-clover=coverage.xml --verbose
-          else
-            vendor/bin/phpunit
-          fi
-
-      - name: Code Coverage Report
-        if: success() && matrix.php-version == '7.4' && matrix.db-type == 'mysql'
-        uses: codecov/codecov-action@v3
+          export DB_URL='mysql://root:root@127.0.0.1/cakephp?init[]=SET sql_mode = "STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"'
+          vendor/bin/phpunit --display-incomplete --display-skipped --display-warnings --display-deprecations
 
   coding-standard:
     name: Coding Standard
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.1'
           extensions: mbstring, intl, apcu
           coverage: none
 
@@ -103,7 +90,7 @@ jobs:
         run: echo "::set-output name=date::$(date +'%Y-%m')"
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}
@@ -116,15 +103,15 @@ jobs:
 
   static-analysis:
     name: Static Analysis
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.1'
           extensions: mbstring, intl, apcu
           coverage: none
           tools: cs2pr
@@ -138,16 +125,13 @@ jobs:
         run: echo "::set-output name=date::$(date +'%Y-%m')"
 
       - name: Cache composer dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}
 
       - name: composer install
         run: composer stan-setup
 
-      - name: Run psalm
-        run: vendor/bin/psalm.phar --output-format=github
-
       - name: Run phpstan
         run: vendor/bin/phpstan.phar analyse --error-format=checkstyle ./src | cs2pr

.gitignore

@@ -5,3 +5,4 @@ vendor/
 composer.lock
 tmp
 .phpunit.result.cache
+.phpunit.cache

composer.json

@@ -29,17 +29,17 @@
         }
     ],
     "require": {
-        "php": ">=7.4.0",
-        "cakephp/cakephp": "^4.4.1",
-        "friendsofcake/crud": "^6.0",
-        "laravel-json-api/neomerx-json-api": "^5.0"
+        "php": ">=8.1.0",
+        "cakephp/cakephp": "^5.0.0",
+        "friendsofcake/crud": "^7.2.0",
+        "laravel-json-api/neomerx-json-api": "^5.0.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "~8.5 || ^9.3",
-        "friendsofcake/cakephp-test-utilities": "^2.0.1",
-        "friendsofcake/search": "^6.2.2",
-        "cakephp/cakephp-codesniffer": "^4.0",
-        "dms/phpunit-arraysubset-asserts": "^0.4.0"
+        "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.0.9",
+        "friendsofcake/cakephp-test-utilities": "^3.0.0",
+        "friendsofcake/search": "^7.0.0",
+        "cakephp/cakephp-codesniffer": "^5.1",
+        "dms/phpunit-arraysubset-asserts": "^0.5.0"
     },
     "autoload": {
         "psr-4": {
@@ -65,13 +65,8 @@
     "scripts": {
         "cs-check": "phpcs -p --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
         "cs-fix": "phpcbf --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
-        "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:~1.8.0 psalm/phar:~4.26.0 && mv composer.backup composer.json",
+        "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:~2.1.17 && mv composer.backup composer.json",
         "phpstan": "phpstan analyse --memory-limit=3G src/",
-        "psalm": "psalm.phar --show-info=false",
-        "stan": [
-            "@phpstan",
-            "@psalm"
-        ],
         "test": "phpunit"
     },
     "config": {

phpstan-baseline.neon

@@ -9,8 +9,3 @@ parameters:
 			message: "#^Access to an undefined property Cake\\\\Controller\\\\Controller\\:\\:\\$Crud\\.$#"
 			count: 1
 			path: src/Listener/PaginationListener.php
-
-		-
-			message: "#^Call to an undefined method Cake\\\\Datasource\\\\EntityInterface\\:\\:visibleProperties\\(\\)\\.$#"
-			count: 1
-			path: src/Schema/JsonApi/DynamicEntitySchema.php

phpstan.neon

@@ -5,9 +5,10 @@ parameters:
 	level: 6
 	paths:
 		- src
-	checkMissingIterableValueType: false
-	checkGenericClassInNonGenericObjectType: false
 	universalObjectCratesClasses:
 		- Crud\Event\Subject
 	bootstrapFiles:
 		- vendor/cakephp/cakephp/src/Core/Exception/CakeException.php
+	ignoreErrors:
+		- identifier: missingType.iterableValue
+		- identifier: missingType.generics

phpunit.xml.dist

@@ -1,28 +1,24 @@
+<?xml version="1.0"?>
 <phpunit
-	colors="true"
-	processIsolation="false"
-	stopOnFailure="false"
-	bootstrap="./tests/bootstrap.php">
-
-	<testsuites>
-		<testsuite name="Crud">
-			<directory>./tests/</directory>
-		</testsuite>
-	</testsuites>
-
-	<listeners>
-		<listener class="\Cake\TestSuite\Fixture\FixtureInjector">
-			<arguments>
-				<object class="\Cake\TestSuite\Fixture\FixtureManager" />
-			</arguments>
-		</listener>
-	</listeners>
-
-	<filter>
-        <whitelist>
-            <directory suffix=".php">./src/</directory>
-            <directory suffix=".ctp">./src/</directory>
-        </whitelist>
-	</filter>
-
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    colors="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    bootstrap="./tests/bootstrap.php"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+    cacheDirectory=".phpunit.cache"
+>
+  <extensions>
+    <bootstrap class="Cake\TestSuite\Fixture\Extension\PHPUnitExtension"/>
+  </extensions>
+  <testsuites>
+    <testsuite name="Crud">
+      <directory>./tests/</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">./src/</directory>
+    </include>
+  </source>
 </phpunit>

psalm.xml

@@ -21,6 +21,8 @@
 use Crud\Traits\SerializeTrait;
 use Crud\Traits\ViewTrait;
 use Crud\Traits\ViewVarTrait;
+use function Cake\Core\pluginSplit;
+use function Cake\I18n\__;
 
 /**
  * Class RelationshipViewAction
@@ -47,7 +49,7 @@ class RelationshipsAction extends BaseAction
      *
      * @var array
      */
-    protected $_defaultConfig = [
+    protected array $_defaultConfig = [
         'enabled' => true,
         'scope' => 'entity',
         'findMethod' => 'all',
@@ -150,7 +152,7 @@ public function checkAllowed(): void
     protected function _findRelations(Subject $subject): EntityInterface
     {
         $relationName = $this->_request()->getParam('type');
-        $table = $this->_table();
+        $table = $this->_controller()->fetchTable();
         $association = $table->getAssociation($relationName);
         $targetTable = $association->getTarget();
 
@@ -188,7 +190,7 @@ protected function _findRelations(Subject $subject): EntityInterface
             ->where(
                 [
                     $table->aliasField($primaryKey) => $foreignKeyParam,
-                ]
+                ],
             )
             ->contain([
                 $relationName => [
@@ -202,7 +204,7 @@ protected function _findRelations(Subject $subject): EntityInterface
                 'association' => $association,
                 'repository' => $table,
                 'query' => $primaryQuery,
-            ]
+            ],
         );
         $this->_trigger('beforeFind', $subject);
         $entity = $subject->query->first();
@@ -239,7 +241,7 @@ protected function _get(): void
      *
      * @return void
      */
-    protected function _delete()
+    protected function _delete(): void
     {
         $subject = $this->_subject();
         $request = $this->_request();
@@ -272,7 +274,7 @@ protected function _delete()
         $idsToDelete = (array)Hash::extract($data, '{n}.id');
         $foreignRecords = $entity->$property;
         $entity->$property = [];
-        foreach ($foreignRecords as $key => $foreignRecord) {
+        foreach ($foreignRecords as $foreignRecord) {
             if (!in_array($foreignRecord->id, $idsToDelete, false)) {
                 $entity->{$property}[] = $foreignRecord;
             }
@@ -284,7 +286,7 @@ protected function _delete()
             $association->setSaveStrategy('replace');
         }
         $saveMethod = $this->saveMethod();
-        if ($this->_table()->$saveMethod($entity, $this->saveOptions())) {
+        if ($this->_controller()->fetchTable()->$saveMethod($entity, $this->saveOptions())) {
             $this->_success($subject);
 
             return;
@@ -298,7 +300,7 @@ protected function _delete()
      *
      * @return void
      */
-    protected function _post()
+    protected function _post(): void
     {
         $subject = $this->_subject();
         $request = $this->_request();
@@ -333,7 +335,7 @@ protected function _post()
         $this->_trigger('beforeSave', $subject);
 
         $saveMethod = $this->saveMethod();
-        if ($this->_table()->$saveMethod($entity, $this->saveOptions())) {
+        if ($this->_controller()->fetchTable()->$saveMethod($entity, $this->saveOptions())) {
             $this->_success($subject);
 
             return;
@@ -347,7 +349,7 @@ protected function _post()
      *
      * @return void
      */
-    protected function _patch()
+    protected function _patch(): void
     {
         $subject = $this->_subject();
         $request = $this->_request();
@@ -363,7 +365,6 @@ protected function _patch()
 
         if (in_array($association->type(), [Association::MANY_TO_ONE, Association::ONE_TO_ONE], true)) {
             //Set the relationship to the corresponding entity
-            /** @psalm-suppress TypeDoesNotContainNull */
             if (array_key_exists('id', $data)) {
                 $entity->{$property} = $foreignTable->get($data['id']);
             } elseif ($data === null) {
@@ -382,7 +383,7 @@ protected function _patch()
             $association->setSaveStrategy('replace');
         }
         $saveMethod = $this->saveMethod();
-        if ($this->_table()->$saveMethod($entity, $this->saveOptions())) {
+        if ($this->_controller()->fetchTable()->$saveMethod($entity, $this->saveOptions())) {
             $this->_success($subject);
 
             return;
@@ -442,21 +443,21 @@ protected function getForeignRecords(array $data, Association $association): arr
             ->where(
                 [
                     $association->aliasField($associationPrimaryKey) . ' in' => $idsToAdd,
-                ]
+                ],
             )
             ->all();
 
         if (count($idsToAdd) !== count($foreignRecords)) {
             $foundIds = $foreignRecords->extract(
                 static function ($record) {
                     return $record->id;
-                }
+                },
             )
                 ->toArray();
             $missingIds = array_diff($idsToAdd, $foundIds);
 
             throw new RecordNotFoundException(
-                __('Not all requested records could be found. Missing IDs are {0}', implode(', ', $missingIds))
+                __('Not all requested records could be found. Missing IDs are {0}', implode(', ', $missingIds)),
             );
         }