Start of support for imageViews.

Image Views associated with Software Systems will show on the Containers View page.
avisi-cloud · Oct 23, 2023 · 73ce67a · 73ce67a
1 parent e9e3ac7
commit 73ce67a
Show file tree

Hide file tree

Showing 12 changed files with 58 additions and 10 deletions.
diff --git a/docs/example/internet-banking-system/images/component.png b/docs/example/internet-banking-system/images/component.png
diff --git a/docs/example/internet-banking-system/images/container.png b/docs/example/internet-banking-system/images/container.png
diff --git a/docs/example/internet-banking-system/images/system.png b/docs/example/internet-banking-system/images/system.png
diff --git a/docs/example/workspace.dsl b/docs/example/workspace.dsl
@@ -176,6 +176,18 @@ workspace "Big Bank plc" "This is an example workspace to illustrate the key fea
             "generatr.markdown.flexmark.extensions" "Abbreviation,Admonition,AnchorLink,Attributes,Autolink,Definition,Emoji,Footnotes,GfmTaskList,GitLab,MediaTags,Tables,TableOfContents,Typographic"
         }
 
+        image internetBankingSystem {
+            image internet-banking-system/images/system.png
+        }
+
+        image apiApplication {
+            image internet-banking-system/images/container.png
+        }
+
+        image accountsSummaryController {
+            image internet-banking-system/images/component.png
+        }
+
         systemlandscape "SystemLandscape" {
             include *
             autoLayout

diff --git a/src/main/kotlin/nl/avisi/structurizr/site/generatr/StructurizrUtilities.kt b/src/main/kotlin/nl/avisi/structurizr/site/generatr/StructurizrUtilities.kt
@@ -47,3 +47,6 @@ fun ViewSet.hasDynamicViews(softwareSystem: SoftwareSystem) =
 
 fun ViewSet.hasDeploymentViews(softwareSystem: SoftwareSystem) =
     deploymentViews.any { it.softwareSystem == softwareSystem }
+
+fun ViewSet.hasElementImageViews(elementId: String) =
+    imageViews.any { it.elementId ==  elementId}
diff --git a/...lin/nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemComponentPageViewModel.kt b/...lin/nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemComponentPageViewModel.kt
@@ -2,6 +2,7 @@ package nl.avisi.structurizr.site.generatr.site.model
 
 import com.structurizr.model.SoftwareSystem
 import nl.avisi.structurizr.site.generatr.hasComponentViews
+import nl.avisi.structurizr.site.generatr.hasElementImageViews
 import nl.avisi.structurizr.site.generatr.site.GeneratorContext
 
 class SoftwareSystemComponentPageViewModel(generatorContext: GeneratorContext, softwareSystem: SoftwareSystem) :
@@ -10,5 +11,9 @@ class SoftwareSystemComponentPageViewModel(generatorContext: GeneratorContext, s
         .filter { it.softwareSystem == softwareSystem }
         .sortedBy { it.key }
         .map { DiagramViewModel.forView(this, it, generatorContext.svgFactory) }
-    val visible = generatorContext.workspace.views.hasComponentViews(softwareSystem)
+    val images = generatorContext.workspace.views.imageViews
+        .filter { it.elementId == softwareSystem.id }
+        .sortedBy { it.key }
+    val diagramsVisible = generatorContext.workspace.views.hasComponentViews(softwareSystem)
+    val imagesVisible = generatorContext.workspace.views.hasElementImageViews(softwareSystem.id)
 }
diff --git a/...lin/nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemContainerPageViewModel.kt b/...lin/nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemContainerPageViewModel.kt
@@ -2,6 +2,7 @@ package nl.avisi.structurizr.site.generatr.site.model
 
 import com.structurizr.model.SoftwareSystem
 import nl.avisi.structurizr.site.generatr.hasContainerViews
+import nl.avisi.structurizr.site.generatr.hasElementImageViews
 import nl.avisi.structurizr.site.generatr.site.GeneratorContext
 
 class SoftwareSystemContainerPageViewModel(generatorContext: GeneratorContext, softwareSystem: SoftwareSystem) :
@@ -10,5 +11,9 @@ class SoftwareSystemContainerPageViewModel(generatorContext: GeneratorContext, s
         .filter { it.softwareSystem == softwareSystem }
         .sortedBy { it.key }
         .map { DiagramViewModel.forView(this, it, generatorContext.svgFactory) }
-    val visible = generatorContext.workspace.views.hasContainerViews(softwareSystem)
+    val images = generatorContext.workspace.views.imageViews
+        .filter { it.elementId == softwareSystem.id }
+        .sortedBy { it.key }
+    val diagramsVisible = generatorContext.workspace.views.hasContainerViews(softwareSystem)
+    val imagesVisible = generatorContext.workspace.views.hasElementImageViews(softwareSystem.id)
 }
diff --git a/src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/SoftwareSystemComponentPage.kt b/src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/SoftwareSystemComponentPage.kt
@@ -4,10 +4,17 @@ import kotlinx.html.HTML
 import nl.avisi.structurizr.site.generatr.site.model.SoftwareSystemComponentPageViewModel
 
 fun HTML.softwareSystemComponentPage(viewModel: SoftwareSystemComponentPageViewModel) {
-    if (viewModel.visible)
+    if (viewModel.diagramsVisible || viewModel.imagesVisible)
         softwareSystemPage(viewModel) {
-            viewModel.diagrams.forEach {
-                diagram(it)
+            if (viewModel.diagramsVisible) {
+                viewModel.diagrams.forEach {
+                    diagram(it)
+                }
+            }
+            if (viewModel.imagesVisible) {
+                viewModel.images.forEach {
+                    rawImage(it.content)
+                }
             }
         }
     else

diff --git a/src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/SoftwareSystemContainerPage.kt b/src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/SoftwareSystemContainerPage.kt
@@ -4,10 +4,17 @@ import kotlinx.html.HTML
 import nl.avisi.structurizr.site.generatr.site.model.SoftwareSystemContainerPageViewModel
 
 fun HTML.softwareSystemContainerPage(viewModel: SoftwareSystemContainerPageViewModel) {
-    if (viewModel.visible)
+    if (viewModel.diagramsVisible || viewModel.imagesVisible)
         softwareSystemPage(viewModel) {
-            viewModel.diagrams.forEach {
-                diagram(it)
+            if (viewModel.diagramsVisible) {
+                viewModel.diagrams.forEach {
+                    diagram(it)
+                }
+            }
+            if (viewModel.imagesVisible) {
+                viewModel.images.forEach {
+                    rawImage(it.content)
+                }
             }
         }
     else

diff --git a/src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/rawImage.kt b/src/main/kotlin/nl/avisi/structurizr/site/generatr/site/views/rawImage.kt
@@ -0,0 +1,9 @@
+package nl.avisi.structurizr.site.generatr.site.views
+
+import kotlinx.html.*
+
+fun FlowContent.rawImage(data: String) {
+    img {
+        src = data
+    }
+}
diff --git a/...nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemComponentPageViewModelTest.kt b/...nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemComponentPageViewModelTest.kt
@@ -57,6 +57,6 @@ class SoftwareSystemComponentPageViewModelTest : ViewModelTest() {
             generatorContext.workspace.model.addSoftwareSystem("Software system 2")
         )
 
-        assertThat(viewModel.visible).isFalse()
+        assertThat(viewModel.diagramsVisible).isFalse()
     }
 }
diff --git a/...nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemContainerPageViewModelTest.kt b/...nl/avisi/structurizr/site/generatr/site/model/SoftwareSystemContainerPageViewModelTest.kt
@@ -56,6 +56,6 @@ class SoftwareSystemContainerPageViewModelTest : ViewModelTest() {
             generatorContext.workspace.model.addSoftwareSystem("Software system 2")
         )
 
-        assertThat(viewModel.visible).isFalse()
+        assertThat(viewModel.diagramsVisible).isFalse()
     }
 }