phpstan level 6

imbo · Jan 7, 2025 · 81aa968 · 81aa968
1 parent e0a8e8f
commit 81aa968
Show file tree

Hide file tree

Showing 13 changed files with 136 additions and 18 deletions.
diff --git a/composer.json b/composer.json
@@ -28,7 +28,9 @@
   },
   "require-dev": {
     "imbo/imbo-coding-standard": "^2.0",
+    "phpstan/extension-installer": "^1.4",
     "phpstan/phpstan": "^2.1",
+    "phpstan/phpstan-phpunit": "^2.0",
     "phpunit/phpunit": "^11.5",
     "slim/psr7": "^1.3",
     "slim/slim": "^4.7",
@@ -65,6 +67,9 @@
     "docs": "cd docs; make html"
   },
   "config": {
-    "sort-packages": true
+    "sort-packages": true,
+    "allow-plugins": {
+      "phpstan/extension-installer": true
+    }
   }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,5 +1,10 @@
 parameters:
-	level: 5
+	level: 6
 	paths:
 		- src
-		- tests
+		- tests
+	ignoreErrors:
+		-
+			message: '#Method [a-zA-Z0-9\\_]+::test#'
+			identifier: missingType.iterableValue
+			path: tests
diff --git a/src/ArrayContainsComparator.php b/src/ArrayContainsComparator.php
@@ -53,7 +53,7 @@ public function getMatcherFunction(string $name): callable
      * To clarify, the method (and other methods in the class) refers to "lists" and "objects". A
      * "list" is a numerically indexed array, and an "object" is an associative array.
      *
-     * @param array<scalar|array> $needle
+     * @param array<scalar|array<mixed>> $needle
      * @param array<mixed> $haystack
      */
     public function compare(array $needle, array $haystack): bool
@@ -239,8 +239,8 @@ protected function compareValues(mixed $needleValue, mixed $haystackValue): bool
     /**
      * Make sure all values in the $needle array is present in the $haystack array
      *
-     * @param array<array|scalar> $needle
-     * @param array $haystack
+     * @param array<array<mixed>|scalar> $needle
+     * @param array<mixed> $haystack
      */
     protected function inArray(array $needle, array $haystack): bool
     {
@@ -350,6 +350,8 @@ protected function inArray(array $needle, array $haystack): bool
 
     /**
      * See if a PHP array is a JSON array
+     *
+     * @param array<mixed> $array
      */
     protected function arrayIsList(array $array): bool
     {
@@ -360,6 +362,8 @@ protected function arrayIsList(array $array): bool
 
     /**
      * See if a PHP array is a JSON object
+     *
+     * @param array<mixed> $array
      */
     protected function arrayIsObject(array $array): bool
     {

diff --git a/src/ArrayContainsComparator/Matcher/ArrayLength.php b/src/ArrayContainsComparator/Matcher/ArrayLength.php
@@ -11,7 +11,7 @@ class ArrayLength
     /**
      * Match the exact length of an array
      *
-     * @param array $array An array
+     * @param array<mixed> $array An array
      * @param int|string $length The expected exact length of $array
      * @throws InvalidArgumentException
      */

diff --git a/src/ArrayContainsComparator/Matcher/ArrayMaxLength.php b/src/ArrayContainsComparator/Matcher/ArrayMaxLength.php
@@ -11,7 +11,7 @@ class ArrayMaxLength
     /**
      * Match the max length of an array
      *
-     * @param array $array An array
+     * @param array<mixed> $array An array
      * @param int|string $maxLength The expected maximum length of $array
      * @throws InvalidArgumentException
      */

diff --git a/src/ArrayContainsComparator/Matcher/ArrayMinLength.php b/src/ArrayContainsComparator/Matcher/ArrayMinLength.php
@@ -11,7 +11,7 @@ class ArrayMinLength
     /**
      * Match the min length of an array
      *
-     * @param array $array An array
+     * @param array<mixed> $array An array
      * @param int|string $minLength The expected minimum length of $array
      * @throws InvalidArgumentException
      */

diff --git a/src/ArrayContainsComparator/Matcher/JWT.php b/src/ArrayContainsComparator/Matcher/JWT.php
@@ -19,7 +19,7 @@ class JWT
     /**
      * JWT tokens present in the response body
      *
-     * @var array<string,array{payload:array,secret:string}>
+     * @var array<string,array{payload:array<mixed>,secret:string}>
      */
     private array $jwtTokens = [];
 
@@ -41,6 +41,8 @@ public function __construct(Comparator $comparator)
 
     /**
      * Add a JWT token that can be matched
+     *
+     * @param array<mixed> $payload
      */
     public function addToken(string $name, array $payload, string $secret): self
     {

diff --git a/src/Context/ApiClientAwareContext.php b/src/Context/ApiClientAwareContext.php
@@ -10,6 +10,8 @@ interface ApiClientAwareContext extends Context
 {
     /**
      * Initialize the Guzzle client
+     *
+     * @param array<mixed> $config
      */
     public function initializeClient(array $config): self;
 }
diff --git a/src/Context/ApiContext.php b/src/Context/ApiContext.php
@@ -86,6 +86,7 @@ class ApiContext implements ApiClientAwareContext, ArrayContainsComparatorAwareC
     /**
      * Set the client instance
      *
+     * @param array<mixed> $config
      * @throws InvalidArgumentException
      */
     public function initializeClient(array $config): static
@@ -1409,7 +1410,7 @@ protected function getResponseBody(): array|stdClass
      * Get the response body as an array
      *
      * @throws InvalidArgumentException
-     * @return array
+     * @return array<mixed>
      */
     protected function getResponseBodyArray(): array
     {

diff --git a/src/Context/Initializer/ApiClientAwareInitializer.php b/src/Context/Initializer/ApiClientAwareInitializer.php
@@ -13,15 +13,15 @@
 class ApiClientAwareInitializer implements ContextInitializer
 {
     /**
-     * @var array Guzzle client configuration array
+     * @var array<mixed> Guzzle client configuration array
      * @see http://docs.guzzlephp.org/ Check out the Guzzle docs for a complete overview of available configuration parameters
      */
     private array $config = [];
 
     /**
      * Class constructor
      *
-     * @param array $config Guzzle client configuration array
+     * @param array<mixed> $config Guzzle client configuration array
      */
     public function __construct(array $config)
     {

diff --git a/src/ServiceContainer/BehatApiExtension.php b/src/ServiceContainer/BehatApiExtension.php
@@ -65,7 +65,7 @@ public function configure(ArrayNodeDefinition $builder): void
     }
 
     /**
-     * @param array $config Guzzle client configuration array
+     * @param array{apiClient:array<mixed>} $config Guzzle client configuration array
      * @see http://docs.guzzlephp.org/ Check out the Guzzle docs for a complete overview of available configuration parameters
      */
     public function load(ContainerBuilder $container, array $config): void

diff --git a/tests/ArrayContainsComparatorTest.php b/tests/ArrayContainsComparatorTest.php
@@ -19,7 +19,7 @@ public function setUp(): void
     }
 
     /**
-     * @return array<string,array{needle:array,haystack:array}>
+     * @return array<string,array{needle:array<mixed>,haystack:array<mixed>}>
      */
     public static function getDataForInArrayCheck(): array
     {
@@ -165,7 +165,7 @@ public static function getDataForInArrayCheck(): array
     }
 
     /**
-     * @return array<string,array{needle:array,haystack:array}>
+     * @return array<string,array{needle:array<mixed>,haystack:array<mixed>}>
      */
     public static function getDataForCompareCheck(): array
     {
@@ -210,7 +210,7 @@ public static function getDataForCompareCheck(): array
     }
 
     /**
-     * @return array<array{needle:array,haystack:array}>
+     * @return array<array{needle:array<mixed>,haystack:array<mixed>}>
      */
     public static function getDataForSpecificKeyInListChecks(): array
     {