Fixes #258.

structurizr · Mar 1, 2024 · 586a32b · 586a32b
1 parent 472d67e
commit 586a32b
Show file tree

Hide file tree

Showing 14 changed files with 224 additions and 172 deletions.
diff --git a/changelog.md b/changelog.md
@@ -6,6 +6,7 @@
 - structurizr-client: Fixes https://github.com/structurizr/java/issues/257 (Serialization to JSON is not deterministic).
 - structurizr-dsl: Fixes https://github.com/structurizr/java/issues/252 (DSL parser does not seem to handle curly brackets balance).
 - structurizr-dsl: Deprecates `!constant`, adds `!const` and `!var` (see https://github.com/structurizr/java/issues/253).
+- structurizr-export: Fixes https://github.com/structurizr/java/issues/258 (Plantuml renderer: Group and system of same name yields puml code resulting in error).
 
 ## 2.0.0 (22nd February 2024)
 

diff --git a/...izr-export/src/main/java/com/structurizr/export/plantuml/StructurizrPlantUMLExporter.java b/...izr-export/src/main/java/com/structurizr/export/plantuml/StructurizrPlantUMLExporter.java
@@ -194,7 +194,7 @@ protected void startGroupBoundary(ModelView view, String group, IndentingWriter
                 icon = "\\n\\n<img:" + icon + "{scale=" + scale + "}>";
             }
 
-            writer.writeLine(String.format("rectangle \"%s%s\" <<group%s>> {", groupName, icon, groupId));
+            writer.writeLine(String.format("rectangle \"%s%s\" <<group%s>> as group%s {", groupName, icon, groupId, groupId));
             writer.indent();
             writer.writeLine(String.format("skinparam RectangleBorderColor<<group%s>> %s", groupId, color));
             writer.writeLine(String.format("skinparam RectangleFontColor<<group%s>> %s", groupId, color));

diff --git a/...rc/test/java/com/structurizr/export/plantuml/StructurizrPlantUMLDiagramExporterTests.java b/...rc/test/java/com/structurizr/export/plantuml/StructurizrPlantUMLDiagramExporterTests.java
diff --git a/...export/src/test/java/com/structurizr/export/plantuml/structurizr/36141-SystemContext.puml b/...export/src/test/java/com/structurizr/export/plantuml/structurizr/36141-SystemContext.puml
@@ -38,7 +38,7 @@ skinparam person<<PersonalBankingCustomer>> {
   shadowing false
 }
 
-rectangle "Big Bank plc" <<group1>> {
+rectangle "Big Bank plc" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #cccccc
   skinparam RectangleFontColor<<group1>> #cccccc
   skinparam RectangleBorderStyle<<group1>> dashed

diff --git a/...port/src/test/java/com/structurizr/export/plantuml/structurizr/36141-SystemLandscape.puml b/...port/src/test/java/com/structurizr/export/plantuml/structurizr/36141-SystemLandscape.puml
@@ -56,7 +56,7 @@ skinparam person<<PersonalBankingCustomer>> {
   shadowing false
 }
 
-rectangle "Big Bank plc" <<group1>> {
+rectangle "Big Bank plc" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #cccccc
   skinparam RectangleFontColor<<group1>> #cccccc
   skinparam RectangleBorderStyle<<group1>> dashed

diff --git a/...om/structurizr/export/plantuml/structurizr/dynamic-view-container-scoped-with-groups.puml b/...om/structurizr/export/plantuml/structurizr/dynamic-view-container-scoped-with-groups.puml
@@ -37,7 +37,7 @@ skinparam rectangle<<B.B>> {
 }
 
 rectangle "A\n<size:10>[Container]</size>" <<A.A>> {
-  rectangle "Group 1" <<group1>> {
+  rectangle "Group 1" <<group1>> as group1 {
     skinparam RectangleBorderColor<<group1>> #cccccc
     skinparam RectangleFontColor<<group1>> #cccccc
     skinparam RectangleBorderStyle<<group1>> dashed
@@ -48,7 +48,7 @@ rectangle "A\n<size:10>[Container]</size>" <<A.A>> {
 }
 
 rectangle "B\n<size:10>[Container]</size>" <<B.B>> {
-  rectangle "Group 2" <<group2>> {
+  rectangle "Group 2" <<group2>> as group2 {
     skinparam RectangleBorderColor<<group2>> #cccccc
     skinparam RectangleFontColor<<group2>> #cccccc
     skinparam RectangleBorderStyle<<group2>> dashed

diff --git a/...ucturizr/export/plantuml/structurizr/dynamic-view-software-system-scoped-with-groups.puml b/...ucturizr/export/plantuml/structurizr/dynamic-view-software-system-scoped-with-groups.puml
@@ -37,7 +37,7 @@ skinparam rectangle<<B>> {
 }
 
 rectangle "A\n<size:10>[Software System]</size>" <<A>> {
-  rectangle "Group 1" <<group1>> {
+  rectangle "Group 1" <<group1>> as group1 {
     skinparam RectangleBorderColor<<group1>> #cccccc
     skinparam RectangleFontColor<<group1>> #cccccc
     skinparam RectangleBorderStyle<<group1>> dashed
@@ -48,7 +48,7 @@ rectangle "A\n<size:10>[Software System]</size>" <<A>> {
 }
 
 rectangle "B\n<size:10>[Software System]</size>" <<B>> {
-  rectangle "Group 2" <<group2>> {
+  rectangle "Group 2" <<group2>> as group2 {
     skinparam RectangleBorderColor<<group2>> #cccccc
     skinparam RectangleFontColor<<group2>> #cccccc
     skinparam RectangleBorderStyle<<group2>> dashed

diff --git a/...t/java/com/structurizr/export/plantuml/structurizr/dynamic-view-unscoped-with-groups.puml b/...t/java/com/structurizr/export/plantuml/structurizr/dynamic-view-unscoped-with-groups.puml
@@ -26,15 +26,15 @@ skinparam rectangle<<B>> {
   shadowing false
 }
 
-rectangle "Group 1" <<group1>> {
+rectangle "Group 1" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #cccccc
   skinparam RectangleFontColor<<group1>> #cccccc
   skinparam RectangleBorderStyle<<group1>> dashed
 
   rectangle "==A\n<size:10>[Software System]</size>" <<A>> as A
 }
 
-rectangle "Group 2" <<group2>> {
+rectangle "Group 2" <<group2>> as group2 {
   skinparam RectangleBorderColor<<group2>> #cccccc
   skinparam RectangleFontColor<<group2>> #cccccc
   skinparam RectangleBorderStyle<<group2>> dashed

diff --git a/...rizr-export/src/test/java/com/structurizr/export/plantuml/structurizr/group-styles-1.puml b/...rizr-export/src/test/java/com/structurizr/export/plantuml/structurizr/group-styles-1.puml
@@ -32,23 +32,23 @@ skinparam rectangle<<User3>> {
   shadowing false
 }
 
-rectangle "Group 1\n\n<img:https://example.com/icon1.png{scale=1.0}>" <<group1>> {
+rectangle "Group 1\n\n<img:https://example.com/icon1.png{scale=1.0}>" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #111111
   skinparam RectangleFontColor<<group1>> #111111
   skinparam RectangleBorderStyle<<group1>> dashed
 
   rectangle "==User 1\n<size:10>[Person]</size>" <<User1>> as User1
 }
 
-rectangle "Group 2\n\n<img:https://example.com/icon2.png{scale=1.0}>" <<group2>> {
+rectangle "Group 2\n\n<img:https://example.com/icon2.png{scale=1.0}>" <<group2>> as group2 {
   skinparam RectangleBorderColor<<group2>> #222222
   skinparam RectangleFontColor<<group2>> #222222
   skinparam RectangleBorderStyle<<group2>> dashed
 
   rectangle "==User 2\n<size:10>[Person]</size>" <<User2>> as User2
 }
 
-rectangle "Group 3" <<group3>> {
+rectangle "Group 3" <<group3>> as group3 {
   skinparam RectangleBorderColor<<group3>> #cccccc
   skinparam RectangleFontColor<<group3>> #cccccc
   skinparam RectangleBorderStyle<<group3>> dashed

diff --git a/...rizr-export/src/test/java/com/structurizr/export/plantuml/structurizr/group-styles-2.puml b/...rizr-export/src/test/java/com/structurizr/export/plantuml/structurizr/group-styles-2.puml
@@ -32,23 +32,23 @@ skinparam rectangle<<User3>> {
   shadowing false
 }
 
-rectangle "Group 1\n\n<img:https://example.com/icon1.png{scale=1.0}>" <<group1>> {
+rectangle "Group 1\n\n<img:https://example.com/icon1.png{scale=1.0}>" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #111111
   skinparam RectangleFontColor<<group1>> #111111
   skinparam RectangleBorderStyle<<group1>> dashed
 
   rectangle "==User 1\n<size:10>[Person]</size>" <<User1>> as User1
 }
 
-rectangle "Group 2\n\n<img:https://example.com/icon2.png{scale=1.0}>" <<group2>> {
+rectangle "Group 2\n\n<img:https://example.com/icon2.png{scale=1.0}>" <<group2>> as group2 {
   skinparam RectangleBorderColor<<group2>> #222222
   skinparam RectangleFontColor<<group2>> #222222
   skinparam RectangleBorderStyle<<group2>> dashed
 
   rectangle "==User 2\n<size:10>[Person]</size>" <<User2>> as User2
 }
 
-rectangle "Group 3" <<group3>> {
+rectangle "Group 3" <<group3>> as group3 {
   skinparam RectangleBorderColor<<group3>> #aabbcc
   skinparam RectangleFontColor<<group3>> #aabbcc
   skinparam RectangleBorderStyle<<group3>> dashed

diff --git a/...r-export/src/test/java/com/structurizr/export/plantuml/structurizr/groups-Components.puml b/...r-export/src/test/java/com/structurizr/export/plantuml/structurizr/groups-Components.puml
@@ -40,7 +40,7 @@ skinparam rectangle<<D.F>> {
 rectangle "==C\n<size:10>[Software System]</size>" <<C>> as C
 
 rectangle "F\n<size:10>[Container]</size>" <<D.F>> {
-  rectangle "Group 5" <<group1>> {
+  rectangle "Group 5" <<group1>> as group1 {
     skinparam RectangleBorderColor<<group1>> #cccccc
     skinparam RectangleFontColor<<group1>> #cccccc
     skinparam RectangleBorderStyle<<group1>> dashed

diff --git a/...r-export/src/test/java/com/structurizr/export/plantuml/structurizr/groups-Containers.puml b/...r-export/src/test/java/com/structurizr/export/plantuml/structurizr/groups-Containers.puml
@@ -40,7 +40,7 @@ skinparam rectangle<<D>> {
 rectangle "==C\n<size:10>[Software System]</size>" <<C>> as C
 
 rectangle "D\n<size:10>[Software System]</size>" <<D>> {
-  rectangle "Group 4" <<group1>> {
+  rectangle "Group 4" <<group1>> as group1 {
     skinparam RectangleBorderColor<<group1>> #cccccc
     skinparam RectangleFontColor<<group1>> #cccccc
     skinparam RectangleBorderStyle<<group1>> dashed

diff --git a/...ort/src/test/java/com/structurizr/export/plantuml/structurizr/groups-SystemLandscape.puml b/...ort/src/test/java/com/structurizr/export/plantuml/structurizr/groups-SystemLandscape.puml
@@ -38,21 +38,21 @@ skinparam rectangle<<D>> {
   shadowing false
 }
 
-rectangle "Group 1" <<group1>> {
+rectangle "Group 1" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #cccccc
   skinparam RectangleFontColor<<group1>> #cccccc
   skinparam RectangleBorderStyle<<group1>> dashed
 
   rectangle "==B\n<size:10>[Software System]</size>" <<B>> as B
 }
 
-rectangle "Group 2" <<group2>> {
+rectangle "Group 2" <<group2>> as group2 {
   skinparam RectangleBorderColor<<group2>> #cccccc
   skinparam RectangleFontColor<<group2>> #cccccc
   skinparam RectangleBorderStyle<<group2>> dashed
 
   rectangle "==C\n<size:10>[Software System]</size>" <<C>> as C
-    rectangle "Group 3" <<group3>> {
+    rectangle "Group 3" <<group3>> as group3 {
       skinparam RectangleBorderColor<<group3>> #cccccc
       skinparam RectangleFontColor<<group3>> #cccccc
       skinparam RectangleBorderStyle<<group3>> dashed

diff --git a/...urizr-export/src/test/java/com/structurizr/export/plantuml/structurizr/nested-groups.puml b/...urizr-export/src/test/java/com/structurizr/export/plantuml/structurizr/nested-groups.puml
@@ -44,27 +44,27 @@ skinparam rectangle<<Team2>> {
   shadowing false
 }
 
-rectangle "Organisation 1" <<group1>> {
+rectangle "Organisation 1" <<group1>> as group1 {
   skinparam RectangleBorderColor<<group1>> #cccccc
   skinparam RectangleFontColor<<group1>> #cccccc
   skinparam RectangleBorderStyle<<group1>> dashed
 
   rectangle "==Organisation 1\n<size:10>[Software System]</size>" <<Organisation1>> as Organisation1
-    rectangle "Department 1" <<group2>> {
+    rectangle "Department 1" <<group2>> as group2 {
       skinparam RectangleBorderColor<<group2>> #cccccc
       skinparam RectangleFontColor<<group2>> #cccccc
       skinparam RectangleBorderStyle<<group2>> dashed
 
       rectangle "==Department 1\n<size:10>[Software System]</size>" <<Department1>> as Department1
-        rectangle "Team 1" <<group3>> {
+        rectangle "Team 1" <<group3>> as group3 {
           skinparam RectangleBorderColor<<group3>> #ff0000
           skinparam RectangleFontColor<<group3>> #ff0000
           skinparam RectangleBorderStyle<<group3>> dashed
 
           rectangle "==Team 1\n<size:10>[Software System]</size>" <<Team1>> as Team1
         }
 
-        rectangle "Team 2" <<group4>> {
+        rectangle "Team 2" <<group4>> as group4 {
           skinparam RectangleBorderColor<<group4>> #0000ff
           skinparam RectangleFontColor<<group4>> #0000ff
           skinparam RectangleBorderStyle<<group4>> dashed
@@ -76,7 +76,7 @@ rectangle "Organisation 1" <<group1>> {
 
 }
 
-rectangle "Organisation 2" <<group5>> {
+rectangle "Organisation 2" <<group5>> as group5 {
   skinparam RectangleBorderColor<<group5>> #cccccc
   skinparam RectangleFontColor<<group5>> #cccccc
   skinparam RectangleBorderStyle<<group5>> dashed