Centralize input stream in base Input class

chalasr · chalasr · commit f7f23b98b3f2 · 2016-06-08T21:28:42.000+02:00
Add StreamableInputInterface
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -769,8 +769,8 @@ protected function configureIO(InputInterface $input, OutputInterface $output)
 
         if (true === $input->hasParameterOption(array('--no-interaction', '-n'), true)) {
             $input->setInteractive(false);
-        } elseif (function_exists('posix_isatty') && $this->getHelperSet()->has('question')) {
-            $inputStream = $this->getHelperSet()->get('question')->getInputStream();
+        } elseif (function_exists('posix_isatty')) {
+            $inputStream = $input->getStream();
             if (!@posix_isatty($inputStream) && false === getenv('SHELL_INTERACTIVE')) {
                 $input->setInteractive(false);
             }
diff --git a/src/Symfony/Component/Console/Helper/QuestionHelper.php b/src/Symfony/Component/Console/Helper/QuestionHelper.php
@@ -52,6 +52,10 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu
             return $question->getDefault();
         }
 
+        if ($stream = $input->getStream()) {
+            $this->inputStream = $stream;
+        }
+
         if (!$question->getValidator()) {
             return $this->doAsk($output, $question);
         }
@@ -74,6 +78,8 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu
      */
     public function setInputStream($stream)
     {
+        @trigger_error(sprintf('The setInputStream() method is deprecated since version 3.1 and will be removed in 4.0. Use %s:setStream() instead.', InputInterface::class), E_USER_DEPRECATED);
+
         if (!is_resource($stream)) {
             throw new InvalidArgumentException('Input stream must be a valid resource.');
         }
@@ -88,6 +94,8 @@ public function setInputStream($stream)
      */
     public function getInputStream()
     {
+        @trigger_error(sprintf('The getInputStream() method is deprecated since version 3.1 and will be removed in 4.0. Use %s:getStream() instead.', InputInterface::class), E_USER_DEPRECATED);
+
         return $this->inputStream;
     }
 
diff --git a/src/Symfony/Component/Console/Input/Input.php b/src/Symfony/Component/Console/Input/Input.php
@@ -25,12 +25,13 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-abstract class Input implements InputInterface
+abstract class Input implements InputInterface, StreamableInputInterface
 {
     /**
      * @var InputDefinition
      */
     protected $definition;
+    protected $stream;
     protected $options = array();
     protected $arguments = array();
     protected $interactive = true;
@@ -233,4 +234,20 @@ public function escapeToken($token)
     {
         return preg_match('{^[\w-]+$}', $token) ? $token : escapeshellarg($token);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setStream($stream)
+    {
+        $this->stream = $stream;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getStream()
+    {
+        return $this->stream;
+    }
 }
diff --git a/src/Symfony/Component/Console/Input/StreamableInputInterface.php b/src/Symfony/Component/Console/Input/StreamableInputInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Input;
+
+/**
+ * StreamableInputInterface is the interface implemented by all input classes
+ * that have an input stream.
+ *
+ * @author Robin Chalas <robin.chalas@gmail.com>
+ */
+interface StreamableInputInterface extends InputInterface
+{
+    /**
+     * Sets the input stream to read from when interacting with the user.
+     *
+     * This is mainly useful for testing purpose.
+     *
+     * @param resource $stream The input stream
+     */
+    public function setStream($stream);
+
+    /**
+     * Returns the input stream.
+     *
+     * @return resource|null
+     */
+    public function getStream();
+}
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -1099,7 +1099,7 @@ public function testCanCheckIfTerminalIsInteractive()
 
         $this->assertFalse($tester->getInput()->hasParameterOption(array('--no-interaction', '-n')));
 
-        $inputStream = $application->getHelperSet()->get('question')->getInputStream();
+        $inputStream = $tester->getInput()->getStream();
         $this->assertEquals($tester->getInput()->isInteractive(), @posix_isatty($inputStream));
     }
 }
diff --git a/src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/QuestionHelperTest.php
diff --git a/src/Symfony/Component/Console/Tests/Input/InputTest.php b/src/Symfony/Component/Console/Tests/Input/InputTest.php

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,10 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu`
`52`	`52`	`return $question->getDefault();`
`53`	`53`	`}`
`54`	`54`
	`55`	`+ if ($stream = $input->getStream()) {`
	`56`	`+ $this->inputStream = $stream;`
	`57`	`+ }`
	`58`	`+`
`55`	`59`	`if (!$question->getValidator()) {`
`56`	`60`	`return $this->doAsk($output, $question);`
`57`	`61`	`}`
`@@ -74,6 +78,8 @@ public function ask(InputInterface $input, OutputInterface $output, Question $qu`
`74`	`78`	`*/`
`75`	`79`	`public function setInputStream($stream)`
`76`	`80`	`{`
	`81`	`+ @trigger_error(sprintf('The setInputStream() method is deprecated since version 3.1 and will be removed in 4.0. Use %s:setStream() instead.', InputInterface::class), E_USER_DEPRECATED);`
	`82`	`+`
`77`	`83`	`if (!is_resource($stream)) {`
`78`	`84`	`throw new InvalidArgumentException('Input stream must be a valid resource.');`
`79`	`85`	`}`
`@@ -88,6 +94,8 @@ public function setInputStream($stream)`
`88`	`94`	`*/`
`89`	`95`	`public function getInputStream()`
`90`	`96`	`{`
	`97`	`+ @trigger_error(sprintf('The getInputStream() method is deprecated since version 3.1 and will be removed in 4.0. Use %s:getStream() instead.', InputInterface::class), E_USER_DEPRECATED);`
	`98`	`+`
`91`	`99`	`return $this->inputStream;`
`92`	`100`	`}`
`93`	`101`
Original file line number	Diff line number	Diff line change
`@@ -1099,7 +1099,7 @@ public function testCanCheckIfTerminalIsInteractive()`
`1099`	`1099`
`1100`	`1100`	`$this->assertFalse($tester->getInput()->hasParameterOption(array('--no-interaction', '-n')));`
`1101`	`1101`
`1102`		`- $inputStream = $application->getHelperSet()->get('question')->getInputStream();`
	`1102`	`+ $inputStream = $tester->getInput()->getStream();`
`1103`	`1103`	`$this->assertEquals($tester->getInput()->isInteractive(), @posix_isatty($inputStream));`
`1104`	`1104`	`}`
`1105`	`1105`	`}`