rename interfaces and mark input observer as untestable

src/AbstractHandler.php

@@ -27,6 +27,14 @@ public function __construct($resource)
         $this->resource = $resource;
     }
 
+    /**
+     * @return resource
+     */
+    public function getResource()
+    {
+        return $this->resource;
+    }
+
     /**
      * @param $resource
      * @return bool|void

src/Console.php

@@ -3,8 +3,8 @@
 namespace Hugga;
 
 use Hugga\Input\ReadlineHandler;
-use Hugga\Input\ResourceHandler as InputHandler;
-use Hugga\Output\ResourceHandler as OutputHandler;
+use Hugga\Input\FileHandler as InputHandler;
+use Hugga\Output\FileHandler as OutputHandler;
 use Hugga\Output\TtyHandler;
 use Psr\Log\LoggerInterface;
 
@@ -38,13 +38,13 @@ class Console
     /** @var bool */
     protected $logMessages = false;
 
-    /** @var OutputInterface */
+    /** @var OutputHandlerInterface */
     protected $stdout;
 
-    /** @var InputInterface */
+    /** @var InputHandlerInterface */
     protected $stdin;
 
-    /** @var OutputInterface */
+    /** @var OutputHandlerInterface */
     protected $stderr;
 
     /** @var bool  */
@@ -219,12 +219,12 @@ public function disableAnsi(bool $disabled = true)
     /**
      * Set the resource for stdout
      *
-     * @param resource|OutputInterface $stdout
+     * @param resource|OutputHandlerInterface $stdout
      * @return $this
      */
     public function setStdout($stdout)
     {
-        if ($stdout instanceof OutputInterface) {
+        if ($stdout instanceof OutputHandlerInterface) {
             $this->stdout = $stdout;
             return $this;
         }
@@ -235,20 +235,20 @@ public function setStdout($stdout)
         return $this;
     }
 
-    public function getStdout(): OutputInterface
+    public function getStdout(): OutputHandlerInterface
     {
         return $this->stdout;
     }
 
     /**
      * Set the resource for stdin
      *
-     * @param resource|InputInterface $stdin
+     * @param resource|InputHandlerInterface $stdin
      * @return $this
      */
     public function setStdin($stdin)
     {
-        if ($stdin instanceof InputInterface) {
+        if ($stdin instanceof InputHandlerInterface) {
             $this->stdin = $stdin;
             return $this;
         }
@@ -259,20 +259,30 @@ public function setStdin($stdin)
         return $this;
     }
 
-    public function getStdin(): InputInterface
+    public function getStdin(): InputHandlerInterface
     {
         return $this->stdin;
     }
 
+    public function getInputObserver()
+    {
+        $resource = $this->stdin->getResource();
+        if (!InputObserver::isCompatible($resource)) {
+            throw new \LogicException('Stdin resource is not compatible for input observer');
+        }
+        // @codeCoverageIgnoreStart
+        return new InputObserver($resource);
+    }
+
     /**
      * Set the resource for stderr
      *
-     * @param resource|OutputInterface $stderr
+     * @param resource|OutputHandlerInterface $stderr
      * @return $this
      */
     public function setStderr($stderr)
     {
-        if ($stderr instanceof OutputInterface) {
+        if ($stderr instanceof OutputHandlerInterface) {
             $this->stderr = $stderr;
             return $this;
         }
@@ -283,7 +293,7 @@ public function setStderr($stderr)
         return $this;
     }
 
-    public function getStderr(): OutputInterface
+    public function getStderr(): OutputHandlerInterface
     {
         return $this->stderr;
     }

src/Input/AbstractInputHandler.php

@@ -3,8 +3,8 @@
 namespace Hugga\Input;
 
 use Hugga\AbstractHandler;
-use Hugga\InputInterface;
+use Hugga\InputHandlerInterface;
 
-abstract class AbstractInputHandler extends AbstractHandler implements InputInterface
+abstract class AbstractInputHandler extends AbstractHandler implements InputHandlerInterface
 {
 }

src/Input/ResourceHandler.php → src/Input/FileHandler.php

@@ -2,7 +2,7 @@
 
 namespace Hugga\Input;
 
-class ResourceHandler extends AbstractInputHandler
+class FileHandler extends AbstractInputHandler
 {
     const BUFFER_SIZE = 4096;
 

src/InputInterface.php → src/InputHandlerInterface.php

@@ -2,11 +2,13 @@
 
 namespace Hugga;
 
-interface InputInterface
+interface InputHandlerInterface
 {
     public function readLine(string $prompt = null): string;
 
     public function read(int $count = 1, string $prompt = null): string;
 
     public function readUntil(string $sequence, string $prompt = null): string;
+
+    public function getResource();
 }

src/TTyObserver.php → src/InputObserver.php

@@ -2,7 +2,14 @@
 
 namespace Hugga;
 
-class TTyObserver
+/**
+ * Class InputObserver
+ *
+ * @package Hugga
+ * @author Thomas Flori <thflori@gmail.com>
+ * @codeCoverageIgnore not testable
+ */
+class InputObserver
 {
     protected $stdin;
 

src/Output/AbstractOutputHandler.php

@@ -3,9 +3,9 @@
 namespace Hugga\Output;
 
 use Hugga\AbstractHandler;
-use Hugga\OutputInterface;
+use Hugga\OutputHandlerInterface;
 
-abstract class AbstractOutputHandler extends AbstractHandler implements OutputInterface
+abstract class AbstractOutputHandler extends AbstractHandler implements OutputHandlerInterface
 {
     public static function isCompatible($resource)
     {

src/Output/ResourceHandler.php → src/Output/FileHandler.php

@@ -2,7 +2,7 @@
 
 namespace Hugga\Output;
 
-class ResourceHandler extends AbstractOutputHandler
+class FileHandler extends AbstractOutputHandler
 {
     const BUFFER_SIZE = 4096;
 

src/OutputInterface.php → src/OutputHandlerInterface.php

@@ -2,11 +2,13 @@
 
 namespace Hugga;
 
-interface OutputInterface
+interface OutputHandlerInterface
 {
     public function write(string $str);
 
     public function delete(int $count);
 
     public function deleteLine();
+
+    public function getResource();
 }

tests/ConsoleTest.php

@@ -3,8 +3,8 @@
 namespace Hugga\Test;
 
 use Hugga\Console;
-use Hugga\Input\ResourceHandler as InputHandler;
-use Hugga\Output\ResourceHandler as OutputHandler;
+use Hugga\Input\FileHandler as InputHandler;
+use Hugga\Output\FileHandler as OutputHandler;
 use Mockery as m;
 use Psr\Log\LoggerInterface;
 
@@ -233,4 +233,12 @@ public function acceptsOutputInterfaceForStderr()
 
         self::assertSame($outputHandler, $this->console->getStderr());
     }
+
+    /** @test */
+    public function throwsWhenStdIsNotCompatible()
+    {
+        self::expectException(\LogicException::class);
+
+        $this->console->getInputObserver();
+    }
 }

tests/Input/CommonTest.php

@@ -2,7 +2,7 @@
 
 namespace Hugga\Test\Input;
 
-use Hugga\Input\ResourceHandler;
+use Hugga\Input\FileHandler;
 use Hugga\Test\TestCase;
 
 class CommonTest extends TestCase
@@ -13,6 +13,6 @@ public function throwsWithoutResource()
         self::expectException(\InvalidArgumentException::class);
         self::expectExceptionMessage('has to be of the type resource');
 
-        new ResourceHandler('php://memory');
+        new FileHandler('php://memory');
     }
 }

tests/Input/ResourceHandlerTest.php

@@ -2,7 +2,7 @@
 
 namespace Hugga\Test\Input;
 
-use Hugga\Input\ResourceHandler as InputHandler;
+use Hugga\Input\FileHandler as InputHandler;
 use Hugga\Test\TestCase;
 
 class ResourceHandlerTest extends TestCase

tests/Output/ResourceHandlerTest.php

@@ -2,27 +2,27 @@
 
 namespace Hugga\Test\Output;
 
-use Hugga\Output\ResourceHandler;
+use Hugga\Output\FileHandler;
 use Hugga\Test\TestCase;
 
 class ResourceHandlerTest extends TestCase
 {
     /** @test */
     public function doesNotRequireATty()
     {
-        self::assertTrue(ResourceHandler::isCompatible($this->stdout));
+        self::assertTrue(FileHandler::isCompatible($this->stdout));
     }
 
     /** @test */
     public function requiresWriteableResource()
     {
-        self::assertFalse(ResourceHandler::isCompatible(fopen('php://memory', 'r')));
+        self::assertFalse(FileHandler::isCompatible(fopen('php://memory', 'r')));
     }
 
     /** @test */
     public function writesToResource()
     {
-        $handler = new ResourceHandler($this->stdout);
+        $handler = new FileHandler($this->stdout);
 
         $handler->write('any string');
 
@@ -33,7 +33,7 @@ public function writesToResource()
     /** @test */
     public function deletesTheLastBytes()
     {
-        $handler = new ResourceHandler($this->stdout);
+        $handler = new FileHandler($this->stdout);
         $handler->write('Calculating something ... ⚬');
 
         $handler->delete(1);
@@ -45,7 +45,7 @@ public function deletesTheLastBytes()
     /** @test */
     public function deletesTheCurrentLine()
     {
-        $handler = new ResourceHandler($this->stdout);
+        $handler = new FileHandler($this->stdout);
         $handler->write('Text before the last line' . PHP_EOL . 'text to be removed...');
 
         $handler->deleteLine();
@@ -57,7 +57,7 @@ public function deletesTheCurrentLine()
     /** @test */
     public function deletesInChunks()
     {
-        $handler = new ResourceHandler($this->stdout);
+        $handler = new FileHandler($this->stdout);
         $handler->write('Text before the last line' . PHP_EOL . 'foo bar');
 
         $handler->deleteLine(3); // buffer size 3 -> 3 steps
@@ -69,7 +69,7 @@ public function deletesInChunks()
     /** @test */
     public function deletesEverythingWithoutLinebreak()
     {
-        $handler = new ResourceHandler($this->stdout);
+        $handler = new FileHandler($this->stdout);
         $handler->write('the first line of the file without line breaks');
 
         $handler->deleteLine();