[Workflow] Support multiline descriptions in PlantUML

valtzu · fabpot · commit ed6291433003 · 2023-08-02T10:37:48.000+02:00
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
    transitions and workflow's metadata into dumped graph
  * Add support for storing marking in a property
  * Add a profiler
+ * Add support for multiline descriptions in PlantUML diagrams
 
 6.2
 ---
diff --git a/src/Symfony/Component/Workflow/Dumper/PlantUmlDumper.php b/src/Symfony/Component/Workflow/Dumper/PlantUmlDumper.php
@@ -208,7 +208,9 @@ private function getState(string $place, Definition $definition, Marking $markin
 
         $description = $workflowMetadata->getMetadata('description', $place);
         if (null !== $description) {
-            $output .= \PHP_EOL.$placeEscaped.' : '.str_replace("\n", ' ', $description);
+            foreach (array_filter(explode("\n", $description)) as $line) {
+                $output .= "\n".$placeEscaped.' : '.$line;
+            }
         }
 
         return $output;
diff --git a/src/Symfony/Component/Workflow/Tests/Dumper/PlantUmlDumperTest.php b/src/Symfony/Component/Workflow/Tests/Dumper/PlantUmlDumperTest.php
@@ -83,7 +83,7 @@ public function testDumpWorkflowWithSpacesInTheStateNamesAndDescription()
 
         $placesMetadata = [];
         $placesMetadata['place a'] = [
-            'description' => 'My custom place description',
+            'description' => "My custom\nplace description",
         ];
         $inMemoryMetadataStore = new InMemoryMetadataStore([], $placesMetadata);
         $definition = new Definition($places, $transitions, null, $inMemoryMetadataStore);
diff --git a/src/Symfony/Component/Workflow/Tests/fixtures/puml/square/simple-workflow-with-spaces.puml b/src/Symfony/Component/Workflow/Tests/fixtures/puml/square/simple-workflow-with-spaces.puml
@@ -15,7 +15,8 @@ skinparam agent {
     BorderColor #3887C6
 }
 state "place a" <<initial>>
-"place a" : My custom place description
+"place a" : My custom
+"place a" : place description
 state "place b"
 agent "t 1"
 "place a" --> "t 1"

Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,9 @@ private function getState(string $place, Definition $definition, Marking $markin`
`208`	`208`
`209`	`209`	`$description = $workflowMetadata->getMetadata('description', $place);`
`210`	`210`	`if (null !== $description) {`
`211`		`- $output .= \PHP_EOL.$placeEscaped.' : '.str_replace("\n", ' ', $description);`
	`211`	`+ foreach (array_filter(explode("\n", $description)) as $line) {`
	`212`	`+ $output .= "\n".$placeEscaped.' : '.$line;`
	`213`	`+ }`
`212`	`214`	`}`
`213`	`215`
`214`	`216`	`return $output;`