Fixing PHPStan level 8 issues

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

Hide file tree

Showing 14 changed files with 43 additions and 139 deletions.
diff --git a/.github/workflows/phpstan-5.yaml b/.github/workflows/phpstan-5.yaml
diff --git a/.github/workflows/phpstan-6.yaml b/.github/workflows/phpstan-6.yaml
diff --git a/.github/workflows/phpstan-7.yaml b/.github/workflows/phpstan-7.yaml
diff --git a/.github/workflows/phpstan-8.yaml → .github/workflows/phpstan-9.yaml b/.github/workflows/phpstan-8.yaml → .github/workflows/phpstan-9.yaml
@@ -19,5 +19,5 @@ jobs:
         uses: php-actions/phpstan@v3
         with:
           path: src/
-          level: 8
+          level: 9
           php_version: '8.2'
diff --git a/.github/workflows/quality.yaml b/.github/workflows/quality.yaml
@@ -33,5 +33,5 @@ jobs:
         uses: php-actions/phpstan@v3
         with:
           path: src/
-          level: 4
+          level: 8
           php_version: '8.2'
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -34,6 +34,7 @@
         'error_suppression' => true,
         'ereg_to_preg' => true,
         'dir_constant' => true,
+        'phpdoc_align' => ['align' => 'left'],
     ])
     ->setFinder($finder)
     ->setCacheFile('.php-cs-fixer.cache') // forward compatibility with 3.x line

diff --git a/README.md b/README.md
@@ -5,13 +5,10 @@ This package brings an implementation for the pipeline component, aimed at provi
 with logging, line rejections and execution states.
 
 
-[![Quality (PHPStan level 4)](https://github.com/php-etl/pipeline/actions/workflows/quality.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/quality.yaml)
+[![Quality (PHPStan level 8)](https://github.com/php-etl/pipeline/actions/workflows/quality.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/quality.yaml)
 [![PHPUnit](https://github.com/php-etl/pipeline/actions/workflows/phpunit.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/phpunit.yaml)
 [![Mutations](https://github.com/php-etl/pipeline/actions/workflows/infection.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/infection.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 5](https://github.com/php-etl/pipeline/actions/workflows/phpstan-6.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/phpstan-6.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)
+[![PHPStan level 9](https://github.com/php-etl/pipeline/actions/workflows/phpstan-9.yaml/badge.svg)](https://github.com/php-etl/pipeline/actions/workflows/phpstan-9.yaml)
 ![PHP](https://img.shields.io/packagist/php-v/php-etl/pipeline)
 
 Documentation

diff --git a/composer.lock b/composer.lock
diff --git a/src/GeneratorWrapper.php b/src/GeneratorWrapper.php
@@ -11,23 +11,23 @@
  */
 class GeneratorWrapper
 {
-    /** @param \Iterator<int<0, max>, Type> ...$iterators */
+    /** @param \Iterator<int, Type> ...$iterators */
     public function rewind(\Iterator ...$iterators): void
     {
         foreach ($iterators as $iterator) {
             $iterator->rewind();
         }
     }
 
-    /** @param \Iterator<int<0, max>, Type> ...$iterators */
+    /** @param \Iterator<int, Type> ...$iterators */
     public function next(\Iterator ...$iterators): void
     {
         foreach ($iterators as $iterator) {
             $iterator->next();
         }
     }
 
-    /** @param \Iterator<int<0, max>, Type> ...$iterators */
+    /** @param \Iterator<int, Type> ...$iterators */
     public function valid(\Iterator ...$iterators): bool
     {
         foreach ($iterators as $iterator) {
@@ -40,7 +40,7 @@ public function valid(\Iterator ...$iterators): bool
     }
 
     /**
-     * @param Type                                                             $value
+     * @param Type $value
      * @param \Generator<int, ResultBucketInterface<Type>, Type, void> ...$generators
      */
     public function send($value, \Generator ...$generators): \Generator

diff --git a/src/Pipeline.php b/src/Pipeline.php
@@ -22,9 +22,9 @@
 
 class Pipeline implements PipelineInterface, WalkableInterface, RunnableInterface
 {
-    /** @var \AppendIterator<int<0, max>, non-empty-array<array-key, mixed>|object, \Iterator<int<0, max>, non-empty-array<array-key, mixed>|object>> */
+    /** @var \AppendIterator<int, mixed, \Iterator<int, mixed>> */
     private readonly \AppendIterator $source;
-    /** @var \Iterator<int<0, max>, non-empty-array<array-key, mixed>|object>|\NoRewindIterator */
+    /** @var \Iterator<int, mixed>|\NoRewindIterator */
     private iterable $subject;
 
     public function __construct(
@@ -45,7 +45,9 @@ public function __construct(
      */
     public function feed(...$data): void
     {
-        $this->source->append(new \ArrayIterator($data));
+        /** @var \ArrayIterator<int, InputType> $iterator */
+        $iterator = new \ArrayIterator($data);
+        $this->source->append($iterator);
     }
 
     private function passThroughCoroutine(): \Generator
@@ -60,8 +62,8 @@ private function passThroughCoroutine(): \Generator
     /**
      * @template Type
      *
-     * @param ExtractorInterface<Type>     $extractor
-     * @param StepRejectionInterface<Type> $rejection
+     * @param ExtractorInterface<Type> $extractor
+     * @param StepRejectionInterface<Type|null> $rejection
      */
     public function extract(
         StepCodeInterface $stepCode,
@@ -71,36 +73,20 @@ public function extract(
     ): ExtractingInterface {
         $extract = $extractor->extract();
         if (\is_array($extract)) {
-            $this->source->append(
-                $this->runner->run(
-                    new \ArrayIterator($extract),
-                    $this->passThroughCoroutine(),
-                    $rejection,
-                    $state,
-                )
-            );
+            /** @var \ArrayIterator<int, mixed> $iterator */
+            $iterator = new \ArrayIterator($extract);
         } elseif ($extract instanceof \Iterator) {
-            $this->source->append(
-                $this->runner->run(
-                    $extract,
-                    $this->passThroughCoroutine(),
-                    $rejection,
-                    $state,
-                )
-            );
+            /** @var \Iterator<int, mixed> $iterator */
+            $iterator = $extract;
         } elseif ($extract instanceof \Traversable) {
-            $this->source->append(
-                $this->runner->run(
-                    new \IteratorIterator($extract),
-                    $this->passThroughCoroutine(),
-                    $rejection,
-                    $state,
-                )
-            );
+            /** @var \IteratorIterator<int, mixed, \Iterator<int, mixed>> $iterator */
+            $iterator = new \IteratorIterator($extract);
         } else {
             throw new \RuntimeException('Invalid data source, expecting array or Traversable.');
         }
 
+        $this->source->append($this->runner->run($iterator, $this->passThroughCoroutine(), $rejection, $state));
+
         return $this;
     }
 
@@ -109,7 +95,7 @@ public function extract(
      * @template OutputType
      *
      * @param TransformerInterface<InputType, OutputType> $transformer
-     * @param StepRejectionInterface<InputType>           $rejection
+     * @param StepRejectionInterface<InputType|null> $rejection
      */
     public function transform(
         StepCodeInterface $stepCode,
@@ -118,6 +104,7 @@ public function transform(
         StepStateInterface $state,
     ): TransformingInterface {
         if ($transformer instanceof FlushableInterface) {
+            /** @var \AppendIterator<int, mixed, \Iterator<int, mixed>> $iterator */
             $iterator = new \AppendIterator();
 
             $iterator->append(
@@ -158,7 +145,7 @@ public function transform(
      * @template OutputType
      *
      * @param LoaderInterface<InputType, OutputType> $loader
-     * @param StepRejectionInterface<InputType>      $rejection
+     * @param StepRejectionInterface<InputType|null> $rejection
      */
     public function load(
         StepCodeInterface $stepCode,

diff --git a/src/PipelineRunner.php b/src/PipelineRunner.php
@@ -21,16 +21,6 @@ public function __construct(
         private readonly LogLevel|string $rejectionLevel = LogLevel::WARNING
     ) {}
 
-    /**
-     * @template InputType
-     * @template OutputType
-     *
-     * @param \Iterator<int<0, max>, InputType|null>                                                                                                                                $source
-     * @param \Generator<int, ResultBucketInterface<OutputType>|AcceptanceResultBucketInterface<InputType>|RejectionResultBucketInterface<InputType>|null, InputType, void> $coroutine
-     * @param StepRejectionInterface<InputType>                                                                                                                                     $rejection
-     *
-     * @return \Iterator<int<0, max>, ResultBucketInterface<OutputType>>
-     */
     public function run(
         \Iterator $source,
         \Generator $coroutine,

diff --git a/src/Transformer/BatchingTransformer.php b/src/Transformer/BatchingTransformer.php
@@ -66,9 +66,7 @@ public function transform(): \Generator
     public function flush(): ResultBucketInterface
     {
         if (\count($this->batch) <= 0) {
-            /** @var EmptyResultBucket<OutputType> $bucket */
-            $bucket = new EmptyResultBucket();
-            return $bucket;
+            return new EmptyResultBucket();
         }
 
         /* @phpstan-ignore-next-line */

diff --git a/src/Transformer/FilterTransformer.php b/src/Transformer/FilterTransformer.php
@@ -45,7 +45,9 @@ public function transform(): \Generator
                 continue;
             }
 
-            $line = yield new AcceptanceResultBucket($line);
+            /** @var AcceptanceResultBucket<Type> $bucket */
+            $bucket = new AcceptanceResultBucket($line);
+            $line = yield $bucket;
         }
     }
 }
diff --git a/src/UnexpectedYieldedValueType.php b/src/UnexpectedYieldedValueType.php
@@ -4,8 +4,6 @@
 
 namespace Kiboko\Component\Pipeline;
 
-use Kiboko\Contract\Bucket\ResultBucketInterface;
-
 /**
  * @template InputType
  * @template OutputType