Updated PHPStan rules level 4

Author: gplanchat

README.md

@@ -0,0 +1,19 @@
+Pipeline implementation
+===
+
+This package brings an implementation for the pipeline component, aimed at providing an Extract-Transform-Load pattern,
+with logging, line rejections and execution states.
+
+
+[![Quality](https://github.com/php-etl/pipeline/actions/workflows/quality.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/quality.yaml)
+[![PHPStan level 5](https://github.com/php-etl/pipeline/actions/workflows/phpstan-5.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/phpstan-5.yaml)
+[![PHPStan level 7](https://github.com/php-etl/pipeline/actions/workflows/phpstan-7.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/phpstan-7.yaml)
+[![PHPStan level 8](https://github.com/php-etl/pipeline/actions/workflows/phpstan-8.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/phpstan-8.yaml)
+![PHP](https://img.shields.io/packagist/php-v/php-etl/pipeline)
+
+Documentation
+---
+
+[See full Documentation](https://php-etl.github.io/documentation)
+
+

composer.lock

@@ -3,10 +3,15 @@
 namespace Kiboko\Component\Pipeline\Loader;
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
+use Kiboko\Component\Bucket\EmptyResultBucket;
 use Kiboko\Contract\Pipeline\LoaderInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 
+/**
+ * @template Type
+ * @template-implements LoaderInterface<Type>
+ */
 final class LogLoader implements LoaderInterface
 {
     /** @var LoggerInterface */
@@ -20,9 +25,10 @@ public function __construct(LoggerInterface $logger, string $logLevel = LogLevel
         $this->logLevel = $logLevel;
     }
 
+    /** @return \Generator<mixed, AcceptanceResultBucket<Type|null>|EmptyResultBucket, null|Type, void> */
     public function load(): \Generator
     {
-        $line = yield;
+        $line = yield new EmptyResultBucket();
         do {
             $this->logger->log($this->logLevel, var_export($line, true));
         } while ($line = yield new AcceptanceResultBucket($line));

src/Loader/LogLoader.php

@@ -3,16 +3,19 @@
 namespace Kiboko\Component\Pipeline\Loader;
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
+use Kiboko\Component\Bucket\EmptyResultBucket;
 use Kiboko\Contract\Pipeline\LoaderInterface;
 
+/**
+ * @template Type
+ * @template-implements LoaderInterface<Type>
+ */
 abstract class StreamLoader implements LoaderInterface
 {
     /** @var resource */
     private $stream;
 
-    /**
-     * @param resource $stream
-     */
+    /** @param resource $stream */
     public function __construct($stream)
     {
         if (!is_resource($stream) || get_resource_type($stream) !== 'stream') {
@@ -24,12 +27,14 @@ public function __construct($stream)
         $this->stream = $stream;
     }
 
+    /** @return \Generator<mixed, AcceptanceResultBucket<Type|null>|EmptyResultBucket, null|Type, void> */
     public function load(): \Generator
     {
-        $line = yield;
-        do {
+        $line = yield new EmptyResultBucket();
+        while (true) {
             fwrite($this->stream, $this->formatLine($line));
-        } while ($line = yield new AcceptanceResultBucket($line));
+            $line = yield new AcceptanceResultBucket($line);
+        }
     }
 
     abstract protected function formatLine($line);

src/Loader/StreamLoader.php

@@ -8,6 +8,7 @@
 use Kiboko\Contract\Pipeline\FlushableInterface;
 use Kiboko\Contract\Pipeline\TransformerInterface;
 
+/** @template Type */
 class BatchingTransformer implements TransformerInterface, FlushableInterface
 {
     private ResultBucketInterface $bucket;
@@ -17,12 +18,13 @@ public function __construct(private int $batchSize)
         $this->bucket = new EmptyResultBucket();
     }
 
+    /** @return \Generator<mixed, AcceptanceAppendableResultBucket<Type>|EmptyResultBucket, null|Type, void> */
     public function transform(): \Generator
     {
         $this->bucket = new AcceptanceAppendableResultBucket();
         $itemCount = 0;
 
-        $line = yield;
+        $line = yield new EmptyResultBucket();
         while (true) {
             $this->bucket->append($line);
 

src/Transformer/BatchingTransformer.php

@@ -3,27 +3,26 @@
 namespace Kiboko\Component\Pipeline\Transformer;
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
+use Kiboko\Component\Bucket\EmptyResultBucket;
 use Kiboko\Contract\Pipeline\TransformerInterface;
 
+/** @template Type */
 class CallableTransformer implements TransformerInterface
 {
-    /**
-     * @var callable
-     */
+    /** @var callable */
     private $callback;
 
-    /**
-     * @param callable $callback
-     */
+    /** @param callable $callback */
     public function __construct(
         callable $callback
     ) {
         $this->callback = $callback;
     }
 
+    /** @return \Generator<mixed, AcceptanceResultBucket<Type>|EmptyResultBucket, null|Type, void> */
     public function transform(): \Generator
     {
-        $line = yield;
+        $line = yield new EmptyResultBucket();
         do {
         } while ($line = yield new AcceptanceResultBucket(($this->callback)($line)));
     }

src/Transformer/CallableTransformer.php

@@ -3,34 +3,38 @@
 namespace Kiboko\Component\Pipeline\Transformer;
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
+use Kiboko\Component\Bucket\EmptyResultBucket;
 use Kiboko\Contract\Pipeline\TransformerInterface;
 
+/**
+ * @template Type
+ * @template-implements TransformerInterface<array>
+ */
 class ColumnTrimTransformer implements TransformerInterface
 {
-    /**
-     * @var array
-     */
-    private $columnsToTrim;
-
-    /**
-     * @param array $columnsToTrim
-     */
-    public function __construct(array $columnsToTrim)
-    {
-        $this->columnsToTrim = $columnsToTrim;
+    /** @param list<string> $columnsToTrim */
+    public function __construct(
+        private array $columnsToTrim
+    ) {
     }
 
+    /** @return \Generator<mixed, AcceptanceResultBucket<Type>|EmptyResultBucket, null|Type, void> */
     public function transform(): \Generator
     {
-        $line = yield;
-        do {
+        $line = yield new EmptyResultBucket();
+        while (true) {
+            if ($line === null) {
+                $line = yield new EmptyResultBucket();
+                continue;
+            }
             foreach ($this->columnsToTrim as $column) {
                 if (!isset($line[$column])) {
                     continue;
                 }
 
                 $line[$column] = trim($line[$column]);
             }
-        } while ($line = yield new AcceptanceResultBucket($line));
+            $line = yield new AcceptanceResultBucket($line);
+        }
     }
 }

src/Transformer/ColumnTrimTransformer.php

@@ -6,28 +6,28 @@
 use Kiboko\Component\Bucket\EmptyResultBucket;
 use Kiboko\Contract\Pipeline\TransformerInterface;
 
+/**
+ * @template Type
+ * @template-implements TransformerInterface<Type>
+ */
 class FilterTransformer implements TransformerInterface
 {
-    /**
-     * @var callable
-     */
+    /** @var callable */
     private $callback;
 
-    /**
-     * @param $callback
-     */
     public function __construct(callable $callback)
     {
         $this->callback = $callback;
     }
 
+    /** @return \Generator<mixed, AcceptanceResultBucket<Type>|EmptyResultBucket, null|Type, void> */
     public function transform(): \Generator
     {
         $callback = $this->callback;
 
-        $line = yield;
+        $line = yield new EmptyResultBucket();
         while (true) {
-            if (!$callback($line)) {
+            if ($line === null || !$callback($line)) {
                 $line = yield new EmptyResultBucket();
                 continue;
             }