Update UML diagrams to resolve rendering issues

PlantUML(1.2023.2) introduced a change in behavior when rendering diagrams. This causes some of the diagrams to be rendered incorrectly or fail to compile. Diagrams are also being rendered in a different theme due to a change in the default color theme. Therefore, some of the PlantUML code and images need to be updated to ensure functionality and consistency. The old color scheme will also be applied as some of the manual color changes are based on it. Let's * update PlantUML code to ensure they can be rendered properly * update diagrams to use the original theme to fit the manual theme changes * update the diagrams to ensure consistency between the PlantUML code and the rendered image
se-edu · Jul 27, 2023 · 8daeab4 · 8daeab4
1 parent a976ec9
commit 8daeab4
Show file tree

Hide file tree

Showing 31 changed files with 41 additions and 32 deletions.
diff --git a/docs/diagrams/CommitActivityDiagram.puml b/docs/diagrams/CommitActivityDiagram.puml
@@ -1,4 +1,6 @@
 @startuml
+!include style.puml
+
 start
 :User executes command;
 

diff --git a/docs/diagrams/ComponentManagers.puml b/docs/diagrams/ComponentManagers.puml
@@ -4,17 +4,17 @@ skinparam arrowThickness 1.1
 skinparam arrowColor LOGIC_COLOR_T4
 skinparam classBackgroundColor LOGIC_COLOR
 
-package Logic {
+package Logic as LogicPackage {
 Class "<<interface>>\nLogic" as Logic
 Class LogicManager
 }
 
-package Model{
+package Model as ModelPackage {
 Class "<<interface>>\nModel" as Model
 Class ModelManager
 }
 
-package Storage{
+package Storage as StoragePackage {
 Class "<<interface>>\nStorage" as Storage
 Class StorageManager
 }

diff --git a/docs/diagrams/LogicClassDiagram.puml b/docs/diagrams/LogicClassDiagram.puml
@@ -4,7 +4,7 @@ skinparam arrowThickness 1.1
 skinparam arrowColor LOGIC_COLOR_T4
 skinparam classBackgroundColor LOGIC_COLOR
 
-package Logic {
+package Logic as LogicPackage {
 
 Class AddressBookParser
 Class XYZCommand
@@ -16,11 +16,11 @@ Class "<<interface>>\nLogic" as Logic
 Class LogicManager
 }
 
-package Model{
+package Model {
 Class HiddenModel #FFFFFF
 }
 
-package Storage{
+package Storage {
 }
 
 Class HiddenOutside #FFFFFF

diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -4,7 +4,7 @@ skinparam arrowThickness 1.1
 skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
 
-Package Model <<Rectangle>>{
+Package Model as ModelPackage <<Rectangle>>{
 Class "<<interface>>\nReadOnlyAddressBook" as ReadOnlyAddressBook
 Class "<<interface>>\nReadOnlyUserPrefs" as ReadOnlyUserPrefs
 Class "<<interface>>\nModel" as Model

diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml
@@ -4,7 +4,7 @@ skinparam arrowThickness 1.1
 skinparam arrowColor STORAGE_COLOR
 skinparam classBackgroundColor STORAGE_COLOR
 
-package Storage{
+package Storage as StoragePackage {
 
 package "UserPrefs Storage" #F4F6F6{
 Class "<<interface>>\nUserPrefsStorage" as UserPrefsStorage

diff --git a/docs/diagrams/UndoRedoState0.puml b/docs/diagrams/UndoRedoState0.puml
@@ -6,15 +6,15 @@ skinparam ClassBorderColor #000000
 title Initial state
 
 package States {
-    class State1 as "__ab0:AddressBook__"
-    class State2 as "__ab1:AddressBook__"
-    class State3 as "__ab2:AddressBook__"
+    class State1 as "<u>ab0:AddressBook</u>"
+    class State2 as "<u>ab1:AddressBook</u>"
+    class State3 as "<u>ab2:AddressBook</u>"
 }
 State1 -[hidden]right-> State2
 State2 -[hidden]right-> State3
 hide State2
 hide State3
 
-class Pointer as "Current State" #FFFFF
+class Pointer as "Current State" #FFFFFF
 Pointer -up-> State1
 @end
diff --git a/docs/diagrams/UndoRedoState1.puml b/docs/diagrams/UndoRedoState1.puml
@@ -6,17 +6,17 @@ skinparam ClassBorderColor #000000
 title After command "delete 5"
 
 package States <<rectangle>> {
-    class State1 as "__ab0:AddressBook__"
-    class State2 as "__ab1:AddressBook__"
-    class State3 as "__ab2:AddressBook__"
+    class State1 as "<u>ab0:AddressBook</u>"
+    class State2 as "<u>ab1:AddressBook</u>"
+    class State3 as "<u>ab2:AddressBook</u>"
 }
 
 State1 -[hidden]right-> State2
 State2 -[hidden]right-> State3
 
 hide State3
 
-class Pointer as "Current State" #FFFFF
+class Pointer as "Current State" #FFFFFF
 
 Pointer -up-> State2
 @end
diff --git a/docs/diagrams/UndoRedoState2.puml b/docs/diagrams/UndoRedoState2.puml
@@ -6,15 +6,15 @@ skinparam ClassBorderColor #000000
 title After command "add n/David"
 
 package States <<rectangle>> {
-    class State1 as "__ab0:AddressBook__"
-    class State2 as "__ab1:AddressBook__"
-    class State3 as "__ab2:AddressBook__"
+    class State1 as "<u>ab0:AddressBook</u>"
+    class State2 as "<u>ab1:AddressBook</u>"
+    class State3 as "<u>ab2:AddressBook</u>"
 }
 
 State1 -[hidden]right-> State2
 State2 -[hidden]right-> State3
 
-class Pointer as "Current State" #FFFFF
+class Pointer as "Current State" #FFFFFF
 
 Pointer -up-> State3
 @end
diff --git a/docs/diagrams/UndoRedoState3.puml b/docs/diagrams/UndoRedoState3.puml
@@ -6,15 +6,15 @@ skinparam ClassBorderColor #000000
 title After command "undo"
 
 package States <<rectangle>> {
-    class State1 as "__ab0:AddressBook__"
-    class State2 as "__ab1:AddressBook__"
-    class State3 as "__ab2:AddressBook__"
+    class State1 as "<u>ab0:AddressBook</u>"
+    class State2 as "<u>ab1:AddressBook</u>"
+    class State3 as "<u>ab2:AddressBook</u>"
 }
 
 State1 -[hidden]right-> State2
 State2 -[hidden]right-> State3
 
-class Pointer as "Current State" #FFFFF
+class Pointer as "Current State" #FFFFFF
 
 Pointer -up-> State2
 @end
diff --git a/docs/diagrams/UndoRedoState4.puml b/docs/diagrams/UndoRedoState4.puml
@@ -6,15 +6,15 @@ skinparam ClassBorderColor #000000
 title After command "list"
 
 package States <<rectangle>> {
-    class State1 as "__ab0:AddressBook__"
-    class State2 as "__ab1:AddressBook__"
-    class State3 as "__ab2:AddressBook__"
+    class State1 as "<u>ab0:AddressBook</u>"
+    class State2 as "<u>ab1:AddressBook</u>"
+    class State3 as "<u>ab2:AddressBook</u>"
 }
 
 State1 -[hidden]right-> State2
 State2 -[hidden]right-> State3
 
-class Pointer as "Current State" #FFFFF
+class Pointer as "Current State" #FFFFFF
 
 Pointer -up-> State2
 @end
diff --git a/docs/diagrams/UndoRedoState5.puml b/docs/diagrams/UndoRedoState5.puml
@@ -6,15 +6,15 @@ skinparam ClassBorderColor #000000
 title After command "clear"
 
 package States <<rectangle>> {
-    class State1 as "__ab0:AddressBook__"
-    class State2 as "__ab1:AddressBook__"
-    class State3 as "__ab3:AddressBook__"
+    class State1 as "<u>ab0:AddressBook</u>"
+    class State2 as "<u>ab1:AddressBook</u>"
+    class State3 as "<u>ab3:AddressBook</u>"
 }
 
 State1 -[hidden]right-> State2
 State2 -[hidden]right-> State3
 
-class Pointer as "Current State" #FFFFF
+class Pointer as "Current State" #FFFFFF
 
 Pointer -up-> State3
 note right on link: State ab2 deleted.

diff --git a/docs/diagrams/style.puml b/docs/diagrams/style.puml
@@ -33,6 +33,13 @@
 
 !define USER_COLOR #000000
 
+skin rose
+
+skinparam PackageBackgroundColor #FFFFFF
+skinparam PackageBorderColor #000000
+skinparam PackageFontStyle bold
+skinparam PackageBorderThickness 1.1
+
 skinparam BackgroundColor #FFFFFFF
 
 skinparam Shadowing false

diff --git a/docs/images/ArchitectureDiagram.png b/docs/images/ArchitectureDiagram.png
diff --git a/docs/images/ArchitectureSequenceDiagram.png b/docs/images/ArchitectureSequenceDiagram.png
diff --git a/docs/images/BetterModelClassDiagram.png b/docs/images/BetterModelClassDiagram.png
diff --git a/docs/images/CommitActivityDiagram.png b/docs/images/CommitActivityDiagram.png
diff --git a/docs/images/ComponentManagers.png b/docs/images/ComponentManagers.png
diff --git a/docs/images/DeleteSequenceDiagram.png b/docs/images/DeleteSequenceDiagram.png
diff --git a/docs/images/LogicClassDiagram.png b/docs/images/LogicClassDiagram.png
diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
diff --git a/docs/images/ParserClasses.png b/docs/images/ParserClasses.png
diff --git a/docs/images/StorageClassDiagram.png b/docs/images/StorageClassDiagram.png
diff --git a/docs/images/UiClassDiagram.png b/docs/images/UiClassDiagram.png
diff --git a/docs/images/UndoRedoState0.png b/docs/images/UndoRedoState0.png
diff --git a/docs/images/UndoRedoState1.png b/docs/images/UndoRedoState1.png
diff --git a/docs/images/UndoRedoState2.png b/docs/images/UndoRedoState2.png
diff --git a/docs/images/UndoRedoState3.png b/docs/images/UndoRedoState3.png
diff --git a/docs/images/UndoRedoState4.png b/docs/images/UndoRedoState4.png
diff --git a/docs/images/UndoRedoState5.png b/docs/images/UndoRedoState5.png
diff --git a/docs/images/UndoSequenceDiagram.png b/docs/images/UndoSequenceDiagram.png
diff --git a/docs/images/tracing/LogicSequenceDiagram.png b/docs/images/tracing/LogicSequenceDiagram.png