*PlantUML exporters: replaces skinparams with styles + adds support for dark mode exports.

Author: simonbrowndotje

changelog.md

@@ -18,6 +18,8 @@
 - structurizr-dsl: Constants and variables are inherited when extending a DSL workspace.
 - structurizr-dsl: DSL source is only stored in the JSON workspace when the DSL is deemed as "portable" (i.e. no files, plugins, scripts).
 - structurizr-export: Removes support for deprecated enterprise and location concepts.
+- structurizr-export: PlantUML exporters - replaces skinparams with styles.
+- structurizr-export: PlantUML exporters - adds support for dark mode exports.
 - structurizr-import: Adds support for `plantuml.inline`, `mermaid.inline`, `kroki.inline`, and `image.inline` properties to inline the resulting PNG/SVG file into the workspace.
 - structurizr-inspection: Adds a way to disable inspections via a workspace property named `structurizr.inspection` (`false` to disable).
 - structurizr-inspection: Default inspector adds a summary of error/warning/info/ignore counts as workspace properties.

structurizr-autolayout/src/test/java/com/structurizr/autolayout/graphviz/DOTExporterTests.java

@@ -8,6 +8,7 @@
 import com.structurizr.view.AutomaticLayout;
 import com.structurizr.view.Shape;
 import com.structurizr.view.SystemContextView;
+import com.structurizr.view.SystemLandscapeView;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
@@ -22,36 +23,36 @@ public void apply_Workspace() throws Exception {
         File tempDir = Files.createTempDirectory("graphviz").toFile();
         GraphvizAutomaticLayout graphviz = new GraphvizAutomaticLayout(tempDir);
 
-        Workspace workspace = new Workspace("Name", "");
-        Person user = workspace.getModel().addPerson("User");
-        SoftwareSystem softwareSystem = workspace.getModel().addSoftwareSystem("Software System");
-        user.uses(softwareSystem, "Uses");
+        Workspace workspace = new Workspace("Name");
+        SoftwareSystem a = workspace.getModel().addSoftwareSystem("A");
+        SoftwareSystem b = workspace.getModel().addSoftwareSystem("B");
+        a.uses(b, "Uses");
 
-        SystemContextView view = workspace.getViews().createSystemContextView(softwareSystem, "SystemContext", "");
+        SystemLandscapeView view = workspace.getViews().createSystemLandscapeView("key");
         view.addAllElements();
 
         workspace.getViews().getConfiguration().getStyles().addElementStyle(Tags.PERSON).shape(Shape.Person);
 
-        assertEquals(0, view.getElementView(user).getX());
-        assertEquals(0, view.getElementView(user).getY());
-        assertEquals(0, view.getElementView(softwareSystem).getX());
-        assertEquals(0, view.getElementView(softwareSystem).getY());
+        assertEquals(0, view.getElementView(a).getX());
+        assertEquals(0, view.getElementView(a).getY());
+        assertEquals(0, view.getElementView(b).getX());
+        assertEquals(0, view.getElementView(b).getY());
 
         graphviz.apply(workspace);
 
         // no change - the view doesn't have automatic layout configured
-        assertEquals(0, view.getElementView(user).getX());
-        assertEquals(0, view.getElementView(user).getY());
-        assertEquals(0, view.getElementView(softwareSystem).getX());
-        assertEquals(0, view.getElementView(softwareSystem).getY());
+        assertEquals(0, view.getElementView(a).getX());
+        assertEquals(0, view.getElementView(a).getY());
+        assertEquals(0, view.getElementView(b).getX());
+        assertEquals(0, view.getElementView(b).getY());
 
         view.enableAutomaticLayout(AutomaticLayout.RankDirection.TopBottom);
         graphviz.apply(workspace);
 
-        assertEquals(233, view.getElementView(user).getX());
-        assertEquals(208, view.getElementView(user).getY());
-        assertEquals(208, view.getElementView(softwareSystem).getX());
-        assertEquals(908, view.getElementView(softwareSystem).getY());
+        assertEquals(208, view.getElementView(a).getX());
+        assertEquals(208, view.getElementView(a).getY());
+        assertEquals(208, view.getElementView(b).getX());
+        assertEquals(808, view.getElementView(b).getY());
     }
 
 }

structurizr-autolayout/src/test/java/com/structurizr/autolayout/graphviz/GraphvizAutomaticLayoutTests.java

@@ -1,17 +1,43 @@
 package com.structurizr.view;
 
 import com.structurizr.PropertyHolder;
+import com.structurizr.util.StringUtils;
 
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class AbstractStyle implements PropertyHolder {
+public abstract class AbstractStyle implements PropertyHolder, Comparable<AbstractStyle> {
 
+    private String tag;
     private ColorScheme colorScheme = null;
-
     private Map<String, String> properties = new HashMap<>();
 
+    AbstractStyle() {
+    }
+
+    AbstractStyle(String tag) {
+        this.tag = tag;
+    }
+
+    AbstractStyle(String tag, ColorScheme colorScheme) {
+        this.tag = tag;
+        this.colorScheme = colorScheme;
+    }
+
+    /**
+     * The tag to which this style applies.
+     *
+     * @return  the tag, as a String
+     */
+    public String getTag() {
+        return tag;
+    }
+
+    void setTag(String tag) {
+        this.tag = tag;
+    }
+
     /**
      * Gets the color scheme of this style.
      *
@@ -46,11 +72,11 @@ public Map<String, String> getProperties() {
      * @param value     the value of the property
      */
     public void addProperty(String name, String value) {
-        if (name == null || name.trim().length() == 0) {
+        if (StringUtils.isNullOrEmpty(name)) {
             throw new IllegalArgumentException("A property name must be specified.");
         }
 
-        if (value == null || value.trim().length() == 0) {
+        if (StringUtils.isNullOrEmpty(value)) {
             throw new IllegalArgumentException("A property value must be specified.");
         }
 
@@ -63,4 +89,26 @@ void setProperties(Map<String, String> properties) {
         }
     }
 
+    @Override
+    public String toString() {
+        return this.tag + " (" + this.colorScheme + ")";
+    }
+
+    @Override
+    public int compareTo(AbstractStyle other) {
+        if (this.colorScheme == null && other.colorScheme == null) {
+            return this.tag.compareTo(other.tag);
+        }
+
+        if (this.colorScheme == null) {
+            return -1;
+        }
+
+        if (other.colorScheme == null) {
+            return 1;
+        }
+
+        return (this.colorScheme + "/" + this.tag).compareTo(other.colorScheme + "/" + other.tag);
+    }
+
 }

structurizr-core/src/main/java/com/structurizr/view/AbstractStyle.java

@@ -12,8 +12,6 @@ public final class ElementStyle extends AbstractStyle {
     public static final int DEFAULT_WIDTH = 450;
     public static final int DEFAULT_HEIGHT = 300;
 
-    private String tag;
-
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Integer width;
 
@@ -59,21 +57,21 @@ public final class ElementStyle extends AbstractStyle {
     ElementStyle() {
     }
 
-    ElementStyle(String tag) {
-        this.tag = tag;
+    public ElementStyle(String tag) {
+        super(tag);
     }
 
     ElementStyle(String tag, ColorScheme colorScheme) {
-        this.tag = tag;
-        setColorScheme(colorScheme);
+        super(tag, colorScheme);
     }
 
     public ElementStyle(String tag, Integer width, Integer height, String background, String color, Integer fontSize) {
         this(tag, width, height, background, color, fontSize, null);
     }
 
     public ElementStyle(String tag, Integer width, Integer height, String background, String color, Integer fontSize, Shape shape) {
-        this.tag = tag;
+        super(tag);
+
         this.width = width;
         this.height = height;
         setBackground(background);
@@ -82,19 +80,6 @@ public ElementStyle(String tag, Integer width, Integer height, String background
         this.shape = shape;
     }
 
-    /**
-     * The tag to which this element style applies.
-     *
-     * @return  the tag, as a String
-     */
-    public String getTag() {
-        return tag;
-    }
-
-    public void setTag(String tag) {
-        this.tag = tag;
-    }
-
     /**
      * Gets the width of the element, in pixels.
      *
@@ -443,6 +428,10 @@ void copyFrom(ElementStyle elementStyle) {
             this.setIcon(elementStyle.getIcon());
         }
 
+        if (elementStyle.getIconPosition() != null) {
+            this.setIconPosition(elementStyle.getIconPosition());
+        }
+
         if (elementStyle.getBorder() != null) {
             this.setBorder(elementStyle.getBorder());
         }

structurizr-core/src/main/java/com/structurizr/view/ElementStyle.java

@@ -8,9 +8,6 @@ public final class RelationshipStyle extends AbstractStyle {
     private static final int START_OF_LINE = 0;
     private static final int END_OF_LINE = 100;
 
-    /** the name of the tag to which this style applies */
-    private String tag;
-
     /** the thickness of the line, in pixels */
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Integer thickness;
@@ -54,21 +51,12 @@ public final class RelationshipStyle extends AbstractStyle {
     RelationshipStyle() {
     }
 
-    RelationshipStyle(String tag) {
-        this.tag = tag;
+    public RelationshipStyle(String tag) {
+        super(tag);
     }
 
     RelationshipStyle(String tag, ColorScheme colorScheme) {
-        this.tag = tag;
-        setColorScheme(colorScheme);
-    }
-
-    public String getTag() {
-        return tag;
-    }
-
-    public void setTag(String tag) {
-        this.tag = tag;
+        super(tag, colorScheme);
     }
 
     public Integer getThickness() {
@@ -253,6 +241,10 @@ void copyFrom(RelationshipStyle relationshipStyle) {
             this.setRouting(relationshipStyle.getRouting());
         }
 
+        if (relationshipStyle.getJump() != null) {
+            this.setJump(relationshipStyle.getJump());
+        }
+
         if (relationshipStyle.getFontSize() != null) {
             this.setFontSize(relationshipStyle.getFontSize());
         }