se-edu / addressbook-level3

:ab::three: Address Book sample application (Level 3)
https://se-education.org/addressbook-level3
MIT License
27 stars 411 forks source link

Upgrade plant uml new theme #202

Closed Eclipse-Dominator closed 11 months ago

Eclipse-Dominator commented 11 months ago

Fixes #200

Alternative to #201 where the new default theme is used instead of the old rose theme.

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.

Let's

canihasreview[bot] commented 11 months ago

Click here to submit a new iteration when this PR is ready for review.

See this repository's contribution guide for more information.

codecov[bot] commented 11 months ago

Codecov Report

Merging #202 (aafaef4) into master (a976ec9) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #202   +/-   ##
=========================================
  Coverage     74.03%   74.03%           
  Complexity      423      423           
=========================================
  Files            71       71           
  Lines          1290     1290           
  Branches        127      127           
=========================================
  Hits            955      955           
  Misses          301      301           
  Partials         34       34           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

canihasreview[bot] commented 11 months ago

v1

@Eclipse-Dominator submitted v1 for review.

(:books: Archive)

Checkout this PR version locally ```sh git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/202/1/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
damithc commented 11 months ago

@Eclipse-Dominator do you see any diagrams that is not optimal under the default theme (compared to the old theme)?

For the following, I'm not sure why the Storage component appears in a different color. image

But while we are at it, we can actually color each of those two boxes with a very light shade of the main color we use the same components in the architecture diagram.

Eclipse-Dominator commented 11 months ago

@damithc I believe there is some rendering logic for Packages that contain classes and Packages that doesn't. The Model package above contains a hidden Class but the Storage package doesn't. This causes a change in rendering.

do you see any diagrams that is not optimal under the default theme (compared to the old theme)?

Mainly it would be the UndoRedoState diagrams. image

The main differences between the 2 themes are:

damithc commented 11 months ago

The main differences between the 2 themes are:

  • Classes are no longer colored
  • Borders, arrows and lines are black by default (previously red)
  • Change in the color of note

Personally, I think the old theme is slightly easier to read. But given that using the defaults is less work, I'm fine to switch to the new theme despite the slight loss of readability.

Eclipse-Dominator commented 11 months ago

Personally, I think the old theme is slightly easier to read. But given that using the defaults is less work, I'm fine to switch to the new theme despite the slight loss of readability.

@damithc It will still be the same amount of work as all the formatting the diagram component to the AB3 style still require the student to import style.puml. So there are actually no difference whether we are using the new theme or the old theme

canihasreview[bot] commented 11 months ago

v2

@Eclipse-Dominator submitted v2 for review.

(:books: Archive) (:chart_with_upwards_trend: Interdiff between v1 and v2) (:chart_with_upwards_trend: Range-Diff between v1 and v2)

Checkout this PR version locally ```sh git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/202/2/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
damithc commented 11 months ago

@se-edu/tech-team-level1 for your review ...

canihasreview[bot] commented 11 months ago

v3

@Eclipse-Dominator submitted v3 for review.

(:books: Archive) (:chart_with_upwards_trend: Interdiff between v2 and v3) (:chart_with_upwards_trend: Range-Diff between v2 and v3)

Checkout this PR version locally ```sh git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/202/3/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
canihasreview[bot] commented 11 months ago

v4

@Eclipse-Dominator submitted v4 for review.

(:books: Archive) (:chart_with_upwards_trend: Interdiff between v3 and v4) (:chart_with_upwards_trend: Range-Diff between v3 and v4)

Checkout this PR version locally ```sh git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/202/4/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.