Merge pull request #64 from clue-labs/cleanup

Remove deprecated functionality

Author: clue

README.md

@@ -17,9 +17,6 @@ built on top of for [ReactPHP](https://reactphp.org).
     * [Cursor](#cursor)
     * [History](#history)
     * [Autocomplete](#autocomplete)
-  * [Advanced](#advanced)
-    * [Stdout](#stdout)
-    * [Stdin](#stdin)
 * [Pitfalls](#pitfalls)
 * [Install](#install)
 * [Tests](#tests)
@@ -82,23 +79,6 @@ $stdio->write('hello');
 $stdio->write(" world\n");
 ```
 
-[Deprecated] The `writeln($line)` method can be used to print a line to console output.
-A trailing newline will be added automatically.
-
-```php
-// deprecated
-$stdio->writeln('hello world');
-```
-
-[Deprecated] The `overwrite($text)` method can be used to overwrite/replace the last
-incomplete line with the given text:
-
-```php
-$stdio->write('Loading…');
-// deprecated
-$stdio->overwrite('Done!');
-```
-
 Alternatively, you can also use the `Stdio` as a writable stream.
 You can `pipe()` any readable stream into this stream.
 
@@ -126,19 +106,6 @@ streams.
 You can control various aspects of the console input through the [`Readline`](#readline),
 so read on..
 
-[Deprecated] It will emit a `line` event for every line read from console input.
-The event will contain the input buffer as-is, without the trailing newline.
-You can register any number of event handlers like this:
-
-```php
-// deprecated
-$stdio->on('line', function ($line) {
-    if ($line === 'start') {
-        doSomething();
-    }
-});
-```
-
 ### Readline
 
 The [`Readline`](#readline) class is responsible for reacting to user input and presenting a prompt to the user.
@@ -486,51 +453,6 @@ disable the autocomplete function:
 $readline->setAutocomplete(null);
 ```
 
-### Advanced
-
-#### Stdout
-
-[Deprecated] The `Stdout` represents a `WritableStream` and is responsible for handling console output.
-
-Interfacing with it directly is *not recommended* and considered *advanced usage*.
-
-If you want to print some text to console output, use the [`Stdio::write()`](#output) instead:
-
-```php
-$stdio->write('hello');
-```
-
-Should you need to interface with the `Stdout`, you can access the current instance through the [`Stdio`](#stdio):
-
-```php
-// deprecated
-$stdout = $stdio->getOutput();
-```
-
-#### Stdin
-
-[Deprecated] The `Stdin` represents a `ReadableStream` and is responsible for handling console input.
-
-Interfacing with it directly is *not recommended* and considered *advanced usage*.
-
-If you want to read a line from console input, use the [`Stdio::on()`](#input) instead:
-
-```php
-$stdio->on('data', function ($line) use ($stdio) {
-    $line = rtrim($line, "\r\n");
-    $stdio->write('You said "' . $line . '"' . PHP_EOL);
-});
-```
-
-Should you need to interface with the `Stdin`, you can access the current instance through the [`Stdio`](#stdio):
-
-You can access the current instance through the [`Stdio`](#stdio):
-
-```php
-// deprecated
-$stdin = $stdio->getInput();
-```
-
 ## Pitfalls
 
 The [`Readline`](#readline) has to redraw the current user

src/Stdin.php renamed to src/Io/Stdin.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace Clue\React\Stdio;
+namespace Clue\React\Stdio\Io;
 
 use React\Stream\Stream;
 use React\EventLoop\LoopInterface;
 
 /**
- * @deprecated
+ * @internal
  */
 class Stdin extends Stream
 {

src/Stdout.php renamed to src/Io/Stdout.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace Clue\React\Stdio;
+namespace Clue\React\Stdio\Io;
 
 use React\Stream\WritableStream;
 
 /**
- * @deprecated
+ * @internal
  */
 class Stdout extends WritableStream
 {

src/Stdio.php

@@ -2,12 +2,14 @@
 
 namespace Clue\React\Stdio;
 
+use Clue\React\Stdio\Io\Stdin;
+use Clue\React\Stdio\Io\Stdout;
 use Evenement\EventEmitter;
-use React\Stream\DuplexStreamInterface;
 use React\EventLoop\LoopInterface;
+use React\Stream\DuplexStreamInterface;
 use React\Stream\ReadableStreamInterface;
-use React\Stream\WritableStreamInterface;
 use React\Stream\Util;
+use React\Stream\WritableStreamInterface;
 
 class Stdio extends EventEmitter implements DuplexStreamInterface
 {
@@ -47,9 +49,6 @@ public function __construct(LoopInterface $loop, ReadableStreamInterface $input
 
             // emit data with trailing newline in order to preserve readable API
             $that->emit('data', array($line . PHP_EOL));
-
-            // emit custom line event for ease of use
-            $that->emit('line', array($line, $that));
         });
 
         // handle all input events (readline forwards all input events)
@@ -162,28 +161,6 @@ public function write($data)
         }
     }
 
-    /**
-     * @deprecated
-     */
-    public function writeln($line)
-    {
-        $this->write($line . PHP_EOL);
-    }
-
-    /**
-     * @deprecated
-     */
-    public function overwrite($data = '')
-    {
-        if ($this->incompleteLine !== '') {
-            // move one line up, move to start of line and clear everything
-            $data = "\033[A\r\033[K" . $data;
-            $this->incompleteLine = '';
-        }
-
-        $this->write($data);
-    }
-
     public function end($data = null)
     {
         if ($this->ending) {
@@ -217,22 +194,6 @@ public function close()
         $this->output->close();
     }
 
-    /**
-     * @deprecated
-     */
-    public function getInput()
-    {
-        return $this->input;
-    }
-
-    /**
-     * @deprecated
-     */
-    public function getOutput()
-    {
-        return $this->output;
-    }
-
     public function getReadline()
     {
         return $this->readline;

tests/StdioTest.php

@@ -21,7 +21,7 @@ public function testCtorDefaultArgs()
         $stdio->close();
     }
 
-    public function testCtorArgsWillBeReturnedByGetters()
+    public function testCtorReadlineArgWillBeReturnedBygetReadline()
     {
         $input = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();
         $output = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
@@ -31,8 +31,6 @@ public function testCtorArgsWillBeReturnedByGetters()
 
         $stdio = new Stdio($this->loop, $input, $output, $readline);
 
-        $this->assertSame($input, $stdio->getInput());
-        $this->assertSame($output, $stdio->getOutput());
         $this->assertSame($readline, $stdio->getReadline());
     }
 
@@ -168,77 +166,7 @@ public function testWriteAfterReadlineInputWillClearReadlineWriteOutputAndRestor
             $buffer .= $data;
         }));
 
-        $stdio->writeln('test');
-
-        $this->assertEquals("\r\033[K" . "test\n" . "> input", $buffer);
-    }
-
-    public function testOverwriteWillClearReadlineMoveToPreviousLineWriteOutputAndRestoreReadline()
-    {
-        $input = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();
-        $output = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
-
-        //$readline = $this->getMockBuilder('Clue\React\Stdio\Readline')->disableOriginalConstructor()->getMock();
-        $readline = new Readline($input, $output);
-        $readline->setPrompt('> ');
-        $readline->setInput('input');
-
-        $stdio = new Stdio($this->loop, $input, $output, $readline);
-
-        $stdio->write('first');
-
-        $buffer = '';
-        $output->expects($this->any())->method('write')->will($this->returnCallback(function ($data) use (&$buffer) {
-            $buffer .= $data;
-        }));
-
-        $stdio->overwrite('overwrite');
-
-        $this->assertEquals("\r\033[K" . "\033[A" . "\r\033[K" . "overwrite\n" . "> input", $buffer);
-    }
-
-    public function testOverwriteAfterNewlineWillClearReadlineAndWriteOutputAndRestoreReadline()
-    {
-        $input = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();
-        $output = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
-
-        //$readline = $this->getMockBuilder('Clue\React\Stdio\Readline')->disableOriginalConstructor()->getMock();
-        $readline = new Readline($input, $output);
-        $readline->setPrompt('> ');
-        $readline->setInput('input');
-
-        $stdio = new Stdio($this->loop, $input, $output, $readline);
-
-        $stdio->write("first\n");
-
-        $buffer = '';
-        $output->expects($this->any())->method('write')->will($this->returnCallback(function ($data) use (&$buffer) {
-            $buffer .= $data;
-        }));
-
-        $stdio->overwrite('overwrite');
-
-        $this->assertEquals("\r\033[K" . "overwrite\n" . "> input", $buffer);
-    }
-
-    public function testWriteLineWillClearReadlineWriteOutputAndRestoreReadline()
-    {
-        $input = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();
-        $output = $this->getMockBuilder('React\Stream\WritableStreamInterface')->getMock();
-
-        //$readline = $this->getMockBuilder('Clue\React\Stdio\Readline')->disableOriginalConstructor()->getMock();
-        $readline = new Readline($input, $output);
-        $readline->setPrompt('> ');
-        $readline->setInput('input');
-
-        $stdio = new Stdio($this->loop, $input, $output, $readline);
-
-        $buffer = '';
-        $output->expects($this->any())->method('write')->will($this->returnCallback(function ($data) use (&$buffer) {
-            $buffer .= $data;
-        }));
-
-        $stdio->writeln('test');
+        $stdio->write("test\n");
 
         $this->assertEquals("\r\033[K" . "test\n" . "> input", $buffer);
     }
@@ -260,8 +188,8 @@ public function testWriteTwoLinesWillClearReadlineWriteOutputAndRestoreReadline(
             $buffer .= $data;
         }));
 
-        $stdio->writeln('hello');
-        $stdio->writeln('world');
+        $stdio->write("hello\n");
+        $stdio->write("world\n");
 
         $this->assertEquals("\r\033[K" . "hello\n" . "> input" . "\r\033[K" . "world\n" . "> input", $buffer);
     }
@@ -454,7 +382,6 @@ public function testDataEventWillBeForwarded()
         $stdio = new Stdio($this->loop, $input, $output, $readline);
 
         $stdio->on('data', $this->expectCallableOnceWith("hello\n"));
-        $stdio->on('line', $this->expectCallableOnceWith('hello'));
 
         $readline->emit('data', array('hello'));
     }