Skip to content

Commit

Permalink
Update UML diagrams to resolve rendering issues
Browse files Browse the repository at this point in the history
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.

Let's update the PlantUML diagrams accordingly.
  • Loading branch information
Eclipse-Dominator committed Jul 30, 2023
1 parent a976ec9 commit 41e3513
Show file tree
Hide file tree
Showing 31 changed files with 53 additions and 36 deletions.
3 changes: 3 additions & 0 deletions docs/diagrams/CommitActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12
start
:User executes command;

Expand Down
6 changes: 3 additions & 3 deletions docs/diagrams/ComponentManagers.puml
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
6 changes: 3 additions & 3 deletions docs/diagrams/LogicClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 6 additions & 2 deletions docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -20,6 +20,7 @@ Class Name
Class Phone
Class Tag

Class I #FFFFFF
}

Class HiddenOutside #FFFFFF
Expand All @@ -42,9 +43,12 @@ Person *--> Email
Person *--> Address
Person *--> "*" Tag

Person -[hidden]up--> I
UniquePersonList -[hidden]right-> I

Name -[hidden]right-> Phone
Phone -[hidden]right-> Address
Address -[hidden]right-> Email

ModelManager -->"~* filtered" Person
ModelManager --> "~* filtered" Person
@enduml
2 changes: 1 addition & 1 deletion docs/diagrams/StorageClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions docs/diagrams/UndoRedoState0.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
!include style.puml
skinparam ClassFontColor #000000
skinparam ClassBorderColor #000000
skinparam ClassBackgroundColor #FFFFAA

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
9 changes: 5 additions & 4 deletions docs/diagrams/UndoRedoState1.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,22 @@
!include style.puml
skinparam ClassFontColor #000000
skinparam ClassBorderColor #000000
skinparam ClassBackgroundColor #FFFFAA

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
9 changes: 5 additions & 4 deletions docs/diagrams/UndoRedoState2.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
!include style.puml
skinparam ClassFontColor #000000
skinparam ClassBorderColor #000000
skinparam ClassBackgroundColor #FFFFAA

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
9 changes: 5 additions & 4 deletions docs/diagrams/UndoRedoState3.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
!include style.puml
skinparam ClassFontColor #000000
skinparam ClassBorderColor #000000
skinparam ClassBackgroundColor #FFFFAA

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
9 changes: 5 additions & 4 deletions docs/diagrams/UndoRedoState4.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
!include style.puml
skinparam ClassFontColor #000000
skinparam ClassBorderColor #000000
skinparam ClassBackgroundColor #FFFFAA

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
9 changes: 5 additions & 4 deletions docs/diagrams/UndoRedoState5.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
!include style.puml
skinparam ClassFontColor #000000
skinparam ClassBorderColor #000000
skinparam ClassBackgroundColor #FFFFAA

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.
Expand Down
10 changes: 7 additions & 3 deletions docs/diagrams/style.puml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,15 @@

!define USER_COLOR #000000

skinparam BackgroundColor #FFFFFFF

skinparam Shadowing false
skinparam Package {
BackgroundColor #FFFFFF
BorderThickness 1
FontSize 16
}

skinparam Class {
FontColor #FFFFFF
FontSize 15
BorderThickness 1
BorderColor #FFFFFF
StereotypeFontColor #FFFFFF
Expand All @@ -64,6 +67,7 @@ skinparam Participant {
Padding 20
}

skinparam ArrowFontStyle bold
skinparam MinClassWidth 50
skinparam ParticipantPadding 10
skinparam Shadowing false
Expand Down
Binary file modified docs/images/ArchitectureDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ArchitectureSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/BetterModelClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/CommitActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ComponentManagers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/DeleteSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/LogicClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ModelClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ParserClasses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/StorageClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UiClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoRedoState0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoRedoState1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoRedoState2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoRedoState3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoRedoState4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoRedoState5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/UndoSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tracing/LogicSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41e3513

Please sign in to comment.