[Console] finished text descriptors

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit 8b56eb19ced08cd61e282377f3991478b75a5ef0
diff --git a/src/Symfony/Component/Console/Command/AbstractDescriptionCommand.php b/src/Symfony/Component/Console/Command/AbstractDescriptionCommand.php
@@ -4,6 +4,7 @@
 
 use Symfony\Component\Console\Descriptor\DescriptorProvider;
 use Symfony\Component\Console\Helper\DescriptorHelper;
+use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -48,6 +49,10 @@ protected function createDefinition()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        if (null === $this->getHelperSet()) {
+            $this->setHelperSet(new HelperSet());
+        }
+
         $this->getHelperSet()->set(new DescriptorHelper($this->provider));
     }
 }
diff --git a/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php b/src/Symfony/Component/Console/Descriptor/ApplicationDescription.php
@@ -41,6 +41,11 @@ class ApplicationDescription
      */
     private $commands;
 
+    /**
+     * @var Command[]
+     */
+    private $aliases;
+
     /**
      * Constructor.
      *
@@ -86,11 +91,11 @@ public function getCommands()
      */
     public function getCommand($name)
     {
-        if (!isset($this->commands[$name])) {
+        if (!isset($this->commands[$name]) && !isset($this->aliases[$name])) {
             throw new \InvalidArgumentException('Command "'.$name.'" does not exist.');
         }
 
-        return $this->commands[$name];
+        return isset($this->commands[$name]) ? $this->commands[$name] : $this->aliases[$name];
     }
 
     private function inspectApplication()
@@ -108,9 +113,10 @@ private function inspectApplication()
                     continue;
                 }
 
-                // aliases must be skipped in commands list
-                if ($name === $command->getName()) {
+                if ($command->getName() === $name) {
                     $this->commands[$name] = $command;
+                } else {
+                    $this->aliases[$name] = $command;
                 }
 
                 $names[] = $name;

diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php b/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php
@@ -43,6 +43,11 @@ public function __construct(array $options = array())
     {
         $this
             ->configure($options)
+            ->add(new Text\ApplicationTextDescriptor())
+            ->add(new Text\CommandTextDescriptor())
+            ->add(new Text\InputDefinitionTextDescriptor())
+            ->add(new Text\InputArgumentTextDescriptor())
+            ->add(new Text\InputOptionTextDescriptor())
             ->add(new Xml\ApplicationXmlDescriptor())
             ->add(new Xml\CommandXmlDescriptor())
             ->add(new Xml\InputDefinitionXmlDescriptor())

diff --git a/src/Symfony/Component/Console/Descriptor/Json/ApplicationJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/ApplicationJsonDescriptor.php
@@ -54,10 +54,10 @@ public function getData($object)
         /** @var Application $object */
         $description = new ApplicationDescription($object, $this->namespace);
         $descriptor = new CommandJsonDescriptor();
-        $commands = array_map(array($descriptor, 'getData'), $description->getCommands());
+        $commands = array_values(array_map(array($descriptor, 'getData'), $description->getCommands()));
 
         return null === $this->namespace
-            ? array('commands' => $commands, 'namespaces' => $description->getNamespaces())
+            ? array('commands' => $commands, 'namespaces' => array_values($description->getNamespaces()))
             : array('commands' => $commands, 'namespace' => $this->namespace);
     }
 

diff --git a/src/Symfony/Component/Console/Descriptor/Text/AbstractTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/AbstractTextDescriptor.php
@@ -84,4 +84,13 @@ public function useFormatting()
     {
         return false;
     }
+
+    protected function formatDefaultValue($default)
+    {
+        if (version_compare(PHP_VERSION, '5.4', '<')) {
+            return str_replace('\/', '/', json_encode($default));
+        }
+
+        return json_encode($default, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+    }
 }
diff --git a/src/Symfony/Component/Console/Descriptor/Text/ApplicationTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/ApplicationTextDescriptor.php
@@ -27,10 +27,12 @@ class ApplicationTextDescriptor extends AbstractTextDescriptor
 
     /**
      * @param string|null $namespace
+     * @param bool        $raw
      */
-    public function __construct($namespace = null)
+    public function __construct($namespace = null, $raw = false)
     {
         $this->namespace = $namespace;
+        parent::__construct($raw);
     }
 
     /**

diff --git a/src/Symfony/Component/Console/Descriptor/Text/CommandTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/CommandTextDescriptor.php
@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Descriptor\Text;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputDefinition;
+
+/**
+ * @author Jean-François Simon <[email protected]>
+ */
+class CommandTextDescriptor extends AbstractTextDescriptor
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getRawText($object)
+    {
+        return strip_tags($this->getFormattedText($object));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormattedText($object)
+    {
+        /** @var Command $object */
+        $messages = array('<comment>Usage:</comment>', ' '.$object->getSynopsis(), '');
+
+        if ($object->getAliases()) {
+            $messages[] = '<comment>Aliases:</comment> <info>'.implode(', ', $object->getAliases()).'</info>';
+        }
+
+        $descriptor = new InputDefinitionTextDescriptor();
+        $messages[] = $descriptor->getFormattedText($object->getDefinition());
+
+        if ($help = $object->getProcessedHelp()) {
+            $messages[] = '<comment>Help:</comment>';
+            $messages[] = ' '.str_replace("\n", "\n ", $help)."\n";
+        }
+
+        return implode("\n", $messages);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof Command;
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Text/InputArgumentTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/InputArgumentTextDescriptor.php
@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Descriptor\Text;
+
+use Symfony\Component\Console\Input\InputArgument;
+
+/**
+ * @author Jean-François Simon <[email protected]>
+ */
+class InputArgumentTextDescriptor extends AbstractTextDescriptor
+{
+    /**
+     * @var int|null
+     */
+    private $nameWidth;
+
+    /**
+     * @param string|null $nameWidth
+     * @param bool        $raw
+     */
+    public function __construct($nameWidth = null, $raw = false)
+    {
+        $this->nameWidth = $nameWidth;
+        parent::__construct($raw);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configure(array $options)
+    {
+        if (isset($options['name_width'])) {
+            $this->nameWidth = $options['name_width'];
+        }
+
+        return parent::configure($options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRawText($object)
+    {
+        return strip_tags($this->getFormattedText($object));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormattedText($object)
+    {
+        /** @var InputArgument $object */
+        if (null !== $object->getDefault() && (!is_array($object->getDefault()) || count($object->getDefault()))) {
+            $default = sprintf('<comment> (default: %s)</comment>', $this->formatDefaultValue($object->getDefault()));
+        } else {
+            $default = '';
+        }
+
+        $nameWidth = $this->nameWidth ?: strlen($object->getName());
+        $description = str_replace("\n", "\n".str_repeat(' ', $nameWidth + 2), $object->getDescription());
+
+        return sprintf(" <info>%-${nameWidth}s</info> %s%s", $object->getName(), $description, $default);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof InputArgument;
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Text/InputDefinitionTextDescriptor.php b/src/Symfony/Component/Console/Descriptor/Text/InputDefinitionTextDescriptor.php
@@ -0,0 +1,83 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Descriptor\Text;
+
+use Symfony\Component\Console\Input\InputDefinition;
+
+/**
+ * @author Jean-François Simon <[email protected]>
+ */
+class InputDefinitionTextDescriptor extends AbstractTextDescriptor
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getRawText($object)
+    {
+        return strip_tags($this->getFormattedText($object));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormattedText($object)
+    {
+        // find the largest option or argument name
+        $nameWidth = 0;
+
+        /** @var InputDefinition $object */
+        foreach ($object->getOptions() as $option) {
+            $nameLength = strlen($option->getName()) + 2;
+            if ($option->getShortcut()) {
+                $nameLength += strlen($option->getShortcut()) + 3;
+            }
+
+            $nameWidth = max($nameWidth, $nameLength);
+        }
+
+        foreach ($object->getArguments() as $argument) {
+            $nameWidth = max($nameWidth, strlen($argument->getName()));
+        }
+
+        ++$nameWidth;
+
+        $text = array();
+
+        if ($object->getArguments()) {
+            $text[] = '<comment>Arguments:</comment>';
+            $descriptor = new InputArgumentTextDescriptor($nameWidth);
+            foreach ($object->getArguments() as $argument) {
+                $text[] = $descriptor->getFormattedText($argument);
+            }
+            $text[] = '';
+        }
+
+        if ($object->getOptions()) {
+            $text[] = '<comment>Options:</comment>';
+            $descriptor = new InputOptionTextDescriptor($nameWidth);
+            foreach ($object->getOptions() as $option) {
+                $text[] = $descriptor->getFormattedText($option);
+            }
+            $text[] = '';
+        }
+
+        return implode("\n", $text);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof InputDefinition;
+    }
+}