Merge pull request #358 from EasyPost/stricter_phpstan

stricter phpstan

Author: Justintime50

composer.json

@@ -36,7 +36,7 @@
     "coverage": "XDEBUG_MODE=coverage ./bin/phpunit --coverage-html clover.html --coverage-clover build/logs/clover.xml && ./bin/coverage-check build/logs/clover.xml 85 --only-percentage",
     "fix": "./bin/phpcbf --standard=examples/style_guides/php/phpcs.xml lib test",
     "lint": "./bin/phpcs --standard=examples/style_guides/php/phpcs.xml lib test",
-    "phpstan": "./bin/phpstan analyse --memory-limit 1G",
+    "phpstan": "./bin/phpstan analyse --memory-limit 4G",
     "scan": "composer update --dry-run roave/security-advisories",
     "test": "./bin/phpunit"
   },

lib/EasyPost/EasyPostClient.php

@@ -75,8 +75,8 @@ class EasyPostClient extends BaseService
     private float $timeout;
     private string $apiBase;
     private ?object $mockingUtility;
-    public object $requestEvent;
-    public object $responseEvent;
+    public RequestHook $requestEvent;
+    public ResponseHook $responseEvent;
     public Client $httpClient;
 
     /**
@@ -198,9 +198,9 @@ public function mock(): bool
     /**
      * Get the mock requests of an EasyPostClient.
      *
-     * @return object
+     * @return object|null
      */
-    public function getMockingUtility(): object
+    public function getMockingUtility(): ?object
     {
         return $this->mockingUtility;
     }

lib/EasyPost/EasyPostObject.php

@@ -126,10 +126,11 @@ public function __get(string $k): mixed
      */
     public static function constructFrom(?EasyPostClient $client, array $values, string $class): mixed
     {
-        $object = new $class($client);
-        $object->convertEach($client, $values);
+        /** @var EasyPostObject $easypostObject */
+        $easypostObject = new $class($client);
+        $easypostObject->convertEach($client, $values);
 
-        return $object;
+        return $easypostObject;
     }
 
     /**
@@ -265,7 +266,7 @@ public function __toJSON(): string|bool
      */
     public function __toString(): string
     {
-        return $this->__toJSON();
+        return (string)$this->__toJSON();
     }
 
     /**

lib/EasyPost/Exception/Api/ApiException.php

@@ -9,7 +9,7 @@
 /**
  * @package EasyPost
  * @property string|null $code
- * @property array<FieldError|array<string>>|null $errors
+ * @property array<FieldError|array<string>> $errors
  * @property string $message
  * @property string|null $httpBody
  * @property int|null $httpStatus
@@ -36,7 +36,7 @@ public function __construct(string $message = '', ?int $httpStatus = null, ?stri
         parent::__construct($message);
         $this->httpStatus = $httpStatus;
         $this->httpBody = $httpBody;
-        $this->errors = null;
+        $this->errors = [];
         $this->code = null;
 
         try {
@@ -59,19 +59,19 @@ public function __construct(string $message = '', ?int $httpStatus = null, ?stri
     /**
      * Get the HTTP status code.
      *
-     * @return int
+     * @return int|null
      */
-    public function getHttpStatus(): int
+    public function getHttpStatus(): ?int
     {
         return $this->httpStatus;
     }
 
     /**
      * Get the HTTP body.
      *
-     * @return string
+     * @return string|null
      */
-    public function getHttpBody(): string
+    public function getHttpBody(): ?string
     {
         return $this->httpBody;
     }

lib/EasyPost/Hook/EventHook.php

@@ -15,7 +15,7 @@ class EventHook
     /**
      * Fires when the class is invoked.
      *
-     * @param array<callable> ...$args
+     * @param array<mixed> ...$args
      * @return void
      */
     public function __invoke(array ...$args): void
@@ -47,7 +47,7 @@ public function removeHandler(callable $handler)
     {
         $index = array_search($handler, $this->eventHandlers, true);
         if ($index !== false) {
-            array_splice($this->eventHandlers, $index, 1);
+            array_splice($this->eventHandlers, (int)$index, 1);
         }
         return $this;
     }

lib/EasyPost/Http/Requestor.php

@@ -171,7 +171,7 @@ private static function requestRaw(
         if ($client->mock()) {
             // If there are mock requests set, this client will ONLY make mock requests
             $mockingUtility = $client->getMockingUtility();
-            $matchingRequest = $mockingUtility->findMatchingMockRequest($method, $absoluteUrl);
+            $matchingRequest = $mockingUtility->findMatchingMockRequest($method, $absoluteUrl); // @phpstan-ignore-line
             if ($matchingRequest === null) {
                 throw new HttpException(sprintf(Constants::NO_MATCHING_MOCK_REQUEST, $method, $absoluteUrl));
             }
@@ -342,7 +342,7 @@ private static function traverseJsonElement(mixed $errorMessage, array &$message
                 }
                 break;
             case 'object':
-                foreach ($errorMessage as $value) {
+                foreach ($errorMessage as $value) { // @phpstan-ignore-line
                     self::traverseJsonElement($value, $messagesList);
                 }
                 break;

lib/EasyPost/Order.php

@@ -34,6 +34,7 @@ class Order extends EasyPostObject
      */
     public function lowestRate(?array $carriers = [], ?array $services = []): Rate
     {
+        /** @var Rate $lowestRate */
         $lowestRate = InternalUtil::getLowestObjectRate($this, $carriers, $services);
 
         return $lowestRate;

lib/EasyPost/Pickup.php

@@ -37,6 +37,7 @@ class Pickup extends EasyPostObject
      */
     public function lowestRate(?array $carriers = [], ?array $services = []): PickupRate
     {
+        /** @var PickupRate $lowestRate */
         $lowestRate = InternalUtil::getLowestObjectRate($this, $carriers, $services, 'pickup_rates');
 
         return $lowestRate;

lib/EasyPost/Service/BaseService.php

@@ -224,15 +224,15 @@ protected function deleteResource(string $class, string $id, mixed $params = nul
      * @param string $class
      * @param string $id
      * @param mixed $params
-     * @param string|null $method
+     * @param string $method
      * @param bool $beta
      * @return mixed
      */
     protected function updateResource(
         string $class,
         string $id,
         mixed $params = null,
-        ?string $method = 'patch',
+        string $method = 'patch',
         bool $beta = false
     ): mixed {
         self::validate();

lib/EasyPost/Shipment.php

@@ -50,6 +50,7 @@ class Shipment extends EasyPostObject
      */
     public function lowestRate(?array $carriers = [], ?array $services = []): Rate
     {
+        /** @var Rate $lowestRate */
         $lowestRate = InternalUtil::getLowestObjectRate($this, $carriers, $services);
 
         return $lowestRate;