Adds a "default" keyword, for setting the default view.

structurizr · Feb 18, 2023 · 06c6b3a · 06c6b3a
1 parent 567fe9c
commit 06c6b3a
Show file tree

Hide file tree

Showing 12 changed files with 129 additions and 2 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -3,6 +3,7 @@
 ## 1.26.1 (18th February 2023)
 
 - Sets titles for image view content specified via URLs.
+- Adds a `default` keyword, for setting the default view.
 
 ## 1.26.0 (17th February 2023)
 

diff --git a/docs/language-reference.md b/docs/language-reference.md
@@ -981,6 +981,7 @@ Permitted children:
 - [include](#include)
 - [exclude](#exclude)
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [animation](#animation)
 - [title](#title)
 - [description](#description)
@@ -1003,6 +1004,7 @@ Permitted children:
 - [include](#include)
 - [exclude](#exclude)
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [animation](#animation)
 - [title](#title)
 - [description](#description)
@@ -1025,6 +1027,7 @@ Permitted children:
 - [include](#include)
 - [exclude](#exclude)
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [animation](#animation)
 - [title](#title)
 - [description](#description)
@@ -1047,6 +1050,7 @@ Permitted children:
 - [include](#include)
 - [exclude](#exclude)
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [animation](#animation)
 - [title](#title)
 - [description](#description)
@@ -1057,13 +1061,22 @@ Permitted children:
 The `filtered` keyword is used to define a [Filtered view](https://structurizr.com/help/filtered-views) on top of the specified view.
 
 ```
-filtered <baseKey> <include|exclude> <tags> [key] [description]
+filtered <baseKey> <include|exclude> <tags> [key] [description] {
+    ...
+}
 ```
 
 The `baseKey` specifies the key of the System Landscape, System Context, Container, or Component view on which this filtered view should be based. The mode (`include` or `exclude`) defines whether the view should include or exclude elements/relationships based upon the `tags` provided.
 
 Please note that once a filtered view is defined for a given "base view", that base view will no longer show up in your diagram list when using the Structurizr renderer. This is by design. If you'd like to see the base view too, just create another filtered view for the same base view, which includes the `Element` and `Relationship` tags.
 
+Permitted children:
+
+- [default](#default)
+- [title](#title)
+- [description](#description)
+- [properties](#properties)
+
 ```
 filtered <baseKey> include "Element,Relationship" [key] [description]
 ```
@@ -1100,6 +1113,7 @@ See [parallel.dsl](../src/test/dsl/parallel.dsl) for an example of how to create
 Permitted children:
 
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [title](#title)
 - [description](#description)
 - [properties](#properties)
@@ -1126,6 +1140,7 @@ Permitted children:
 - [include](#include)
 - [exclude](#exclude)
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [animation](#animation)
 - [title](#title)
 - [description](#description)
@@ -1146,6 +1161,7 @@ Permitted children:
 - [include](#include)
 - [exclude](#exclude)
 - [autoLayout](#autoLayout)
+- [default](#default)
 - [animation](#animation)
 - [title](#title)
 - [description](#description)
@@ -1250,6 +1266,14 @@ The second property is the separation of ranks in pixels (default: `300`), while
 Please note that if your DSL workspace does not explicitly define any views, the DSL parser will automatically create a default set of views for you, with auto-layout enabled.
 To change this behaviour, you can either (1) explicitly define your views or (2) use a script to disable automatic layout ([example](https://github.com/structurizr/dsl/tree/master/docs/cookbook/scripts#create-the-default-views-without-automatic-layout)).
 
+### default
+
+Sets the default view to be shown.
+
+```
+default
+```
+
 ### animation
 
 The `animation` keyword defines the animation for the specified view.

diff --git a/src/main/java/com/structurizr/dsl/CustomViewDslContext.java b/src/main/java/com/structurizr/dsl/CustomViewDslContext.java
@@ -18,6 +18,7 @@ protected String[] getPermittedTokens() {
                 StructurizrDslTokens.INCLUDE_IN_VIEW_TOKEN,
                 StructurizrDslTokens.EXCLUDE_IN_VIEW_TOKEN,
                 StructurizrDslTokens.AUTOLAYOUT_VIEW_TOKEN,
+                StructurizrDslTokens.DEFAULT_VIEW_TOKEN,
                 StructurizrDslTokens.ANIMATION_IN_VIEW_TOKEN,
                 StructurizrDslTokens.VIEW_TITLE_TOKEN,
                 StructurizrDslTokens.VIEW_DESCRIPTION_TOKEN,

diff --git a/src/main/java/com/structurizr/dsl/DefaultViewParser.java b/src/main/java/com/structurizr/dsl/DefaultViewParser.java
@@ -0,0 +1,12 @@
+package com.structurizr.dsl;
+
+import com.structurizr.view.View;
+
+final class DefaultViewParser extends AbstractParser {
+
+    void parse(ViewDslContext context) {
+        View view = context.getView();
+        context.getWorkspace().getViews().getConfiguration().setDefaultView(view);
+    }
+
+}
diff --git a/src/main/java/com/structurizr/dsl/DeploymentViewDslContext.java b/src/main/java/com/structurizr/dsl/DeploymentViewDslContext.java
@@ -18,6 +18,7 @@ protected String[] getPermittedTokens() {
                 StructurizrDslTokens.INCLUDE_IN_VIEW_TOKEN,
                 StructurizrDslTokens.EXCLUDE_IN_VIEW_TOKEN,
                 StructurizrDslTokens.AUTOLAYOUT_VIEW_TOKEN,
+                StructurizrDslTokens.DEFAULT_VIEW_TOKEN,
                 StructurizrDslTokens.ANIMATION_IN_VIEW_TOKEN,
                 StructurizrDslTokens.VIEW_TITLE_TOKEN,
                 StructurizrDslTokens.VIEW_DESCRIPTION_TOKEN,

diff --git a/src/main/java/com/structurizr/dsl/DynamicViewDslContext.java b/src/main/java/com/structurizr/dsl/DynamicViewDslContext.java
@@ -16,6 +16,7 @@ DynamicView getView() {
     protected String[] getPermittedTokens() {
         return new String[] {
                 StructurizrDslTokens.AUTOLAYOUT_VIEW_TOKEN,
+                StructurizrDslTokens.DEFAULT_VIEW_TOKEN,
                 StructurizrDslTokens.VIEW_TITLE_TOKEN,
                 StructurizrDslTokens.VIEW_DESCRIPTION_TOKEN,
                 StructurizrDslTokens.PROPERTIES_TOKEN,

diff --git a/src/main/java/com/structurizr/dsl/FilteredViewDslContext.java b/src/main/java/com/structurizr/dsl/FilteredViewDslContext.java
@@ -0,0 +1,25 @@
+package com.structurizr.dsl;
+
+import com.structurizr.view.FilteredView;
+
+class FilteredViewDslContext extends ViewDslContext {
+
+    FilteredViewDslContext(FilteredView view) {
+        super(view);
+    }
+
+    FilteredView getView() {
+        return (FilteredView)super.getView();
+    }
+
+    @Override
+    protected String[] getPermittedTokens() {
+        return new String[] {
+                StructurizrDslTokens.DEFAULT_VIEW_TOKEN,
+                StructurizrDslTokens.VIEW_TITLE_TOKEN,
+                StructurizrDslTokens.VIEW_DESCRIPTION_TOKEN,
+                StructurizrDslTokens.PROPERTIES_TOKEN
+        };
+    }
+
+}
diff --git a/src/main/java/com/structurizr/dsl/StaticViewDslContext.java b/src/main/java/com/structurizr/dsl/StaticViewDslContext.java
@@ -18,6 +18,7 @@ protected String[] getPermittedTokens() {
                 StructurizrDslTokens.INCLUDE_IN_VIEW_TOKEN,
                 StructurizrDslTokens.EXCLUDE_IN_VIEW_TOKEN,
                 StructurizrDslTokens.AUTOLAYOUT_VIEW_TOKEN,
+                StructurizrDslTokens.DEFAULT_VIEW_TOKEN,
                 StructurizrDslTokens.ANIMATION_IN_VIEW_TOKEN,
                 StructurizrDslTokens.VIEW_TITLE_TOKEN,
                 StructurizrDslTokens.VIEW_DESCRIPTION_TOKEN,

diff --git a/src/main/java/com/structurizr/dsl/StructurizrDslParser.java b/src/main/java/com/structurizr/dsl/StructurizrDslParser.java
@@ -590,7 +590,11 @@ void parse(List<String> lines, File dslFile) throws StructurizrDslParserExceptio
                         startContext(new DeploymentViewDslContext(view));
 
                     } else if (FILTERED_VIEW_TOKEN.equalsIgnoreCase(firstToken) && inContext(ViewsDslContext.class)) {
-                        new FilteredViewParser().parse(getContext(), tokens);
+                        FilteredView view = new FilteredViewParser().parse(getContext(), tokens.withoutContextStartToken());
+
+                        if (shouldStartContext(tokens)) {
+                            startContext(new FilteredViewDslContext(view));
+                        }
 
                     } else if (IMAGE_VIEW_TOKEN.equalsIgnoreCase(firstToken) && inContext(ViewsDslContext.class)) {
                         ImageView view = new ImageViewParser().parse(getContext(), tokens.withoutContextStartToken());
@@ -647,6 +651,9 @@ void parse(List<String> lines, File dslFile) throws StructurizrDslParserExceptio
                     } else if (AUTOLAYOUT_VIEW_TOKEN.equalsIgnoreCase(firstToken) && inContext(ViewDslContext.class)) {
                         new AutoLayoutParser().parse(getContext(ModelViewDslContext.class), tokens);
 
+                    } else if (DEFAULT_VIEW_TOKEN.equalsIgnoreCase(firstToken) && inContext(ViewDslContext.class)) {
+                        new DefaultViewParser().parse(getContext(ViewDslContext.class));
+
                     } else if (VIEW_TITLE_TOKEN.equalsIgnoreCase(firstToken) && inContext(ViewDslContext.class)) {
                         new ViewParser().parseTitle(getContext(ViewDslContext.class), tokens);
 

diff --git a/src/main/java/com/structurizr/dsl/StructurizrDslTokens.java b/src/main/java/com/structurizr/dsl/StructurizrDslTokens.java
@@ -48,6 +48,7 @@ class StructurizrDslTokens {
     static final String ANIMATION_IN_VIEW_TOKEN = "animation";
     static final String ANIMATION_STEP_IN_VIEW_TOKEN = "animationStep";
     static final String AUTOLAYOUT_VIEW_TOKEN = "autolayout";
+    static final String DEFAULT_VIEW_TOKEN = "default";
     static final String VIEW_TITLE_TOKEN = "title";
     static final String VIEW_DESCRIPTION_TOKEN = "description";
     static final String PLANTUML_TOKEN = "plantuml";

diff --git a/src/test/dsl/test.dsl b/src/test/dsl/test.dsl
@@ -146,6 +146,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         systemLandscape "SystemLandscape" "Description" {
@@ -158,6 +160,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         systemContext softwareSystem "SystemContext" "Description" {
@@ -170,6 +174,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         container softwareSystem "Containers" "Description" {
@@ -182,6 +188,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         component webApplication "Components" "Description" {
@@ -194,6 +202,21 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
+        }
+
+        filtered "SystemLandscape" include "Element,Relationship" "Filtered1"
+
+        filtered "SystemLandscape" include "Element,Relationship" "Filtered2" {
+            title "Filtered view"
+            description "Description"
+
+            properties {
+                "Name" "Value"
+            }
+
+            default
         }
 
         dynamic webApplication "Dynamic" "Description" {
@@ -206,6 +229,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         deployment * developmentEnvironment "Deployment-Development" "Description" {
@@ -218,6 +243,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         deployment * "Live" "Deployment-Live" "Description" {
@@ -230,6 +257,8 @@ workspace "Name" "Description" {
             properties {
                 "Name" "Value"
             }
+
+            default
         }
 
         styles {

diff --git a/src/test/java/com/structurizr/dsl/DefaultViewParserTests.java b/src/test/java/com/structurizr/dsl/DefaultViewParserTests.java
@@ -0,0 +1,24 @@
+package com.structurizr.dsl;
+
+import com.structurizr.view.SystemLandscapeView;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class DefaultViewParserTests extends AbstractTests {
+
+    private final DefaultViewParser parser = new DefaultViewParser();
+
+    @Test
+    void test_parse_SetsTheDefaultView() {
+        SystemLandscapeView view = workspace.getViews().createSystemLandscapeView("key", "description");
+        SystemLandscapeViewDslContext context = new SystemLandscapeViewDslContext(view);
+        context.setWorkspace(workspace);
+
+        assertNull(context.getWorkspace().getViews().getConfiguration().getDefaultView());
+        parser.parse(context);
+        assertEquals("key", context.getWorkspace().getViews().getConfiguration().getDefaultView());
+    }
+
+}