Merge pull request #10 from php-etl/feature/with-step-codes

Updated pipeline-contracts package to add the step codes

.github/workflows/quality.yaml

@@ -1,4 +1,4 @@
-name: Quality (PHPStan level 4)
+name: Quality (PHPStan level 5)
 on: push
 jobs:
   cs-fixer:
@@ -34,5 +34,5 @@ jobs:
         uses: php-actions/phpstan@v3
         with:
           path: src/
-          level: 4
+          level: 5
           php_version: '8.2'

composer.json

@@ -34,7 +34,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "0.4.x-dev"
+            "dev-main": "0.5.x-dev"
         }
     }
 }

src/ExtractingInterface.php

@@ -12,8 +12,9 @@ interface ExtractingInterface
      * @param ExtractorInterface<Type> $extractor
      */
     public function extract(
+        StepCodeInterface $step,
         ExtractorInterface $extractor,
-        RejectionInterface $rejection,
-        StateInterface $state,
+        StepRejectionInterface $rejection,
+        StepStateInterface $state,
     ): self;
 }

src/LoadingInterface.php

@@ -12,8 +12,9 @@ interface LoadingInterface
      * @param LoaderInterface<Type> $loader
      */
     public function load(
+        StepCodeInterface $step,
         LoaderInterface $loader,
-        RejectionInterface $rejection,
-        StateInterface $state,
+        StepRejectionInterface $rejection,
+        StepStateInterface $state,
     ): self;
 }

src/NullRejection.php

@@ -11,8 +11,14 @@ public function initialize(): void
         // NOOP
     }
 
-    /** @param non-empty-array<mixed>|object $rejection */
-    public function reject(array|object $rejection, \Throwable $exception = null, string $reason = null): void
+    /** @param non-empty-array<array-key, mixed>|object $rejection */
+    public function reject(StepCodeInterface $step, array|object $rejection, \Throwable $exception = null, string $reason = null): void
+    {
+        // NOOP
+    }
+
+    /** @param non-empty-array<array-key, mixed>|object $rejection */
+    public function rejectWithReason(StepCodeInterface $step, array|object $rejection, string $reason, \Throwable $exception = null): void
     {
         // NOOP
     }

src/NullState.php

@@ -11,17 +11,17 @@ public function initialize(int $start = 0): void
         // NOOP
     }
 
-    public function accept(int $step = 1): void
+    public function accept(StepCodeInterface $step, int $count = 1): void
     {
         // NOOP
     }
 
-    public function reject(int $step = 1): void
+    public function reject(StepCodeInterface $step, int $count = 1): void
     {
         // NOOP
     }
 
-    public function error(int $step = 1): void
+    public function error(StepCodeInterface $step, int $count = 1): void
     {
         // NOOP
     }

src/PipelineRunnerInterface.php

@@ -12,7 +12,7 @@
 interface PipelineRunnerInterface
 {
     /**
-     * @param \Iterator<array|object>                                    $source
+     * @param \Iterator<int, array|object>                               $source
      * @param \Generator<mixed, Type, ResultBucketInterface<Type>, void> $async
      *
      * @return \Iterator<array|object>

src/RejectionInterface.php

@@ -8,8 +8,11 @@ interface RejectionInterface
 {
     public function initialize(): void;
 
-    /** @param non-empty-array<mixed>|object $rejection */
-    public function reject(array|object $rejection, \Throwable $exception = null, string $reason = null): void;
+    /** @param non-empty-array<array-key, mixed>|object $rejection */
+    public function reject(StepCodeInterface $step, array|object $rejection, \Throwable $exception = null): void;
+
+    /** @param non-empty-array<array-key, mixed>|object $rejection */
+    public function rejectWithReason(StepCodeInterface $step, array|object $rejection, string $reason, \Throwable $exception = null): void;
 
     public function teardown(): void;
 }

src/StateInterface.php

@@ -8,11 +8,11 @@ interface StateInterface
 {
     public function initialize(int $start = 0): void;
 
-    public function accept(int $step = 1): void;
+    public function accept(StepCodeInterface $step, int $count = 1): void;
 
-    public function reject(int $step = 1): void;
+    public function reject(StepCodeInterface $step, int $count = 1): void;
 
-    public function error(int $step = 1): void;
+    public function error(StepCodeInterface $step, int $count = 1): void;
 
     public function teardown(): void;
 }

src/StepCodeInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kiboko\Contract\Pipeline;
+
+interface StepCodeInterface extends \Stringable {}

src/StepRejectionInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kiboko\Contract\Pipeline;
+
+interface StepRejectionInterface
+{
+    public function initialize(): void;
+
+    /** @param non-empty-array<mixed>|object $rejection */
+    public function reject(array|object $rejection, \Throwable $exception = null): void;
+
+    public function rejectWithReason(array|object $rejection, string $reason, \Throwable $exception = null): void;
+
+    public function teardown(): void;
+}

src/StepStateInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kiboko\Contract\Pipeline;
+
+interface StepStateInterface
+{
+    public function accept(StepCodeInterface $step, int $count = 1): void;
+
+    public function reject(StepCodeInterface $step, int $count = 1): void;
+
+    public function error(StepCodeInterface $step, int $count = 1): void;
+}

src/TransformingInterface.php

@@ -12,8 +12,9 @@ interface TransformingInterface
      * @param TransformerInterface<Type> $transformer
      */
     public function transform(
+        StepCodeInterface $step,
         TransformerInterface $transformer,
-        RejectionInterface $rejection,
-        StateInterface $state,
+        StepRejectionInterface $rejection,
+        StepStateInterface $state,
     ): self;
 }