Support saving and restoring state. (consolidation#970)

mtk3d · Aug 30, 2020 · cf58ea6 · cf58ea6
1 parent 45842d0
commit cf58ea6
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 17 deletions.
diff --git a/.scenarios.lock/symfony4/composer.json b/.scenarios.lock/symfony4/composer.json
@@ -33,7 +33,7 @@
         "php": ">=7.1.3",
         "consolidation/config": "^1.2.1|^2",
         "consolidation/log": "^1.1.1|^2.0.1",
-        "consolidation/annotated-command": "^4.2",
+        "consolidation/annotated-command": "^4.2.1",
         "consolidation/output-formatters": "^4.1.1",
         "consolidation/self-update": "^1.2",
         "league/container": "^2.4.1"

diff --git a/.scenarios.lock/symfony4/composer.lock b/.scenarios.lock/symfony4/composer.lock
diff --git a/LICENSE b/LICENSE
@@ -22,7 +22,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 DEPENDENCY LICENSES:
 
 Name                                 Version  License
-consolidation/annotated-command      4.2.0    MIT
+consolidation/annotated-command      4.2.1    MIT
 consolidation/config                 2.0.0    MIT
 consolidation/log                    2.0.1    MIT
 consolidation/output-formatters      4.1.1    MIT

diff --git a/composer.json b/composer.json
@@ -24,7 +24,7 @@
         "php": ">=7.1.3",
         "consolidation/config": "^1.2.1|^2",
         "consolidation/log": "^1.1.1|^2.0.1",
-        "consolidation/annotated-command": "^4.2",
+        "consolidation/annotated-command": "^4.2.1",
         "consolidation/output-formatters": "^4.1.1",
         "consolidation/self-update": "^1.2",
         "league/container": "^2.4.1",

diff --git a/composer.lock b/composer.lock
diff --git a/src/Common/IO.php b/src/Common/IO.php
@@ -8,6 +8,8 @@
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Question\Question;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Consolidation\AnnotatedCommand\State\SavableState;
+use Consolidation\AnnotatedCommand\State\State;
 
 trait IO
 {
@@ -19,6 +21,39 @@ trait IO
      */
     protected $io;
 
+    public function currentState()
+    {
+        return new class($this, $this->input, $this->output, $this->io) implements State {
+            protected $obj;
+            protected $input;
+            protected $output;
+            protected $io;
+
+            public function __construct($obj, $input, $output, $io)
+            {
+                $this->obj = $obj;
+                $this->input = $input;
+                $this->output = $output;
+                $this->io = $io;
+            }
+
+            public function restore()
+            {
+                $this->obj->restoreState($this->input, $this->output, $this->io);
+            }
+        };
+    }
+
+    // This should typically only be called by State::restore()
+    public function restoreState(InputInterface $input = null, OutputInterface $output = null, SymfonyStyle $io = null)
+    {
+        $this->setInput($input);
+        $this->setOutput($output);
+        $this->io = $io;
+
+        return $this;
+    }
+
     public function setInput(InputInterface $input)
     {
         if ($input != $this->input) {

diff --git a/src/Contract/IOAwareInterface.php b/src/Contract/IOAwareInterface.php
@@ -7,7 +7,8 @@
 namespace Robo\Contract;
 
 use Symfony\Component\Console\Input\InputAwareInterface;
+use Consolidation\AnnotatedCommand\State\SavableState;
 
-interface IOAwareInterface extends OutputAwareInterface, InputAwareInterface
+interface IOAwareInterface extends OutputAwareInterface, InputAwareInterface, SavableState
 {
 }
diff --git a/tests/integration/CommandTesterTest.php b/tests/integration/CommandTesterTest.php
@@ -17,9 +17,9 @@ public function setUp()
     public function testInputApis()
     {
         list($tryInputOutput, $statusCode) = $this->executeCommand('try:input', ["I'm great!", "yes", "PHP", "1234"]);
-        $this->assertEquals(0, $statusCode);
         $this->assertContains("I'm great!", $tryInputOutput);
         $this->assertContains("PHP", $tryInputOutput);
         $this->assertContains("1234", $tryInputOutput);
+        $this->assertEquals(0, $statusCode);
     }
 }
diff --git a/tests/integration/RunnerTest.php b/tests/integration/RunnerTest.php
@@ -105,6 +105,7 @@ public function testCommandEventHook()
 
         $expected = <<<EOT
  This is the command-event hook for the test:command-event command.
+
  This is the main method for the test:command-event command.
  This is the post-command hook for the test:command-event command.
 EOT;