feat(tools): add composition, aggregation relationships in UML

[mttrbrts]

Closes #166

Adds support for Composition and Aggregation relationships in UML output formats (Mermaid & PlantUML).

Current Behaviour

classDiagram
class `org.acme.Root` {
<< concept>>
   + `String` `firstName`
   + `String` `lastName`
   + `DateTime` `dob`
   + `Integer` `age`
   + `Double` `height`
   + `Children[]` `children`
}

`org.acme.Root` "1" o-- "1" `org.acme.Company` : company
`org.acme.Root` --|> `[email protected]`
class `org.acme.Person`
<< concept>> `org.acme.Person`

`org.acme.Person` --|> `[email protected]`
class `org.acme.Children` {
<< concept>>
   + `String` `name`
   + `Integer` `age`
   + `String` `hairColor`
   + `Boolean` `coolDude`
   + `String` `missing`
   + `Pet` `pet`
   + `String[]` `favoriteColors`
   + `Integer[]` `favoriteNumbers`
   + `String[]` `mixed`
   + `String[]` `arrayOfNull`
   + `String[]` `emptyArray`
   + `Pet[]` `favoritePets`
   + `Stuff[]` `stuff`
}

`org.acme.Children` --|> `org.acme.Person`
class `org.acme.Pet` {
<< concept>>
   + `String` `name`
   + `String` `breed`
}

`org.acme.Pet` --|> `[email protected]`
class `org.acme.Stuff` {
<< concept>>
   + `String` `ssn`
   + `String` `firstName`
   + `String` `sku`
   + `Double` `price`
   + `Pet` `product`
}

`org.acme.Stuff` --|> `[email protected]`
class `org.acme.Company` {
<< concept>>
   + `String` `name`
   + `Employee[]` `employees`
}

`org.acme.Company` --|> `[email protected]`
class `org.acme.Employee` {
<< concept>>
   + `String` `name`
}

`org.acme.Employee` --|> `org.acme.Person`

Loading

New Behaviour

classDiagram
class `org.acme.Root` {
<< concept>>
   + `String` `firstName`
   + `String` `lastName`
   + `DateTime` `dob`
   + `Integer` `age`
   + `Double` `height`
   + `Children[]` `children`
}

`org.acme.Root` "1" *-- "*" `org.acme.Children`
`org.acme.Root` "1" o-- "1" `org.acme.Company` : company
class `org.acme.Person`
<< concept>> `org.acme.Person`

class `org.acme.Children` {
<< concept>>
   + `String` `name`
   + `Integer` `age`
   + `String` `hairColor`
   + `Boolean` `coolDude`
   + `String` `missing`
   + `Pet` `pet`
   + `String[]` `favoriteColors`
   + `Integer[]` `favoriteNumbers`
   + `String[]` `mixed`
   + `String[]` `arrayOfNull`
   + `String[]` `emptyArray`
   + `Pet[]` `favoritePets`
   + `Stuff[]` `stuff`
}

`org.acme.Children` "1" *-- "1" `org.acme.Pet`
`org.acme.Children` "1" *-- "*" `org.acme.Pet`
`org.acme.Children` "1" *-- "*" `org.acme.Stuff`
`org.acme.Children` --|> `org.acme.Person`
class `org.acme.Pet` {
<< concept>>
   + `String` `name`
   + `String` `breed`
}

class `org.acme.Stuff` {
<< concept>>
   + `String` `ssn`
   + `String` `firstName`
   + `String` `sku`
   + `Double` `price`
   + `Pet` `product`
}

`org.acme.Stuff` "1" *-- "1" `org.acme.Pet`
class `org.acme.Company` {
<< concept>>
   + `String` `name`
   + `Employee[]` `employees`
}

`org.acme.Company` "1" *-- "*" `org.acme.Employee`
class `org.acme.Employee` {
<< concept>>
   + `String` `name`
}

`org.acme.Employee` --|> `org.acme.Person`

Loading

Changes

• Refactors and standardises the output of Mermaid and PlantUML diagrams (both now support the same UML features and have a common base class)
• Improves treatment of escaped characters in both formats
• Adds two new CLI parameters to expose the new options showCompositionRelationships, and hideBaseModel. The existing behaviour is retained for backwards compatibility. A candidate for change in Planned deprecations #554 .
• Increases test coverage, and refactors tests to show individual format failures

Author Checklist

• Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
• Vital features and changes captured in unit and/or integration tests
• Commits messages follow AP format
• Extend the documentation, if necessary
• Merging to main from fork:branchname

[dselman]

Love it!