Merge pull request #440 from consolidation-org/symfony-style

Add accessor for SymfonyStyle object.

docs/getting-started.md

@@ -316,6 +316,12 @@ $name = $this->ask("What is your name?");
 
 There are also `askDefault`, `askHidden`, and `confirm` methods.
 
+In addition, Robo makes all of the methods of Symfony Style available throgh the `io()` method:
+
+$this->io()->title("Build all site assets");
+
+This allows Robo scripts to follow the [Symfony Console Style Guide](http://symfony.com/blog/new-in-symfony-2-8-console-style-guide) if desired.
+
 ### Formatters
 
 It is preferable for commands that look up and display information should avoid doing IO directly, and should instead return the data they wish to display as an array. This data can then be converted into different data formats, such as "table" and "json". The user may select which formatter to use via the --format option. For details on formatters, see the [consolidation/output-formatters](https://github.com/consolidation-org/output-formatters) project.

src/Common/IO.php

@@ -9,12 +9,29 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Question\Question;
+use Symfony\Component\Console\Style\SymfonyStyle;
 
 trait IO
 {
     use InputAwareTrait;
     use OutputAwareTrait;
 
+    /** var: SymfonyStyle */
+    protected $io;
+
+    /**
+     * Provide access to SymfonyStyle object.
+     * See: http://symfony.com/blog/new-in-symfony-2-8-console-style-guide
+     * @return SymfonyStyle
+     */
+    protected function io()
+    {
+        if (!$this->io) {
+            $this->io = new SymfonyStyle($this->input(), $this->output());
+        }
+        return $this->io;
+    }
+
     protected function decorationCharacter($nonDecorated, $decorated)
     {
         if (!$this->output()->isDecorated() || (strncasecmp(PHP_OS, 'WIN', 3) == 0)) {

tests/src/TestRoboFile.php

@@ -23,6 +23,19 @@ public function testArrayArgs(array $a)
         $this->say("The parameters passed are:\n" . var_export($a, true));
     }
 
+    /**
+     * Demonstrate use of SymfonyStyle
+     */
+    public function testSymfonyStyle()
+    {
+        $this->io()->title('My Title');
+        $this->io()->section('Section 1');
+        $this->io()->text('Some text in section one.');
+        $this->io()->comment('This is just an example of different styles.');
+        $this->io()->section('Section 2');
+        $this->io()->text('Some text in section two.');
+    }
+
     /**
      * Demonstrate Robo error output and command failure.
      */

tests/unit/RunnerTest.php

@@ -106,6 +106,13 @@ public function testRunnerTryArgs()
         $this->guy->seeOutputEquals($expected);
     }
 
+    public function testSymfonyStyle()
+    {
+        $argv = ['placeholder', 'test:symfony-style'];
+        $this->runner->execute($argv, Robo::output());
+        $this->guy->seeInOutput('Some text in section one.');
+    }
+
     public function testRunnerTryError()
     {
         $argv = ['placeholder', 'test:error'];