-
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
519 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| .idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,5 @@ | ||
| # plantuml-libs | ||
| Libraries for plantuml | ||
|
|
||
| Set of libraries for [PlantUML](http://plantuml.com). | ||
|
|
||
| - [C4 Model](c4model/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| # C4 Model | ||
|
|
||
| Library implementing elements respecting the [C4 Model](https://c4model.com). | ||
|
|
||
| ## Install | ||
|
|
||
| To include every thing: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| @enduml | ||
| ``` | ||
|
|
||
| To override constants (font size, colors): | ||
| ```plantuml | ||
| @startuml | ||
| ' load the macros and constants | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-macros.puml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-constants.puml | ||
| ' user override of the constants | ||
| !define TITLE_FONT_SIZE 14 | ||
| !define TECH_FONT_SIZE 10 | ||
| !define DESC_FONT_SIZE 12 | ||
| !define CONTAINER_COLOR_BG Orange | ||
| !define CONTAINER_COLOR_BORDER DarkOrange | ||
| ' load the styles | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-styles.puml | ||
| container(container, The container name, Java, The description of the system.) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Elements | ||
|
|
||
| The `person` and `external person`: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| person(person1, A person) | ||
| person(person2, A person, An optional descrition.) | ||
| person_ext(person_ext1, An external person) | ||
| person_ext(person_ext2, An external person, An optional description.) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The `system` and `external system`: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| system(person1, A system) | ||
| system(person2, A system, An optional descrition.) | ||
| system_ext(system_ext1, An external system) | ||
| system_ext(system_ext2, An external system, An optional description.) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The `container` and `database`: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| container(container1, A container) | ||
| container_t(container2, A container, Java) | ||
| container_d(container3, A container, An optional description.) | ||
| container(container4, A container, Java, An optional description.) | ||
| database(database1, A database) | ||
| database_t(database2, A database, MariaDB) | ||
| database_d(database3, A database, An optional description.) | ||
| database(database4, A database, Java, An optional description.) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The `component`: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| component(component1, A component) | ||
| component_t(component2, A component, Controller) | ||
| component_d(component3, A component, An optional description.) | ||
| component(component4, A component, Controller, An optional description.) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The `boundaries`: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| enterprise(enterprise1, An enterprise) { | ||
| system_boundary(system1, A system) { | ||
| container_boundary(container1, A container) { | ||
| component(component1, A component) | ||
| } | ||
| } | ||
| } | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The `relations`: | ||
| ```plantuml | ||
| @startuml | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| person(person1, A person) | ||
| system(system1, System1) | ||
| system(system2, System2) | ||
| system(system3, System3) | ||
| system(system4, System4) | ||
| system(system6, System6) | ||
| system(system5, System5) | ||
| person1 -l-> system1 | ||
| person1 -u-> system3: format_name(uses, HTTPS) | ||
| person1 -u-> system2: format_name(uses) | ||
| person1 -r-> system4: format_tech(HTTPS) | ||
| person1 -d-> system6: format_desc(uses, HTTPS) | ||
| person1 -d-> system5: format_desc(uses) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## System Context diagram | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| title | ||
| System Context diagram for Internet Banking System | ||
| endtitle | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| hide stereotype | ||
| LAYOUT_WITH_LEGEND | ||
| person(customer, Personal Banking Customer, "A customer of the bank, with personal bank accounts.") | ||
| system(ebanking, Internet Banking System, "Allows customers to view information about their bank accounts, and make payments.") | ||
| system_ext(email, E-mail System, "The internal Microsoft Exchange e-mail system.") | ||
| system_ext(mainframe, Mainframe Banking System, "Stores all of the core banking information about customers accounts, transactions etc.") | ||
| customer --> ebanking: format_name("Views accounts balances, and make payments using") | ||
| ebanking --> mainframe: format_name("Gets accounts information from and makes payment using") | ||
| ebanking -> email: format_name("Sends e-mail using") | ||
| email -u-> customer: format_name("Sends e-mail to") | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Container diagram | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| title | ||
| Container diagram for Internet Banking System | ||
| endtitle | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| hide stereotype | ||
| LAYOUT_WITH_LEGEND | ||
| person(customer, Personal Banking Customer, "A customer of the bank, with personal bank accounts.") | ||
| system_ext(email, E-mail System, "The internal Microsoft Exchange e-mail system.") | ||
| system_ext(mainframe, Mainframe Banking System, "Stores all of the core banking information about customers accounts, transactions etc.") | ||
| system_boundary(ebanking, Internet Banking System) { | ||
| container(web, Web Application, Java and Spring MVC, "Delivers the static content and the Internet banking single page application.") | ||
| container(spa, Single Page Application, JavaScript and Angular, "Provides all of the Internet banking functionality to customers via their web browser.") | ||
| container(mobile, Mobile App, Xamarin, "Provides a limited subset of the Internet banking functionality to customers via their mobile device.") | ||
| database(db, Database, Relational Database Schema, "Stores user registration information, hashed authentication credentials, access logs, etc.") | ||
| container(api, API Application, Java and Spring MVC, "Provides Internet banking functionalit via a JSON/HTTPS API.") | ||
| } | ||
| customer --> web: format_name(Visits, HTTPS) | ||
| customer --> spa: format_name("Views accounts balances, and make payments using") | ||
| customer --> mobile: format_name("Views accounts balances, and make payments using") | ||
| spa --> api: format_name(Makes API calls to, JSON/HTTPS) | ||
| mobile --> api: format_name(Makes API calls to, JSON/HTTPS) | ||
| api -l-> db: format_name(Reads from and writes to, JDBC) | ||
| api -u-> email: format_name(Sends e-mail using, SMTP) | ||
| api -> mainframe: format_name(Makes API calls to, XML/HTTPS) | ||
| email -u-> customer: format_name(Sends e-mails to) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Component diagram | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| title | ||
| Component diagram for Internet Banking System - API Application | ||
| endtitle | ||
| !includeurl https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model/c4-all.puml | ||
| hide stereotype | ||
| LAYOUT_WITH_LEGEND | ||
| system_ext(email, E-mail System, "The internal Microsoft Exchange e-mail system.") | ||
| system_ext(mainframe, Mainframe Banking System, "Stores all of the core banking information about customers accounts, transactions etc.") | ||
| container(spa, Single Page Application, JavaScript and Angular, "Provides all of the Internet banking functionality to customers via their web browser.") | ||
| container(mobile, Mobile App, Xamarin, "Provides a limited subset of the Internet banking functionality to customers via their mobile device.") | ||
| database(db, Database, Relational Database Schema, "Stores user registration information, hashed authentication credentials, access logs, etc.") | ||
| container_boundary(api, API Application) { | ||
| component(api_signin, Sign In Controller, Spring MVC Rest Controller, Allows users to sign in to the Internet Banking System.) | ||
| component(api_password, Reset Password Controller, Spring MVC Rest Controller, Allows users to reset their passwords with a single URL.) | ||
| component(api_summary, Account Summary Controller, Spring MVC Rest Controller, Provides customers with a summary of their bank accounts.) | ||
| component(api_security, Security Component, Spring Bean, "Provides functionality related to signing in, changing passwords, etc.") | ||
| component(api_email, E-mail Component, Spring Bean, "Sends e-mails to users.") | ||
| component(api_maiframe, Mainframe Banking System Facade, Spring Bean, "A facade onto the mainframe banking system.") | ||
| } | ||
| spa --> api_signin: format_name(Makes API calls to, JSON/HTTPS) | ||
| spa --> api_password: format_name(Makes API calls to, JSON/HTTPS) | ||
| spa --> api_summary: format_name(Makes API calls to, JSON/HTTPS) | ||
| mobile --> api_signin: format_name(Makes API calls to, JSON/HTTPS) | ||
| mobile --> api_password: format_name(Makes API calls to, JSON/HTTPS) | ||
| mobile --> api_summary: format_name(Makes API calls to, JSON/HTTPS) | ||
| api_signin --> api_security: format_name(Uses) | ||
| api_password --> api_security: format_name(Uses) | ||
| api_password --> api_email: format_name(Uses) | ||
| api_summary --> api_maiframe: format_name(Uses) | ||
| api_maiframe --> mainframe: format_name(Uses, XML/HTTPS) | ||
| api_email --> email: format_name(Sends e-mail using) | ||
| api_security --> db: format_name(Reads from and writes to, JDBC) | ||
| @enduml | ||
| ``` | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ' remote inclusions | ||
| !define C4_LIB_BASE_URL https://raw.githubusercontent.com/tmorin/plantuml-libs/master/c4model | ||
| !includeurl C4_LIB_BASE_URL/c4-macros.puml | ||
| !includeurl C4_LIB_BASE_URL/c4-constants.puml | ||
| !includeurl C4_LIB_BASE_URL/c4-styles.puml | ||
|
|
||
| ' local inclusions | ||
| '!include c4-macros.puml | ||
| '!include c4-constants.puml | ||
| '!include c4-styles.puml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| !define TITLE_FONT_SIZE 12 | ||
| !define TECH_FONT_SIZE 11 | ||
| !define DESC_FONT_SIZE 12 | ||
|
|
||
| !define ARROW_COLOR #747A80 | ||
| !define ELEMENT_COLOR_TEXT White | ||
|
|
||
| !define BOUNDARY_COLOR_TEXT #46494D | ||
| !define BOUNDARY_COLOR_BORDER #46494D | ||
|
|
||
| !define PERSON_COLOR_BG #08427B | ||
| !define PERSON_COLOR_BORDER #05284A | ||
|
|
||
| !define SYSTEM_COLOR_BG #396895 | ||
| !define SYSTEM_COLOR_BORDER #223E59 | ||
|
|
||
| !define CONTAINER_COLOR_BG #6B8EB0 | ||
| !define CONTAINER_COLOR_BORDER #40556A | ||
|
|
||
| !define COMPONENT_COLOR_BG #9CB3CA | ||
| !define COMPONENT_COLOR_BORDER #5E6B79 | ||
|
|
||
| !define PERSON_EXT_COLOR_BG #747A80 | ||
| !define PERSON_EXT_COLOR_BORDER #46494D | ||
|
|
||
| !define SYSTEM_EXT_COLOR_BG #747A80 | ||
| !define SYSTEM_EXT_COLOR_BORDER #46494D |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
|
|
||
| !define format_tech(iTech) <size:TECH_FONT_SIZE>[iTech]</size> | ||
| !define format_name(iName) <b><size:TITLE_FONT_SIZE>iName</size></b> | ||
| !define format_name(iName, iTech) format_name(iName)\n format_tech(iTech) | ||
| !define format_desc(iDesc) <size:DESC_FONT_SIZE>iDesc</size> | ||
| !define format_desc(iDesc, iTech) <size:DESC_FONT_SIZE>iDesc</size>\n format_tech(iTech) | ||
|
|
||
| !define item(iShape, iId, iName, iStereotype) iShape "format_name(iName)" as iId <<iStereotype>> | ||
| !define item(iShape, iId, iName, iDesc, iType, iStereotype) iShape "format_name(iName, iType)\n\n format_desc(iDesc)" as iId <<iStereotype>> | ||
| !define item_t(iShape, iId, iName, iType, iStereotype) iShape "format_name(iName, iType)" as iId <<iStereotype>> | ||
| !define item_d(iShape, iId, iName, iDesc, iStereotype) iShape "format_name(iName)\n\n format_desc(iDesc)" as iId <<iStereotype>> | ||
|
|
||
| !define box(iId, iName, iStereotype) item(rectangle, iId, iName, iStereotype) | ||
| !define box(iId, iName, iDesc, iType, iStereotype) item(rectangle, iId, iName, iDesc, iType, iStereotype) | ||
| !define box_t(iId, iName, iType, iStereotype) item_t(rectangle, iId, iName, iType, iStereotype) | ||
| !define box_d(iId, iName, iDesc, iStereotype) item_d(rectangle, iId, iName, iDesc, iStereotype) | ||
|
|
||
| !define person(iId, iName) item_t(rectangle, iId, iName, Person, Person) | ||
| !define person(iId, iName, iDesc) item(rectangle, iId, iName, iDesc, Person, Person) | ||
| !define person_ext(iId, iName) item_t(rectangle, iId, iName, Person, ExternalPerson) | ||
| !define person_ext(iId, iName, iDesc) item(rectangle, iId, iName, iDesc, Person, ExternalPerson) | ||
|
|
||
| !define system(iId, iName) item_t(rectangle, iId, iName, Software System, System) | ||
| !define system(iId, iName, iDesc) item(rectangle, iId, iName, iDesc, Software System, System) | ||
| !define system_ext(iId, iName) item_t(rectangle, iId, iName, Software System, ExternalSystem) | ||
| !define system_ext(iId, iName, iDesc) item(rectangle, iId, iName, iDesc, Software System, ExternalSystem) | ||
| !define system_boundary(iId, iName) item_t(rectangle, iId, iName, System, Boundary) | ||
|
|
||
| !define container(iId, iName) item_t(rectangle, iId, iName, Container, Container) | ||
| !define container(iId, iName, iTech, iDesc) item(rectangle, iId, iName, iDesc, "Container: iTech", Container) | ||
| !define container_t(iId, iName, iTech) item_t(rectangle, iId, iName, "Container: iTech", Container) | ||
| !define container_d(iId, iName, iDesc) item(rectangle, iId, iName, iDesc, Container, Container) | ||
| !define container_boundary(iId, iName) item_t(rectangle, iId, iName, "Container", Boundary) | ||
| !define container_boundary(iId, iName, iTech) item_t(rectangle, iId, iName, "Container: iTech", Boundary) | ||
|
|
||
| !define database(iId, iName) item_t(database, iId, iName, Container, Container) | ||
| !define database(iId, iName, iTech, iDesc) item(database, iId, iName, iDesc, "Container: iTech", Container) | ||
| !define database_t(iId, iName, iTech) item_t(database, iId, iName, "Container: iTech", Container) | ||
| !define database_d(iId, iName, iDesc) item(database, iId, iName, iDesc, Container, Container) | ||
|
|
||
| !define component(iId, iName) item_t(rectangle, iId, iName, Component, Component) | ||
| !define component(iId, iName, iTech, iDesc) item(rectangle, iId, iName, iDesc, "Component: iTech", Component) | ||
| !define component_t(iId, iName, iTech) item_t(rectangle, iId, iName, "Component: iTech", Component) | ||
| !define component_d(iId, iName, iDesc) item(rectangle, iId, iName, iDesc, Component, Component) | ||
|
|
||
| !define enterprise(iId, iName) item_t(rectangle, iId, iName, Enterprise, Boundary) |
Oops, something went wrong.