Merge pull request #670 from FriendsOfCake/cake-4.3

Fix deprecation warnings on CakePHP 4.3.

.github/workflows/ci.yml

@@ -8,9 +8,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['7.2', '7.4', '8.0']
+        php-version: ['7.4', '8.0']
         db-type: [sqlite, mysql, pgsql]
-    name: PHP ${{ matrix.php-version }} & ${{ matrix.db-type }}
+        prefer-lowest: ['']
+        include:
+          - php-version: '7.2'
+            db-type: 'mysql'
+            prefer-lowest: 'prefer-lowest'
+          - php-version: '8.1'
+            db-type: 'mysql'
 
     services:
       postgres:
@@ -21,9 +27,7 @@ jobs:
           POSTGRES_PASSWORD: postgres
 
     steps:
-    - uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
+    - uses: actions/checkout@v2
 
     - name: Setup Service
       if: matrix.db-type == 'mysql'
@@ -39,32 +43,35 @@ jobs:
         coverage: pcov
 
     - name: Composer install
-      run: composer install
+      run: |
+        if ${{ matrix.prefer-lowest == 'prefer-lowest' }}; then
+          composer update --prefer-lowest --prefer-stable
+        else
+          composer update
+        fi
 
     - name: Run PHPUnit
       run: |
         if [[ ${{ matrix.db-type }} == 'sqlite' ]]; then export DB_URL='sqlite:///:memory:'; fi
         if [[ ${{ matrix.db-type }} == 'mysql' ]]; then export DB_URL='mysql://root:root@127.0.0.1/cakephp'; fi
         if [[ ${{ matrix.db-type }} == 'pgsql' ]]; then export DB_URL='postgres://postgres:postgres@127.0.0.1/postgres'; fi
 
-        if [[ ${{ matrix.php-version }} == '7.2' && ${{ matrix.db-type }} == 'sqlite' ]]; then
+        if [[ ${{ matrix.php-version }} == '7.4' && ${{ matrix.db-type }} == 'sqlite' ]]; then
           vendor/bin/phpunit --coverage-clover=coverage.xml
         else
           vendor/bin/phpunit
         fi
 
     - name: Code Coverage Report
-      if: success() && matrix.php-version == '7.2' && matrix.db-type == 'sqlite'
-      uses: codecov/codecov-action@v1
+      if: success() && matrix.php-version == '7.4' && matrix.db-type == 'sqlite'
+      uses: codecov/codecov-action@v2
 
   cs-stan:
     name: Coding Standard & Static Analysis
     runs-on: ubuntu-18.04
 
     steps:
-    - uses: actions/checkout@v1
-      with:
-        fetch-depth: 1
+    - uses: actions/checkout@v2
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -74,7 +81,7 @@ jobs:
         coverage: none
 
     - name: Composer Install
-      run: composer require --dev cakephp/cakephp-codesniffer:^4.1 psalm/phar:^3.18 phpstan/phpstan:^0.12
+      run: composer require --dev cakephp/cakephp-codesniffer:^4.1 psalm/phar:~4.19 phpstan/phpstan:~1.4
 
     - name: Run phpcs
       run: vendor/bin/phpcs --report=checkstyle --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/

composer.json

@@ -42,8 +42,8 @@
         "cakephp/cakephp": "^4.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~8.5.0",
-        "friendsofcake/cakephp-test-utilities": "^2.0",
+        "phpunit/phpunit": "^8.5.23 || ^9.3",
+        "friendsofcake/cakephp-test-utilities": "^2.0.1",
         "friendsofcake/search": "^6.0"
     },
     "autoload": {

phpstan.neon

@@ -6,7 +6,7 @@ parameters:
 	paths:
 		- src
 	checkMissingIterableValueType: false
-	excludes_analyse:
+	excludePaths:
 		- */src/TestSuite/*
 	universalObjectCratesClasses:
 		- Crud\Event\Subject

psalm.xml

@@ -14,6 +14,10 @@
         </ignoreFiles>
     </projectFiles>
 
+    <stubs>
+        <file name="src/Error/Exception/CrudException.php" preloadClasses="true" />
+    </stubs>
+
     <universalObjectCrates>
         <class name="Crud\Event\Subject" />
     </universalObjectCrates>

src/Action/BaseAction.php

@@ -314,7 +314,7 @@ protected function _deriveResourceName(): string
     /**
      * Additional auxiliary events emitted if certain traits are loaded
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Controller/Component/CrudComponent.php

@@ -108,7 +108,7 @@ class CrudComponent extends Component
      *
      * `eventLogging` boolean to determine whether the class should log triggered events.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected $_defaultConfig = [
         'actions' => [],
@@ -611,13 +611,12 @@ public function eventLog(): array
     /**
      * Sets the model class to be used during the action execution.
      *
-     * @param string $modelName The name of the model to load.
+     * @param string $modelName The name of the model to use.
      * @return void
      */
     public function useModel(string $modelName): void
     {
-        $this->_controller->loadModel($modelName);
-        [, $this->_modelName] = pluginSplit($modelName);
+        $this->_modelName = $modelName;
     }
 
     /**
@@ -627,7 +626,15 @@ public function useModel(string $modelName): void
      */
     public function table(): Table
     {
-        return $this->_controller->{$this->_modelName};
+        if (method_exists($this->_controller, 'fetchTable')) {
+            return $this->_controller->fetchTable($this->_modelName);
+        }
+
+        /**
+         * @var \Cake\ORM\Table
+         * @psalm-suppress DeprecatedMethod
+         */
+        return $this->_controller->loadModel($this->_modelName);
     }
 
     /**

src/Core/BaseObject.php

@@ -50,7 +50,7 @@ public function __construct(Controller $Controller, array $config = [])
     /**
      * List of implemented events
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Core/ProxyTrait.php

@@ -127,10 +127,17 @@ protected function _response(): Response
      */
     protected function _table()
     {
+        $modelType = $this->getConfig('modelFactory');
+
+        if (!$modelType && method_exists($this->_controller(), 'fetchTable')) {
+            return $this->_controller()->fetchTable();
+        }
+
+        /** @psalm-suppress DeprecatedMethod */
         return $this->_controller()
             ->loadModel(
                 null,
-                $this->getConfig('modelFactory') ?: $this->_controller()->getModelType()
+                $modelType ?: $this->_controller()->getModelType()
             );
     }
 

src/Error/Exception/ValidationException.php

@@ -37,7 +37,7 @@ class ValidationException extends BadRequestException
      */
     public function __construct(EntityInterface $entity, int $code = 422, ?Throwable $previous = null)
     {
-        $this->_validationErrors = array_filter((array)$entity->getErrors());
+        $this->_validationErrors = array_filter($entity->getErrors());
         $flat = Hash::flatten($this->_validationErrors);
 
         $errorCount = $this->_validationErrorCount = count($flat);

src/Listener/ApiListener.php

@@ -52,7 +52,7 @@ class ApiListener extends BaseListener
      *
      * We attach at priority 10 so normal bound events can run before us
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Listener/ApiPaginationListener.php

@@ -20,7 +20,7 @@ class ApiPaginationListener extends BaseListener
      *
      * We attach at priority 10 so normal bound events can run before us
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Listener/ApiQueryLogListener.php

@@ -37,7 +37,7 @@ class ApiQueryLogListener extends BaseListener
      *
      * We attach at priority 10 so normal bound events can run before us
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {
@@ -65,6 +65,7 @@ public function setupLogging(EventInterface $event): void
             try {
                 $connection = $this->_getSource($connectionName);
                 $connection->enableQueryLogging(true);
+                /** @psalm-suppress InternalMethod */
                 $connection->setLogger(new QueryLogger());
             } catch (MissingDatasourceConfigException $e) {
                 //Safe to ignore this :-)

src/Listener/BaseListener.php

@@ -29,7 +29,7 @@ abstract class BaseListener extends BaseObject implements EventListenerInterface
      * - invalidId : Called if the ID format validation failed
      * - setFlash : Called before any FlashComponent::set()
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Listener/RedirectListener.php

@@ -30,7 +30,7 @@ class RedirectListener extends BaseListener
      * Returns a list of all events that will fire in the controller during its lifecycle.
      * You can override this function to add your own listener callbacks
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Listener/RelatedModelsListener.php

@@ -21,7 +21,7 @@ class RelatedModelsListener extends BaseListener
     /**
      * Returns a list of events this listener is interested in.
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/Listener/SearchListener.php

@@ -26,7 +26,7 @@ class SearchListener extends BaseListener
      * Returns a list of all events that will fire in the controller during its lifecycle.
      * You can override this function to add your own listener callbacks
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function implementedEvents(): array
     {

src/TestSuite/IntegrationTestCase.php

@@ -49,7 +49,9 @@ public function setUp(): void
 
         Router::extensions('json');
 
-        Router::connect('/:controller', ['action' => 'index'], ['routeClass' => 'DashedRoute']);
-        Router::connect('/:controller/:action/*', [], ['routeClass' => 'DashedRoute']);
+        $routeBuilder = Router::createRouteBuilder('/');
+
+        $routeBuilder->connect('/{controller}', ['action' => 'index'], ['routeClass' => 'DashedRoute']);
+        $routeBuilder->connect('/{controller}/{action}/*', [], ['routeClass' => 'DashedRoute']);
     }
 }

src/Traits/FindMethodTrait.php

@@ -61,7 +61,10 @@ protected function _findRecord(?string $id, Subject $subject): EntityInterface
 
         [$finder, $options] = $this->_extractFinder();
         $query = $repository->find($finder, $options);
-        /** @psalm-suppress PossiblyInvalidArgument */
+        /**
+         * @psalm-suppress PossiblyInvalidArgument
+         * @psalm-suppress InvalidArrayOffset
+         */
         $query->where([current($query->aliasField($repository->getPrimaryKey())) => $id]);
 
         $subject->set([

src/Traits/SerializeTrait.php

@@ -20,6 +20,6 @@ public function serialize(?array $keys = null)
             return (array)$this->getConfig('serialize');
         }
 
-        return $this->setConfig('serialize', (array)$keys);
+        return $this->setConfig('serialize', $keys);
     }
 }

tests/TestCase/Action/AddActionTest.php

@@ -4,6 +4,7 @@
 namespace Crud\Test\TestCase\Action;
 
 use Cake\Controller\Component\FlashComponent;
+use Cake\Core\Configure;
 use Cake\Routing\Router;
 use Crud\TestSuite\IntegrationTestCase;
 
@@ -239,16 +240,17 @@ function ($event) {
 
                 $this->_subscribeToEvents($this->_controller);
 
-                $this->_controller->Blogs = $this->getMockForModel(
+                $blogs = $this->getMockForModel(
                     $this->tableClass,
                     ['save'],
                     ['alias' => 'Blogs', 'table' => 'blogs']
                 );
-
-                $this->_controller->Blogs
+                $blogs
                     ->expects($this->once())
                     ->method('save')
                     ->will($this->returnValue(false));
+
+                $this->getTableLocator()->set('Blogs', $blogs);
             }
         );
 
@@ -314,7 +316,11 @@ function ($event) {
         $this->assertFalse($this->_subject->success);
         $this->assertFalse($this->_subject->created);
 
-        $expected = '<div class="error-message">Name need to be at least 10 characters long</div>';
+        if (version_compare(Configure::version(), '4.3.0', '>=')) {
+            $expected = '<div class="error-message" id="name-error">Name need to be at least 10 characters long</div>';
+        } else {
+            $expected = '<div class="error-message">Name need to be at least 10 characters long</div>';
+        }
         $this->assertStringContainsString(
             $expected,
             (string)$this->_response->getBody(),
@@ -344,10 +350,9 @@ public function apiGetHttpMethodProvider()
      */
     public function testApiGet($method)
     {
-        Router::scope('/', function ($routes) {
-            $routes->setExtensions(['json']);
-            $routes->fallbacks();
-        });
+        Router::createRouteBuilder('/')
+            ->setExtensions(['json'])
+            ->fallbacks();
 
         $this->{$method}('/Blogs/add.json');
 

tests/TestCase/Action/BaseActionTest.php

@@ -46,9 +46,9 @@ public function setUp(): void
             ->addMethods(['foobar'])
             ->getMock();
         $this->Controller->Crud = $this->Crud;
-        $this->Controller->modelClass = 'CrudExamples';
-        $this->Controller->CrudExamples = $this->getTableLocator()->get('Crud.CrudExamples');
-        $this->Controller->CrudExamples->setAlias('MyModel');
+        $this->Controller->defaultTable = 'CrudExamples';
+
+        $this->getTableLocator()->get('CrudExamples')->setAlias('MyModel');
 
         $this->actionClassName = $this->getMockBuilder(BaseAction::class)
             ->addMethods(['_handle'])