Define custom line delimiter

Author: legionth

README.md

@@ -11,15 +11,24 @@ Line reader stream to forward complete lines to a stream.
 
 ### LineReader
 
-The center of this project is the `LineReader` class. This class checks incoming data for an new line delimiter, if the delimeter has been found in the current data chunk the data will be exposed on the stream. When the new line delimeter isn't found the data chunk, it will be buffered until a delimiter occures. The `LineReader` is a duplex stream, so a readable and writable stream at the same time. 
+The center of this project is the `LineReader` class.
+This class checks incoming data for an new line delimiter, if the delimeter has been found in the current data chunk the data will be exposed on the stream.
+When the new line delimeter isn't found the data chunk,
+it will be buffered until a delimiter occures.
+The `LineReader` is a duplex stream, so a readable and writable stream at the same time. 
 
 Checkout `examples` how you can use this project.
 
 ```
 $ cat words.txt | php examples/readLine.php
 ```
 
-This example makes clear what example this project can be used for. Every line with a new line delimiter will put into the readable stream. Every other line without a new line delimiter will be buffered until another occures.
+This example makes clear what example this project can be used for.
+Every line with a new line delimiter will put into the readable stream.
+Every other line without a new line delimiter will be buffered until another occures.
+
+The first parameter of the `LineReader` is the custom delimiter.
+The default value of this delimiter is `PHP_EOL`.
 
 ## Install
 

src/LineReader.php

@@ -8,30 +8,43 @@
 use React\Stream\Util;
 
 /**
- * Read the stream line wise. This class is a duplex stream so a writeable and readable 
- * stream at the same time 
+ * Read the stream line wise. This class is a duplex stream so a writeable and readable
+ * stream at the same time
  */
 class LineReader extends EventEmitter implements ReadableStreamInterface, WritableStreamInterface
 {
     private $closed = false;
     private $buffer = '';
-    
+    private $eol;
+
     /**
-     * Reads the incomg data until the new line delimiter occures, 
-     * if there is no delimiter in the chunk the data will be buffered until 
+     * @param string $eol - delimiter that defines the end of line
+     */
+    public function __construct($eol = PHP_EOL)
+    {
+        $this->eol = $eol;
+    }
+
+    /**
+     * Reads the incomg data until the new line delimiter occures,
+     * if there is no delimiter in the chunk the data will be buffered until
      * the next data chunk comes in
      *
      * @param string $chunk - string entered by the input stream
      */
     public function write($chunk)
     {
-        for ($i = 0; $i < strlen($chunk); $i++) {
-            $this->buffer .= $chunk[$i];
-        
-            if ($chunk[$i] == PHP_EOL) {
-                $this->emit('data', array($this->buffer));
-                $this->buffer = '';
+        $this->buffer .= $chunk;
+        while ($this->buffer !== "") {
+            $position = strpos($this->buffer, $this->eol);
+
+            if ($position === false) {
+                return;
             }
+
+            $data = substr($this->buffer, 0, $position + strlen($this->eol));
+            $this->emit('data', array($data));
+            $this->buffer = substr($this->buffer, $position + strlen($this->eol));
         }
     }
 
@@ -74,7 +87,7 @@ public function close()
         $this->emit('close');
         $this->removeAllListeners();
     }
-    
+
     public function isWritable()
     {
         return !$this->closed;

tests/LineReaderTest.php

@@ -111,6 +111,24 @@ public function testStreamIsAlreadyClosed()
         $lineReader->close();
     }
 
+    public function testDefinedEolWillSeperateStrings()
+    {
+        $lineReader = new LineReader('you');
+        $input = new ReadableStream();
+        $input->pipe($lineReader);
+
+        $expectedValues = array(
+            'hello you',
+            ' world you'
+        );
+
+        $lineReader->on('data', $this->expectCallableConsecutive(2, $expectedValues));
+
+        $input->emit('data', array(
+            'hello you world you'
+        ));
+    }
+
     private function expectCallableConsecutive($numberOfCalls, array $with)
     {
         $mock = $this->createCallableMock();