-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[Workflow] Move the dump command to the component #61933
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,120 +12,14 @@ | |
| namespace Symfony\Bundle\FrameworkBundle\Command; | ||
|
|
||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Completion\CompletionInput; | ||
| use Symfony\Component\Console\Completion\CompletionSuggestions; | ||
| use Symfony\Component\Console\Exception\InvalidArgumentException; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\DependencyInjection\ServiceLocator; | ||
| use Symfony\Component\Workflow\Debug\TraceableWorkflow; | ||
| use Symfony\Component\Workflow\Dumper\GraphvizDumper; | ||
| use Symfony\Component\Workflow\Dumper\MermaidDumper; | ||
| use Symfony\Component\Workflow\Dumper\PlantUmlDumper; | ||
| use Symfony\Component\Workflow\Dumper\StateMachineGraphvizDumper; | ||
| use Symfony\Component\Workflow\Marking; | ||
| use Symfony\Component\Workflow\StateMachine; | ||
| use Symfony\Component\Workflow\Command\WorkflowDumpCommand as BaseWorkflowDumpCommand; | ||
|
|
||
| trigger_deprecation('symfony/framework-bundle', '7.4', 'The "%s" class is deprecated, use "%s" instead.', WorkflowDumpCommand::class, BaseWorkflowDumpCommand::class); | ||
|
|
||
| /** | ||
| * @author Grégoire Pineau <lyrixx@lyrixx.info> | ||
| * | ||
| * @final | ||
| * @deprecated since Symfony 7.4, use {@see \Symfony\Component\Workflow\Command\WorkflowDumpCommand} instead. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The suggested code style change looks legit to me.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Too late, I've fixed it after the merge. |
||
| */ | ||
| #[AsCommand(name: 'workflow:dump', description: 'Dump a workflow')] | ||
| class WorkflowDumpCommand extends Command | ||
| class WorkflowDumpCommand extends BaseWorkflowDumpCommand | ||
|
Check failure on line 23 in src/Symfony/Bundle/FrameworkBundle/Command/WorkflowDumpCommand.php
|
||
| { | ||
| private const DUMP_FORMAT_OPTIONS = [ | ||
| 'puml', | ||
| 'mermaid', | ||
| 'dot', | ||
| ]; | ||
|
|
||
| public function __construct( | ||
| private ServiceLocator $workflows, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void | ||
| { | ||
| $this | ||
| ->setDefinition([ | ||
| new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'), | ||
| new InputArgument('marking', InputArgument::IS_ARRAY, 'A marking (a list of places)'), | ||
| new InputOption('label', 'l', InputOption::VALUE_REQUIRED, 'Label a graph'), | ||
| new InputOption('with-metadata', null, InputOption::VALUE_NONE, 'Include the workflow\'s metadata in the dumped graph', null), | ||
| new InputOption('dump-format', null, InputOption::VALUE_REQUIRED, 'The dump format ['.implode('|', self::DUMP_FORMAT_OPTIONS).']', 'dot'), | ||
| ]) | ||
| ->setHelp(<<<'EOF' | ||
| The <info>%command.name%</info> command dumps the graphical representation of a | ||
| workflow in different formats | ||
| <info>DOT</info>: %command.full_name% <workflow name> | dot -Tpng > workflow.png | ||
| <info>PUML</info>: %command.full_name% <workflow name> --dump-format=puml | java -jar plantuml.jar -p > workflow.png | ||
| <info>MERMAID</info>: %command.full_name% <workflow name> --dump-format=mermaid | mmdc -o workflow.svg | ||
| EOF | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int | ||
| { | ||
| $workflowName = $input->getArgument('name'); | ||
|
|
||
| if (!$this->workflows->has($workflowName)) { | ||
| throw new InvalidArgumentException(\sprintf('The workflow named "%s" cannot be found.', $workflowName)); | ||
| } | ||
| $workflow = $this->workflows->get($workflowName); | ||
| if ($workflow instanceof TraceableWorkflow) { | ||
| $workflow = $workflow->getInner(); | ||
| } | ||
| $type = $workflow instanceof StateMachine ? 'state_machine' : 'workflow'; | ||
| $definition = $workflow->getDefinition(); | ||
|
|
||
| switch ($input->getOption('dump-format')) { | ||
| case 'puml': | ||
| $transitionType = 'workflow' === $type ? PlantUmlDumper::WORKFLOW_TRANSITION : PlantUmlDumper::STATEMACHINE_TRANSITION; | ||
| $dumper = new PlantUmlDumper($transitionType); | ||
| break; | ||
|
|
||
| case 'mermaid': | ||
| $transitionType = 'workflow' === $type ? MermaidDumper::TRANSITION_TYPE_WORKFLOW : MermaidDumper::TRANSITION_TYPE_STATEMACHINE; | ||
| $dumper = new MermaidDumper($transitionType); | ||
| break; | ||
|
|
||
| case 'dot': | ||
| default: | ||
| $dumper = ('workflow' === $type) ? new GraphvizDumper() : new StateMachineGraphvizDumper(); | ||
| } | ||
|
|
||
| $marking = new Marking(); | ||
|
|
||
| foreach ($input->getArgument('marking') as $place) { | ||
| $marking->mark($place); | ||
| } | ||
|
|
||
| $options = [ | ||
| 'name' => $workflowName, | ||
| 'with-metadata' => $input->getOption('with-metadata'), | ||
| 'nofooter' => true, | ||
| 'label' => $input->getOption('label'), | ||
| ]; | ||
| $output->writeln($dumper->dump($definition, $marking, $options)); | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void | ||
| { | ||
| if ($input->mustSuggestArgumentValuesFor('name')) { | ||
| $suggestions->suggestValues(array_keys($this->workflows->getProvidedServices())); | ||
| } | ||
|
|
||
| if ($input->mustSuggestOptionValuesFor('dump-format')) { | ||
| $suggestions->suggestValues(self::DUMP_FORMAT_OPTIONS); | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Workflow\Command; | ||
|
|
||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Completion\CompletionInput; | ||
| use Symfony\Component\Console\Completion\CompletionSuggestions; | ||
| use Symfony\Component\Console\Exception\InvalidArgumentException; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Workflow\Debug\TraceableWorkflow; | ||
| use Symfony\Component\Workflow\Dumper\GraphvizDumper; | ||
| use Symfony\Component\Workflow\Dumper\MermaidDumper; | ||
| use Symfony\Component\Workflow\Dumper\PlantUmlDumper; | ||
| use Symfony\Component\Workflow\Dumper\StateMachineGraphvizDumper; | ||
| use Symfony\Component\Workflow\Marking; | ||
| use Symfony\Component\Workflow\StateMachine; | ||
| use Symfony\Contracts\Service\ServiceProviderInterface; | ||
|
|
||
| /** | ||
| * @author Grégoire Pineau <lyrixx@lyrixx.info> | ||
| * | ||
| * @final | ||
| */ | ||
| #[AsCommand(name: 'workflow:dump', description: 'Dump a workflow')] | ||
| class WorkflowDumpCommand extends Command | ||
lyrixx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| private const DUMP_FORMAT_OPTIONS = [ | ||
| 'puml', | ||
| 'mermaid', | ||
| 'dot', | ||
| ]; | ||
|
|
||
| public function __construct( | ||
| private ServiceProviderInterface $workflows, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void | ||
| { | ||
| $this | ||
| ->setDefinition([ | ||
| new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'), | ||
| new InputArgument('marking', InputArgument::IS_ARRAY, 'A marking (a list of places)'), | ||
| new InputOption('label', 'l', InputOption::VALUE_REQUIRED, 'Label a graph'), | ||
| new InputOption('with-metadata', null, InputOption::VALUE_NONE, 'Include the workflow\'s metadata in the dumped graph', null), | ||
| new InputOption('dump-format', null, InputOption::VALUE_REQUIRED, 'The dump format ['.implode('|', self::DUMP_FORMAT_OPTIONS).']', 'dot'), | ||
| ]) | ||
| ->setHelp(<<<'EOF' | ||
| The <info>%command.name%</info> command dumps the graphical representation of a | ||
| workflow in different formats | ||
|
|
||
| <info>DOT</info>: %command.full_name% <workflow name> | dot -Tpng > workflow.png | ||
| <info>PUML</info>: %command.full_name% <workflow name> --dump-format=puml | java -jar plantuml.jar -p > workflow.png | ||
| <info>MERMAID</info>: %command.full_name% <workflow name> --dump-format=mermaid | mmdc -o workflow.svg | ||
| EOF | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int | ||
| { | ||
| $workflowName = $input->getArgument('name'); | ||
|
|
||
| if (!$this->workflows->has($workflowName)) { | ||
| throw new InvalidArgumentException(\sprintf('The workflow named "%s" cannot be found.', $workflowName)); | ||
| } | ||
| $workflow = $this->workflows->get($workflowName); | ||
| if ($workflow instanceof TraceableWorkflow) { | ||
| $workflow = $workflow->getInner(); | ||
| } | ||
| $type = $workflow instanceof StateMachine ? 'state_machine' : 'workflow'; | ||
| $definition = $workflow->getDefinition(); | ||
|
|
||
| switch ($input->getOption('dump-format')) { | ||
| case 'puml': | ||
| $transitionType = 'workflow' === $type ? PlantUmlDumper::WORKFLOW_TRANSITION : PlantUmlDumper::STATEMACHINE_TRANSITION; | ||
| $dumper = new PlantUmlDumper($transitionType); | ||
| break; | ||
|
|
||
| case 'mermaid': | ||
| $transitionType = 'workflow' === $type ? MermaidDumper::TRANSITION_TYPE_WORKFLOW : MermaidDumper::TRANSITION_TYPE_STATEMACHINE; | ||
| $dumper = new MermaidDumper($transitionType); | ||
| break; | ||
|
|
||
| case 'dot': | ||
| default: | ||
| $dumper = ('workflow' === $type) ? new GraphvizDumper() : new StateMachineGraphvizDumper(); | ||
| } | ||
|
|
||
| $marking = new Marking(); | ||
|
|
||
| foreach ($input->getArgument('marking') as $place) { | ||
| $marking->mark($place); | ||
| } | ||
|
|
||
| $options = [ | ||
| 'name' => $workflowName, | ||
| 'with-metadata' => $input->getOption('with-metadata'), | ||
| 'nofooter' => true, | ||
| 'label' => $input->getOption('label'), | ||
| ]; | ||
| $output->writeln($dumper->dump($definition, $marking, $options)); | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void | ||
| { | ||
| if ($input->mustSuggestArgumentValuesFor('name')) { | ||
| $suggestions->suggestValues(array_keys($this->workflows->getProvidedServices())); | ||
| } | ||
|
|
||
| if ($input->mustSuggestOptionValuesFor('dump-format')) { | ||
| $suggestions->suggestValues(self::DUMP_FORMAT_OPTIONS); | ||
| } | ||
| } | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.