Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Console] application/command as text/xml/whatever decoupling #7454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 24 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
da67c12
[Console] added descriptor & refactored description commands
jfsimon Mar 22, 2013
f239b1c
[Console] added JSON descriptors
jfsimon Apr 1, 2013
bebf1eb
[Console] added markdown descriptors
jfsimon Apr 3, 2013
43b5e5c
[Console] added forgotten headers
jfsimon Apr 3, 2013
acc7414
[Console] removed unused methods (tests broken)
jfsimon Apr 3, 2013
774794c
[Console] fixed tests
jfsimon Apr 3, 2013
2066a9b
[Console] added XML descriptors
jfsimon Apr 6, 2013
47fa194
[Console] started text derciptors
jfsimon Apr 6, 2013
8b56eb1
[Console] finished text descriptors
jfsimon Apr 8, 2013
27aa872
[Console] repaired tests
jfsimon Apr 10, 2013
30d8807
[Console] re-introduced asText & asXml methods to avoid BC break
jfsimon Apr 14, 2013
9964838
[Console] added command definition merge be fore description
jfsimon Apr 14, 2013
ef6d8ba
[Console] simplified description commands
jfsimon Apr 14, 2013
389101a
[Console] re-introduced --xml option to avoid BC break
jfsimon Apr 14, 2013
84be8de
[Console] simplified mardown descriptors
jfsimon Apr 14, 2013
ce5c0fd
[Console] applied comments from github
jfsimon Apr 14, 2013
49a4612
[Console] applied comments from github
jfsimon Apr 14, 2013
20c10a5
[Console] added provider injection to descriptors
jfsimon Apr 14, 2013
9c7b358
[Console] simplified descriptors
jfsimon Apr 23, 2013
d3ec073
[Console] applied advices from github comments
jfsimon Apr 23, 2013
d70e086
[Console] removed proxy
jfsimon Apr 23, 2013
ce60fb7
[Console] simplified descriptor interface
jfsimon Apr 23, 2013
28f082e
[Console] removed changes
jfsimon Apr 23, 2013
cbb8105
[Console] moved commands arguments
jfsimon Apr 23, 2013
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[Console] added provider injection to descriptors
  • Loading branch information
jfsimon committed Apr 14, 2013
commit 20c10a5606b0c9e3622c7af38a839d17b4fbffe4
10 changes: 5 additions & 5 deletions src/Symfony/Component/Console/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@

namespace Symfony\Component\Console;

use Symfony\Component\Console\Descriptor\Text\ApplicationTextDescriptor;
use Symfony\Component\Console\Descriptor\Xml\ApplicationXmlDescriptor;
use Symfony\Component\Console\Descriptor\DescriptorProvider;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Input\ArrayInput;
Expand Down Expand Up @@ -694,9 +693,9 @@ public static function getAbbreviations($names)
*/
public function asText($namespace = null, $raw = false)
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need to provide a BC layer to avoid the BC break

$descriptor = new ApplicationTextDescriptor($namespace, $raw);
$descriptor = new DescriptorProvider(array('namespace' => $namespace, 'raw_text' => $raw));

return $descriptor->describe($this);
return $descriptor->get($this, 'txt')->describe($this);
}

/**
Expand All @@ -711,7 +710,8 @@ public function asText($namespace = null, $raw = false)
*/
public function asXml($namespace = null, $asDom = false)
{
$descriptor = new ApplicationXmlDescriptor($namespace);
$provider = new DescriptorProvider(array('namespace' => $namespace));
$descriptor = $provider->get($this, 'xml');

if ($asDom) {
$dom = new \DOMDocument('1.0', 'UTF-8');
Expand Down
10 changes: 5 additions & 5 deletions src/Symfony/Component/Console/Command/Command.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@

namespace Symfony\Component\Console\Command;

use Symfony\Component\Console\Descriptor\Text\CommandTextDescriptor;
use Symfony\Component\Console\Descriptor\Xml\CommandXmlDescriptor;
use Symfony\Component\Console\Descriptor\DescriptorProvider;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
Expand Down Expand Up @@ -566,9 +565,9 @@ public function getHelper($name)
*/
public function asText()
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also requires a BC layer

$descriptor = new CommandTextDescriptor();
$descriptor = new DescriptorProvider();

return $descriptor->describe($this);
return $descriptor->get($this, 'txt')->describe($this);
}

/**
Expand All @@ -582,7 +581,8 @@ public function asText()
*/
public function asXml($asDom = false)
{
$descriptor = new CommandXmlDescriptor();
$provider = new DescriptorProvider();
$descriptor = $provider->get($this, 'xml');

if ($asDom) {
$dom = new \DOMDocument('1.0', 'UTF-8');
Expand Down
40 changes: 40 additions & 0 deletions src/Symfony/Component/Console/Descriptor/AbstractDescriptor.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

namespace Symfony\Component\Console\Descriptor;

/**
* @author Jean-François Simon <[email protected]>
*/
abstract class AbstractDescriptor implements DescriptorInterface
{
/**
* @var DescriptorProvider|null
*/
private $descriptorProvider;

/**
* {@inheritdoc}
*/
public function setDescriptorProvider(DescriptorProvider $descriptorProvider)
{
$this->descriptorProvider = $descriptorProvider;
}

/**
* Returns a descriptor for given object with current format.
*
* @param object $object
*
* @return DescriptorInterface
*
* @throws \LogicException
*/
protected function getDescriptor($object)
{
if (null === $this->descriptorProvider) {
throw new \LogicException('You must set a descriptor provider to get a descriptor.');
}

return $this->descriptorProvider->get($object, $this->getFormat());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,9 @@ public function getFormat();
* @return boolean
*/
public function useFormatting();

/**
* @param DescriptorProvider $descriptorProvider
*/
public function setDescriptorProvider(DescriptorProvider $descriptorProvider);
}
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ public function __construct(array $options = array())
public function add(DescriptorInterface $descriptor)
{
$descriptor->configure($this->options);
$descriptor->setDescriptorProvider($this);
$this->descriptors[] = $descriptor;

return $this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

namespace Symfony\Component\Console\Descriptor\Json;

use Symfony\Component\Console\Descriptor\DescriptorInterface;
use Symfony\Component\Console\Descriptor\AbstractDescriptor;

/**
* @author Jean-François Simon <[email protected]>
*/
abstract class AbstractJsonDescriptor implements DescriptorInterface
abstract class AbstractJsonDescriptor extends AbstractDescriptor
{
/**
* @var int
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,11 @@ public function getData($object)
{
/** @var Application $object */
$description = new ApplicationDescription($object, $this->namespace);
$descriptor = new CommandJsonDescriptor();
$commands = array_values(array_map(array($descriptor, 'getData'), $description->getCommands()));
$commands = array();

foreach ($description->getCommands() as $command) {
$commands[] = $this->getDescriptor($command)->getData($command);
}

return null === $this->namespace
? array('commands' => $commands, 'namespaces' => array_values($description->getNamespaces()))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ public function getData($object)
/** @var Command $object */
$object->getSynopsis();
$object->mergeApplicationDefinition(false);
$definitionDescriptor = new InputDefinitionJsonDescriptor();
$definition = $object->getNativeDefinition();

return array(
'name' => $object->getName(),
'usage' => $object->getSynopsis(),
'description' => $object->getDescription(),
'help' => $object->getProcessedHelp(),
'aliases' => $object->getAliases(),
'definition' => $definitionDescriptor->getData($object->getNativeDefinition()),
'definition' => $this->getDescriptor($definition)->getData($definition),
);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,20 @@ class InputDefinitionJsonDescriptor extends AbstractJsonDescriptor
*/
public function getData($object)
{
$argumentDescriptor = new InputArgumentJsonDescriptor();
$optionDescriptor = new InputOptionJsonDescriptor();

$arguments = array();
/** @var InputDefinition $object */
foreach ($object->getArguments() as $name => $argument) {
$arguments[$name] = $this->getDescriptor($argument)->getData($argument);
}

$options = array();
foreach ($object->getOptions() as $name => $option) {
$options[$name] = $this->getDescriptor($option)->getData($option);
}

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()),
'arguments' => $arguments,
'options' => $options
);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

namespace Symfony\Component\Console\Descriptor\Markdown;

use Symfony\Component\Console\Descriptor\DescriptorInterface;
use Symfony\Component\Console\Descriptor\AbstractDescriptor;

/**
* @author Jean-François Simon <[email protected]>
*/
abstract class AbstractMarkdownDescriptor implements DescriptorInterface
abstract class AbstractMarkdownDescriptor extends AbstractDescriptor
{
/**
* {@inheritdoc}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ public function describe($object)
{
/** @var Application $object */
$description = new ApplicationDescription($object, $this->namespace);
$descriptor = new CommandMarkdownDescriptor();

$blocks = array($object->getName()."\n".str_repeat('=', strlen($object->getName())));

foreach ($description->getNamespaces() as $namespace) {
Expand All @@ -67,7 +65,7 @@ public function describe($object)
}

foreach ($description->getCommands() as $command) {
$blocks[] = $descriptor->describe($command);
$blocks[] = $this->getDescriptor($command)->describe($command);
}

return implode("\n\n", $blocks);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ public function describe($object)
/** @var Command $object */
$object->getSynopsis();
$object->mergeApplicationDefinition(false);
$definitionDescriptor = new InputDefinitionMarkdownDescriptor();

$markdown = $object->getName()."\n"
.str_repeat('-', strlen($object->getName()))."\n\n"
Expand All @@ -38,7 +37,8 @@ public function describe($object)
$markdown .= "\n\n".$help;
}

$definitionMarkdown = $definitionDescriptor->describe($object->getNativeDefinition());
$definition = $object->getNativeDefinition();
$definitionMarkdown = $this->getDescriptor($definition)->describe($definition);
if ($definitionMarkdown) {
$markdown .= "\n\n".$definitionMarkdown;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,19 @@ class InputDefinitionMarkdownDescriptor extends AbstractMarkdownDescriptor
public function describe($object)
{
$blocks = array();
$argumentDescriptor = new InputArgumentMarkdownDescriptor();
$optionDescriptor = new InputOptionMarkdownDescriptor();

/** @var InputDefinition $object */

if (count($object->getArguments()) > 0) {
$blocks[] = '### Arguments:';
foreach ($object->getArguments() as $argument) {
$blocks[] = $argumentDescriptor->describe($argument);
$blocks[] = $this->getDescriptor($argument)->describe($argument);
}
}

if (count($object->getOptions()) > 0) {
$blocks[] = '### Options:';
foreach ($object->getOptions() as $option) {
$blocks[] = $optionDescriptor->describe($option);
$blocks[] = $this->getDescriptor($option)->describe($option);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

namespace Symfony\Component\Console\Descriptor\Text;

use Symfony\Component\Console\Descriptor\DescriptorInterface;
use Symfony\Component\Console\Descriptor\AbstractDescriptor;

/**
* @author Jean-François Simon <[email protected]>
*/
abstract class AbstractTextDescriptor implements DescriptorInterface
abstract class AbstractTextDescriptor extends AbstractDescriptor
{
/**
* @var boolean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public function getFormattedText($object)
$messages[] = '<comment>Aliases:</comment> <info>'.implode(', ', $object->getAliases()).'</info>';
}

$descriptor = new InputDefinitionTextDescriptor();
$messages[] = $descriptor->getFormattedText($object->getNativeDefinition());
$definition = $object->getNativeDefinition();
$messages[] = $this->getDescriptor($definition)->getFormattedText($definition);

if ($help = $object->getProcessedHelp()) {
$messages[] = '<comment>Help:</comment>';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,22 @@ public function getFormattedText($object)

if ($object->getArguments()) {
$text[] = '<comment>Arguments:</comment>';
$descriptor = new InputArgumentTextDescriptor($nameWidth);
foreach ($object->getArguments() as $argument) {
$text[] = $descriptor->getFormattedText($argument);
$text[] = $this
->getDescriptor($argument)
->configure(array('name_width' => $nameWidth))
->getFormattedText($argument);
}
$text[] = '';
}

if ($object->getOptions()) {
$text[] = '<comment>Options:</comment>';
$descriptor = new InputOptionTextDescriptor($nameWidth);
foreach ($object->getOptions() as $option) {
$text[] = $descriptor->getFormattedText($option);
$text[] = $this
->getDescriptor($option)
->configure(array('name_width' => $nameWidth))
->getFormattedText($option);
}
$text[] = '';
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

namespace Symfony\Component\Console\Descriptor\Xml;

use Symfony\Component\Console\Descriptor\DescriptorInterface;
use Symfony\Component\Console\Descriptor\AbstractDescriptor;

/**
* @author Jean-François Simon <[email protected]>
*/
abstract class AbstractXmlDescriptor implements DescriptorInterface
abstract class AbstractXmlDescriptor extends AbstractDescriptor
{
/**
* {@inheritdoc}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,13 @@ public function buildDocument(\DOMNode $parent, $object)

/** @var Application $object */
$description = new ApplicationDescription($object, $this->namespace);
$descriptor = new CommandXmlDescriptor();

if ($this->namespace) {
$commandsXML->setAttribute('namespace', $this->namespace);
}

foreach ($description->getCommands() as $command) {
$descriptor->buildDocument($commandsXML, $command);
$this->getDescriptor($command)->buildDocument($commandsXML, $command);
}

if (!$this->namespace) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ public function buildDocument(\DOMNode $parent, $object)
$aliasXML->appendChild($dom->createTextNode($alias));
}

$descriptor = new InputDefinitionXmlDescriptor();
$descriptor->buildDocument($commandXML, $object->getNativeDefinition());
$definition = $object->getNativeDefinition();
$this->getDescriptor($definition)->buildDocument($commandXML, $definition);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,14 @@ public function buildDocument(\DOMNode $parent, $object)
}

$parent->appendChild($argumentsXML = $dom->createElement('arguments'));
$descriptor = new InputArgumentXmlDescriptor();
/** @var InputDefinition $object */
foreach ($object->getArguments() as $argument) {
$descriptor->buildDocument($argumentsXML, $argument);
$this->getDescriptor($argument)->buildDocument($argumentsXML, $argument);
}

$parent->appendChild($optionsXML = $dom->createElement('options'));
$descriptor = new InputOptionXmlDescriptor();
foreach ($object->getOptions() as $option) {
$descriptor->buildDocument($optionsXML, $option);
$this->getDescriptor($option)->buildDocument($optionsXML, $option);
}
}

Expand Down
Loading