Added json lines reader and writer (#29)

* Added reader for jsonl format

* Added writer for jsonl format

* Fixed missing phpstan return type

* Fixed checkstyle

Author: yann-eugone

src/batch/src/Job/Item/Reader/Filesystem/JsonLinesReader.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Job\Item\Reader\Filesystem;
+
+use Generator;
+use Yokai\Batch\Exception\RuntimeException;
+use Yokai\Batch\Job\Item\ItemReaderInterface;
+use Yokai\Batch\Job\JobExecutionAwareInterface;
+use Yokai\Batch\Job\JobExecutionAwareTrait;
+use Yokai\Batch\Job\Parameters\JobParameterAccessorInterface;
+
+final class JsonLinesReader implements
+    ItemReaderInterface,
+    JobExecutionAwareInterface
+{
+    use JobExecutionAwareTrait;
+
+    private JobParameterAccessorInterface $filePath;
+
+    public function __construct(JobParameterAccessorInterface $filePath)
+    {
+        $this->filePath = $filePath;
+    }
+
+    /**
+     * @inheritdoc
+     * @phpstan-return Generator<mixed>
+     */
+    public function read(): Generator
+    {
+        $path = (string)$this->filePath->get($this->jobExecution);
+        $file = @\fopen($path, 'r');
+        if ($file === false) {
+            throw new RuntimeException(\sprintf('Cannot open %s for reading.', $path));
+        }
+
+        while ($line = \fgets($file)) {
+            yield \json_decode($line, true);
+        }
+
+        \fclose($file);
+    }
+}

src/batch/src/Job/Item/Writer/Filesystem/JsonLinesWriter.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Job\Item\Writer\Filesystem;
+
+use Yokai\Batch\Exception\RuntimeException;
+use Yokai\Batch\Job\Item\FlushableInterface;
+use Yokai\Batch\Job\Item\InitializableInterface;
+use Yokai\Batch\Job\Item\ItemWriterInterface;
+use Yokai\Batch\Job\JobExecutionAwareInterface;
+use Yokai\Batch\Job\JobExecutionAwareTrait;
+use Yokai\Batch\Job\Parameters\JobParameterAccessorInterface;
+
+final class JsonLinesWriter implements
+    ItemWriterInterface,
+    InitializableInterface,
+    FlushableInterface,
+    JobExecutionAwareInterface
+{
+    use JobExecutionAwareTrait;
+
+    private JobParameterAccessorInterface $filePath;
+
+    /**
+     * @var resource
+     */
+    private $file;
+
+    public function __construct(JobParameterAccessorInterface $filePath)
+    {
+        $this->filePath = $filePath;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function initialize(): void
+    {
+        $path = (string)$this->filePath->get($this->jobExecution);
+        $file = @\fopen($path, 'w+');
+        if ($file === false) {
+            throw new RuntimeException(\sprintf('Cannot open %s for writing.', $path));
+        }
+
+        $this->file = $file;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function write(iterable $items): void
+    {
+        foreach ($items as $json) {
+            if (!\is_string($json)) {
+                $json = \json_encode($json);
+            }
+            \fwrite($this->file, $json . \PHP_EOL);
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function flush(): void
+    {
+        if (isset($this->file)) {
+            \fclose($this->file);
+        }
+    }
+}

src/batch/tests/Job/Item/Reader/Filesystem/JsonLinesReaderTest.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Job\Item\Reader\Filesystem;
+
+use PHPUnit\Framework\TestCase;
+use Yokai\Batch\Exception\RuntimeException;
+use Yokai\Batch\Job\Item\Reader\Filesystem\JsonLinesReader;
+use Yokai\Batch\Job\Parameters\StaticValueParameterAccessor;
+use Yokai\Batch\JobExecution;
+
+class JsonLinesReaderTest extends TestCase
+{
+    public function testRead(): void
+    {
+        $reader = new JsonLinesReader(new StaticValueParameterAccessor(__DIR__ . '/fixtures/lines.jsonl'));
+        $reader->setJobExecution(JobExecution::createRoot('123456', 'test'));
+
+        self::assertSame(
+            [
+                ['object' => 'foo'],
+                ['array', 'value'],
+                'string',
+                false,
+                null,
+                0,
+            ],
+            \iterator_to_array($reader->read())
+        );
+    }
+
+    public function testReadUnknownFile(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $reader = new JsonLinesReader(new StaticValueParameterAccessor(__DIR__ . '/fixtures/unknown-file.ext'));
+        $reader->setJobExecution(JobExecution::createRoot('123456', 'test'));
+        \iterator_to_array($reader->read());
+    }
+}

src/batch/tests/Job/Item/Reader/Filesystem/fixtures/lines.jsonl

@@ -0,0 +1,6 @@
+{"object":"foo"}
+["array","value"]
+"string"
+false
+null
+0

src/batch/tests/Job/Item/Writer/Filesystem/JsonLinesWriterTest.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Job\Item\Writer\Filesystem;
+
+use PHPUnit\Framework\TestCase;
+use Yokai\Batch\Exception\RuntimeException;
+use Yokai\Batch\Job\Item\Writer\Filesystem\JsonLinesWriter;
+use Yokai\Batch\Job\Parameters\StaticValueParameterAccessor;
+use Yokai\Batch\JobExecution;
+
+class JsonLinesWriterTest extends TestCase
+{
+    private const WRITE_DIR = ARTIFACT_DIR . '/json-lines-writer';
+
+    public static function setUpBeforeClass(): void
+    {
+        if (!\is_dir(self::WRITE_DIR)) {
+            \mkdir(self::WRITE_DIR, 0777, true);
+        }
+    }
+
+    public function testWrite(): void
+    {
+        $filename = self::WRITE_DIR . '/lines.jsonl';
+        $writer = new JsonLinesWriter(new StaticValueParameterAccessor($filename));
+
+        self::assertFileDoesNotExist($filename);
+
+        $writer->setJobExecution(JobExecution::createRoot('123456', 'test'));
+        $writer->initialize();
+        $writer->write([
+            ['object' => 'foo'],
+            ['array', 'value'],
+        ]);
+        $writer->write([
+            '"string"',
+            false,
+            null,
+            0,
+        ]);
+        $writer->flush();
+
+        self::assertFileExists($filename);
+        self::assertSame(
+            <<<JSONL
+            {"object":"foo"}
+            ["array","value"]
+            "string"
+            false
+            null
+            0
+            JSONL,
+            \trim(\file_get_contents($filename))
+        );
+    }
+
+    public function testWriteUnknownDir(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $filename = '/path/to/unknown/dir/lines.jsonl';
+        $writer = new JsonLinesWriter(new StaticValueParameterAccessor($filename));
+
+        self::assertFileDoesNotExist($filename);
+
+        $writer->setJobExecution(JobExecution::createRoot('123456', 'test'));
+        $writer->initialize();
+    }
+}