Improve static analysis

Author: cerbero90

src/Concerns/ParsesPages.php

@@ -17,7 +17,7 @@ trait ParsesPages
     /**
      * The number of items per page.
      */
-    protected readonly int $itemsPerPage;
+    protected int $itemsPerPage;
 
     /**
      * Yield paginated items and the given key from the provided response.
@@ -35,6 +35,7 @@ protected function yieldItemsAndGetKey(ResponseInterface $response, string $key)
 
         foreach (JsonParser::parse($response)->pointers($pointers) as $item) {
             if (is_object($item)) {
+                /** @var object{value: mixed} $item */
                 $value = $item->value;
             } else {
                 yield $item;
@@ -54,6 +55,7 @@ protected function yieldItemsAndGetKey(ResponseInterface $response, string $key)
      */
     protected function yieldItemsFrom(mixed $source): Generator
     {
+        /** @phpstan-ignore-next-line */
         yield from JsonParser::parse($source)->pointer($this->config->itemsPointer);
     }
 }

src/Concerns/ResolvesPages.php

@@ -27,13 +27,14 @@ protected function toPage(mixed $value, bool $onlyNumerics = true): string|int|n
             is_numeric($value) => (int) $value,
             !is_string($value) || $value === '' => null,
             !$this->isEndpoint($value) => $onlyNumerics ? null : $value,
-            default => $this->pageFromParsedUri(parse_url($value), $onlyNumerics),
+            default => $this->pageFromParsedUri(parse_url($value), $onlyNumerics), /** @phpstan-ignore-line */
         };
     }
 
     /**
      * Retrieve the page from the given parsed URI.
      *
+     * @param array{path?: string, query?: string} $parsedUri
      * @return ($onlyNumerics is true ? int|null : string|int|null)
      */
     protected function pageFromParsedUri(array $parsedUri, bool $onlyNumerics = true): string|int|null
@@ -55,7 +56,9 @@ protected function pageFromParsedUri(array $parsedUri, bool $onlyNumerics = true
     protected function uriForPage(UriInterface $uri, string $page): UriInterface
     {
         if ($key = $this->config->offsetKey) {
-            return Uri::withQueryValue($uri, $key, strval(($page - $this->config->firstPage) * $this->itemsPerPage));
+            $value = (intval($page) - $this->config->firstPage) * $this->itemsPerPage;
+
+            return Uri::withQueryValue($uri, $key, strval($value));
         }
 
         if (!$pattern = $this->config->pageInPath) {

src/Concerns/RetriesHttpRequests.php

@@ -5,6 +5,7 @@
 namespace Cerbero\LazyJsonPages\Concerns;
 
 use Cerbero\LazyJsonPages\Exceptions\OutOfAttemptsException;
+use Closure;
 use Generator;
 use GuzzleHttp\Exception\TransferException;
 use Illuminate\Support\LazyCollection;
@@ -20,10 +21,11 @@ trait RetriesHttpRequests
     /**
      * Retry to yield HTTP responses from the given callback.
      *
-     * @param callable $callback
-     * @return Generator<int, mixed>
+     * @template TGen of Generator
+     * @param Closure(): TGen $callback
+     * @return TGen
      */
-    protected function retry(callable $callback): Generator
+    protected function retry(Closure $callback): Generator
     {
         $attempt = 0;
         $remainingAttempts = $this->config->attempts;

src/Concerns/YieldsItemsByLength.php

@@ -20,7 +20,7 @@ trait YieldsItemsByLength
      * Yield paginated items until the page resolved from the given key is reached.
      *
      * @param ?Closure(int): int $callback
-     * @return Generator<int, mixed, null, int>
+     * @return Generator<int, mixed>
      */
     protected function yieldItemsUntilKey(string $key, ?Closure $callback = null): Generator
     {
@@ -38,14 +38,17 @@ protected function yieldItemsUntilKey(string $key, ?Closure $callback = null): G
     /**
      * Yield paginated items until the resolved page is reached.
      *
-     * @param Closure(ResponseInterface): Generator<int, mixed, null, int> $callback
+     * @param Closure(ResponseInterface): Generator<int, mixed> $callback
      * @return Generator<int, mixed>
      */
     protected function yieldItemsUntilPage(Closure $callback): Generator
     {
         yield from $generator = $callback($this->source->pullResponse());
 
-        foreach ($this->fetchPagesAsynchronously($generator->getReturn()) as $response) {
+        /** @var int */
+        $totalPages = $generator->getReturn();
+
+        foreach ($this->fetchPagesAsynchronously($totalPages) as $response) {
             yield from $this->yieldItemsFrom($response);
         }
     }

src/Data/RateLimit.php

@@ -57,7 +57,7 @@ public function wasReached(): bool
     /**
      * Retrieve the timestamp when this rate limit resets.
      */
-    public function resetsAt(): float
+    public function resetsAt(): ?float
     {
         return $this->resetsAt;
     }

src/Exceptions/OutOfAttemptsException.php

@@ -2,7 +2,6 @@
 
 namespace Cerbero\LazyJsonPages\Exceptions;
 
-use Closure;
 use GuzzleHttp\Exception\TransferException;
 use Illuminate\Support\LazyCollection;
 
@@ -15,7 +14,7 @@ class OutOfAttemptsException extends LazyJsonPagesException
      * Instantiate the class.
      *
      * @param array<int, int> $failedPages
-     * @param (Closure(): Generator<int, mixed>) $items
+     * @param LazyCollection<int, mixed> $items
      */
     public function __construct(
         TransferException $e,

src/LazyJsonPages.php

@@ -277,15 +277,15 @@ public function onError(Closure $callback): self
      * Retrieve a lazy collection yielding the paginated items.
      *
      * @return LazyCollection<int, mixed>
-     * @throws UnsupportedPaginationException
+     * @throws \Cerbero\LazyJsonPages\Exceptions\UnsupportedPaginationException
      */
     public function collect(string $dot = '*'): LazyCollection
     {
         $this->config[Config::OPTION_ITEMS_POINTER] = DotsConverter::toPointer($dot);
 
         return new LazyCollection(function () {
             $client = $this->client->make();
-            $config = new Config(...$this->config);
+            $config = new Config(...$this->config); /** @phpstan-ignore-line */
             $source = (new AnySource($this->source))->setClient($client);
 
             yield from new AnyPagination($source, $client, $config);

src/Middleware/Tap.php

@@ -50,7 +50,7 @@ public function __construct(private readonly TapCallbacks $callbacks) {}
     /**
      * Handle an HTTP request before and after it is sent.
      *
-     * @param callable(RequestInterface, array): PromiseInterface $handler
+     * @param callable(RequestInterface, array<string, mixed>): PromiseInterface $handler
      */
     public function __invoke(callable $handler): Closure
     {

src/Paginations/CursorAwarePagination.php

@@ -34,6 +34,7 @@ public function matches(): bool
     public function getIterator(): Traversable
     {
         yield from $this->yieldItemsByCursor(function (ResponseInterface $response) {
+            /** @phpstan-ignore-next-line */
             yield from $generator = $this->yieldItemsAndGetKey($response, $this->config->cursorKey);
 
             return $generator->getReturn();

src/Paginations/LastPageAwarePagination.php

@@ -29,6 +29,7 @@ public function matches(): bool
      */
     public function getIterator(): Traversable
     {
+        /** @phpstan-ignore-next-line */
         yield from $this->yieldItemsUntilKey($this->config->lastPageKey, function (int $page) {
             return $this->config->firstPage === 0 ? $page + 1 : $page;
         });