From cc87eeec32e8612d679381e38ad3104895478974 Mon Sep 17 00:00:00 2001
From: Ciaran McNulty <mail@ciaranmcnulty.com>
Date: Sun, 23 Jan 2022 20:45:27 +0000
Subject: [PATCH] Stream readers and writers for NdJson input

---
 .../php/src/Streams/NdJsonStreamReader.php    | 21 +++++++
 .../php/src/Streams/NdJsonStreamWriter.php    | 20 +++++++
 messages/php/src/Streams/StreamReader.php     | 13 ++++
 messages/php/src/Streams/StreamWriter.php     | 13 ++++
 .../php/src/Streams/WithFileHandleTrait.php   | 24 ++++++++
 messages/php/tests/AcceptanceTest.php         | 59 +++++++++++++++++--
 6 files changed, 145 insertions(+), 5 deletions(-)
 create mode 100644 messages/php/src/Streams/NdJsonStreamReader.php
 create mode 100644 messages/php/src/Streams/NdJsonStreamWriter.php
 create mode 100644 messages/php/src/Streams/StreamReader.php
 create mode 100644 messages/php/src/Streams/StreamWriter.php
 create mode 100644 messages/php/src/Streams/WithFileHandleTrait.php

diff --git a/messages/php/src/Streams/NdJsonStreamReader.php b/messages/php/src/Streams/NdJsonStreamReader.php
new file mode 100644
index 00000000000..ed3396da765
--- /dev/null
+++ b/messages/php/src/Streams/NdJsonStreamReader.php
@@ -0,0 +1,21 @@
+<?php declare(strict_types=1);
+
+namespace Cucumber\Messages\Streams;
+
+use Cucumber\Messages\Envelope;
+use Generator;
+
+final class NdJsonStreamReader implements StreamReader
+{
+    use WithFileHandleTrait;
+
+    /**
+     * @return Generator<int, Envelope>
+     */
+    public function envelopes() : Generator
+    {
+        while (!feof($this->fileHandle) && ($line = fgets($this->fileHandle))) {
+            yield Envelope::fromJson($line);
+        }
+    }
+}
diff --git a/messages/php/src/Streams/NdJsonStreamWriter.php b/messages/php/src/Streams/NdJsonStreamWriter.php
new file mode 100644
index 00000000000..2b447cb9ea9
--- /dev/null
+++ b/messages/php/src/Streams/NdJsonStreamWriter.php
@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace Cucumber\Messages\Streams;
+
+use Cucumber\Messages\Envelope;
+
+final class NdJsonStreamWriter implements StreamWriter
+{
+    use WithFileHandleTrait;
+
+    /**
+     * @param iterable<Envelope> $envelopes
+     */
+    public function writeEnvelopes(iterable $envelopes) : void
+    {
+        foreach($envelopes as $envelope) {
+            fputs($this->fileHandle, $envelope->asJson() . "\n");
+        }
+    }
+}
diff --git a/messages/php/src/Streams/StreamReader.php b/messages/php/src/Streams/StreamReader.php
new file mode 100644
index 00000000000..09744516774
--- /dev/null
+++ b/messages/php/src/Streams/StreamReader.php
@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Cucumber\Messages\Streams;
+
+use Cucumber\Messages\Envelope;
+
+interface StreamReader
+{
+    /**
+     * @return iterable<Envelope>
+     */
+    public function envelopes(): iterable;
+}
diff --git a/messages/php/src/Streams/StreamWriter.php b/messages/php/src/Streams/StreamWriter.php
new file mode 100644
index 00000000000..606c74c6eda
--- /dev/null
+++ b/messages/php/src/Streams/StreamWriter.php
@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Cucumber\Messages\Streams;
+
+use Cucumber\Messages\Envelope;
+
+interface StreamWriter
+{
+    /**
+     * @param iterable<Envelope> $envelopes
+     */
+    public function writeEnvelopes(iterable $envelopes): void;
+}
diff --git a/messages/php/src/Streams/WithFileHandleTrait.php b/messages/php/src/Streams/WithFileHandleTrait.php
new file mode 100644
index 00000000000..187821662f6
--- /dev/null
+++ b/messages/php/src/Streams/WithFileHandleTrait.php
@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace Cucumber\Messages\Streams;
+
+/**
+ * @internal
+ */
+trait WithFileHandleTrait
+{
+    /**
+     * @param resource $fileHandle
+     */
+    private function __construct(
+        private mixed $fileHandle,
+    ){}
+
+    /**
+     * @param resource $fileHandle
+     */
+    public static function fromFileHandle($fileHandle): self
+    {
+        return new self($fileHandle);
+    }
+}
diff --git a/messages/php/tests/AcceptanceTest.php b/messages/php/tests/AcceptanceTest.php
index e9c475f357f..577e02c0bcf 100644
--- a/messages/php/tests/AcceptanceTest.php
+++ b/messages/php/tests/AcceptanceTest.php
@@ -1,11 +1,13 @@
 <?php
 
 use Cucumber\Messages\Envelope;
+use Cucumber\Messages\Streams\NdJsonStreamReader;
+use Cucumber\Messages\Streams\NdJsonStreamWriter;
 use PHPUnit\Framework\TestCase;
 
 class AcceptanceTest extends TestCase
 {
-    /** @dataProvider provideJson */
+    /** @dataProvider provideJsonLines */
     public function testAllNdJsonSurvivesDecodingThenEncoding(string $json) : void
     {
        $envelope = Envelope::fromJson($json);
@@ -14,13 +16,41 @@ public function testAllNdJsonSurvivesDecodingThenEncoding(string $json) : void
        self::assertJsonStringEqualsJsonString($json, $newJson);
     }
 
+    /** @dataProvider provideNdJsonFilenames */
+    public function testAllFileStreamsSurviveDecodingThenEncoding(string $filename) : void
+    {
+        $sourceHandle = fopen($filename, 'r');
+        $destHandle = fopen('php://memory', 'w');
+
+        $reader = NdJsonStreamReader::fromFileHandle($sourceHandle);
+        $writer = NdJsonStreamWriter::fromFileHandle($destHandle);
+
+        $writer->writeEnvelopes($reader->envelopes());
+
+        rewind($sourceHandle);
+        rewind($destHandle);
+
+        while (!feof($sourceHandle)) {
+            $sourceLine = fgets($sourceHandle);
+            $destLine = fgets($destHandle);
+
+            if (!$sourceLine && !$destLine) {
+                break;
+            }
+
+            self::assertJsonStringEqualsJsonString($sourceLine, $destLine);
+        }
+
+        // we exhausted source so dest should also be at end
+        self::assertTrue(feof($destHandle));
+    }
+
     /**
-     * @return Generator<string, list<string>>
+     * @return Generator<string, array{0: string}>
      */
-    public function provideJson() : Generator
+    public function provideJsonLines() : Generator
     {
-        $filePattern = __DIR__ . '/../../../compatibility-kit/javascript/features/**/*.ndjson';
-        foreach (glob($filePattern) as $filename) {
+        foreach ($this->getSampleFiles() as $filename) {
             foreach(file($filename) ?: [] as $lineNumber => $line) {
                 // key is provided for better error messages
                 $key = realpath($filename) . ':' . $lineNumber;
@@ -28,4 +58,23 @@ public function provideJson() : Generator
             }
         }
     }
+
+    /**
+     * @return Generator<string, array{0: string}>
+     */
+    public function provideNdJsonFilenames() : Generator
+    {
+        foreach($this->getSampleFiles() as $filename)
+        {
+            yield $filename => [$filename];
+        }
+    }
+
+    /**
+     * @return list<string>
+     */
+    private function getSampleFiles(): array
+    {
+        return glob(__DIR__ . '/../../../compatibility-kit/javascript/features/**/*.ndjson') ?: [];
+    }
 }