[Console] applied comments from github

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit 49a46120148a28458b5e96b414e3d1bfe501a9ef
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -1005,33 +1005,6 @@ private function getConsoleMode()
         }
     }
 
-    /**
-     * Sorts commands in alphabetical order.
-     *
-     * @param array $commands An associative array of commands to sort
-     *
-     * @return array A sorted array of commands
-     */
-    private function sortCommands($commands)
-    {
-        $namespacedCommands = array();
-        foreach ($commands as $name => $command) {
-            $key = $this->extractNamespace($name, 1);
-            if (!$key) {
-                $key = '_global';
-            }
-
-            $namespacedCommands[$key][$name] = $command;
-        }
-        ksort($namespacedCommands);
-
-        foreach ($namespacedCommands as &$commands) {
-            ksort($commands);
-        }
-
-        return $namespacedCommands;
-    }
-
     /**
      * Returns abbreviated suggestions in string format.
      *
@@ -1052,7 +1025,7 @@ private function getAbbreviationSuggestions($abbrevs)
      *
      * @return string The namespace of the command
      */
-    private function extractNamespace($name, $limit = null)
+    public function extractNamespace($name, $limit = null)
     {
         $parts = explode(':', $name);
         array_pop($parts);

diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -277,7 +277,7 @@ public function setCode($code)
      *
      * @param Boolean $mergeArgs Whether to merge or not the Application definition arguments to Command definition arguments
      */
-    private function mergeApplicationDefinition($mergeArgs = true)
+    public function mergeApplicationDefinition($mergeArgs = true)
     {
         if (null === $this->application || true === $this->applicationDefinitionMerged) {
             return;
@@ -336,7 +336,7 @@ public function getDefinition()
      *
      * @return InputDefinition An InputDefinition instance
      */
-    protected function getNativeDefinition()
+    public function getNativeDefinition()
     {
         return $this->getDefinition();
     }

diff --git a/src/Symfony/Component/Console/Command/HelpCommand.php b/src/Symfony/Component/Console/Command/HelpCommand.php
@@ -31,7 +31,6 @@ class HelpCommand extends Command
      */
     protected function configure()
     {
-        parent::configure();
         $this->ignoreValidationErrors();
 
         $this

diff --git a/src/Symfony/Component/Console/Command/ListCommand.php b/src/Symfony/Component/Console/Command/ListCommand.php
@@ -30,8 +30,6 @@ class ListCommand extends Command
      */
     protected function configure()
     {
-        parent::configure();
-
         $this
             ->setName('list')
             ->setDescription('Lists commands')
@@ -60,7 +58,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function createDefinition()
+    private function createDefinition()
     {
         return new InputDefinition(array(
             new InputOption('format', null, InputOption::VALUE_REQUIRED, 'To output list in other formats.'),
@@ -73,7 +71,7 @@ protected function createDefinition()
     /**
      * {@inheritdoc}
      */
-    protected function getNativeDefinition()
+    public function getNativeDefinition()
     {
         return $this->createDefinition();
     }

diff --git a/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php b/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php
@@ -133,9 +133,21 @@ private function inspectApplication()
      */
     private function sortCommands(array $commands)
     {
-        $method = new \ReflectionMethod($this->application, 'sortCommands');
-        $method->setAccessible(true);
+        $namespacedCommands = array();
+        foreach ($commands as $name => $command) {
+            $key = $this->application->extractNamespace($name, 1);
+            if (!$key) {
+                $key = '_global';
+            }
+
+            $namespacedCommands[$key][$name] = $command;
+        }
+        ksort($namespacedCommands);
+
+        foreach ($namespacedCommands as &$commands) {
+            ksort($commands);
+        }
 
-        return $method->invoke($this->application, $commands);
+        return $namespacedCommands;
     }
 }
diff --git a/src/Symfony/Component/Console/Descriptor/CommandDescription.php b/src/Symfony/Component/Console/Descriptor/CommandDescription.php
diff --git a/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Descriptor\Json;
 
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <[email protected]>
@@ -24,17 +23,18 @@ class CommandJsonDescriptor extends AbstractJsonDescriptor
      */
     public function getData($object)
     {
-        $definitionDescriptor = new InputDefinitionJsonDescriptor();
         /** @var Command $object */
-        $description = new CommandDescription($object);
+        $object->getSynopsis();
+        $object->mergeApplicationDefinition(false);
+        $definitionDescriptor = new InputDefinitionJsonDescriptor();
 
         return array(
-            'name'        => $description->getName(),
-            'usage'       => $description->getSynopsis(),
-            'description' => $description->getDescription(),
-            'help'        => $description->getHelp(),
-            'aliases'     => $description->getAliases(),
-            'definition'  => $definitionDescriptor->getData($description->getDefinition()),
+            'name'        => $object->getName(),
+            'usage'       => $object->getSynopsis(),
+            'description' => $object->getDescription(),
+            'help'        => $object->getProcessedHelp(),
+            'aliases'     => $object->getAliases(),
+            'definition'  => $definitionDescriptor->getData($object->getNativeDefinition()),
         );
     }
 

diff --git a/src/Symfony/Component/Console/Descriptor/Markdown/CommandMarkdownDescriptor.php b/src/Symfony/Component/Console/Descriptor/Markdown/CommandMarkdownDescriptor.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Descriptor\Markdown;
 
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <[email protected]>
@@ -25,20 +24,21 @@ class CommandMarkdownDescriptor extends AbstractMarkdownDescriptor
     public function describe($object)
     {
         /** @var Command $object */
-        $description = new CommandDescription($object);
+        $object->getSynopsis();
+        $object->mergeApplicationDefinition(false);
         $definitionDescriptor = new InputDefinitionMarkdownDescriptor();
 
-        $markdown = $description->getName()."\n"
-            .str_repeat('-', strlen($description->getName()))."\n\n"
-            .'* Description: '.($description->getDescription() ?: '<none>')."\n"
-            .'* Usage: `'.$description->getSynopsis().'`'."\n"
-            .'* Aliases: '.(count($description->getAliases()) ? '`'.implode('`, `', $description->getAliases()).'`' : '<none>');
+        $markdown = $object->getName()."\n"
+            .str_repeat('-', strlen($object->getName()))."\n\n"
+            .'* Description: '.($object->getDescription() ?: '<none>')."\n"
+            .'* Usage: `'.$object->getSynopsis().'`'."\n"
+            .'* Aliases: '.(count($object->getAliases()) ? '`'.implode('`, `', $object->getAliases()).'`' : '<none>');
 
-        if ($description->getHelp()) {
-            $markdown .= "\n\n".$description->getHelp();
+        if ($help = $object->getProcessedHelp()) {
+            $markdown .= "\n\n".$help;
         }
 
-        $definitionMarkdown = $definitionDescriptor->describe($description->getDefinition());
+        $definitionMarkdown = $definitionDescriptor->describe($object->getNativeDefinition());
         if ($definitionMarkdown) {
             $markdown .= "\n\n".$definitionMarkdown;
         }

diff --git a/src/Symfony/Component/Console/Descriptor/Text/CommandTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/CommandTextDescriptor.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Descriptor\Text;
 
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <[email protected]>
@@ -33,17 +32,18 @@ public function getRawText($object)
     public function getFormattedText($object)
     {
         /** @var Command $object */
-        $description = new CommandDescription($object);
-        $messages = array('<comment>Usage:</comment>', ' '.$description->getSynopsis(), '');
+        $object->getSynopsis();
+        $object->mergeApplicationDefinition(false);
+        $messages = array('<comment>Usage:</comment>', ' '.$object->getSynopsis(), '');
 
         if ($object->getAliases()) {
-            $messages[] = '<comment>Aliases:</comment> <info>'.implode(', ', $description->getAliases()).'</info>';
+            $messages[] = '<comment>Aliases:</comment> <info>'.implode(', ', $object->getAliases()).'</info>';
         }
 
         $descriptor = new InputDefinitionTextDescriptor();
-        $messages[] = $descriptor->getFormattedText($description->getDefinition());
+        $messages[] = $descriptor->getFormattedText($object->getNativeDefinition());
 
-        if ($help = $description->getHelp()) {
+        if ($help = $object->getProcessedHelp()) {
             $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,7 +12,6 @@
 namespace Symfony\Component\Console\Descriptor\Xml;
 
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Descriptor\CommandDescription;
 
 /**
  * @author Jean-François Simon <[email protected]>
@@ -28,28 +27,29 @@ public function buildDocument(\DOMNode $parent, $object)
         $parent->appendChild($commandXML = $dom->createElement('command'));
 
         /** @var Command $object */
-        $description = new CommandDescription($object);
-
-        $commandXML->setAttribute('id', $description->getName());
-        $commandXML->setAttribute('name', $description->getName());
+        $object->getSynopsis();
+        $object->mergeApplicationDefinition(false);
+
+        $commandXML->setAttribute('id', $object->getName());
+        $commandXML->setAttribute('name', $object->getName());
 
         $commandXML->appendChild($usageXML = $dom->createElement('usage'));
-        $usageXML->appendChild($dom->createTextNode(sprintf($description->getSynopsis(), '')));
+        $usageXML->appendChild($dom->createTextNode(sprintf($object->getSynopsis(), '')));
 
         $commandXML->appendChild($descriptionXML = $dom->createElement('description'));
-        $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $description->getDescription())));
+        $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $object->getDescription())));
 
         $commandXML->appendChild($helpXML = $dom->createElement('help'));
-        $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $description->getHelp())));
+        $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $object->getProcessedHelp())));
 
         $commandXML->appendChild($aliasesXML = $dom->createElement('aliases'));
-        foreach ($description->getAliases() as $alias) {
+        foreach ($object->getAliases() as $alias) {
             $aliasesXML->appendChild($aliasXML = $dom->createElement('alias'));
             $aliasXML->appendChild($dom->createTextNode($alias));
         }
 
         $descriptor = new InputDefinitionXmlDescriptor();
-        $descriptor->buildDocument($commandXML, $description->getDefinition());
+        $descriptor->buildDocument($commandXML, $object->getNativeDefinition());
     }
 
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,7 +31,6 @@ class HelpCommand extends Command @@
          */
         protected function configure()
         {
-            parent::configure();
             $this->ignoreValidationErrors();
             $this
@@ Expand Down @@