[Console] added JSON descriptors

symfony · jfsimon · Mar 22, 2013 · Apr 1, 2013 · Apr 3, 2013 · Apr 3, 2013
commit f239b1c5c442b788b6c779ca110e34f97669f521
diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php b/src/Symfony/Component/Console/Descriptor/DescriptorInterface.php
@@ -16,6 +16,15 @@
  */
 interface DescriptorInterface
 {
+    /**
+     * Configures descriptor with description options.
+     *
+     * @param array $options Description options
+     *
+     * @return DescriptorInterface
+     */
+    public function configure(array $options);
+
     /**
      * Returns given object's representation.
      *

diff --git a/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php b/src/Symfony/Component/Console/Descriptor/DescriptorProvider.php
@@ -2,6 +2,8 @@
 
 namespace Symfony\Component\Console\Descriptor;
 
+use Symfony\Component\Console\Descriptor\Json;
+
 /**
  * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
  */
@@ -13,18 +15,29 @@ class DescriptorProvider
     private $descriptors = array();
 
     /**
-     * @var string
+     * @var array
      */
-    private $defaultFormat;
+    private $options = array(
+        'default_format' => 'txt',
+        'json_encoding'  => 0,
+        'namespace'      => null,
+    );
 
     /**
      * Constructor.
      *
-     * @param string $defaultFormat
+     * @param array $options
      */
-    public function __construct($defaultFormat = 'txt')
+    public function __construct(array $options = array())
     {
-        $this->defaultFormat = $defaultFormat;
+        $this
+            ->configure($options)
+            ->add(new Json\ApplicationJsonDescriptor())
+            ->add(new Json\CommandJsonDescriptor())
+            ->add(new Json\InputDefinitionJsonDescriptor())
+            ->add(new Json\InputArgumentJsonDescriptor())
+            ->add(new Json\InputOptionJsonDescriptor())
+        ;
     }
 
     /**
@@ -36,11 +49,30 @@ public function __construct($defaultFormat = 'txt')
      */
     public function add(DescriptorInterface $descriptor)
     {
+        $descriptor->configure($this->options);
         $this->descriptors[] = $descriptor;
 
         return $this;
     }
 
+    /**
+     * Configures provider with options.
+     *
+     * @param array $options
+     *
+     * @return DescriptorProvider
+     */
+    public function configure(array $options)
+    {
+        $this->options = array_replace($this->options, $options);
+
+        foreach ($this->descriptors as $descriptor) {
+            $descriptor->configure($this->options);
+        }
+
+        return $this;
+    }
+
     /**
      * Provides a descriptor for given object and format.
      *
@@ -69,7 +101,7 @@ public function get($object, $format)
      */
     public function getDefaultFormat()
     {
-        return $this->defaultFormat;
+        return $this->options['default_format'];
     }
 
     /**

diff --git a/src/Symfony/Component/Console/Descriptor/Json/AbstractJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/AbstractJsonDescriptor.php
@@ -0,0 +1,81 @@
+<?php
+
+namespace Symfony\Component\Console\Descriptor\Json;
+
+use Symfony\Component\Console\Descriptor\DescriptorInterface;
+
+/**
+ * @author Jean-François Simon <contact@jfsimon.fr>
+ */
+abstract class AbstractJsonDescriptor implements DescriptorInterface
+{
+    /**
+     * @var int
+     */
+    private $encodingOptions = 0;
+
+    /**
+     * @param int $encodingOptions
+     */
+    public function __construct($encodingOptions = 0)
+    {
+        $this->encodingOptions = $encodingOptions;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configure(array $options)
+    {
+        $this->encodingOptions = $options['json_encoding'];
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function describe($object, $raw = false)
+    {
+        return json_encode($this->getData($object), $this->encodingOptions);
+    }
+
+    /**
+     * Returns object data to encode.
+     *
+     * @param object $object
+     *
+     * @return array
+     */
+    abstract public function getData($object);
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormat()
+    {
+        return 'json';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function useFormatting()
+    {
+        return false;
+    }
+
+    /**
+     * Builds a JSON descriptor.
+     *
+     * @param AbstractJsonDescriptor $descriptor
+     *
+     * @return AbstractJsonDescriptor
+     */
+    protected function build(AbstractJsonDescriptor $descriptor)
+    {
+        $descriptor->configure(array('json_encoding' => $this->encodingOptions));
+
+        return $descriptor;
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Json/ApplicationJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/ApplicationJsonDescriptor.php
@@ -0,0 +1,90 @@
+<?php
+
+namespace Symfony\Component\Console\Descriptor\Json;
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Command\Command;
+
+/**
+ * @author Jean-François Simon <contact@jfsimon.fr>
+ */
+class ApplicationJsonDescriptor extends AbstractJsonDescriptor
+{
+    /**
+     * @var string|null
+     */
+    private $namespace;
+
+    public function __construct($namespace = null, $encodingOptions = 0)
+    {
+        $this->namespace = $namespace;
+        parent::__construct($encodingOptions);
+    }
+
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configure(array $options)
+    {
+        $this->namespace = $options['namespace'];
+
+        return parent::configure($options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getData($object)
+    {
+        $commandDescriptor = $this->build(new CommandJsonDescriptor());
+
+        /** @var Application $object */
+        $commands = $object->all($this->namespace ? $object->findNamespace($this->namespace) : null);
+        $data = array('commands' => array(), 'namespaces' => array());
+
+        foreach ($this->sortCommands($object, $commands) as $space => $commands) {
+            $namespaceData = array('id' => $space, 'commands' => array());
+
+            /** @var Command $command */
+            foreach ($commands as $command) {
+                if (!$command->getName()) {
+                    continue;
+                }
+
+                $data['commands'][] = $commandDescriptor->getData($command);
+                $namespaceData['commands'][] = $command->getName();
+            }
+
+            $data['namespaces'][] = $namespaceData;
+        }
+
+        if ($this->namespace) {
+            $data['namespace'] = $this->namespace;
+        }
+
+        return $data;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof Application;
+    }
+
+    /**
+     * @param Application $application
+     * @param Command[]   $commands
+     *
+     * @return array
+     */
+    private function sortCommands(Application $application, array $commands)
+    {
+        $method = new \ReflectionMethod($application, 'sortCommands');
+        $method->setAccessible(true);
+
+        return $method->invoke($application, $commands);
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/CommandJsonDescriptor.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Symfony\Component\Console\Descriptor\Json;
+
+use Symfony\Component\Console\Command\Command;
+
+/**
+ * @author Jean-François Simon <contact@jfsimon.fr>
+ */
+class CommandJsonDescriptor extends AbstractJsonDescriptor
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getData($object)
+    {
+        $definitionDescriptor = $this->build(new InputDefinitionJsonDescriptor());
+
+            /** @var Command $object */
+        return array(
+            'name'        => $object->getName(),
+            'usage'       => $object->getSynopsis(),
+            'description' => $object->getDescription(),
+            'help'        => $object->getProcessedHelp(),
+            'aliases'     => $object->getAliases(),
+            'definition'  => $definitionDescriptor->getData($object->getDefinition()),
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof Command;
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Json/InputArgumentJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/InputArgumentJsonDescriptor.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Symfony\Component\Console\Descriptor\Json;
+
+use Symfony\Component\Console\Input\InputArgument;
+
+/**
+ * @author Jean-François Simon <contact@jfsimon.fr>
+ */
+class InputArgumentJsonDescriptor extends AbstractJsonDescriptor
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getData($object)
+    {
+        /** @var InputArgument $object */
+        return array(
+            'name'        => $object->getName(),
+            'is_required' => $object->isRequired(),
+            'is_array'    => $object->isArray(),
+            'description' => $object->getDescription(),
+            'default'     => $object->getDefault(),
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof InputArgument;
+    }
+}
diff --git a/src/Symfony/Component/Console/Descriptor/Json/InputDefinitionJsonDescriptor.php b/src/Symfony/Component/Console/Descriptor/Json/InputDefinitionJsonDescriptor.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Symfony\Component\Console\Descriptor\Json;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputDefinition;
+use Symfony\Component\Console\Input\InputOption;
+
+/**
+ * @author Jean-François Simon <contact@jfsimon.fr>
+ */
+class InputDefinitionJsonDescriptor extends AbstractJsonDescriptor
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getData($object)
+    {
+        $argumentDescriptor = $this->build(new InputArgumentJsonDescriptor());
+        $optionDescriptor = $this->build(new InputOptionJsonDescriptor());
+
+        /** @var InputDefinition $object */
+        return array(
+            'arguments' => array_map(function (InputArgument $argument) use ($argumentDescriptor) {
+                return $argumentDescriptor->getData($argument);
+            }, $object->getArguments()),
+            'options' => array_map(function (InputOption $option) use ($optionDescriptor) {
+                return $optionDescriptor->getData($option);
+            }, $object->getOptions()),
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($object)
+    {
+        return $object instanceof InputDefinition;
+    }
+}