Adds a way to remove views from the workspace.

Author: simonbrowndotje

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

@@ -630,6 +630,49 @@ public View getViewWithKey(String key) {
         return getViews().stream().filter(v -> key.equals(v.getKey())).findFirst().orElse(null);
     }
 
+    /**
+     * Removes the view with the specified key.
+     *
+     * @param key   the key
+     * @throws  IllegalArgumentException    if a view with the specified key could not be found
+     */
+    public void removeViewWithKey(String key) {
+        if (StringUtils.isNullOrEmpty(key)) {
+            throw new IllegalArgumentException("A view key must be specified.");
+        }
+
+        View view = getViewWithKey(key);
+        if (view == null) {
+            throw new IllegalArgumentException("A view with key \"" + key + "\" does not exist.");
+        }
+
+        for (FilteredView filteredView : filteredViews) {
+            if (filteredView.getBaseViewKey().equals(key)) {
+                throw new IllegalArgumentException("A filtered view based upon \"" + key + "\" exists - please remove this first.");
+            }
+        }
+
+        if (view instanceof CustomView) {
+            customViews.remove(view);
+        } else if (view instanceof SystemLandscapeView) {
+            systemLandscapeViews.remove(view);
+        } else if (view instanceof SystemContextView) {
+            systemContextViews.remove(view);
+        } else if (view instanceof ContainerView) {
+            containerViews.remove(view);
+        } else if (view instanceof ComponentView) {
+            componentViews.remove(view);
+        } else if (view instanceof DynamicView) {
+            dynamicViews.remove(view);
+        } else if (view instanceof DeploymentView) {
+            deploymentViews.remove(view);
+        } else if (view instanceof ImageView) {
+            imageViews.remove(view);
+        } else if (view instanceof FilteredView) {
+            filteredViews.remove(view);
+        }
+    }
+
     /**
      * Finds the filtered view with the specified key, or null if the view does not exist.
      *

structurizr-core/src/test/java/com/structurizr/view/ViewSetTests.java

@@ -1090,4 +1090,141 @@ public void createDefaultViews_ForSoftwareSystemsWithNamesUsingUTF8Characters()
         assertSame(ss3, workspace.getViews().getSystemContextViews().stream().filter(v -> v.getKey().equals("SystemContext-003")).findFirst().get().getSoftwareSystem());
     }
 
+    @Test
+    void removeViewWithKey_ThrowsAndException_WhenNoKeyIsSpecified() {
+        try {
+            new Workspace("Name").getViews().removeViewWithKey(null);
+            fail();
+        } catch (Exception e) {
+            assertEquals("A view key must be specified.", e.getMessage());
+        }
+
+        try {
+            new Workspace("Name").getViews().removeViewWithKey("");
+            fail();
+        } catch (Exception e) {
+            assertEquals("A view key must be specified.", e.getMessage());
+        }
+    }
+
+    @Test
+    void removeViewWithKey_ThrowsAndException_WhenNoViewExists() {
+        try {
+            new Workspace("Name").getViews().removeViewWithKey("key");
+            fail();
+        } catch (Exception e) {
+            assertEquals("A view with key \"key\" does not exist.", e.getMessage());
+        }
+    }
+
+    @Test
+    void removeViewWithKey_ThrowsAndException_WhenABaseViewExistsForTheSpecifiedFilteredView() {
+        Workspace workspace = new Workspace("Name");
+
+        try {
+            SystemLandscapeView view = workspace.getViews().createSystemLandscapeView("landscape");
+            workspace.getViews().createFilteredView(view, "filtered", FilterMode.Include, Tags.ELEMENT);
+
+            workspace.getViews().removeViewWithKey("landscape");
+            fail();
+        } catch (Exception e) {
+            assertEquals("A filtered view based upon \"landscape\" exists - please remove this first.", e.getMessage());
+        }
+    }
+
+    @Test
+    void removeViewWithKey_CustomView() {
+        Workspace workspace = new Workspace("Name");
+        workspace.getViews().createCustomView("key", "title");
+
+        assertFalse(workspace.getViews().getCustomViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getCustomViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_SystemLandscapeView() {
+        Workspace workspace = new Workspace("Name");
+        workspace.getViews().createSystemLandscapeView("key");
+
+        assertFalse(workspace.getViews().getSystemLandscapeViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getSystemLandscapeViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_SystemContextView() {
+        Workspace workspace = new Workspace("Name");
+        SoftwareSystem softwareSystem = workspace.getModel().addSoftwareSystem("Name");
+        workspace.getViews().createSystemContextView(softwareSystem, "key");
+
+        assertFalse(workspace.getViews().getSystemContextViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getSystemContextViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_ContainerView() {
+        Workspace workspace = new Workspace("Name");
+        SoftwareSystem softwareSystem = workspace.getModel().addSoftwareSystem("Name");
+        workspace.getViews().createContainerView(softwareSystem, "key");
+
+        assertFalse(workspace.getViews().getContainerViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getContainerViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_ComponentView() {
+        Workspace workspace = new Workspace("Name");
+        SoftwareSystem softwareSystem = workspace.getModel().addSoftwareSystem("Name");
+        Container container = softwareSystem.addContainer("Name");
+        workspace.getViews().createComponentView(container, "key");
+
+        assertFalse(workspace.getViews().getComponentViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getComponentViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_DynamicView() {
+        Workspace workspace = new Workspace("Name");
+        workspace.getViews().createDynamicView("key");
+
+        assertFalse(workspace.getViews().getDynamicViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getDynamicViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_DeploymentView() {
+        Workspace workspace = new Workspace("Name");
+        workspace.getViews().createDeploymentView("key");
+
+        assertFalse(workspace.getViews().getDeploymentViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getDeploymentViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_FilteredView() {
+        Workspace workspace = new Workspace("Name");
+        SystemLandscapeView view = workspace.getViews().createSystemLandscapeView("landscape");
+        workspace.getViews().createFilteredView(view, "key", FilterMode.Include, Tags.ELEMENT);
+
+        assertFalse(workspace.getViews().getFilteredViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getFilteredViews().isEmpty());
+    }
+
+    @Test
+    void removeViewWithKey_ImageView() {
+        Workspace workspace = new Workspace("Name");
+        workspace.getViews().createImageView("key");
+
+        assertFalse(workspace.getViews().getImageViews().isEmpty());
+        workspace.getViews().removeViewWithKey("key");
+        assertTrue(workspace.getViews().getImageViews().isEmpty());
+    }
+
 }