-
Notifications
You must be signed in to change notification settings - Fork 19
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
Added option to dump a RST reference for the application #87
Open
dantleech
wants to merge
2
commits into
1.x
Choose a base branch
from
reference_generator
base: 1.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| <?php | ||
|
|
||
| namespace PHPCR\Shell\Console\Descriptor; | ||
|
|
||
| use Symfony\Component\Console\Descriptor\Descriptor; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Input\InputDefinition; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Application; | ||
| use Symfony\Component\Console\Descriptor\ApplicationDescription; | ||
|
|
||
| /** | ||
| * Class which dumps the command reference in RST format | ||
| * for use by the official documentation. | ||
| * | ||
| * @author Daniel Leech <[email protected]> | ||
| */ | ||
| class RstDescriptor extends Descriptor | ||
| { | ||
| protected $ignoreOptions = array( | ||
| 'verbose', | ||
| 'version', | ||
| 'quiet', | ||
| 'ansi', | ||
| 'no-ansi', | ||
| 'no-interaction', | ||
| ); | ||
|
|
||
| protected function getCommandRefName($name) | ||
| { | ||
| return 'phpcr_shell_command_' . str_replace(':', '', $name); | ||
| } | ||
|
|
||
| protected function underline($string, $char) | ||
| { | ||
| return str_repeat($char, strlen($string)); | ||
| } | ||
|
|
||
| protected function formatText($text) | ||
| { | ||
| $lines = explode("\n", $text); | ||
| $newLines = array(); | ||
| $blockLines = array(); | ||
|
|
||
| foreach ($lines as $line) { | ||
| // if line is indented by 2 or 4 spaces, assume | ||
| // that it is a code block | ||
| if (preg_match('{^[ | ]}', $line)) { | ||
| $inBlock = true; | ||
| $blockLines = array(); | ||
| } else { | ||
| $inBlock = false; | ||
| } | ||
|
|
||
| if (true === $inBlock) { | ||
| $blockLines[] = $line; | ||
| continue; | ||
| } | ||
|
|
||
| if (false === $inBlock && $blockLines) { | ||
| $newLines[] = ''; | ||
| $newLines[] = '.. code-block:: bash'; | ||
| $newLines[] = ''; | ||
| foreach ($blockLines as $blockLine) { | ||
| $blockLine = preg_replace('{( +)<(.*?)>(.*)</(.*)>}', '\3', $blockLine); | ||
| $newLines[] = ' ' . $blockLine; | ||
| } | ||
| $newLines[] = ''; | ||
| $blockLines = array(); | ||
| } else { | ||
| // replace inline tags with literals | ||
| $line = preg_replace('{<(.*?)>(.*)</(.*)>}', '``\2``', $line); | ||
| $newLines[] = $line; | ||
| } | ||
| } | ||
|
|
||
|
|
||
| return implode("\n", $newLines); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeInputArgument(InputArgument $argument, array $options = array()) | ||
| { | ||
| return implode("\n", array( | ||
| $argument->getName(), | ||
| $this->underline($argument->getName(), '"'), | ||
| '', | ||
| '* **Name:** ``'. ($argument->getName() ?: '*<none>*').'``', | ||
| '* **Is required:** '.($argument->isRequired() ? 'yes' : 'no'), | ||
| '* **Is array:** '.($argument->isArray() ? 'yes' : 'no'), | ||
| '* **Description:** '.($argument->getDescription() ?: '*<none>*'), | ||
| '* **Default:** ``'.str_replace("\n", '', var_export($argument->getDefault(), true)).'``', | ||
| '', | ||
| )); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeInputOption(InputOption $option, array $options = array()) | ||
| { | ||
| if (in_array($option->getName(), $this->ignoreOptions)) { | ||
| return ''; | ||
| } | ||
|
|
||
| return implode("\n", array( | ||
| $option->getName(), | ||
| $this->underline($option->getName(), '"'), | ||
| '', | ||
| '* **Name:** ``--'.$option->getName().'``', | ||
| '* **Accept value:** '.($option->acceptValue() ? 'yes' : 'no'), | ||
| '* **Is value required:** '.($option->isValueRequired() ? 'yes' : 'no'), | ||
| '* **Is multiple:** '.($option->isArray() ? 'yes' : 'no'), | ||
| '* **Description:** '.($option->getDescription() ?: '*<none>*'), | ||
| '* **Default:** ``'.str_replace("\n", '', var_export($option->getDefault(), true)).'``', | ||
| '', | ||
| )); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeInputDefinition(InputDefinition $definition, array $options = array()) | ||
| { | ||
| $blocks = array(); | ||
|
|
||
| if (count($definition->getArguments()) > 0) { | ||
| $blocks[] = 'Arguments:'; | ||
| $blocks[] = '~~~~~~~~~~'; | ||
| $blocks[] = ''; | ||
| foreach ($definition->getArguments() as $argument) { | ||
| $blocks[] = $this->describeInputArgument($argument); | ||
| } | ||
| $blocks[] = ''; | ||
| } | ||
|
|
||
| if (count($definition->getOptions()) > 0) { | ||
| $blocks[] = 'Options:'; | ||
| $blocks[] = '~~~~~~~~'; | ||
| $blocks[] = ''; | ||
| foreach ($definition->getOptions() as $option) { | ||
| $blocks[] = $this->describeInputOption($option); | ||
| } | ||
| $blocks[] = ''; | ||
| } | ||
|
|
||
| return implode("\n", $blocks); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeCommand(Command $command, array $options = array()) | ||
| { | ||
| $command->getSynopsis(); | ||
| $command->mergeApplicationDefinition(false); | ||
|
|
||
| $rst = array( | ||
| '', | ||
| '.. _' . $this->getCommandRefName($command->getName()) . ':', | ||
| '', | ||
| $command->getName(), | ||
| $this->underline($command->getName(), '-'), | ||
| '', | ||
| '* **Description:** '.($command->getDescription() ? $this->formatText($command->getDescription()) : '*<none>*'), | ||
| '* **Usage:** ``'.$command->getSynopsis().'``', | ||
| ); | ||
|
|
||
| $rst[] = ''; | ||
|
|
||
| if ($help = $command->getProcessedHelp()) { | ||
| $rst[] = $this->formatText($help); | ||
| $rst[] = ''; | ||
| } | ||
|
|
||
| if ($definitionRst = $this->describeInputDefinition($command->getNativeDefinition())) { | ||
| $rst[] = $this->formatText($definitionRst); | ||
| $rst[] = ''; | ||
| } | ||
|
|
||
| return implode("\n", $rst); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeApplication(Application $application, array $options = array()) | ||
| { | ||
| $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null; | ||
| $description = new ApplicationDescription($application, $describedNamespace); | ||
| $blocks[] = 'Reference'; | ||
| $blocks[] = '========='; | ||
| $blocks[] = ''; | ||
|
|
||
| foreach ($description->getNamespaces() as $namespace) { | ||
| if (ApplicationDescription::GLOBAL_NAMESPACE !== $namespace['id']) { | ||
| $blocks[] = $namespace['id']; | ||
| $blocks[] = str_repeat('-', strlen($namespace['id'])); | ||
| $blocks[] = ''; | ||
| } | ||
|
|
||
| $blocks[] = implode("\n", array_map(function ($commandName) { | ||
| return '* :ref:`' . $this->getCommandRefName($commandName) . '`'; | ||
| } , $namespace['commands'])); | ||
| $blocks[] = ''; | ||
| } | ||
|
|
||
| foreach ($description->getCommands() as $command) { | ||
| $blocks[] = $this->describeCommand($command); | ||
| } | ||
|
|
||
| return implode("\n", $blocks); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't have been removed ..