View keys will be automatically generated if not specified.

structurizr · Feb 18, 2024 · 3d8da34 · 3d8da34
1 parent 36edcae
commit 3d8da34
Show file tree

Hide file tree

Showing 13 changed files with 270 additions and 261 deletions.
diff --git a/changelog.md b/changelog.md
@@ -5,6 +5,7 @@
 - Removes deprecated concepts (e.g. enterprise and software system/person location).
 - structurizr-core: Adds `Workspace.trim()` to trim a workspace of unused elements (i.e. those not associated with any views).
 - structurizr-core: Adds support for SVG image views (https://github.com/structurizr/java/issues/249).
+- structurizr-core: View keys will be automatically generated if not specified.
 - structurizr-client: Removes `StructurizrClient` (use `WorkspaceApiClient` instead).
 - structurizr-import: Adds support for importing decisions managed by Log4brains.
 - structurizr-import: Adds support for importing decisions in MADR format.

diff --git a/structurizr-core/src/main/java/com/structurizr/view/View.java b/structurizr-core/src/main/java/com/structurizr/view/View.java
@@ -1,6 +1,7 @@
 package com.structurizr.view;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.structurizr.PropertyHolder;
 
 import javax.annotation.Nonnull;
@@ -13,6 +14,8 @@
 public abstract class View implements PropertyHolder {
 
     private String key;
+    private boolean generatedKey = false;
+
     private int order;
     private String title;
     private String description;
@@ -57,6 +60,20 @@ void setKey(String key) {
         this.key = key;
     }
 
+    /**
+     * Returns true if this view has an automatically generated view key, false otherwise.
+     *
+     * @return  true if this view has an automatically generated view key, false otherwise
+     */
+    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
+    public boolean isGeneratedKey() {
+        return generatedKey;
+    }
+
+    void setGeneratedKey(boolean generatedKey) {
+        this.generatedKey = generatedKey;
+    }
+
     /**
      * Gets the order of this view.
      *

diff --git a/structurizr-core/src/main/java/com/structurizr/view/ViewSet.java b/structurizr-core/src/main/java/com/structurizr/view/ViewSet.java
diff --git a/structurizr-core/src/test/java/com/structurizr/view/ViewSetTests.java b/structurizr-core/src/test/java/com/structurizr/view/ViewSetTests.java
diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/ComponentViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/ComponentViewParser.java
@@ -9,8 +9,6 @@ final class ComponentViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "component <container identifier> [key] [description] {";
 
-    private static final String VIEW_TYPE = "Component";
-
     private static final int CONTAINER_IDENTIFIER_INDEX = 1;
     private static final int KEY_INDEX = 2;
     private static final int DESCRIPTION_INDEX = 3;
@@ -44,10 +42,8 @@ ComponentView parse(DslContext context, Tokens tokens) {
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         if (tokens.includes(DESCRIPTION_INDEX)) {
             description = tokens.get(DESCRIPTION_INDEX);

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/ContainerViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/ContainerViewParser.java
@@ -9,8 +9,6 @@ final class ContainerViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "container <software system identifier> [key] [description] {";
 
-    private static final String VIEW_TYPE = "Container";
-
     private static final int SOFTWARE_SYSTEM_IDENTIFIER_INDEX = 1;
     private static final int KEY_INDEX = 2;
     private static final int DESCRIPTION_INDEX = 3;
@@ -44,10 +42,8 @@ ContainerView parse(DslContext context, Tokens tokens) {
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         if (tokens.includes(DESCRIPTION_INDEX)) {
             description = tokens.get(DESCRIPTION_INDEX);

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/CustomViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/CustomViewParser.java
@@ -7,8 +7,6 @@ final class CustomViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "custom [key] [title] [description] {";
 
-    private static final String VIEW_TYPE = "Custom";
-
     private static final int KEY_INDEX = 1;
     private static final int TITLE_INDEX = 2;
     private static final int DESCRIPTION_INDEX = 3;
@@ -27,10 +25,8 @@ CustomView parse(DslContext context, Tokens tokens) {
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         if (tokens.includes(TITLE_INDEX)) {
             title = tokens.get(TITLE_INDEX);

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/DeploymentViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/DeploymentViewParser.java
@@ -9,8 +9,6 @@ final class DeploymentViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "deployment <*|software system identifier> <environment> [key] [description] {";
 
-    private static final String VIEW_TYPE = "Deployment";
-
     private static final int SCOPE_IDENTIFIER_INDEX = 1;
     private static final int ENVIRONMENT_INDEX = 2;
     private static final int KEY_INDEX = 3;
@@ -51,10 +49,8 @@ DeploymentView parse(DslContext context, Tokens tokens) {
         if ("*".equals(scopeIdentifier)) {
             if (tokens.includes(KEY_INDEX)) {
                 key = tokens.get(KEY_INDEX);
-            } else {
-                key = workspace.getViews().generateViewKey(VIEW_TYPE);
+                validateViewKey(key);
             }
-            validateViewKey(key);
 
             view = workspace.getViews().createDeploymentView(key, description);
         } else {
@@ -66,10 +62,8 @@ DeploymentView parse(DslContext context, Tokens tokens) {
             if (element instanceof SoftwareSystem) {
                 if (tokens.includes(KEY_INDEX)) {
                     key = tokens.get(KEY_INDEX);
-                } else {
-                    key = workspace.getViews().generateViewKey(VIEW_TYPE);
+                    validateViewKey(key);
                 }
-                validateViewKey(key);
 
                 view = workspace.getViews().createDeploymentView((SoftwareSystem)element, key, description);
             } else {

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/DynamicViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/DynamicViewParser.java
@@ -6,14 +6,10 @@
 import com.structurizr.model.SoftwareSystem;
 import com.structurizr.view.DynamicView;
 
-import java.text.DecimalFormat;
-
 class DynamicViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "dynamic <*|software system identifier|container identifier> [key] [description] {";
 
-    private static final String VIEW_TYPE = "Dynamic";
-
     private static final int SCOPE_IDENTIFIER_INDEX = 1;
     private static final int KEY_INDEX = 2;
     private static final int DESCRIPTION_INDEX = 3;
@@ -45,10 +41,8 @@ DynamicView parse(DslContext context, Tokens tokens) {
         if (WILDCARD.equals(scopeIdentifier)) {
             if (tokens.includes(KEY_INDEX)) {
                 key = tokens.get(KEY_INDEX);
-            } else {
-                key = workspace.getViews().generateViewKey(VIEW_TYPE);
+                validateViewKey(key);
             }
-            validateViewKey(key);
 
             view = workspace.getViews().createDynamicView(key, description);
         } else {
@@ -60,20 +54,15 @@ DynamicView parse(DslContext context, Tokens tokens) {
             if (element instanceof SoftwareSystem) {
                 if (tokens.includes(KEY_INDEX)) {
                     key = tokens.get(KEY_INDEX);
-                } else {
-                    key = workspace.getViews().generateViewKey(VIEW_TYPE);
+                    validateViewKey(key);
                 }
-                validateViewKey(key);
 
                 view = workspace.getViews().createDynamicView((SoftwareSystem)element, key, description);
             } else if (element instanceof Container) {
-                Container container = (Container)element;
                 if (tokens.includes(KEY_INDEX)) {
                     key = tokens.get(KEY_INDEX);
-                } else {
-                    key = workspace.getViews().generateViewKey(VIEW_TYPE);
+                    validateViewKey(key);
                 }
-                validateViewKey(key);
 
                 view = workspace.getViews().createDynamicView((Container)element, key, description);
             } else {

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/FilteredViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/FilteredViewParser.java
@@ -14,8 +14,6 @@ final class FilteredViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "filtered <baseKey> <include|exclude> <tags> [key] [description]";
 
-    private static final String VIEW_TYPE = "Filtered";
-
     private static final int BASE_KEY_INDEX = 1;
     private static final int MODE_INDEX = 2;
     private static final int TAGS_INDEX = 3;
@@ -37,7 +35,7 @@ FilteredView parse(DslContext context, Tokens tokens) {
         }
 
         Workspace workspace = context.getWorkspace();
-        String key;
+        String key = "";
 
         StaticView baseView;
         String baseKey = tokens.get(BASE_KEY_INDEX);
@@ -77,10 +75,8 @@ FilteredView parse(DslContext context, Tokens tokens) {
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         return workspace.getViews().createFilteredView(baseView, key, description, filterMode, tags.toArray(new String[0]));
     }

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/ImageViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/ImageViewParser.java
@@ -8,8 +8,6 @@ class ImageViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "image <*|element identifier> [key] {";
 
-    private static final String VIEW_TYPE = "Image";
-
     private static final int SCOPE_IDENTIFIER_INDEX = 1;
     private static final int KEY_INDEX = 2;
 
@@ -32,10 +30,8 @@ ImageView parse(DslContext context, Tokens tokens) {
         ImageView view;
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         String scopeIdentifier = tokens.get(SCOPE_IDENTIFIER_INDEX);
         if (WILDCARD.equals(scopeIdentifier)) {

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/SystemContextViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/SystemContextViewParser.java
@@ -9,8 +9,6 @@ final class SystemContextViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "systemContext <software system identifier> [key] [description] {";
 
-    private static final String VIEW_TYPE = "SystemContext";
-
     private static final int SOFTWARE_SYSTEM_IDENTIFIER_INDEX = 1;
     private static final int KEY_INDEX = 2;
     private static final int DESCRIPTION_INDEX = 3;
@@ -44,10 +42,8 @@ SystemContextView parse(DslContext context, Tokens tokens) {
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         if (tokens.includes(DESCRIPTION_INDEX)) {
             description = tokens.get(DESCRIPTION_INDEX);

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/SystemLandscapeViewParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/SystemLandscapeViewParser.java
@@ -7,8 +7,6 @@ final class SystemLandscapeViewParser extends AbstractViewParser {
 
     private static final String GRAMMAR = "systemLandscape [key] [description] {";
 
-    private static final String VIEW_TYPE = "SystemLandscape";
-
     private static final int KEY_INDEX = 1;
     private static final int DESCRIPTION_INDEX = 2;
 
@@ -25,10 +23,8 @@ SystemLandscapeView parse(DslContext context, Tokens tokens) {
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
-        } else {
-            key = workspace.getViews().generateViewKey(VIEW_TYPE);
+            validateViewKey(key);
         }
-        validateViewKey(key);
 
         if (tokens.includes(DESCRIPTION_INDEX)) {
             description = tokens.get(DESCRIPTION_INDEX);