[Console] repaired tests

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit 27aa872544b8ef0161dba00c9214cc40caff4a92
diff --git a/src/Symfony/Component/Console/Command/AbstractDescriptionCommand.php b/src/Symfony/Component/Console/Command/AbstractDescriptionCommand.php
@@ -39,8 +39,8 @@ protected function configure()
     protected function createDefinition()
     {
         return new InputDefinition(array(
-            new InputOption('format', null, InputOption::VALUE_REQUIRED, 'To output help in other formats'),
-            new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command list'),
+            new InputOption('format', null, InputOption::VALUE_REQUIRED, 'To output help in other formats.'),
+            new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command list.'),
         ));
     }
 

diff --git a/src/Symfony/Component/Console/Descriptor/CommandDescription.php b/src/Symfony/Component/Console/Descriptor/CommandDescription.php
@@ -0,0 +1,85 @@
+<?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\Descriptor;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputDefinition;
+
+/**
+ * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
+ */
+class CommandDescription
+{
+    /**
+     * @var Command
+     */
+    private $command;
+
+    /**
+     * @param Command $command
+     */
+    public function __construct(Command $command)
+    {
+        $this->command = $command;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->command->getName();
+    }
+
+    /**
+     * @return string
+     */
+    public function getDescription()
+    {
+        return $this->command->getDescription();
+    }
+
+    /**
+     * @return array
+     */
+    public function getAliases()
+    {
+        return $this->command->getAliases();
+    }
+
+    /**
+     * @return string
+     */
+    public function getSynopsis()
+    {
+        return $this->command->getSynopsis();
+    }
+
+    /**
+     * @return string
+     */
+    public function getHelp()
+    {
+        return $this->command->getProcessedHelp();
+    }
+
+    /**
+     * @return InputDefinition
+     */
+    public function getDefinition()
+    {
+        $method = new \ReflectionMethod($this->command, 'getNativeDefinition');
+        $method->setAccessible(true);
+
+        return $method->invoke($this->command);
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Descriptor\Json;
 
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <contact@jfsimon.fr>
@@ -24,15 +25,16 @@ class CommandJsonDescriptor extends AbstractJsonDescriptor
     public function getData($object)
     {
         $definitionDescriptor = new InputDefinitionJsonDescriptor();
-
         /** @var Command $object */
+        $description = new CommandDescription($object);
+
         return array(
-            'name'        => $object->getName(),
-            'usage'       => $object->getSynopsis(),
-            'description' => $object->getDescription(),
-            'help'        => $object->getProcessedHelp(),
-            'aliases'     => $object->getAliases(),
-            'definition'  => $definitionDescriptor->getData($object->getDefinition()),
+            'name'        => $description->getName(),
+            'usage'       => $description->getSynopsis(),
+            'description' => $description->getDescription(),
+            'help'        => $description->getHelp(),
+            'aliases'     => $description->getAliases(),
+            'definition'  => $definitionDescriptor->getData($description->getDefinition()),
         );
     }
 

diff --git a/src/Symfony/Component/Console/Descriptor/Markdown/CommandMarkdownDescriptor.php b/src/Symfony/Component/Console/Descriptor/Markdown/CommandMarkdownDescriptor.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Descriptor\Markdown;
 
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <contact@jfsimon.fr>
@@ -23,20 +24,19 @@ class CommandMarkdownDescriptor extends AbstractMarkdownDescriptor
      */
     public function getDocument($object)
     {
+        /** @var Command $object */
+        $description = new CommandDescription($object);
         $definitionDescriptor = new InputDefinitionMarkdownDescriptor();
 
-        $object->getProcessedHelp();
-
-        /** @var Command $object */
         return new Document\Document(array(
-            new Document\Title($object->getName(), 2),
+            new Document\Title($description->getName(), 2),
             new Document\UnorderedList(array(
-                'Description: '.($object->getDescription() ?: '<none>'),
-                'Usage: `'.$object->getSynopsis().'`',
-                'Aliases: '.(count($object->getAliases()) ? '`'.implode('`, `', $object->getAliases()).'`' : '<none>'),
+                'Description: '.($description->getDescription() ?: '<none>'),
+                'Usage: `'.$description->getSynopsis().'`',
+                'Aliases: '.(count($description->getAliases()) ? '`'.implode('`, `', $description->getAliases()).'`' : '<none>'),
             )),
-            new Document\Paragraph($object->getProcessedHelp()),
-            $definitionDescriptor->getDocument($object->getDefinition()),
+            new Document\Paragraph($description->getHelp()),
+            $definitionDescriptor->getDocument($description->getDefinition()),
         ));
     }
 

diff --git a/sr F438 c/Symfony/Component/Console/Descriptor/Text/AbstractTextDescriptor.php b/sr F438 c/Symfony/Component/Console/Descriptor/Text/AbstractTextDescriptor.php
@@ -82,7 +82,7 @@ public function getFormat()
      */
     public function useFormatting()
     {
-        return false;
+        return true;
     }
 
     protected function formatDefaultValue($default)

diff --git a/src/Symfony/Component/Console/Descriptor/Text/CommandTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/CommandTextDescriptor.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Descriptor\Text;
 
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Descriptor\CommandDescription;
 use Symfony\Component\Console\Input\InputDefinition;
 
 /**
@@ -33,16 +34,17 @@ public function getRawText($object)
     public function getFormattedText($object)
     {
         /** @var Command $object */
-        $messages = array('<comment>Usage:</comment>', ' '.$object->getSynopsis(), '');
+        $description = new CommandDescription($object);
+        $messages = array('<comment>Usage:</comment>', ' '.$description->getSynopsis(), '');
 
         if ($object->getAliases()) {
-            $messages[] = '<comment>Aliases:</comment> <info>'.implode(', ', $object->getAliases()).'</info>';
+            $messages[] = '<comment>Aliases:</comment> <info>'.implode(', ', $description->getAliases()).'</info>';
         }
 
         $descriptor = new InputDefinitionTextDescriptor();
-        $messages[] = $descriptor->getFormattedText($object->getDefinition());
+        $messages[] = $descriptor->getFormattedText($description->getDefinition());
 
-        if ($help = $object->getProcessedHelp()) {
+        if ($help = $description->getHelp()) {
             $messages[] = '<comment>Help:</comment>';
             $messages[] = ' '.str_replace("\n", "\n ", $help)."\n";
         }

diff --git a/src/Symfony/Component/Console/Descriptor/Xml/CommandXmlDescriptor.php b/src/Symfony/Component/Console/Descriptor/Xml/CommandXmlDescriptor.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Descriptor\Xml;
 
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <contact@jfsimon.fr>
@@ -27,26 +28,28 @@ public function buildDocument(\DOMNode $parent, $object)
         $parent->appendChild($commandXML = $dom->createElement('command'));
 
         /** @var Command $object */
-        $commandXML->setAttribute('id', $object->getName());
-        $commandXML->setAttribute('name', $object->getName());
+        $description = new CommandDescription($object);
+
+        $commandXML->setAttribute('id', $description->getName());
+        $commandXML->setAttribute('name', $description->getName());
 
         $commandXML->appendChild($usageXML = $dom->createElement('usage'));
-        $usageXML->appendChild($dom->createTextNode(sprintf($object->getSynopsis(), '')));
+        $usageXML->appendChild($dom->createTextNode(sprintf($description->getSynopsis(), '')));
 
         $commandXML->appendChild($descriptionXML = $dom->createElement('description'));
-        $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $object->getDescription())));
+        $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $description->getDescription())));
 
         $commandXML->appendChild($helpXML = $dom->createElement('help'));
-        $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $object->getProcessedHelp())));
+        $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $description->getHelp())));
 
         $commandXML->appendChild($aliasesXML = $dom->createElement('aliases'));
-        foreach ($object->getAliases() as $alias) {
+        foreach ($description->getAliases() as $alias) {
             $aliasesXML->appendChild($aliasXML = $dom->createElement('alias'));
             $aliasXML->appendChild($dom->createTextNode($alias));
         }
 
         $descriptor = new InputDefinitionXmlDescriptor();
-        $descriptor->buildDocument($commandXML, $object->getDefinition());
+        $descriptor->buildDocument($commandXML, $description->getDefinition());
     }
 
     /**

diff --git a/src/Symfony/Component/Console/Helper/DescriptorHelper.php b/src/Symfony/Component/Console/Helper/DescriptorHelper.php
@@ -48,7 +48,7 @@ public function describe(OutputInterface $output, $object, $format = null, $raw
     {
         $format = $format ?: $this->provider->getDefaultFormat();
         $descriptor = $this->provider->configure(array('raw_text' => $raw))->get($object, $format);
-        $type = $raw && $descriptor->useFormatting() ? OutputInterface::OUTPUT_NORMAL : OutputInterface::OUTPUT_RAW;
+        $type = !$raw && $descriptor->useFormatting() ? OutputInterface::OUTPUT_NORMAL : OutputInterface::OUTPUT_RAW;
 
         $output->writeln($descriptor->describe($object), $type);
     }

diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_1.json b/src/Symfony/Component/Console/Tests/Fixtures/application_1.json
@@ -1 +1 @@
-{"commands":[{"name":"help","usage":"help [--format=\"...\"] [--raw] [command_name]","description":"Displays help for a command","help":"The <info>help<\/info> command displays help for a given command:\n\n  <info>php app\/console help list<\/info>\n\nYou can also output the help in other formats by using the <comment>--format<\/comment> option:\n\n  <info>php app\/console help --format=xml list<\/info>\n\nTo display the list of available commands, please use the <info>list<\/info> command.","aliases":[],"definition":{"arguments":{"command_name":{"name":"command_name","is_required":false,"is_array":false,"description":"The command name","default":"help"}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list","default":false}}}},{"name":"list","usage":"list [--format=\"...\"] [--raw] [namespace]","description":"Lists commands","help":"The <info>list<\/info> command lists all commands:\n\n  <info>php app\/console list<\/info>\n\nYou can also display the commands for a specific namespace:\n\n  <info>php app\/console list test<\/info>\n\nYou can also output the information in other formats by using the <comment>--format<\/comment> option:\n\n  <info>php app\/console list --format=xml<\/info>\n\nIt's also possible to get raw list of commands (useful for embedding command runner):\n\n  <info>php app\/console list --raw<\/info>","aliases":[],"definition":{"arguments":{"namespace":{"name":"namespace","is_required":false,"is_array":false,"description":"The namespace name","default":null}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list","default":false}}}}],"namespaces":[{"id":"_global","commands":["help","list"]}]}
+{"commands":[{"name":"help","usage":"help [--format=\"...\"] [--raw] [command_name]","description":"Displays help for a command","help":"The <info>help<\/info> command displays help for a given command:\n\n  <info>php app\/console help list<\/info>\n\nYou can also output the help in other formats by using the <comment>--format<\/comment> option:\n\n  <info>php app\/console help --format=xml list<\/info>\n\nTo display the list of available commands, please use the <info>list<\/info> command.","aliases":[],"definition":{"arguments":{"command_name":{"name":"command_name","is_required":false,"is_array":false,"description":"The command name","default":"help"}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats.","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list.","default":false}}}},{"name":"list","usage":"list [--format=\"...\"] [--raw] [namespace]","description":"Lists commands","help":"The <info>list<\/info> command lists all commands:\n\n  <info>php app\/console list<\/info>\n\nYou can also display the commands for a specific namespace:\n\n  <info>php app\/console list test<\/info>\n\nYou can also output the information in other formats by using the <comment>--format<\/comment> option:\n\n  <info>php app\/console list --format=xml<\/info>\n\nIt's also possible to get raw list of commands (useful for embedding command runner):\n\n  <info>php app\/console list --raw<\/info>","aliases":[],"definition":{"arguments":{"namespace":{"name":"namespace","is_required":false,"is_array":false,"description":"The namespace name","default":null}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats.","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list.","default":false}}}}],"namespaces":[{"id":"_global","commands":["help","list"]}]}
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_1.md b/src/Symfony/Component/Console/Tests/Fixtures/application_1.md
@@ -40,7 +40,7 @@ To display the list of available commands, please use the <info>list</info> comm
 * Accept value: yes
 * Is value required: yes
 * Is multiple: no
-* Description: To output help in other formats
+* Description: To output help in other formats.
 * Default: `NULL`
 
 **raw:**
@@ -50,7 +50,7 @@ To display the list of available commands, please use the <info>list</info> comm
 * Accept value: no
 * Is value required: no
 * Is multiple: no
-* Description: To output raw command list
+* Description: To output raw command list.
 * Default: `false`
 
 list
@@ -95,7 +95,7 @@ It's also possible to get raw list of commands (useful for embedding command run
 * Accept value: yes
 * Is value required: yes
 * Is multiple: no
-* Description: To output help in other formats
+* Description: To output help in other formats.
 * Default: `NULL`
 
 **raw:**
@@ -105,5 +105,5 @@ It's also possible to get raw list of commands (useful for embedding command run
 * Accept value: no
 * Is value required: no
 * Is multiple: no
-* Description: To output raw command list
+* Description: To output raw command list.
 * Default: `false`
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_1.xml b/src/Symfony/Component/Console/Tests/Fixtures/application_1.xml
@@ -24,10 +24,10 @@
       </arguments>
       <options>
         <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
-          <description>To output help in other formats</description>
+          <description>To output help in other formats.</description>
         </option>
         <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
-          <description>To output raw command list</description>
+          <description>To output raw command list.</description>
         </option>
       </options>
     </command>
@@ -58,10 +58,10 @@
       </arguments>
       <options>
         <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
-          <description>To output help in other formats</description>
+          <description>To output help in other formats.</description>
         </option>
         <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
-          <description>To output raw command list</description>
+          <description>To output raw command list.</description>
         </option>
       </options>
     </command>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"commands":[{"name":"help","usage":"help [--format=\"...\"] [--raw] [command_name]","description":"Displays help for a command","help":"The <info>help<\/info> command displays help for a given command:\n\n <info>php app\/console help list<\/info>\n\nYou can also output the help in other formats by using the <comment>--format<\/comment> option:\n\n <info>php app\/console help --format=xml list<\/info>\n\nTo display the list of available commands, please use the <info>list<\/info> command.","aliases":[],"definition":{"arguments":{"command_name":{"name":"command_name","is_required":false,"is_array":false,"description":"The command name","default":"help"}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list","default":false}}}},{"name":"list","usage":"list [--format=\"...\"] [--raw] [namespace]","description":"Lists commands","help":"The <info>list<\/info> command lists all commands:\n\n <info>php app\/console list<\/info>\n\nYou can also display the commands for a specific namespace:\n\n <info>php app\/console list test<\/info>\n\nYou can also output the information in other formats by using the <comment>--format<\/comment> option:\n\n <info>php app\/console list --format=xml<\/info>\n\nIt's also possible to get raw list of commands (useful for embedding command runner):\n\n <info>php app\/console list --raw<\/info>","aliases":[],"definition":{"arguments":{"namespace":{"name":"namespace","is_required":false,"is_array":false,"description":"The namespace name","default":null}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list","default":false}}}}],"namespaces":[{"id":"_global","commands":["help","list"]}]}
		{"commands":[{"name":"help","usage":"help [--format=\"...\"] [--raw] [command_name]","description":"Displays help for a command","help":"The <info>help<\/info> command displays help for a given command:\n\n <info>php app\/console help list<\/info>\n\nYou can also output the help in other formats by using the <comment>--format<\/comment> option:\n\n <info>php app\/console help --format=xml list<\/info>\n\nTo display the list of available commands, please use the <info>list<\/info> command.","aliases":[],"definition":{"arguments":{"command_name":{"name":"command_name","is_required":false,"is_array":false,"description":"The command name","default":"help"}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats.","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list.","default":false}}}},{"name":"list","usage":"list [--format=\"...\"] [--raw] [namespace]","description":"Lists commands","help":"The <info>list<\/info> command lists all commands:\n\n <info>php app\/console list<\/info>\n\nYou can also display the commands for a specific namespace:\n\n <info>php app\/console list test<\/info>\n\nYou can also output the information in other formats by using the <comment>--format<\/comment> option:\n\n <info>php app\/console list --format=xml<\/info>\n\nIt's also possible to get raw list of commands (useful for embedding command runner):\n\n <info>php app\/console list --raw<\/info>","aliases":[],"definition":{"arguments":{"namespace":{"name":"namespace","is_required":false,"is_array":false,"description":"The namespace name","default":null}},"options":{"format":{"name":"--format","shortcut":"","accept_value":true,"is_value_required":true,"is_multiple":false,"description":"To output help in other formats.","default":null},"raw":{"name":"--raw","shortcut":"","accept_value":false,"is_value_required":false,"is_multiple":false,"description":"To output raw command list.","default":false}}}}],"namespaces":[{"id":"_global","commands":["help","list"]}]}