Merge pull request #47 from mikey179/master

api rework

CHANGELOG.md

@@ -4,6 +4,7 @@
 ### BC breaks
 
   * removed namespace prefix `net`, base namespace is now `stubbles\console` only
+  * deprecated `stubbles\console\Executor::getOutputStream()`, use `stubbles\console\Executor::out()` instead, will be removed with 4.0.0
 
 ### Other changes
 

src/main/php/ConsoleExecutor.php

@@ -20,13 +20,13 @@ class ConsoleExecutor implements Executor
      *
      * @type  OutputStream
      */
-    protected $out;
+    private $out;
     /**
      * redirect direction
      *
      * @type  string
      */
-    protected $redirect = '2>&1';
+    private $redirect = '2>&1';
 
     /**
      * sets the output stream to write data outputted by executed command to
@@ -45,11 +45,22 @@ public function streamOutputTo(OutputStream $out)
      *
      * @return  OutputStream
      */
-    public function getOutputStream()
+    public function out()
     {
         return $this->out;
     }
 
+    /**
+     * returns the output stream to write data outputted by executed command to
+     *
+     * @return  OutputStream
+     * @deprecated  since 3.0.0, use out() instead, will be removed with 4.0.0
+     */
+    public function getOutputStream()
+    {
+        return $this->out();
+    }
+
     /**
      * sets the redirect
      *
@@ -76,10 +87,11 @@ public function execute($command)
             throw new RuntimeException('Can not execute ' . $command);
         }
 
+        // must read all output even if we don't need it, otherwise we don't
+        // receive a correct return code when closing the process file pointer
         while (!feof($pd) && false !== ($line = fgets($pd, 4096))) {
-            $line = chop($line);
             if (null !== $this->out) {
-                $this->out->writeLine($line);
+                $this->out->writeLine(rtrim($line));
             }
         }
 
@@ -127,7 +139,7 @@ public function executeDirect($command)
 
         $result = [];
         while (!feof($pd) && false !== ($line = fgets($pd, 4096))) {
-            $result[] = chop($line);
+            $result[] = rtrim($line);
         }
 
         $returnCode = pclose($pd);

src/main/php/Executor.php

@@ -29,6 +29,14 @@ public function streamOutputTo(OutputStream $out);
      *
      * @return  OutputStream
      */
+    public function out();
+
+    /**
+     * returns the output stream to write data outputted by executed command to
+     *
+     * @return  OutputStream
+     * @deprecated  since 3.0.0, use out() instead, will be removed with 4.0.0
+     */
     public function getOutputStream();
 
     /**

src/test/php/ConsoleExecutorTest.php

@@ -38,15 +38,34 @@ public function redirectToReturnsItself()
         $this->assertSame($this->executor, $this->executor->redirectTo('2>&1'));
     }
 
+    /**
+     * @test
+     */
+    public function hasNoOutputStreamByDefault()
+    {
+        $this->assertNull($this->executor->out());
+    }
+
     /**
      * @test
      */
     public function executeWithoutOutputStream()
     {
-        $this->assertNull($this->executor->getOutputStream());
         $this->assertSame($this->executor, $this->executor->execute('echo foo'));
     }
 
+    /**
+     * @test
+     */
+    public function outReturnsOutputStreamOriginallySet()
+    {
+        $mockOutputStream = $this->getMock('stubbles\streams\OutputStream');
+        $this->assertSame(
+                $mockOutputStream,
+                $this->executor->streamOutputTo($mockOutputStream)->out()
+        );
+    }
+
     /**
      * @test
      */
@@ -56,9 +75,10 @@ public function executeWithOutputStreamWritesResponseDataToOutputStream()
         $mockOutputStream->expects($this->once())
                          ->method('writeLine')
                          ->with($this->equalTo('foo'));
-        $this->assertSame($this->executor, $this->executor->streamOutputTo($mockOutputStream));
-        $this->assertSame($mockOutputStream, $this->executor->getOutputStream());
-        $this->assertSame($this->executor, $this->executor->execute('echo foo'));
+        $this->assertSame(
+                $this->executor,
+                $this->executor->streamOutputTo($mockOutputStream)->execute('echo foo')
+        );
     }
 
     /**
@@ -133,5 +153,4 @@ public function executeDirectFailsThrowsRuntimeException()
     {
         $this->executor->executeDirect('php -r "throw new Exception();"');
     }
-
 }