fix issues related to the latest core changes. phpstan level 4,5 fixes

skie · skie · commit 723488262caf · 2019-12-27T15:24:16.000+03:00
diff --git a/.semver b/.semver
@@ -1,5 +1,5 @@
 ---
-:major: 6
+:major: 8
 :minor: 0
-:patch: 1
+:patch: 0
 :special: ''
diff --git a/composer.json b/composer.json
@@ -29,8 +29,8 @@
     "require": {
         "php": ">=7.2",
         "ext-json": "*",
-        "cakephp/cakephp": "4.x-dev as 4.0.0",
-        "cakedc/users": "9.next-dev",
+        "cakephp/cakephp": "^4.0.0",
+        "cakedc/users": "^9.0.0",
         "firebase/php-jwt": "^5.0"
     },
     "require-dev": {
@@ -72,8 +72,10 @@
         "stan": "phpstan analyse src/",
         "psalm": "php vendor/psalm/phar/psalm.phar --show-info=false src/ ",
         "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan-shim:^0.11.18 psalm/phar:^3.5  && mv composer.backup composer.json",
+        "stan-rebuild-baseline": "phpstan analyse --configuration phpstan.neon --error-format baselineNeon src/ > phpstan-baseline.neon",
+        "psalm-rebuild-baseline": "php vendor/psalm/phar/psalm.phar --show-info=false  --set-baseline=psalm-baseline.xml  src/",
         "rector": "rector process src/",
-        "rector-setup": "cp composer.json composer.backup && composer require --dev rector/rector:^0.4.11 && mv composer.backup composer.json", 
+        "rector-setup": "cp composer.json composer.backup && composer require --dev rector/rector:^0.4.11 && mv composer.backup composer.json",
         "coverage-test": "phpunit --stderr --coverage-clover=clover.xml"
     }
 }
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<ruleset name="CakePHP Core">
+    <config name="installed_paths" value="../../cakephp/cakephp-codesniffer" />
+
+    <rule ref="CakePHP" />
+</ruleset>
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -0,0 +1,50 @@
+
+
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:getRegisterValidators\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\RegisterAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:register\\(\\)\\.$#"
+			count: 2
+			path: src\Service\Action\Auth\RegisterAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:validate\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\ResetPasswordAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:validationPasswordConfirm\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\ResetPasswordAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:changePassword\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\ResetPasswordAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:resetToken\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\ResetPasswordRequestAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:socialLogin\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\SocialLoginAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:validate\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\ValidateAccountAction.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Table\\:\\:resetToken\\(\\)\\.$#"
+			count: 1
+			path: src\Service\Action\Auth\ValidateAccountRequestAction.php
+
+
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,26 +1,10 @@
+includes:
+    - phpstan-baseline.neon
+
 parameters:
     level: 4
     autoload_files:
         - tests/bootstrap.php
     ignoreErrors:
-        -
-            message: '#Call to an undefined method Cake\\ORM\\Table.*#'
-            path: 'src/Service/Action/Auth/RegisterAction.php'
-        -
-            message: '#Call to an undefined method Cake\\ORM\\Table.*#'
-            path: 'src/Service/Action/Auth/ResetPasswordAction.php'
-        -
-            message: '#Call to an undefined method Cake\\ORM\\Table.*#'
-            path: 'src/Service/Action/Auth/ResetPasswordRequestAction.php'
-        -
-            message: '#Call to an undefined method Cake\\ORM\\Table.*#'
-            path: 'src/Service/Action/Auth/SocialLoginAction.php'
-        -
-            message: '#Call to an undefined method Cake\\ORM\\Table.*#'
-            path: 'src/Service/Action/Auth/ValidateAccountAction.php'
-        -
-            message: '#Call to an undefined method Cake\\ORM\\Table.*#'
-            path: 'src/Service/Action/Auth/ValidateAccountRequestAction.php'
-        -
-            message: '#PHPDoc tag @throws with type PHPUnit.*#'
-            path: 'src/TestSuite/IntegrationTestCase.php'
+
+services:
diff --git a/src/Service/Action/Auth/LoginAction.php b/src/Service/Action/Auth/LoginAction.php
@@ -64,7 +64,7 @@ public function validates(): bool
         $validator
             ->requirePresence($this->_passwordField, 'create')
             ->notBlank($this->_passwordField);
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Auth/RegisterAction.php b/src/Service/Action/Auth/RegisterAction.php
@@ -53,7 +53,7 @@ public function validates(): bool
     {
         $validator = $this->getUsersTable()->getRegisterValidators($this->_registerOptions());
 
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Auth/ResetPasswordAction.php b/src/Service/Action/Auth/ResetPasswordAction.php
@@ -56,7 +56,7 @@ public function validates(): bool
         $validator
             ->requirePresence('token', 'create')
             ->notBlank('token');
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Auth/ResetPasswordRequestAction.php b/src/Service/Action/Auth/ResetPasswordRequestAction.php
@@ -55,7 +55,7 @@ public function validates(): bool
         $validator
             ->requirePresence('reference', 'create')
             ->notBlank('reference');
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Auth/SocialLoginAction.php b/src/Service/Action/Auth/SocialLoginAction.php
@@ -59,7 +59,7 @@ public function validates(): bool
             ->requirePresence('data', 'create');
         $validator
             ->requirePresence('options', 'create');
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Auth/ValidateAccountAction.php b/src/Service/Action/Auth/ValidateAccountAction.php
@@ -55,7 +55,7 @@ public function validates(): bool
         $validator
             ->requirePresence('token', 'create')
             ->notBlank('token');
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Auth/ValidateAccountRequestAction.php b/src/Service/Action/Auth/ValidateAccountRequestAction.php
@@ -55,7 +55,7 @@ public function validates(): bool
         $validator
             ->requirePresence('reference', 'create')
             ->notBlank('reference');
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Collection/CollectionAction.php b/src/Service/Action/Collection/CollectionAction.php
@@ -37,7 +37,7 @@ protected function _validateMany(): bool
         $this->_validateDataIsArray($data);
         $index = 0;
         $errors = collection($data)->reduce(function ($errors, $data) use ($validator, &$index) {
-            $error = $validator->errors($data);
+            $error = $validator->validate($data);
             if ($error) {
                 $errors[$index] = $error;
             }
@@ -57,11 +57,11 @@ protected function _validateMany(): bool
     /**
      * Save many entities
      *
-     * @param array $entities entities
-     * @return array of entities saved
+     * @param \Cake\Datasource\EntityInterface[]  $entities entities
+     * @return \Cake\Datasource\EntityInterface[]|\Cake\Datasource\ResultSetInterface|array of entities saved
      * @throws \Exception
      */
-    protected function _saveMany(array $entities = []): array
+    protected function _saveMany(iterable $entities)
     {
         if ($this->getTable()->saveMany($entities)) {
             return $entities;
@@ -77,10 +77,10 @@ protected function _saveMany(array $entities = []): array
     /**
      * Create entities from the posted data
      *
-     * @param array $patchOptions options to use un patch
-     * @return array entities
+     * @param array $patchOptions options to use in patch
+     * @return \Cake\Datasource\EntityInterface[] entities
      */
-    protected function _newEntities(array $patchOptions = []): array
+    protected function _newEntities(array $patchOptions = [])
     {
         $data = $this->getData();
         $this->_validateDataIsArray($data);
diff --git a/src/Service/Action/CrudAction.php b/src/Service/Action/CrudAction.php
@@ -295,7 +295,7 @@ protected function _getEntityQuery($primaryKey)
     /**
      * Build condition for get entity method.
      *
-     * @param string|int $primaryKey Primary key
+     * @param mixed $primaryKey Primary key
      * @return array
      */
     protected function _buildViewCondition($primaryKey): array
diff --git a/src/Service/Action/CrudAddAction.php b/src/Service/Action/CrudAddAction.php
@@ -30,7 +30,7 @@ class CrudAddAction extends CrudAction
     public function validates(): bool
     {
         $validator = $this->getTable()->getValidator();
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/CrudEditAction.php b/src/Service/Action/CrudEditAction.php
@@ -30,7 +30,7 @@ class CrudEditAction extends CrudAction
     public function validates(): bool
     {
         $validator = $this->getTable()->getValidator();
-        $errors = $validator->errors($this->getData(), false);
+        $errors = $validator->validate($this->getData(), false);
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/DescribeAction.php b/src/Service/Action/DescribeAction.php
@@ -36,7 +36,7 @@ public function validates(): bool
         $validator
             ->requirePresence('service', 'create')
             ->notBlank('service');
-        $errors = $validator->errors($this->getData());
+        $errors = $validator->validate($this->getData());
         if (!empty($errors)) {
             throw new ValidationException(__('Validation failed'), 0, null, $errors);
         }
diff --git a/src/Service/Action/Extension/CrudAutocompleteListExtension.php b/src/Service/Action/Extension/CrudAutocompleteListExtension.php
@@ -41,12 +41,16 @@ public function implementedEvents(): array
     /**
      * On find entities.
      *
-     * @param \Cake\Event\Event $Event An Event instance.
+     * @param \Cake\Event\Event $event An Event instance.
      * @return \Cake\ORM\Query
      */
-    public function findEntities(Event $Event): \Cake\ORM\Query
+    public function findEntities(Event $event): \Cake\ORM\Query
     {
-        return $this->_autocompleteList($Event->getSubject(), $Event->getData('query'));
+        /** @var \CakeDC\Api\Service\Action\CrudAction $action */
+        $action = $event->getSubject();
+        /** @var \Cake\ORM\Query $query */
+        $query = $event->getData('query');
+        return $this->_autocompleteList($action, $query);
     }
 
     /**
diff --git a/src/Service/Action/Extension/CrudHateoasExtension.php b/src/Service/Action/Extension/CrudHateoasExtension.php
@@ -66,6 +66,7 @@ public function implementedEvents(): array
      */
     public function afterAction(Event $event): void
     {
+        /** @var \CakeDC\Api\Service\Action\Action $action */
         $action = $event->getSubject();
         $result = $action->getService()->getResult();
         $actionName = $action->getName();
diff --git a/src/Service/Action/Extension/CrudRelationsExtension.php b/src/Service/Action/Extension/CrudRelationsExtension.php
@@ -52,7 +52,11 @@ public function implementedEvents(): array
      */
     public function findEntity(Event $event): \Cake\ORM\Query
     {
-        return $this->_attachAssociations($event->getSubject(), $event->getData('query'));
+        /** @var \CakeDC\Api\Service\Action\CrudAction $action */
+        $action = $event->getSubject();
+        /** @var \Cake\ORM\Query $query */
+        $query = $event->getData('query');
+        return $this->_attachAssociations($action, $query);
     }
 
     /**
@@ -63,7 +67,11 @@ public function findEntity(Event $event): \Cake\ORM\Query
      */
     public function findEntities(Event $event): \Cake\ORM\Query
     {
-        return $this->_attachAssociations($event->getSubject(), $event->getData('query'));
+        /** @var \CakeDC\Api\Service\Action\CrudAction $action */
+        $action = $event->getSubject();
+        /** @var \Cake\ORM\Query $query */
+        $query = $event->getData('query');
+        return $this->_attachAssociations($action, $query);
     }
 
     /**
diff --git a/src/Service/Action/Extension/CursorPaginateExtension.php b/src/Service/Action/Extension/CursorPaginateExtension.php
@@ -76,7 +76,9 @@ public function implementedEvents(): array
      */
     public function findEntities(Event $event): \Cake\ORM\Query
     {
+        /** @var \CakeDC\Api\Service\Action\Action $action */
         $action = $event->getSubject();
+        /** @var \Cake\ORM\Query $query */
         $query = $event->getData('query');
         if ($event->getResult()) {
             $query = $event->getResult();
@@ -160,6 +162,7 @@ protected function _count(Action $action): ?int
      */
     public function afterFind(EventInterface $event): ?Entity
     {
+        /** @var \CakeDC\Api\Service\Action\Action $action */
         $action = $event->getSubject();
         $records = $event->getData('records');
         $result = $action->getService()->getResult();
diff --git a/src/Service/Action/Extension/NestedExtension.php b/src/Service/Action/Extension/NestedExtension.php
@@ -46,7 +46,9 @@ public function implementedEvents(): array
      */
     public function findEntities(Event $event): \Cake\ORM\Query
     {
+        /** @var \CakeDC\Api\Service\Action\CrudAction $action */
         $action = $event->getSubject();
+        /** @var \Cake\ORM\Query $query */
         $query = $event->getData('query');
         $foreignKey = $action->getParentId();
         $field = $action->getParentIdName();
@@ -68,7 +70,9 @@ public function findEntities(Event $event): \Cake\ORM\Query
      */
     public function findEntity(Event $event): \Cake\ORM\Query
     {
+        /** @var \CakeDC\Api\Service\Action\CrudAction $action */
         $action = $event->getSubject();
+        /** @var \Cake\ORM\Query $query */
         $query = $event->getData('query');
         $foreignKey = $action->getParentId();
         $field = $action->getParentIdName();
@@ -90,8 +94,10 @@ public function findEntity(Event $event): \Cake\ORM\Query
      */
     public function patchEntity(Event $event): \Cake\ORM\Entity
     {
+        /** @var \CakeDC\Api\Service\Action\CrudAction $action */
         $action = $event->getSubject();
-        $entity = $event->getData('entity');
+        /** @var \Cake\ORM\Query $query */
+        $query = $event->getData('query');
         if ($event->getResult()) {
             $entity = $event->getResult();
         }
diff --git a/src/Service/Auth/Authorize/SimpleRbacAuthorize.php b/src/Service/Auth/Authorize/SimpleRbacAuthorize.php
@@ -223,7 +223,7 @@ protected function _matchRule(array $permission, $user, string $role, ServerRequ
      *
      * @param array $permission permission configuration
      * @param string $key key to retrieve and check in permissions configuration
-     * @param string $value value to check with (coming from the request) We'll check the DASHERIZED value too
+     * @param string|null $value value to check with (coming from the request) We'll check the DASHERIZED value too
      * @param bool $allowEmpty true if we allow
      * @return bool
      */
diff --git a/src/Service/Renderer/FlysystemRenderer.php b/src/Service/Renderer/FlysystemRenderer.php
@@ -22,6 +22,7 @@
 use League\Flysystem\File;
 use League\Flysystem\FileNotFoundException;
 use League\Flysystem\Filesystem;
+use League\Flysystem\Handler;
 use Zend\Diactoros\Stream;
 
 /**
@@ -65,9 +66,9 @@ public function response(?Result $result = null): bool
      *
      * @param \League\Flysystem\Filesystem $filesystem custom filesystem
      * @param string $path of file at filesystem
-     * @return \League\Flysystem\File
+     * @return \League\Flysystem\Handler
      */
-    protected function getFile(Filesystem $filesystem, string $path): File
+    protected function getFile(Filesystem $filesystem, string $path): Handler
     {
         return $filesystem->get($path);
     }
diff --git a/src/Service/Service.php b/src/Service/Service.php
@@ -568,7 +568,7 @@ public function dispatchProcessAction($request): Result
     /**
      * Dispatch service call through callbacks and action.
      *
-     * @return \CakeDC\Api\Service\Action\Result
+     * @return \CakeDC\Api\Service\Action\Result|null
 
      */
     protected function _dispatch()
diff --git a/src/Service/Utility/ReverseRouting.php b/src/Service/Utility/ReverseRouting.php
diff --git a/tests/App/Application.php b/tests/App/Application.php
diff --git a/tests/App/Service/Action/ArticlesTagAction.php b/tests/App/Service/Action/ArticlesTagAction.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function validates(): bool`
`64`	`64`	`$validator`
`65`	`65`	`->requirePresence($this->_passwordField, 'create')`
`66`	`66`	`->notBlank($this->_passwordField);`
`67`		`- $errors = $validator->errors($this->getData());`
	`67`	`+ $errors = $validator->validate($this->getData());`
`68`	`68`	`if (!empty($errors)) {`
`69`	`69`	`throw new ValidationException(__('Validation failed'), 0, null, $errors);`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function validates(): bool`
`53`	`53`	`{`
`54`	`54`	`$validator = $this->getUsersTable()->getRegisterValidators($this->_registerOptions());`
`55`	`55`
`56`		`- $errors = $validator->errors($this->getData());`
	`56`	`+ $errors = $validator->validate($this->getData());`
`57`	`57`	`if (!empty($errors)) {`
`58`	`58`	`throw new ValidationException(__('Validation failed'), 0, null, $errors);`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public function validates(): bool`
`56`	`56`	`$validator`
`57`	`57`	`->requirePresence('token', 'create')`
`58`	`58`	`->notBlank('token');`
`59`		`- $errors = $validator->errors($this->getData());`
	`59`	`+ $errors = $validator->validate($this->getData());`
`60`	`60`	`if (!empty($errors)) {`
`61`	`61`	`throw new ValidationException(__('Validation failed'), 0, null, $errors);`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function validates(): bool`
`55`	`55`	`$validator`
`56`	`56`	`->requirePresence('reference', 'create')`
`57`	`57`	`->notBlank('reference');`
`58`		`- $errors = $validator->errors($this->getData());`
	`58`	`+ $errors = $validator->validate($this->getData());`
`59`	`59`	`if (!empty($errors)) {`
`60`	`60`	`throw new ValidationException(__('Validation failed'), 0, null, $errors);`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public function validates(): bool`
`59`	`59`	`->requirePresence('data', 'create');`
`60`	`60`	`$validator`
`61`	`61`	`->requirePresence('options', 'create');`
`62`		`- $errors = $validator->errors($this->getData());`
	`62`	`+ $errors = $validator->validate($this->getData());`
`63`	`63`	`if (!empty($errors)) {`
`64`	`64`	`throw new ValidationException(__('Validation failed'), 0, null, $errors);`
`65`	`65`	`}`