Merge pull request #325 from cakephp/update-tools

Upgrade phpstan/psalm

.github/workflows/ci.yml

@@ -129,7 +129,7 @@ jobs:
       with:
         home: ${{ runner.temp }}/.phive
         binPath: ${{ github.workspace }}/tools/phive
-        trustGpgKeys: "CF1A108D0E7AE720,12CE0F1D262429A5"
+        trustGpgKeys: "CF1A108D0E7AE720,12CE0F1D262429A5,51C67305FFC2E5C0"
 
     - name: Run PHP CodeSniffer
       run: vendor/bin/phpcs --report=checkstyle src/ tests/ | cs2pr

.phive/phars.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="1.9.12" installed="1.9.12" location="./tools/phpstan" copy="false"/>
-  <phar name="psalm" version="5.4.0" installed="5.4.0" location="./tools/psalm" copy="false"/>
+  <phar name="phpstan" version="2.0.1" installed="2.0.1" location="./tools/phpstan" copy="true"/>
+  <phar name="psalm" version="5.26.1" installed="5.26.1" location="./tools/psalm" copy="true"/>
 </phive>

phpstan-baseline.neon

@@ -1,16 +1,31 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Access to an undefined property Cake\\\\Datasource\\\\EntityInterface\\:\\:\\$version\\.$#"
+			message: '#^Strict comparison using \!\=\= between string and array\{\} will always evaluate to true\.$#'
+			identifier: notIdentical.alwaysTrue
+			count: 1
+			path: src/Document.php
+
+		-
+			message: '#^Access to an undefined property Cake\\Datasource\\EntityInterface\:\:\$version\.$#'
+			identifier: property.notFound
 			count: 1
 			path: src/Index.php
 
 		-
-			message: "#^Method Cake\\\\ElasticSearch\\\\Query\\:\\:find\\(\\) should return static\\(Cake\\\\ElasticSearch\\\\Query\\<TSubject of array\\|Cake\\\\ElasticSearch\\\\Document\\>\\) but returns Cake\\\\ElasticSearch\\\\Query\\<Cake\\\\ElasticSearch\\\\Document\\>\\.$#"
+			message: '#^Method Cake\\ElasticSearch\\Query\:\:find\(\) should return static\(Cake\\ElasticSearch\\Query\<TSubject of array\|Cake\\ElasticSearch\\Document\>\) but returns Cake\\ElasticSearch\\Query\<Cake\\ElasticSearch\\Document\>\.$#'
+			identifier: return.type
 			count: 1
 			path: src/Query.php
 
 		-
-			message: "#^PHPDoc tag @return with type Cake\\\\ElasticSearch\\\\Query\\<TSubject of array\\|Cake\\\\ElasticSearch\\\\Document\\> is not subtype of native type static\\(Cake\\\\ElasticSearch\\\\Query\\<TSubject of array\\|Cake\\\\ElasticSearch\\\\Document\\>\\)\\.$#"
+			message: '#^PHPDoc tag @return with type Cake\\ElasticSearch\\Query\<TSubject of array\|Cake\\ElasticSearch\\Document\> is not subtype of native type static\(Cake\\ElasticSearch\\Query\<TSubject of array\|Cake\\ElasticSearch\\Document\>\)\.$#'
+			identifier: return.phpDocType
 			count: 1
 			path: src/Query.php
+
+		-
+			message: '#^Strict comparison using \!\=\= between mixed and null will always evaluate to true\.$#'
+			identifier: notIdentical.alwaysTrue
+			count: 1
+			path: src/QueryBuilder.php

phpstan.neon

@@ -2,12 +2,12 @@ includes:
 	- phpstan-baseline.neon
 
 parameters:
-	level: 6
-	checkMissingIterableValueType: false
-	checkGenericClassInNonGenericObjectType: false
-	treatPhpDocTypesAsCertain: false
-	bootstrapFiles:
-		- tests/bootstrap.php
-		- vendor/cakephp/cakephp/src/Core/Exception/CakeException.php
-	paths:
-		- src/
+    level: 6
+    paths:
+        - src/
+    bootstrapFiles:
+        - tests/bootstrap.php
+    ignoreErrors:
+        - identifier: missingType.iterableValue
+        - identifier: missingType.generics
+

psalm-baseline.xml

@@ -1,41 +1,38 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="dev-master@">
+<files psalm-version="5.26.1@d747f6500b38ac4f7dfc5edbcae6e4b637d7add0">
   <file src="src/Datasource/Connection.php">
-    <InvalidReturnStatement occurrences="1">
-      <code>$this-&gt;_client-&gt;getConfig()</code>
+    <InvalidReturnStatement>
+      <code><![CDATA[$this->_client->getConfig()]]></code>
     </InvalidReturnStatement>
-    <InvalidReturnType occurrences="1">
-      <code>array</code>
+    <InvalidReturnType>
+      <code><![CDATA[array]]></code>
     </InvalidReturnType>
-    <LessSpecificImplementedReturnType occurrences="1">
-      <code>array</code>
+    <LessSpecificImplementedReturnType>
+      <code><![CDATA[array]]></code>
     </LessSpecificImplementedReturnType>
   </file>
   <file src="src/Index.php">
-    <NoInterfaceProperties occurrences="5">
-      <code>$entity-&gt;version</code>
-      <code>$entity-&gt;id</code>
-      <code>$entity-&gt;id</code>
-      <code>$entity-&gt;id</code>
-      <code>$entity-&gt;id</code>
+    <NoInterfaceProperties>
+      <code><![CDATA[$entity->id]]></code>
+      <code><![CDATA[$entity->id]]></code>
+      <code><![CDATA[$entity->id]]></code>
+      <code><![CDATA[$entity->id]]></code>
+      <code><![CDATA[$entity->version]]></code>
     </NoInterfaceProperties>
   </file>
   <file src="src/Marshaller.php">
-    <InvalidDocblock occurrences="1">
-      <code>public function one(array $data, array $options = []): Document</code>
-    </InvalidDocblock>
-    <NoInterfaceProperties occurrences="1">
-      <code>$record-&gt;id</code>
+    <NoInterfaceProperties>
+      <code><![CDATA[$record->id]]></code>
     </NoInterfaceProperties>
   </file>
   <file src="src/Query.php">
-    <InvalidArgument occurrences="3">
-      <code>$query</code>
-      <code>$query</code>
-      <code>false</code>
-    </InvalidArgument>
-    <LessSpecificImplementedReturnType occurrences="1">
-      <code>\Traversable</code>
+    <LessSpecificImplementedReturnType>
+      <code><![CDATA[\Traversable]]></code>
     </LessSpecificImplementedReturnType>
   </file>
+  <file src="src/View/Form/DocumentContext.php">
+    <InvalidReturnStatement>
+      <code><![CDATA[$entity]]></code>
+    </InvalidReturnStatement>
+  </file>
 </files>

psalm.xml

@@ -7,7 +7,10 @@
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
     autoloader="tests/bootstrap.php"
     usePhpDocMethodsWithoutMagicCall="true"
-    errorBaseline="psalm-baseline.xml"
+    errorBaseline="./psalm-baseline.xml"
+    findUnusedPsalmSuppress="true"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />

src/Marshaller.php

@@ -59,7 +59,7 @@ public function __construct(Index $index)
      *
      * @param array $data The data to hydrate.
      * @param array $options List of options
-     * @return \Cake\ElasticSearch\Document;
+     * @return \Cake\ElasticSearch\Document
      */
     public function one(array $data, array $options = []): Document
     {

src/Query.php

@@ -1065,7 +1065,6 @@ public function formatResults(?Closure $formatter = null, int|bool $mode = self:
             $this->_formatters = [];
         }
         if ($formatter === null) {
-            /** @psalm-suppress RedundantCondition */
             if ($mode !== self::OVERWRITE) {
                 throw new InvalidArgumentException('$formatter can be null only when $mode is overwrite.');
             }

tests/TestCase/View/Form/DocumentContextTest.php

@@ -537,13 +537,13 @@ public function testErrorNestedFields()
                 ],
                 'en' => [
                     ['family_name' => 'ZZ', 'given_name' => 'AA'],
-                ]
-            ]
+                ],
+            ],
         ]);
         $row->setError('name', [
             'ja' => [
-                ['family_name' => ['_empty' => 'Invalid value']]
-            ]
+                ['family_name' => ['_empty' => 'Invalid value']],
+            ],
         ]);
 
         $articles = $this->setupIndex();