Fixing PHPStan level 9 issues

php-etl · Nov 14, 2023 · bbc5991 · bbc5991
1 parent e61319b
commit bbc5991
Show file tree

Hide file tree

Showing 17 changed files with 106 additions and 68 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/Extractor/ArrayExtractor.php b/src/Extractor/ArrayExtractor.php
@@ -7,7 +7,7 @@
 use Kiboko\Contract\Pipeline\ExtractorInterface;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @implements ExtractorInterface<Type>
  */

diff --git a/src/Extractor/IteratorExtractor.php b/src/Extractor/IteratorExtractor.php
@@ -7,7 +7,7 @@
 use Kiboko\Contract\Pipeline\ExtractorInterface;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @implements ExtractorInterface<Type>
  */

diff --git a/src/GeneratorWrapper.php b/src/GeneratorWrapper.php
@@ -7,7 +7,7 @@
 use Kiboko\Contract\Bucket\ResultBucketInterface;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  */
 class GeneratorWrapper
 {
@@ -41,7 +41,7 @@ public function valid(\Iterator ...$iterators): bool
 
     /**
      * @param Type                                                             $value
-     * @param \Generator<int<0, max>, ResultBucketInterface<Type>, Type, void> ...$generators
+     * @param \Generator<int, ResultBucketInterface<Type>, Type, void> ...$generators
      */
     public function send($value, \Generator ...$generators): \Generator
     {

diff --git a/src/Loader/DebugLoader.php b/src/Loader/DebugLoader.php
@@ -5,7 +5,7 @@
 namespace Kiboko\Component\Pipeline\Loader;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @extends StreamLoader<Type>
  */

diff --git a/src/Loader/JSONStreamLoader.php b/src/Loader/JSONStreamLoader.php
@@ -5,7 +5,7 @@
 namespace Kiboko\Component\Pipeline\Loader;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @extends StreamLoader<Type>
  */

diff --git a/src/Loader/LogLoader.php b/src/Loader/LogLoader.php
@@ -6,32 +6,39 @@
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
 use Kiboko\Component\Bucket\EmptyResultBucket;
+use Kiboko\Contract\Bucket\ResultBucketInterface;
 use Kiboko\Contract\Pipeline\LoaderInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @implements LoaderInterface<Type, Type>
  */
 final readonly class LogLoader implements LoaderInterface
 {
     public function __construct(private LoggerInterface $logger, private string $logLevel = LogLevel::DEBUG) {}
 
-    /** @return \Generator<int<0, max>, AcceptanceResultBucket<Type>|EmptyResultBucket, Type|null, void> */
+    /** @return \Generator<int, ResultBucketInterface<Type>, Type|null, void> */
     public function load(): \Generator
     {
-        $line = yield new EmptyResultBucket();
+        /** @var EmptyResultBucket<Type> $bucket */
+        $bucket = new EmptyResultBucket();
+        $line = yield $bucket;
         /* @phpstan-ignore-next-line */
         while (true) {
             if (null === $line) {
-                $line = yield new EmptyResultBucket();
+                /** @var EmptyResultBucket<Type> $bucket */
+                $bucket = new EmptyResultBucket();
+                $line = yield $bucket;
                 continue;
             }
 
             $this->logger->log($this->logLevel, var_export($line, true));
-            $line = yield new AcceptanceResultBucket($line);
+            /** @var AcceptanceResultBucket<Type> $bucket */
+            $bucket = new AcceptanceResultBucket($line);
+            $line = yield $bucket;
         }
     }
 }
diff --git a/src/Loader/StderrLoader.php b/src/Loader/StderrLoader.php
@@ -5,7 +5,7 @@
 namespace Kiboko\Component\Pipeline\Loader;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @extends StreamLoader<Type>
  */

diff --git a/src/Loader/StdoutLoader.php b/src/Loader/StdoutLoader.php
@@ -5,7 +5,7 @@
 namespace Kiboko\Component\Pipeline\Loader;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @extends StreamLoader<Type>
  */

diff --git a/src/Loader/StreamLoader.php b/src/Loader/StreamLoader.php
@@ -6,10 +6,11 @@
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
 use Kiboko\Component\Bucket\EmptyResultBucket;
+use Kiboko\Contract\Bucket\ResultBucketInterface;
 use Kiboko\Contract\Pipeline\LoaderInterface;
 
 /**
- * @template Type of non-empty-array<array-key, mixed>|object
+ * @template Type
  *
  * @implements LoaderInterface<Type, Type>
  */
@@ -28,19 +29,25 @@ public function __construct($stream)
         $this->stream = $stream;
     }
 
-    /** @return \Generator<int<0, max>, AcceptanceResultBucket<Type>|EmptyResultBucket, Type|null, void> */
+    /** @return \Generator<int, ResultBucketInterface<Type>, Type|null, void> */
     public function load(): \Generator
     {
-        $line = yield new EmptyResultBucket();
+        /** @var EmptyResultBucket<Type> $bucket */
+        $bucket = new EmptyResultBucket();
+        $line = yield $bucket;
         /* @phpstan-ignore-next-line */
         while (true) {
             if (null === $line) {
-                $line = yield new EmptyResultBucket();
+                /** @var EmptyResultBucket<Type> $bucket */
+                $bucket = new EmptyResultBucket();
+                $line = yield $bucket;
                 continue;
             }
 
             fwrite($this->stream, $this->formatLine($line));
-            $line = yield new AcceptanceResultBucket($line);
+            /** @var AcceptanceResultBucket<Type> $bucket */
+            $bucket = new AcceptanceResultBucket($line);
+            $line = yield $bucket;
         }
     }
 

diff --git a/src/Pipeline.php b/src/Pipeline.php
@@ -39,7 +39,7 @@ public function __construct(
     }
 
     /**
-     * @template InputType of non-empty-array<array-key, mixed>|object
+     * @template InputType
      *
      * @param InputType ...$data
      */
@@ -58,7 +58,7 @@ private function passThroughCoroutine(): \Generator
     }
 
     /**
-     * @template Type of non-empty-array<array-key, mixed>|object
+     * @template Type
      *
      * @param ExtractorInterface<Type>     $extractor
      * @param StepRejectionInterface<Type> $rejection
@@ -105,8 +105,8 @@ public function extract(
     }
 
     /**
-     * @template InputType of non-empty-array<array-key, mixed>|object
-     * @template OutputType of non-empty-array<array-key, mixed>|object
+     * @template InputType
+     * @template OutputType
      *
      * @param TransformerInterface<InputType, OutputType> $transformer
      * @param StepRejectionInterface<InputType>           $rejection
@@ -154,8 +154,8 @@ public function transform(
     }
 
     /**
-     * @template InputType of non-empty-array<array-key, mixed>|object
-     * @template OutputType of non-empty-array<array-key, mixed>|object
+     * @template InputType
+     * @template OutputType
      *
      * @param LoaderInterface<InputType, OutputType> $loader
      * @param StepRejectionInterface<InputType>      $rejection

diff --git a/src/PipelineRunner.php b/src/PipelineRunner.php
@@ -22,11 +22,11 @@ public function __construct(
     ) {}
 
     /**
-     * @template InputType of non-empty-array<array-key, mixed>|object
-     * @template OutputType of non-empty-array<array-key, mixed>|object
+     * @template InputType
+     * @template OutputType
      *
      * @param \Iterator<int<0, max>, InputType|null>                                                                                                                                $source
-     * @param \Generator<int<0, max>, ResultBucketInterface<OutputType>|AcceptanceResultBucketInterface<InputType>|RejectionResultBucketInterface<InputType>|null, InputType, void> $coroutine
+     * @param \Generator<int, ResultBucketInterface<OutputType>|AcceptanceResultBucketInterface<InputType>|RejectionResultBucketInterface<InputType>|null, InputType, void> $coroutine
      * @param StepRejectionInterface<InputType>                                                                                                                                     $rejection
      *
      * @return \Iterator<int<0, max>, ResultBucketInterface<OutputType>>

diff --git a/src/Transformer/BatchingTransformer.php b/src/Transformer/BatchingTransformer.php
@@ -11,8 +11,8 @@
 use Kiboko\Contract\Pipeline\TransformerInterface;
 
 /**
- * @template InputType of non-empty-array<array-key, mixed>|object
- * @template OutputType of non-empty-array<array-key, InputType>
+ * @template InputType
+ * @template OutputType of list<InputType>
  *
  * @implements TransformerInterface<InputType, OutputType>
  * @implements FlushableInterface<OutputType>
@@ -29,36 +29,46 @@ public function __construct(
         private readonly int $batchSize
     ) {}
 
-    /** @return \Generator<int<0, max>, ResultBucketInterface<OutputType>|EmptyResultBucket, InputType|null, void> */
+    /** @return \Generator<int, ResultBucketInterface<OutputType>, InputType|null, void> */
     public function transform(): \Generator
     {
         $this->batch = [];
 
-        $line = yield new EmptyResultBucket();
+        /** @var EmptyResultBucket<OutputType> $bucket */
+        $bucket = new EmptyResultBucket();
+        $line = yield $bucket;
         /* @phpstan-ignore-next-line */
         while (true) {
             if (null === $line) {
-                $line = yield new EmptyResultBucket();
+                /** @var EmptyResultBucket<OutputType> $bucket */
+                $bucket = new EmptyResultBucket();
+                $line = yield $bucket;
                 continue;
             }
             $this->batch[] = $line;
 
             if (\count($this->batch) >= $this->batchSize) {
-                /** @phpstan-ignore-next-line */
-                $line = yield new AcceptanceResultBucket($this->batch);
+                /** @var EmptyResultBucket<OutputType> $bucket */
+                $bucket = new AcceptanceResultBucket($this->batch);
+                $line = yield $bucket;
+
                 $this->batch = [];
                 continue;
             }
 
-            $line = yield new EmptyResultBucket();
+            /** @var EmptyResultBucket<OutputType> $bucket */
+            $bucket = new EmptyResultBucket();
+            $line = yield $bucket;
         }
     }
 
-    /** @return AcceptanceResultBucket<OutputType>|EmptyResultBucket */
+    /** @return ResultBucketInterface<OutputType> */
     public function flush(): ResultBucketInterface
     {
         if (\count($this->batch) <= 0) {
-            return new EmptyResultBucket();
+            /** @var EmptyResultBucket<OutputType> $bucket */
+            $bucket = new EmptyResultBucket();
+            return $bucket;
         }
 
         /* @phpstan-ignore-next-line */

diff --git a/src/Transformer/CallableTransformer.php b/src/Transformer/CallableTransformer.php
@@ -6,11 +6,12 @@
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
 use Kiboko\Component\Bucket\EmptyResultBucket;
+use Kiboko\Contract\Bucket\ResultBucketInterface;
 use Kiboko\Contract\Pipeline\TransformerInterface;
 
 /**
- * @template InputType of non-empty-array<array-key, mixed>|object
- * @template OutputType of non-empty-array<array-key, mixed>|object
+ * @template InputType
+ * @template OutputType
  *
  * @template-implements TransformerInterface<InputType, OutputType>
  */
@@ -20,30 +21,34 @@ class CallableTransformer implements TransformerInterface
     private $callback;
 
     /**
-     * @param callable(InputType $item): OutputType $callback
+     * @param callable(InputType|null $item): OutputType $callback
      */
     public function __construct(
         callable $callback,
     ) {
         $this->callback = $callback;
     }
 
-    /**
-     * @return \Generator<int<0, max>, AcceptanceResultBucket<OutputType>|EmptyResultBucket, InputType|null, void>
-     */
+    /** @return \Generator<int, ResultBucketInterface<OutputType>, InputType|null, void> */
     public function transform(): \Generator
     {
         $callback = $this->callback;
 
-        $line = yield new EmptyResultBucket();
+        /** @var EmptyResultBucket<OutputType> $bucket */
+        $bucket = new EmptyResultBucket();
+        $line = yield $bucket;
         /* @phpstan-ignore-next-line */
         while (true) {
             if (null === $line) {
-                $line = yield new EmptyResultBucket();
+                /** @var EmptyResultBucket<OutputType> $bucket */
+                $bucket = new EmptyResultBucket();
+                $line = yield $bucket;
                 continue;
             }
 
-            $line = yield new AcceptanceResultBucket($callback($line));
+            /** @var AcceptanceResultBucket<OutputType> $bucket */
+            $bucket = new AcceptanceResultBucket($callback($line));
+            $line = yield $bucket;
         }
     }
 }