[Console] re-introduced asText & asXml methods to avoid BC break

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit 30d88073111a460ff947955ebd35adc98951b50a
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Console;
 
+use Symfony\Component\Console\Descriptor\Text\ApplicationTextDescriptor;
+use Symfony\Component\Console\Descriptor\Xml\ApplicationXmlDescriptor;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Input\ArrayInput;
@@ -680,6 +682,47 @@ public static function getAbbreviations($names)
         return $abbrevs;
     }
 
+    /**
+     * Returns a text representation of the Application.
+     *
+     * @param string  $namespace An optional namespace name
+     * @param boolean $raw       Whether to return raw command list
+     *
+     * @return string A string representing the Application
+     *
+     * @deprecated
+     */
+    public function asText($namespace = null, $raw = false)
+    {
+        $descriptor = new ApplicationTextDescriptor($namespace, $raw);
+
+        return $descriptor->describe($this);
+    }
+
+    /**
+     * Returns an XML representation of the Application.
+     *
+     * @param string  $namespace An optional namespace name
+     * @param Boolean $asDom     Whether to return a DOM or an XML string
+     *
+     * @return string|\DOMDocument An XML string representing the Application
+     *
+     * @deprecated
+     */
+    public function asXml($namespace = null, $asDom = false)
+    {
+        $descriptor = new ApplicationXmlDescriptor($namespace);
+
+        if ($asDom) {
+            $dom = new \DOMDocument('1.0', 'UTF-8');
+            $descriptor->buildDocument($dom, $this);
+
+            return $dom;
+        }
+
+        return $descriptor->describe($this);
+    }
+
     /**
      * Renders a caught exception.
      *

diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Console\Command;
 
+use Symfony\Component\Console\Descriptor\Text\CommandTextDescriptor;
+use Symfony\Component\Console\Descriptor\Xml\CommandXmlDescriptor;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
@@ -555,6 +557,43 @@ public function getHelper($name)
         return $this->helperSet->get($name);
     }
 
+    /**
+     * Returns a text representation of the command.
+     *
+     * @return string A string representing the command
+     *
+     * @deprecated
+     */
+    public function asText()
+    {
+        $descriptor = new CommandTextDescriptor();
+
+        return $descriptor->describe($this);
+    }
+
+    /**
+     * Returns an XML representation of the command.
+     *
+     * @param Boolean $asDom Whether to return a DOM or an XML string
+     *
+     * @return string|\DOMDocument An XML string representing the command
+     *
+     * @deprecated
+     */
+    public function asXml($asDom = false)
+    {
+        $descriptor = new CommandXmlDescriptor();
+
+        if ($asDom) {
+            $dom = new \DOMDocument('1.0', 'UTF-8');
+            $descriptor->buildDocument($dom, $this);
+
+            return $dom;
+        }
+
+        return $descriptor->describe($this);
+    }
+
     private function validateName($name)
     {
         if (!preg_match('/^[^\:]+(\:[^\:]+)*$/', $name)) {

diff --git a/src/Symfony/Component/Console/Descriptor/Xml/InputOptionXmlDescriptor.php b/src/Symfony/Component/Console/Descriptor/Xml/InputOptionXmlDescriptor.php
@@ -37,9 +37,9 @@ public function buildDocument(\DOMNode $parent, $object)
 
         if ($object->acceptValue()) {
             $defaults = is_array($object->getDefault()) ? $object->getDefault() : (is_bool($object->getDefault()) ? array(var_export($object->getDefault(), true)) : ($object->getDefault() ? array($object->getDefault()) : array()));
+            $objectXML->appendChild($defaultsXML = $dom->createElement('defaults'));
 
             if (!empty($defaults)) {
-                $objectXML->appendChild($defaultsXML = $dom->createElement('defaults'));
                 foreach ($defaults as $default) {
                     $defaultsXML->appendChild($defaultXML = $dom->createElement('default'));
                     $defaultXML->appendChild($dom->createTextNode($default));

diff --git a/src/Symfony/Component/Console/Input/InputDefinition.php b/src/Symfony/Component/Console/Input/InputDefinition.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Console\Input;
 
+use Symfony\Component\Console\Descriptor\Text\InputDefinitionTextDescriptor;
+use Symfony\Component\Console\Descriptor\Xml\InputDefinitionXmlDescriptor;
+
 /**
  * A InputDefinition represents a set of valid command line arguments and options.
  *
@@ -399,4 +402,42 @@ public function getSynopsis()
 
         return implode(' ', $elements);
     }
+
+
+    /**
+     * Returns a textual representation of the InputDefinition.
+     *
+     * @return string A string representing the InputDefinition
+     *
+     * @deprecated
+     */
+    public function asText()
+    {
+        $descriptor = new InputDefinitionTextDescriptor();
+
+        return $descriptor->describe($this);
+    }
+
+    /**
+     * Returns an XML representation of the InputDefinition.
+     *
+     * @param Boolean $asDom Whether to return a DOM or an XML string
+     *
+     * @return string|\DOMDocument An XML string representing the InputDefinition
+     *
+     * @deprecated
+     */
+    public function asXml($asDom = false)
+    {
+        $descriptor = new InputDefinitionXmlDescriptor();
+
+        if ($asDom) {
+            $dom = new \DOMDocument('1.0', 'UTF-8');
+            $descriptor->buildDocument($dom, $this);
+
+            return $dom;
+        }
+
+        return $descriptor->describe($this);
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -392,6 +392,24 @@ public function testSetCatchExceptions()
         }
     }
 
+    public function testAsText()
+    {
+        $application = new Application();
+        $application->add(new \FooCommand);
+        $this->ensureStaticCommandHelp($application);
+        $this->assertStringEqualsFile(self::$fixturesPath.'/application_astext1.txt', $this->normalizeLineBreaks($application->asText()), '->asText() returns a text representation of the application');
+        $this->assertStringEqualsFile(self::$fixturesPath.'/application_astext2.txt', $this->normalizeLineBreaks($application->asText('foo')), '->asText() returns a text representation of the application');
+    }
+
+    public function testAsXml()
+    {
+        $application = new Application();
+        $application->add(new \FooCommand);
+        $this->ensureStaticCommandHelp($application);
+        $this->assertXmlStringEqualsXmlFile(self::$fixturesPath.'/application_asxml1.txt', $application->asXml(), '->asXml() returns an XML representation of the application');
+        $this->assertXmlStringEqualsXmlFile(self::$fixturesPath.'/application_asxml2.txt', $application->asXml('foo'), '->asXml() returns an XML representation of the application');
+    }
+
     public function testRenderException()
     {
         $application = $this->getMock('Symfony\Component\Console\Application', array('getTerminalWidth'));

diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -280,4 +280,22 @@ public function callableMethodCommand(InputInterface $input, OutputInterface $ou
     {
         $output->writeln('from the code...');
     }
+
+    public function testAsText()
+    {
+        $command = new \TestCommand();
+        $command->setApplication(new Application());
+        $tester = new CommandTester($command);
+        $tester->execute(array('command' => $command->getName()));
+        $this->assertStringEqualsFile(self::$fixturesPath.'/command_astext.txt', $command->asText(), '->asText() returns a text representation of the command');
+    }
+
+    public function testAsXml()
+    {
+        $command = new \TestCommand();
+        $command->setApplication(new Application());
+        $tester = new CommandTester($command);
+        $tester->execute(array('command' => $command->getName()));
+        $this->assertXmlStringEqualsXmlFile(self::$fixturesPath.'/command_asxml.txt', $command->asXml(), '->asXml() returns an XML representation of the command');
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_1.xml b/src/Symfony/Component/Console/Tests/Fixtures/application_1.xml
@@ -25,6 +25,7 @@
       <options>
         <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
           <description>To output help in other formats.</description>
+          <defaults/>
         </option>
         <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
           <description>To output raw command list.</description>
@@ -59,6 +60,7 @@
       <options>
         <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
           <description>To output help in other formats.</description>
+          <defaults/>
         </option>
         <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
           <description>To output raw command list.</description>

diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_2.xml b/src/Symfony/Component/Console/Tests/Fixtures/application_2.xml
@@ -25,6 +25,7 @@
       <options>
         <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
           <description>To output help in other formats.</description>
+          <defaults/>
         </option>
         <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
           <description>To output raw command list.</description>
@@ -59,6 +60,7 @@
       <options>
         <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
           <description>To output help in other formats.</description>
+          <defaults/>
         </option&
F42D
gt;
         <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
           <description>To output raw command list.</description>

diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_astext1.txt b/src/Symfony/Component/Console/Tests/Fixtures/application_astext1.txt
@@ -0,0 +1,20 @@
+<info>Console Tool</info>
+
+<comment>Usage:</comment>
+  [options] command [arguments]
+
+<comment>Options:</comment>
+  <info>--help</info>           <info>-h</info> Display this help message.
+  <info>--quiet</info>          <info>-q</info> Do not output any message.
+  <info>--verbose</info>        <info>-v</info> Increase verbosity of messages.
+  <info>--version</info>        <info>-V</info> Display this application version.
+  <info>--ansi</info>              Force ANSI output.
+  <info>--no-ansi</info>           Disable ANSI output.
+  <info>--no-interaction</info> <info>-n</info> Do not ask any interactive question.
+
+<comment>Available commands:</comment>
+  <info>afoobar  </info> The foo:bar command
+  <info>help     </info> Displays help for a command
+  <info>list     </info> Lists commands
+<comment>foo</comment>
+  <info>foo:bar  </info> The foo:bar command
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_astext2.txt b/src/Symfony/Component/Console/Tests/Fixtures/application_astext2.txt
@@ -0,0 +1,16 @@
+<info>Console Tool</info>
+
+<comment>Usage:</comment>
+  [options] command [arguments]
+
+<comment>Options:</comment>
+  <info>--help</info>           <info>-h</info> Display this help message.
+  <info>--quiet</info>          <info>-q</info> Do not output any message.
+  <info>--verbose</info>        <info>-v</info> Increase verbosity of messages.
+  <info>--version</info>        <info>-V</info> Display this application version.
+  <info>--ansi</info>              Force ANSI output.
+  <info>--no-ansi</info>           Disable ANSI output.
+  <info>--no-interaction</info> <info>-n</info> Do not ask any interactive question.
+
+<comment>Available commands for the "foo" namespace:</comment>
+  <info>foo:bar  </info> The foo:bar command