structurizr-dsl: DSL source is only stored in the JSON workspace when the DSL is deemed as "portable" (i.e. no files, plugins, scripts).

Author: simonbrowndotje

changelog.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## v4.2.0 (unreleased)
+## v5.0.0 (unreleased)
 
 - structurizr-java: Fixes https://github.com/structurizr/java/issues/437 (Make ComponentFinder.run() not fail on empty Set<DiscoveredComponent>).
 - structurizr-dsl: Adds support for `iconPosition` on element styles (options are `Top`, `Bottom`, `Left`).
@@ -15,6 +15,7 @@
 - structurizr-dsl: Adds support for a `jump` property on relationship styles.
 - structurizr-dsl: PlantUML, Mermaid, and Kroki image views can now be defined by an inline source block.
 - 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-import: Adds support for `plantuml.inline`, `mermaid.inline`, and `kroki.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.

gradle.properties

@@ -5,4 +5,4 @@ signing.secretKeyRingFile=/some/path
 ossrhUsername=username
 ossrhPassword=password
 
-version=4.2.0
+version=5.0.0

structurizr-core/src/main/java/com/structurizr/AbstractWorkspace.java

@@ -1,6 +1,7 @@
 package com.structurizr;
 
 import com.structurizr.configuration.WorkspaceConfiguration;
+import com.structurizr.util.StringUtils;
 
 import java.lang.reflect.Constructor;
 import java.util.Collections;
@@ -229,17 +230,30 @@ 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.");
         }
 
         properties.put(name, value);
     }
 
+    /**
+     * Removes a name-value pair property from this workspace.
+     *
+     * @param name      the name of the property to remove
+     */
+    public void removeProperty(String name) {
+        if (StringUtils.isNullOrEmpty(name)) {
+            throw new IllegalArgumentException("A property name must be specified.");
+        }
+
+        properties.remove(name);
+    }
+
     void setProperties(Map<String, String> properties) {
         if (properties != null) {
             this.properties = new HashMap<>(properties);

structurizr-dsl/src/main/java/com/structurizr/dsl/BrandingParser.java

@@ -30,6 +30,7 @@ void parseLogo(BrandingDslContext context, Tokens tokens, boolean restricted) {
                 if (!restricted) {
                     File file = new File(context.getFile().getParent(), path);
                     if (file.exists() && !file.isDirectory()) {
+                        context.setDslPortable(false);
                         try {
                             String dataUri = ImageUtils.getImageAsDataUri(file);
                             context.getWorkspace().getViews().getConfiguration().getBranding().setLogo(dataUri);

structurizr-dsl/src/main/java/com/structurizr/dsl/ComponentFinderDslContext.java

@@ -16,6 +16,7 @@ final class ComponentFinderDslContext extends DslContext {
         this.dslParser = dslParser;
         this.containerDslContext = containerDslContext;
         componentFinderBuilder.forContainer(containerDslContext.getContainer());
+        setDslPortable(false);
     }
 
     @Override

structurizr-dsl/src/main/java/com/structurizr/dsl/DecisionsParser.java

@@ -47,6 +47,8 @@ void parse(ComponentDslContext context, File dslFile, Tokens tokens) {
     private void parse(DslContext context, Documentable documentable, File dslFile, Tokens tokens) {
         // !adrs <path>
 
+        context.setDslPortable(false);
+
         if (tokens.hasMoreThan(TYPE_OR_FQN_INDEX)) {
             throw new RuntimeException("Too many tokens, expected: " + GRAMMAR);
         }

structurizr-dsl/src/main/java/com/structurizr/dsl/DocsParser.java

@@ -35,6 +35,8 @@ void parse(ComponentDslContext context, File dslFile, Tokens tokens) {
     private void parse(DslContext context, Documentable documentable, File dslFile, Tokens tokens) {
         // !docs <path>
 
+        context.setDslPortable(false);
+
         if (tokens.hasMoreThan(FQN_INDEX)) {
             throw new RuntimeException("Too many tokens, expected: " + GRAMMAR);
         }

structurizr-dsl/src/main/java/com/structurizr/dsl/DslContext.java

@@ -17,6 +17,7 @@ abstract class DslContext {
 
     private Workspace workspace;
     private boolean extendingWorkspace;
+    private boolean dslPortable = true;
 
     protected IdentifiersRegister identifiersRegister = new IdentifiersRegister();
 
@@ -36,6 +37,14 @@ void setExtendingWorkspace(boolean extendingWorkspace) {
         this.extendingWorkspace = extendingWorkspace;
     }
 
+    boolean isDslPortable() {
+        return dslPortable;
+    }
+
+    void setDslPortable(boolean bool) {
+        this.dslPortable = bool;
+    }
+
     void setIdentifierRegister(IdentifiersRegister identifersRegister) {
         this.identifiersRegister = identifersRegister;
     }

structurizr-dsl/src/main/java/com/structurizr/dsl/DslLine.java

@@ -8,8 +8,8 @@ class DslLine {
     private final String source;
     private final int lineNumber;
 
-    DslLine(String source, int lineNumber) {
-        this.source = source;
+    DslLine(String processedSource, int lineNumber) {
+        this.source = processedSource;
         this.lineNumber = lineNumber;
     }
 

structurizr-dsl/src/main/java/com/structurizr/dsl/DslUtils.java

@@ -42,4 +42,13 @@ public static void setDsl(Workspace workspace, String dsl) {
         }
     }
 
+    /**
+     * Clears the DSL associated with a workspace.
+     *
+     * @param workspace     a Workspace object
+     */
+    public static void clearDsl(Workspace workspace) {
+        workspace.removeProperty(STRUCTURIZR_DSL_PROPERTY_NAME);
+    }
+
 }