Zero pads automatically generated view keys for better sorting.

Author: simonbrowndotje

build.gradle

@@ -27,7 +27,7 @@ targetCompatibility = 1.8
 
 description = 'Structurizr DSL'
 group = 'com.structurizr'
-version = '1.26.1'
+version = '1.26.2'
 
 test {
     useJUnitPlatform()

docs/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.26.2 (21st February 2023)
+
+- Zero pads automatically generated view keys for better sorting. 
+
 ## 1.26.1 (18th February 2023)
 
 - Sets titles for image view content specified via URLs.

src/main/java/com/structurizr/dsl/AbstractViewParser.java

@@ -4,17 +4,21 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
+import java.text.DecimalFormat;
+import java.text.NumberFormat;
+
 abstract class AbstractViewParser extends AbstractParser {
 
     private static final Log log = LogFactory.getLog(AbstractViewParser.class);
 
     protected String generateViewKey(Workspace workspace, String prefix) {
+        NumberFormat format = new DecimalFormat("000");
         int counter = 1;
-        String key = prefix + "-" + counter;
+        String key = prefix + "-" + format.format(counter);
 
         while (hasViewWithKey(workspace, key)) {
             counter++;
-            key = prefix + "-" + counter;
+            key = prefix + "-" + format.format(counter);
         }
 
         log.warn(key + " is an automatically generated view key - you will likely lose manual layout information when using automatically generated view keys.");

src/test/java/com/structurizr/dsl/ComponentViewParserTests.java

@@ -71,7 +71,7 @@ void test_parse_CreatesAComponentView() {
         List<ComponentView> views = new ArrayList<>(context.getWorkspace().getViews().getComponentViews());
 
         assertEquals(1, views.size());
-        assertEquals("Component-1", views.get(0).getKey());
+        assertEquals("Component-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
         assertTrue(views.get(0).getExternalContainerBoundariesVisible());
     }

src/test/java/com/structurizr/dsl/ContainerViewParserTests.java

@@ -71,7 +71,7 @@ void test_parse_CreatesAContainerView() {
         List<ContainerView> views = new ArrayList<>(context.getWorkspace().getViews().getContainerViews());
 
         assertEquals(1, views.size());
-        assertEquals("Container-1", views.get(0).getKey());
+        assertEquals("Container-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
         assertTrue(views.get(0).getExternalSoftwareSystemBoundariesVisible());
     }

src/test/java/com/structurizr/dsl/CustomViewParserTests.java

@@ -31,7 +31,7 @@ void test_parse_CreatesACustomView() {
         List<CustomView> views = new ArrayList<>(context.getWorkspace().getViews().getCustomViews());
 
         assertEquals(1, views.size());
-        assertEquals("Custom-1", views.get(0).getKey());
+        assertEquals("Custom-001", views.get(0).getKey());
         assertEquals("", views.get(0).getTitle());
         assertEquals("", views.get(0).getDescription());
     }

src/test/java/com/structurizr/dsl/DeploymentViewParserTests.java

@@ -96,7 +96,7 @@ void test_parse_CreatesADeploymentViewWithNoScope() {
         List<DeploymentView> views = new ArrayList<>(this.views.getDeploymentViews());
 
         assertEquals(1, views.size());
-        assertEquals("Deployment-1", views.get(0).getKey());
+        assertEquals("Deployment-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
         assertNull(views.get(0).getSoftwareSystem());
     }
@@ -163,7 +163,7 @@ void test_parse_CreatesADeploymentViewWithSoftwareSystemScope() {
         List<DeploymentView> views = new ArrayList<>(this.views.getDeploymentViews());
 
         assertEquals(1, views.size());
-        assertEquals("Deployment-1", views.get(0).getKey());
+        assertEquals("Deployment-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
         assertSame(softwareSystem, views.get(0).getSoftwareSystem());
     }

src/test/java/com/structurizr/dsl/DslTests.java

@@ -59,7 +59,7 @@ void test_gettingstarted() throws Exception {
         assertEquals(1, views.getViews().size());
         assertEquals(1, views.getSystemContextViews().size());
         SystemContextView view = views.getSystemContextViews().iterator().next();
-        assertEquals("SystemContext-1", view.getKey());
+        assertEquals("SystemContext-001", view.getKey());
         assertEquals(2, view.getElements().size());
         assertEquals(1, view.getRelationships().size());
     }
@@ -1028,9 +1028,9 @@ void test_viewsWithoutKeys() throws Exception {
         StructurizrDslParser parser = new StructurizrDslParser();
         parser.parse(new File("src/test/dsl/views-without-keys.dsl"));
 
-        assertTrue(parser.getWorkspace().getViews().getSystemLandscapeViews().stream().anyMatch(view -> view.getKey().equals("SystemLandscape-1")));
-        assertTrue(parser.getWorkspace().getViews().getSystemLandscapeViews().stream().anyMatch(view -> view.getKey().equals("SystemLandscape-2")));
-        assertTrue(parser.getWorkspace().getViews().getSystemLandscapeViews().stream().anyMatch(view -> view.getKey().equals("SystemLandscape-3")));
+        assertTrue(parser.getWorkspace().getViews().getSystemLandscapeViews().stream().anyMatch(view -> view.getKey().equals("SystemLandscape-001")));
+        assertTrue(parser.getWorkspace().getViews().getSystemLandscapeViews().stream().anyMatch(view -> view.getKey().equals("SystemLandscape-002")));
+        assertTrue(parser.getWorkspace().getViews().getSystemLandscapeViews().stream().anyMatch(view -> view.getKey().equals("SystemLandscape-003")));
     }
 
     @Test

src/test/java/com/structurizr/dsl/DynamicViewParserTests.java

@@ -41,7 +41,7 @@ void test_parse_GeneratesAKey_WhenTheKeyIsMissing() {
         DslContext context = context();
         DynamicView view = parser.parse(context, tokens("dynamic", "*"));
 
-        assertEquals("Dynamic-1", view.getKey());
+        assertEquals("Dynamic-001", view.getKey());
     }
 
     @Test
@@ -104,7 +104,7 @@ void test_parse_CreatesADynamicViewWithSoftwareSystemScope() {
         List<DynamicView> views = new ArrayList<>(this.views.getDynamicViews());
 
         assertEquals(1, views.size());
-        assertEquals("Dynamic-1", views.get(0).getKey());
+        assertEquals("Dynamic-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
         assertSame(softwareSystem, views.get(0).getElement());
     }
@@ -155,7 +155,7 @@ void test_parse_CreatesADynamicViewWithContainerScope() {
         List<DynamicView> views = new ArrayList<>(this.views.getDynamicViews());
 
         assertEquals(1, views.size());
-        assertEquals("Dynamic-1", views.get(0).getKey());
+        assertEquals("Dynamic-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
         assertSame(container, views.get(0).getElement());
     }

src/test/java/com/structurizr/dsl/FilteredViewParserTests.java

@@ -99,7 +99,7 @@ void test_parse_CreatesAFilteredView() {
         List<FilteredView> views = new ArrayList<>(context.getWorkspace().getViews().getFilteredViews());
 
         assertEquals(1, views.size());
-        assertEquals("Filtered-1", views.get(0).getKey());
+        assertEquals("Filtered-001", views.get(0).getKey());
         assertEquals(2, views.get(0).getTags().size());
         assertTrue(views.get(0).getTags().contains("Tag 1"));
         assertTrue(views.get(0).getTags().contains("Tag 2"));

src/test/java/com/structurizr/dsl/SystemContextViewParserTests.java

@@ -72,7 +72,7 @@ void test_parse_CreatesASystemContextView() {
         List<SystemContextView> views = new ArrayList<>(context.getWorkspace().getViews().getSystemContextViews());
 
         assertEquals(1, views.size());
-        assertEquals("SystemContext-1", views.get(0).getKey());
+        assertEquals("SystemContext-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
     }
 

src/test/java/com/structurizr/dsl/SystemLandscapeViewParserTests.java

@@ -31,7 +31,7 @@ void test_parse_CreatesASystemLandscapeView() {
         List<SystemLandscapeView> views = new ArrayList<>(context.getWorkspace().getViews().getSystemLandscapeViews());
 
         assertEquals(1, views.size());
-        assertEquals("SystemLandscape-1", views.get(0).getKey());
+        assertEquals("SystemLandscape-001", views.get(0).getKey());
         assertEquals("", views.get(0).getDescription());
     }