chore: fix psalm errors

ksassnowski · ksassnowski · commit 653347a121d2 · 2024-03-22T22:06:04.000+01:00
diff --git a/composer.json b/composer.json
@@ -20,11 +20,11 @@
         "psr/container": "^2.0.2",
         "psy/psysh": "^0.11.22 || ^0.12.0",
         "spatie/robots-txt": "^2.0.3",
-        "symfony/console": "^6.3.8 || ^7.0",
-        "symfony/css-selector": "^6.3.2 || ^7.0",
-        "symfony/dom-crawler": "^6.3.4 || ^7.0",
-        "symfony/event-dispatcher": "^6.3.2 || ^7.0",
-        "symfony/options-resolver": "^6.3 || ^7.0"
+        "symfony/console": "^7.0",
+        "symfony/css-selector": "^7.0",
+        "symfony/dom-crawler": "^7.0",
+        "symfony/event-dispatcher": "^7.0",
+        "symfony/options-resolver": "^7.0"
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.39",
diff --git a/composer.lock b/composer.lock
diff --git a/src/Core/FakeRunner.php b/src/Core/FakeRunner.php
@@ -20,7 +20,7 @@
 final class FakeRunner implements RunnerInterface
 {
     /**
-     * @var list<class-string<SpiderInterface>, array<int, array{overrides: null|Overrides, context: array}>>
+     * @var array<class-string<SpiderInterface>, array<int, array{overrides: null|Overrides, context: array}>>
      */
     private array $runs = [];
 
diff --git a/src/Core/Run.php b/src/Core/Run.php
@@ -25,11 +25,11 @@
 final class Run
 {
     /**
-     * @param list<Request>                       $startRequests
-     * @param list<DownloaderMiddlewareInterface> $downloaderMiddleware
-     * @param list<ItemProcessorInterface>        $itemProcessors
-     * @param list<SpiderMiddlewareInterface>     $responseMiddleware
-     * @param list<ExtensionInterface>            $extensions
+     * @param array<array-key, Request>                       $startRequests
+     * @param array<array-key, DownloaderMiddlewareInterface> $downloaderMiddleware
+     * @param array<array-key, ItemProcessorInterface>        $itemProcessors
+     * @param array<array-key, SpiderMiddlewareInterface>     $responseMiddleware
+     * @param array<array-key, ExtensionInterface>            $extensions
      */
     public function __construct(
         public array $startRequests,
diff --git a/src/Core/RunFactory.php b/src/Core/RunFactory.php
@@ -51,9 +51,9 @@ public function fromSpider(SpiderInterface $spider, ?Overrides $overrides = null
     }
 
     /**
-     * @psalm-param class-string<DownloaderMiddlewareInterface>[] $downloaderMiddleware
+     * @param array<array-key, class-string<DownloaderMiddlewareInterface>> $downloaderMiddleware
      *
-     * @return list<DownloaderMiddlewareInterface>
+     * @return array<array-key, DownloaderMiddlewareInterface>
      */
     private function buildDownloaderMiddleware(array $downloaderMiddleware): array
     {
@@ -63,19 +63,19 @@ private function buildDownloaderMiddleware(array $downloaderMiddleware): array
     }
 
     /**
-     * @psalm-param array<class-string<ItemProcessorInterface>> $processors
+     * @param array<array-key, class-string<ItemProcessorInterface>> $processors
      *
-     * @return list<ItemProcessorInterface>
+     * @return array<array-key, ItemProcessorInterface>
      */
     private function buildItemPipeline(array $processors): array
     {
         return \array_map([$this, 'buildConfigurable'], $processors);
     }
 
     /**
-     * @psalm-param array<class-string<SpiderMiddlewareInterface>> $handlers
+     * @param array<array-key, class-string<SpiderMiddlewareInterface>> $handlers
      *
-     * @return list<SpiderMiddlewareInterface>
+     * @return array<array-key, SpiderMiddlewareInterface>
      */
     private function buildResponseMiddleware(array $handlers): array
     {
@@ -85,9 +85,9 @@ private function buildResponseMiddleware(array $handlers): array
     }
 
     /**
-     * @param list<class-string<ExtensionInterface>> $extensions
+     * @param array<array-key, class-string<ExtensionInterface>> $extensions
      *
-     * @return list<ExtensionInterface>
+     * @return array<array-key, ExtensionInterface>
      */
     private function buildExtensions(array $extensions): array
     {
diff --git a/src/Downloader/Downloader.php b/src/Downloader/Downloader.php
@@ -26,7 +26,7 @@
 final class Downloader
 {
     /**
-     * @var list<DownloaderMiddlewareInterface>
+     * @var array<array-key, DownloaderMiddlewareInterface>
      */
     private array $middleware = [];
 
diff --git a/src/ItemPipeline/AbstractItem.php b/src/ItemPipeline/AbstractItem.php
@@ -116,6 +116,6 @@ final public function offsetSet(mixed $offset, mixed $value): void
 
     final public function offsetUnset(mixed $offset): void
     {
-        throw new RuntimeException('Unsetting properties is not supported for custom item classes');
+        throw new \RuntimeException('Unsetting properties is not supported for custom item classes');
     }
 }
diff --git a/src/ItemPipeline/ItemPipeline.php b/src/ItemPipeline/ItemPipeline.php
@@ -22,7 +22,7 @@
 final class ItemPipeline implements ItemPipelineInterface
 {
     /**
-     * @var list<ItemProcessorInterface>
+     * @var array<array-key, ItemProcessorInterface>
      */
     private array $processors = [];
 
diff --git a/src/Roach.php b/src/Roach.php
@@ -61,7 +61,7 @@ public static function startSpider(string $spiderClass, ?Overrides $overrides =
      *
      * @psalm-param class-string<SpiderInterface> $spiderClass
      *
-     * @return list<ItemInterface>
+     * @return array<array-key, ItemInterface>
      */
     public static function collectSpider(string $spiderClass, ?Overrides $overrides = null, array $context = []): array
     {
diff --git a/src/Scheduling/ArrayRequestScheduler.php b/src/Scheduling/ArrayRequestScheduler.php
@@ -43,7 +43,7 @@ public function empty(): bool
     }
 
     /**
-     * @return list<Request>
+     * @return array<array-key, Request>
      */
     public function nextRequests(int $batchSize): array
     {
@@ -77,7 +77,9 @@ private function updateNextBatchTime(): void
     }
 
     /**
-     * @return list<Request>
+     * @psalm-suppress MixedReturnTypeCoercion
+     *
+     * @return array<array-key, Request>
      */
     private function getNextRequests(int $batchSize): array
     {
diff --git a/src/Scheduling/RequestSchedulerInterface.php b/src/Scheduling/RequestSchedulerInterface.php
@@ -23,15 +23,15 @@ public function schedule(Request $request): void;
      * Return the next number of requests as defined by $batchSize as soon
      * as they are ready.
      *
-     * @return list<Request>
+     * @return array<array-key, Request>
      */
     public function nextRequests(int $batchSize): array;
 
     /**
      * Immediately return the next number of requests as defined by $batchSize
      * regardless of the configured delay.
      *
-     * @return list<Request>
+     * @return array<array-key, Request>
      */
     public function forceNextRequests(int $batchSize): array;
 
diff --git a/src/Shell/Commands/FetchCommand.php b/src/Shell/Commands/FetchCommand.php
@@ -26,7 +26,7 @@
 #[AsCommand(name: 'fetch')]
 final class FetchCommand extends Command
 {
-    protected static $defaultName = 'fetch';
+    protected static string $defaultName = 'fetch';
 
     protected function configure(): void
     {
diff --git a/src/Shell/Commands/RunSpiderCommand.php b/src/Shell/Commands/RunSpiderCommand.php
@@ -25,9 +25,9 @@
 #[AsCommand(name: 'roach:run')]
 final class RunSpiderCommand extends Command
 {
-    protected static $defaultName = 'roach:run';
+    protected static string $defaultName = 'roach:run';
 
-    protected static $defaultDescription = 'Start a spider run for the provided spider class';
+    protected static string $defaultDescription = 'Start a spider run for the provided spider class';
 
     protected function configure(): void
     {
diff --git a/src/Shell/Repl.php b/src/Shell/Repl.php
@@ -29,9 +29,9 @@
 #[AsCommand(name: 'roach:shell')]
 final class Repl extends Command
 {
-    protected static $defaultName = 'roach:shell';
+    protected static string $defaultName = 'roach:shell';
 
-    protected static $defaultDescription = 'Launch an interactive roach shell';
+    protected static string $defaultDescription = 'Launch an interactive roach shell';
 
     protected function configure(): void
     {
diff --git a/src/Spider/AbstractSpider.php b/src/Spider/AbstractSpider.php
@@ -35,7 +35,7 @@ public function __construct(ConfigurationLoaderStrategy $loaderStrategy)
     abstract public function parse(Response $response): \Generator;
 
     /**
-     * @return list<Request>
+     * @return array<array-key, Request>
      */
     final public function getInitialRequests(): array
     {
@@ -76,7 +76,7 @@ protected function item(array|ItemInterface $item): ParseResult
     }
 
     /**
-     * @return list<Request>
+     * @return array<array-key, Request>
      */
     protected function initialRequests(): array
     {
diff --git a/src/Spider/Configuration/Configuration.php b/src/Spider/Configuration/Configuration.php
@@ -21,11 +21,11 @@
 final class Configuration
 {
     /**
-     * @param list<string>                                      $startUrls
-     * @param list<class-string<DownloaderMiddlewareInterface>> $downloaderMiddleware
-     * @param list<class-string<ItemProcessorInterface>>        $itemProcessors
-     * @param list<class-string<SpiderMiddlewareInterface>>     $spiderMiddleware
-     * @param list<class-string<ExtensionInterface>>            $extensions
+     * @param array<array-key, string>                                      $startUrls
+     * @param array<array-key, class-string<DownloaderMiddlewareInterface>> $downloaderMiddleware
+     * @param array<array-key, class-string<ItemProcessorInterface>>        $itemProcessors
+     * @param array<array-key, class-string<SpiderMiddlewareInterface>>     $spiderMiddleware
+     * @param array<array-key, class-string<ExtensionInterface>>            $extensions
      */
     public function __construct(
         public array $startUrls,
diff --git a/src/Spider/Processor.php b/src/Spider/Processor.php
@@ -24,7 +24,7 @@
 final class Processor
 {
     /**
-     * @var list<SpiderMiddlewareInterface>
+     * @var array<array-key, SpiderMiddlewareInterface>
      */
     private array $middleware = [];
 
diff --git a/src/Spider/SpiderInterface.php b/src/Spider/SpiderInterface.php
@@ -34,7 +34,7 @@ public function withConfiguration(Configuration $configuration): void;
     public function withContext(array $context): void;
 
     /**
-     * @return list<Request>
+     * @return array<array-key, Request>
      */
     public function getInitialRequests(): array;
 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`final class FakeRunner implements RunnerInterface`
`21`	`21`	`{`
`22`	`22`	`/**`
`23`		`- * @var list<class-string<SpiderInterface>, array<int, array{overrides: null\|Overrides, context: array}>>`
	`23`	`+ * @var array<class-string<SpiderInterface>, array<int, array{overrides: null\|Overrides, context: array}>>`
`24`	`24`	`*/`
`25`	`25`	`private array $runs = [];`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -51,9 +51,9 @@ public function fromSpider(SpiderInterface $spider, ?Overrides $overrides = null`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`54`		`- * @psalm-param class-string<DownloaderMiddlewareInterface>[] $downloaderMiddleware`
	`54`	`+ * @param array<array-key, class-string<DownloaderMiddlewareInterface>> $downloaderMiddleware`
`55`	`55`	`*`
`56`		`- * @return list<DownloaderMiddlewareInterface>`
	`56`	`+ * @return array<array-key, DownloaderMiddlewareInterface>`
`57`	`57`	`*/`
`58`	`58`	`private function buildDownloaderMiddleware(array $downloaderMiddleware): array`
`59`	`59`	`{`
`@@ -63,19 +63,19 @@ private function buildDownloaderMiddleware(array $downloaderMiddleware): array`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
`66`		`- * @psalm-param array<class-string<ItemProcessorInterface>> $processors`
	`66`	`+ * @param array<array-key, class-string<ItemProcessorInterface>> $processors`
`67`	`67`	`*`
`68`		`- * @return list<ItemProcessorInterface>`
	`68`	`+ * @return array<array-key, ItemProcessorInterface>`
`69`	`69`	`*/`
`70`	`70`	`private function buildItemPipeline(array $processors): array`
`71`	`71`	`{`
`72`	`72`	`return \array_map([$this, 'buildConfigurable'], $processors);`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`/**`
`76`		`- * @psalm-param array<class-string<SpiderMiddlewareInterface>> $handlers`
	`76`	`+ * @param array<array-key, class-string<SpiderMiddlewareInterface>> $handlers`
`77`	`77`	`*`
`78`		`- * @return list<SpiderMiddlewareInterface>`
	`78`	`+ * @return array<array-key, SpiderMiddlewareInterface>`
`79`	`79`	`*/`
`80`	`80`	`private function buildResponseMiddleware(array $handlers): array`
`81`	`81`	`{`
`@@ -85,9 +85,9 @@ private function buildResponseMiddleware(array $handlers): array`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/**`
`88`		`- * @param list<class-string<ExtensionInterface>> $extensions`
	`88`	`+ * @param array<array-key, class-string<ExtensionInterface>> $extensions`
`89`	`89`	`*`
`90`		`- * @return list<ExtensionInterface>`
	`90`	`+ * @return array<array-key, ExtensionInterface>`
`91`	`91`	`*/`
`92`	`92`	`private function buildExtensions(array $extensions): array`
`93`	`93`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`final class Downloader`
`27`	`27`	`{`
`28`	`28`	`/**`
`29`		`- * @var list<DownloaderMiddlewareInterface>`
	`29`	`+ * @var array<array-key, DownloaderMiddlewareInterface>`
`30`	`30`	`*/`
`31`	`31`	`private array $middleware = [];`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,6 @@ final public function offsetSet(mixed $offset, mixed $value): void`
`116`	`116`
`117`	`117`	`final public function offsetUnset(mixed $offset): void`
`118`	`118`	`{`
`119`		`- throw new RuntimeException('Unsetting properties is not supported for custom item classes');`
	`119`	`+ throw new \RuntimeException('Unsetting properties is not supported for custom item classes');`
`120`	`120`	`}`
`121`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`final class ItemPipeline implements ItemPipelineInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`		`- * @var list<ItemProcessorInterface>`
	`25`	`+ * @var array<array-key, ItemProcessorInterface>`
`26`	`26`	`*/`
`27`	`27`	`private array $processors = [];`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public static function startSpider(string $spiderClass, ?Overrides $overrides =`
`61`	`61`	`*`
`62`	`62`	`* @psalm-param class-string<SpiderInterface> $spiderClass`
`63`	`63`	`*`
`64`		`- * @return list<ItemInterface>`
	`64`	`+ * @return array<array-key, ItemInterface>`
`65`	`65`	`*/`
`66`	`66`	`public static function collectSpider(string $spiderClass, ?Overrides $overrides = null, array $context = []): array`
`67`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function empty(): bool`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * @return list<Request>`
	`46`	`+ * @return array<array-key, Request>`
`47`	`47`	`*/`
`48`	`48`	`public function nextRequests(int $batchSize): array`
`49`	`49`	`{`
`@@ -77,7 +77,9 @@ private function updateNextBatchTime(): void`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`/**`
`80`		`- * @return list<Request>`
	`80`	`+ * @psalm-suppress MixedReturnTypeCoercion`
	`81`	`+ *`
	`82`	`+ * @return array<array-key, Request>`
`81`	`83`	`*/`
`82`	`84`	`private function getNextRequests(int $batchSize): array`
`83`	`85`	`{`