[Workflow] Fixed graphviz dumper for state machine #20583
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,80 @@ | ||
| <?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\Workflow\Dumper; | ||
|
|
||
| use Symfony\Component\Workflow\Definition; | ||
| use Symfony\Component\Workflow\Marking; | ||
|
|
||
| class StateMachineGraphvizDumper extends GraphvizDumper | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * Dumps the workflow as a graphviz graph. | ||
| * | ||
| * Available options: | ||
| * | ||
| * * graph: The default options for the whole graph | ||
| * * node: The default options for nodes (places) | ||
| * * edge: The default options for edges | ||
| */ | ||
| public function dump(Definition $definition, Marking $marking = null, array $options = array()) | ||
| { | ||
| $places = $this->findPlaces($definition, $marking); | ||
| $edges = $this->findEdges($definition); | ||
|
|
||
| $options = array_replace_recursive(self::$defaultOptions, $options); | ||
|
|
||
| return $this->startDot($options) | ||
| .$this->addPlaces($places) | ||
| .$this->addEdges($edges) | ||
| .$this->endDot() | ||
| ; | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| protected function findEdges(Definition $definition) | ||
| { | ||
| $edges = array(); | ||
|
|
||
| foreach ($definition->getTransitions() as $transition) { | ||
| foreach ($transition->getFroms() as $from) { | ||
| foreach ($transition->getTos() as $to) { | ||
| $edges[$from][] = array( | ||
| 'name' => $transition->getName(), | ||
| 'to' => $to, | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $edges; | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| protected function addEdges(array $edges) | ||
| { | ||
| $code = ''; | ||
|
|
||
| foreach ($edges as $id => $edges) { | ||
| foreach ($edges as $edge) { | ||
| $code .= sprintf(" place_%s -> place_%s [label=\"%s\" style=\"%s\"];\n", $this->dotize($id), $this->dotize($edge['to']), $edge['name'], 'solid'); | ||
| } | ||
| } | ||
|
|
||
| return $code; | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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,74 @@ | ||
| <?php | ||
|
|
||
| namespace Symfony\Component\Workflow\Tests\Dumper; | ||
|
|
||
| use Symfony\Component\Workflow\Dumper\StateMachineGraphvizDumper; | ||
| use Symfony\Component\Workflow\Marking; | ||
| use Symfony\Component\Workflow\Tests\WorkflowBuilderTrait; | ||
|
|
||
| class StateMachineGraphvizDumperTest extends \PHPUnit_Framework_TestCase | ||
| { | ||
| use WorkflowBuilderTrait; | ||
|
|
||
| private $dumper; | ||
|
|
||
| public function setUp() | ||
| { | ||
| $this->dumper = new StateMachineGraphvizDumper(); | ||
| } | ||
|
|
||
| public function testDumpWithoutMarking() | ||
| { | ||
| $definition = $this->createComplexStateMachineDefinition(); | ||
|
|
||
| $dump = $this->dumper->dump($definition); | ||
|
|
||
| $expected = <<<'EOGRAPH' | ||
| digraph workflow { | ||
| ratio="compress" rankdir="LR" | ||
| node [fontsize="9" fontname="Arial" color="#333333" fillcolor="lightblue" fixedsize="1" width="1"]; | ||
| edge [fontsize="9" fontname="Arial" color="#333333" arrowhead="normal" arrowsize="0.5"]; | ||
|
|
||
| place_a [label="a", shape=circle, style="filled"]; | ||
| place_b [label="b", shape=circle]; | ||
| place_c [label="c", shape=circle]; | ||
| place_d [label="d", shape=circle]; | ||
| place_a -> place_b [label="t1" style="solid"]; | ||
| place_d -> place_b [label="t1" style="solid"]; | ||
| place_b -> place_c [label="t2" style="solid"]; | ||
| place_b -> place_d [label="t3" style="solid"]; | ||
| } | ||
|
|
||
| EOGRAPH; | ||
|
|
||
| $this->assertEquals($expected, $dump); | ||
| } | ||
|
|
||
| public function testDumpWithMarking() | ||
| { | ||
| $definition = $this->createComplexStateMachineDefinition(); | ||
| $marking = new Marking(array('b' => 1)); | ||
|
|
||
| $expected = <<<'EOGRAPH' | ||
| digraph workflow { | ||
| ratio="compress" rankdir="LR" | ||
| node [fontsize="9" fontname="Arial" color="#333333" fillcolor="lightblue" fixedsize="1" width="1"]; | ||
| edge [fontsize="9" fontname="Arial" color="#333333" arrowhead="normal" arrowsize="0.5"]; | ||
|
|
||
| place_a [label="a", shape=circle, style="filled"]; | ||
| place_b [label="b", shape=circle, color="#FF0000", shape="doublecircle"]; | ||
| place_c [label="c", shape=circle]; | ||
| place_d [label="d", shape=circle]; | ||
| place_a -> place_b [label="t1" style="solid"]; | ||
| place_d -> place_b [label="t1" style="solid"]; | ||
| place_b -> place_c [label="t2" style="solid"]; | ||
| place_b -> place_d [label="t3" style="solid"]; | ||
| } | ||
|
|
||
| EOGRAPH; | ||
|
|
||
| $dump = $this->dumper->dump($definition, $marking); | ||
|
|
||
| $this->assertEquals($expected, $dump); | ||
| } | ||
| } |
Oops, something went wrong.
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.
should we have a way to dump the state machine in workflow mode ? It is a subset after all.
But anyway, I agree it should not be the default dumping for state machines.
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 of course means that it should be fixed to work properly, but I know how to do this (stop assuming that transition names are unique identifiers of the transition, as we stopped doing this.
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.
For now, it's not really readable to dump a state machine with the workflow dumper. So IMHO, it's not useful to add a way to do it.