Merge pull request #3 from php-etl/feature/update-contracts

Updated php-etl contract versions
php-etl · Nov 22, 2023 · 9bf4a09 · 9bf4a09
2 parents 5437a58 + dded8ed
commit 9bf4a09
Show file tree

Hide file tree

Showing 11 changed files with 82 additions and 101 deletions.
diff --git a/.github/workflows/infection.yaml b/.github/workflows/infection.yaml
@@ -23,8 +23,8 @@ jobs:
 
             -   name: Infection
                 run: |
-                    wget -q https://github.com/infection/infection/releases/download/0.26.18/infection.phar
-                    wget -q https://github.com/infection/infection/releases/download/0.26.18/infection.phar.asc
+                    wget -q https://github.com/infection/infection/releases/download/0.27.0/infection.phar
+                    wget -q https://github.com/infection/infection/releases/download/0.27.0/infection.phar.asc
                     chmod +x infection.phar
                     ./infection.phar
 

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
@@ -1,7 +1,7 @@
 name: PHPStan level 6
 on: push
 jobs:
-  phpstan:
+  phpstan-6:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/phpstan-7.yaml b/.github/workflows/phpstan-7.yaml
@@ -1,7 +1,7 @@
 name: PHPStan level 7
 on: push
 jobs:
-  phpstan:
+  phpstan-7:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/phpstan-8.yaml b/.github/workflows/phpstan-8.yaml
@@ -1,7 +1,7 @@
 name: PHPStan level 8
 on: push
 jobs:
-  phpstan:
+  phpstan-8:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/quality.yaml b/.github/workflows/quality.yaml
@@ -1,4 +1,4 @@
-name: Quality (PHPStan lvl 4)
+name: Quality (PHPStan lvl 5)
 on: push
 jobs:
     cs-fixer:
@@ -17,20 +17,20 @@ jobs:
     phpstan:
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v3
-            -   uses: actions/cache@v3
-                with:
-                    path: '**/vendor'
-                    key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-                    restore-keys: |
-                        ${{ runner.os }}-composer-
-            -   uses: php-actions/composer@v6
-                with:
-                    args: --prefer-dist
-                    php_version: '8.2'
-
-            -   name: PHPStan
-                uses: php-actions/phpstan@v3
-                with:
-                    path: src/
-                    level: 4
+            - uses: actions/checkout@v3
+            - uses: actions/cache@v3
+              with:
+                  path: '**/vendor'
+                  key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-composer-
+            - uses: php-actions/composer@v6
+              with:
+                  args: --prefer-dist
+                  php_version: '8.2'
+            - name: PHPStan
+              uses: php-actions/phpstan@v3
+              with:
+                  path: src/
+                  level: 5
+                  php_version: '8.2'
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ This package brings tools to read and write JSON-LD files in a pipeline.
 
 
 [![Quality](https://github.com/php-etl/json-flow/actions/workflows/quality.yaml/badge.svg)](https://github.com/php-etl/json-flow/actions/workflows/quality.yaml)
-[![PHPStan level 5](https://github.com/php-etl/json-flow/actions/workflows/phpstan-5.yaml/badge.svg)](https://github.com/php-etl/json-flow/actions/workflows/phpstan-5.yaml)
+[![PHPStan level 6](https://github.com/php-etl/json-flow/actions/workflows/phpstan-6.yaml/badge.svg)](https://github.com/php-etl/json-flow/actions/workflows/phpstan-6.yaml)
 [![PHPStan level 7](https://github.com/php-etl/json-flow/actions/workflows/phpstan-7.yaml/badge.svg)](https://github.com/php-etl/json-flow/actions/workflows/phpstan-7.yaml)
 [![PHPStan level 8](https://github.com/php-etl/json-flow/actions/workflows/phpstan-8.yaml/badge.svg)](https://github.com/php-etl/json-flow/actions/workflows/phpstan-8.yaml)
 ![PHP](https://img.shields.io/packagist/php-v/php-etl/json-flow)

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,33 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
-<phpunit
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
-        backupGlobals="true"
-        colors="false"
-        processIsolation="false"
-        stopOnError="false"
-        stopOnFailure="false"
-        stopOnIncomplete="false"
-        stopOnSkipped="false"
-        stopOnRisky="false"
-        timeoutForSmallTests="1"
-        timeoutForMediumTests="10"
-        timeoutForLargeTests="60"
-        cacheDirectory=".phpunit.cache"
-        backupStaticProperties="false"
-        requireCoverageMetadata="false">
-    <testsuites>
-        <testsuite name="Functional tests">
-            <directory>tests/</directory>
-        </testsuite>
-    </testsuites>
-    <coverage>
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-    </coverage>
-    <php>
-        <ini name="allow_url_include" value="1"/>
-    </php>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" backupGlobals="true" colors="false" processIsolation="false" stopOnError="false" stopOnFailure="false" stopOnIncomplete="false" stopOnSkipped="false" stopOnRisky="false" timeoutForSmallTests="1" timeoutForMediumTests="10" timeoutForLargeTests="60" cacheDirectory=".phpunit.cache" backupStaticProperties="false" requireCoverageMetadata="false">
+  <testsuites>
+    <testsuite name="Functional tests">
+      <directory>tests/</directory>
+    </testsuite>
+  </testsuites>
+  <coverage/>
+  <php>
+    <ini name="allow_url_include" value="1"/>
+  </php>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/Extractor.php b/src/Extractor.php
@@ -5,19 +5,34 @@
 namespace Kiboko\Component\Flow\JSON;
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
+use Kiboko\Component\Bucket\RejectionResultBucket;
 use Kiboko\Contract\Pipeline\ExtractorInterface;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 
 readonly class Extractor implements ExtractorInterface
 {
     public function __construct(
-        private \SplFileObject $file
-    ) {
-    }
+        private \SplFileObject $file,
+        private LoggerInterface $logger = new NullLogger(),
+    ) {}
 
     public function extract(): iterable
     {
+        $data = null;
         while (!$this->file->eof()) {
-            yield new AcceptanceResultBucket(json_decode($this->file->fgets(), true, 512, \JSON_ERROR_NONE));
+            try {
+                $data = json_decode($this->file->fgets(), true, 512, \JSON_ERROR_NONE);
+
+                yield new AcceptanceResultBucket($data);
+            } catch (\Throwable $exception) {
+                $this->logger->critical($exception->getMessage(), ['item' => $data, 'exception' => $exception]);
+                yield new RejectionResultBucket(
+                    'It seems that something failed when decoding the json file.',
+                    $exception,
+                    $data
+                );
+            }
         }
     }
 }
diff --git a/src/Loader.php b/src/Loader.php
@@ -6,27 +6,35 @@
 
 use Kiboko\Component\Bucket\AcceptanceResultBucket;
 use Kiboko\Component\Bucket\EmptyResultBucket;
+use Kiboko\Component\Bucket\RejectionResultBucket;
 use Kiboko\Contract\Pipeline\LoaderInterface;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 
-class Loader implements LoaderInterface
+readonly class Loader implements LoaderInterface
 {
     public function __construct(
-        private readonly \SplFileObject $file,
-    ) {
-    }
+        private \SplFileObject $file,
+        private LoggerInterface $logger = new NullLogger(),
+    ) {}
 
     public function load(): \Generator
     {
-        $line = yield;
+        $line = yield new EmptyResultBucket();
 
-        while (true) {
-            if ($line === null) {
-                $line = yield new EmptyResultBucket();
-                continue;
-            }
-            $this->file->fwrite(json_encode($line, \JSON_THROW_ON_ERROR)."\n");
+        while ($line) {
+            try {
+                $this->file->fwrite(json_encode($line, \JSON_THROW_ON_ERROR)."\n");
 
-            $line = yield new AcceptanceResultBucket($line);
+                $line = yield new AcceptanceResultBucket($line);
+            } catch (\Throwable $exception) {
+                $this->logger->critical($exception->getMessage(), ['item' => $line, 'exception' => $exception]);
+                $line = yield new RejectionResultBucket(
+                    'It seems that something went wrong when writing to the json file',
+                    $exception,
+                    $line
+                );
+            }
         }
     }
 }
diff --git a/tests/functional/PipelineRunner.php b/tests/functional/PipelineRunner.php
@@ -9,18 +9,17 @@
 use Kiboko\Contract\Pipeline\PipelineRunnerInterface;
 use Kiboko\Contract\Pipeline\RejectionInterface;
 use Kiboko\Contract\Pipeline\StateInterface;
+use Kiboko\Contract\Pipeline\StepRejectionInterface;
+use Kiboko\Contract\Pipeline\StepStateInterface;
 
 final class PipelineRunner implements PipelineRunnerInterface
 {
     public function run(
         \Iterator $source,
         \Generator $async,
-        RejectionInterface $rejection,
-        StateInterface $state,
+        StepRejectionInterface $rejection,
+        StepStateInterface $state,
     ): \Iterator {
-        $state->initialize();
-        $rejection->initialize();
-
         $source->rewind();
         $async->rewind();
 
@@ -40,8 +39,5 @@ public function run(
 
             $source->next();
         }
-
-        $rejection->teardown();
-        $state->teardown();
     }
 }