Update PHPStan

.github/workflows/ci.yml

@@ -32,7 +32,9 @@ jobs:
       fail-fast: false
       matrix:
         php-version:
+          - "7.1"
           - "7.4"
+          - "8.1"
 
     steps:
       - uses: actions/checkout@master
@@ -102,6 +104,12 @@ jobs:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('composer.json') }}
 
+      # We run PHPStan in a separate job, and the version of PHPStan we use is not compatible
+      # with all the versions we support and run unit tests for. We need to temporarily remove it 
+      # from composer.json here, else composer install will fail due the version incompatibility.
+      - name: Trim dependency
+        run: composer remove --dev phpstan/phpstan
+
       - name: Validate composer.json and composer.lock
         run: composer validate
 

Makefile

@@ -4,10 +4,6 @@ export PHPSTAN_VERSION := 0.12.59
 vendor: composer.json
 	composer install
 
-vendor/bin/phpstan: vendor
-	curl -sfL https://github.com/phpstan/phpstan/releases/download/$(PHPSTAN_VERSION)/phpstan.phar -o vendor/bin/phpstan
-	chmod +x vendor/bin/phpstan
-
 vendor/bin/phpdoc: vendor
 	curl -sfL https://github.com/phpDocumentor/phpDocumentor/releases/download/$(PHPDOCUMENTOR_VERSION)/phpDocumentor.phar -o vendor/bin/phpdoc
 	chmod +x vendor/bin/phpdoc
@@ -27,7 +23,7 @@ fmtcheck: vendor
 phpdoc: vendor/bin/phpdoc
 	vendor/bin/phpdoc
 
-phpstan: vendor/bin/phpstan
+phpstan: vendor
 	php -d memory_limit=512M vendor/bin/phpstan analyse lib tests
 .PHONY: phpstan
 

composer.json

@@ -24,7 +24,8 @@
     "phpunit/phpunit": "^5.7 || ^9.0",
     "php-coveralls/php-coveralls": "^2.1",
     "squizlabs/php_codesniffer": "^3.3",
-    "friendsofphp/php-cs-fixer": "3.2.1 || 2.17.1"
+    "friendsofphp/php-cs-fixer": "3.2.1 || 2.17.1",
+    "phpstan/phpstan": "^1.2"
   },
   "autoload": {
     "psr-4": {

lib/ApiOperations/Request.php

@@ -53,8 +53,6 @@ protected function _request($method, $url, $params = [], $options = null)
      * @param null|array|string $options
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
-     *
-     * @return array tuple containing (the JSON response, $options)
      */
     protected function _requestStream($method, $url, $readBodyChunk, $params = [], $options = null)
     {

lib/ApiRequestor.php

@@ -135,8 +135,6 @@ public function request($method, $url, $params = null, $headers = null)
      * @param null|array $headers
      *
      * @throws Exception\ApiErrorException
-     *
-     * @return array tuple containing (ApiReponse, API key)
      */
     public function requestStream($method, $url, $readBodyChunkCallable, $params = null, $headers = null)
     {

lib/ApiResource.php

@@ -82,6 +82,8 @@ public static function classUrl()
     {
         // Replace dots with slashes for namespaced resources, e.g. if the object's name is
         // "foo.bar", then its URL will be "/v1/foo/bars".
+
+        /** @phpstan-ignore-next-line */
         $base = \str_replace('.', '/', static::OBJECT_NAME);
 
         return "/v1/{$base}s";

lib/Collection.php

@@ -107,6 +107,7 @@ public function retrieve($id, $params = null, $opts = null)
     /**
      * @return int the number of objects in the current page
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return \count($this->data);
@@ -116,6 +117,7 @@ public function count()
      * @return \ArrayIterator an iterator that can be used to iterate
      *    across objects in the current page
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \ArrayIterator($this->data);

lib/Customer.php

@@ -78,6 +78,8 @@ public function deleteDiscount($params = null, $opts = null)
         $url = $this->instanceUrl() . '/discount';
         list($response, $opts) = $this->_request('delete', $url, $params, $opts);
         $this->refreshFrom(['discount' => null], $opts, true);
+
+        return $this;
     }
 
     /**

lib/Quote.php

@@ -66,8 +66,6 @@ class Quote extends ApiResource
      * @param null|array|string $opts
      *
      * @throws \Stripe\Exception\ApiErrorException if the request fails
-     *
-     * @return \Stripe\File the created file
      */
     public function pdf($readBodyChunkCallable, $params = null, $opts = null)
     {

lib/SingletonApiResource.php

@@ -23,6 +23,8 @@ public static function classUrl()
     {
         // Replace dots with slashes for namespaced resources, e.g. if the object's name is
         // "foo.bar", then its URL will be "/v1/foo/bar".
+
+        /** @phpstan-ignore-next-line */
         $base = \str_replace('.', '/', static::OBJECT_NAME);
 
         return "/v1/{$base}";

lib/StripeObject.php

@@ -194,16 +194,19 @@ public function __debugInfo()
     }
 
     // ArrayAccess methods
+    #[\ReturnTypeWillChange]
     public function offsetSet($k, $v)
     {
         $this->{$k} = $v;
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetExists($k)
     {
         return \array_key_exists($k, $this->_values);
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetUnset($k)
     {
         unset($this->{$k});
@@ -215,6 +218,7 @@ public function offsetGet($k)
     }
 
     // Countable method
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return \count($this->_values);

lib/Subscription.php

@@ -114,5 +114,7 @@ public function deleteDiscount($params = null, $opts = null)
         $url = $this->instanceUrl() . '/discount';
         list($response, $opts) = $this->_request('delete', $url, $params, $opts);
         $this->refreshFrom(['discount' => null], $opts, true);
+
+        return $this;
     }
 }

lib/Util/CaseInsensitiveArray.php

@@ -21,16 +21,19 @@ public function __construct($initial_array = [])
         $this->container = \array_change_key_case($initial_array, \CASE_LOWER);
     }
 
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return \count($this->container);
     }
 
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \ArrayIterator($this->container);
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         $offset = static::maybeLowercase($offset);
@@ -41,13 +44,15 @@ public function offsetSet($offset, $value)
         }
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         $offset = static::maybeLowercase($offset);
 
         return isset($this->container[$offset]);
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $offset = static::maybeLowercase($offset);

lib/Util/Set.php

@@ -37,6 +37,7 @@ public function toArray()
         return \array_keys($this->_elts);
     }
 
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new ArrayIterator($this->toArray());

phpstan-baseline.neon

@@ -1,12 +0,0 @@
-parameters:
-	ignoreErrors:
-		-
-			message: "#^Access to undefined constant Stripe\\\\ApiResource\\:\\:OBJECT_NAME\\.$#"
-			count: 1
-			path: lib/ApiResource.php
-
-		-
-			message: "#^Access to undefined constant Stripe\\\\SingletonApiResource\\:\\:OBJECT_NAME\\.$#"
-			count: 1
-			path: lib/SingletonApiResource.php
-

phpstan.neon.dist

@@ -9,3 +9,5 @@ parameters:
 
 	ignoreErrors:
 		- '#Unsafe usage of new static\(\).#'
+
+	reportUnmatchedIgnoredErrors: false

tests/TestCase.php

@@ -16,6 +16,7 @@ class TestCase extends \PHPUnit\Framework\TestCase
     public static function compatAssertIsArray($obj)
     {
         if (method_exists(static::class, 'assertIsArray')) {
+            // @phpstan-ignore-next-line
             static::assertIsArray($obj);
         } else {
             // @phpstan-ignore-next-line
@@ -26,6 +27,7 @@ public static function compatAssertIsArray($obj)
     public function compatExpectExceptionMessageMatches($msg)
     {
         if (method_exists($this, 'expectExceptionMessageMatches')) {
+            // @phpstan-ignore-next-line
             $this->expectExceptionMessageMatches($msg);
         } else {
             // @phpstan-ignore-next-line
@@ -36,15 +38,18 @@ public function compatExpectExceptionMessageMatches($msg)
     public static function compatAssertStringContainsString($a, $b)
     {
         if (method_exists(static::class, 'assertStringContainsString')) {
+            // @phpstan-ignore-next-line
             static::assertStringContainsString($a, $b);
         } else {
+            // @phpstan-ignore-next-line
             static::assertContains($a, $b);
         }
     }
 
     public function compatAssertIsString($x)
     {
         if (method_exists($this, 'assertIsString')) {
+            // @phpstan-ignore-next-line
             static::assertIsString($x);
         } else {
             // @phpstan-ignore-next-line
@@ -55,6 +60,7 @@ public function compatAssertIsString($x)
     public static function compatWarningClass()
     {
         if (class_exists('\PHPUnit\Framework\Error\Warning')) {
+            // @phpstan-ignore-next-line
             return \PHPUnit\Framework\Error\Warning::class;
         }
 

tests/TestHelper.php

@@ -153,8 +153,6 @@ function ($method, $absUrl, $readBodyChunkCallable, $headers, $params, $hasFile)
      * @param array $response
      * @param int $rcode
      * @param null|string $base
-     *
-     * @return array
      */
     protected function stubRequest(
         $method,