Arbeiten mit Git und AsciiDoc

@startuml example-c4-dynamic-diagram
' source: https://github.com/plantuml-stdlib/C4-PlantUML
' C4 Model
!include <c4/C4_Dynamic.puml>
'!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml

' Diagram title
title \nDynamic diagram example\n

' Diagram syntax
ContainerDb(c4, "Database", "Relational Database Schema", "Stores user registration information, hashed authentication credentials, access logs, etc.")
Container(c1, "Single-Page Application", "JavaScript and Angular", "Provides all of the Internet banking functionality to customers via their web browser.")
Container_Boundary(b, "API Application") {
  Component(c3, "Security Component", "Spring Bean", "Provides functionality Related to signing in, changing passwords, etc.")
  Component(c2, "Sign In Controller", "Spring MVC Rest Controller", "Allows users to sign in to the Internet Banking System.")
}
Rel_R(c1, c2, "Submits credentials to", "JSON/HTTPS")
Rel(c2, c3, "Calls isAuthenticated() on")
Rel_R(c3, c4, "select * from users where username = ?", "JDBC")

' Use complete legend
'LAYOUT_WITH_LEGEND()
' calculated legend, only show used items
SHOW_LEGEND()
@enduml

@startuml example-c4-dynamic-diagram
' source: https://github.com/plantuml-stdlib/C4-PlantUML
' C4 Model
!include <c4/C4_Deployment.puml>
' !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml

AddElementTag("fallback", $bgColor="#c0c0c0")
AddRelTag("fallback", $textColor="#c0c0c0", $lineColor="#438DD5")

title Deployment Diagram for Internet Banking System - Live

Deployment_Node(plc, "Big Bank plc", "Big Bank plc data center"){
    Deployment_Node(dn, "bigbank-api***\tx8", "Ubuntu 16.04 LTS"){
        Deployment_Node(apache, "Apache Tomcat", "Apache Tomcat 8.x"){
            Container(api, "API Application", "Java and Spring MVC", "Provides Internet Banking functionality via a JSON/HTTPS API.")
        }
    }
    Deployment_Node(bigbankdb01, "bigbank-db01", "Ubuntu 16.04 LTS"){
        Deployment_Node(oracle, "Oracle - Primary", "Oracle 12c"){
            ContainerDb(db, "Database", "Relational Database Schema", "Stores user registration information, hashed authentication credentials, access logs, etc.")
        }
    }
    Deployment_Node(bigbankdb02, "bigbank-db02", "Ubuntu 16.04 LTS", $tags="fallback") {
        Deployment_Node(oracle2, "Oracle - Secondary", "Oracle 12c", $tags="fallback") {
            ContainerDb(db2, "Database", "Relational Database Schema", "Stores user registration information, hashed authentication credentials, access logs, etc.", $tags="fallback")
        }
    }
    Deployment_Node(bb2, "bigbank-web***\tx4", "Ubuntu 16.04 LTS"){
        Deployment_Node(apache2, "Apache Tomcat", "Apache Tomcat 8.x"){
            Container(web, "Web Application", "Java and Spring MVC", "Delivers the static content and the Internet Banking single page application.")
        }
    }
}

Deployment_Node(mob, "Customer's mobile device", "Apple IOS or Android"){
    Container(mobile, "Mobile App", "Xamarin", "Provides a limited subset of the Internet Banking functionality to customers via their mobile device.")
}

Deployment_Node(comp, "Customer's computer", "Mircosoft Windows or Apple macOS"){
    Deployment_Node(browser, "Web Browser", "Google Chrome, Mozilla Firefox, Apple Safari or Microsoft Edge"){
        Container(spa, "Single Page Application", "JavaScript and Angular", "Provides all of the Internet Banking functionality to customers via their web browser.")
    }
}

Rel(mobile, api, "Makes API calls to", "json/HTTPS")
Rel(spa, api, "Makes API calls to", "json/HTTPS")
Rel_U(web, spa, "Delivers to the customer's web browser")
Rel(api, db, "Reads from and writes to", "JDBC")
Rel(api, db2, "Reads from and writes to", "JDBC", $tags="fallback")
Rel_R(db, db2, "Replicates data to")

' Use complete legend
'LAYOUT_WITH_LEGEND()
' calculated legend, only show used items
SHOW_LEGEND()
@enduml

@startuml example-component-diagram
left to right direction

cloud "Cloud" {
  [Space]
}

node "Webserver" {
  database "Database" {
    [MySQL]
  }
  component [Web App] #fadbd8
  [Apache] -- HTTP
  [Web App] <-- [Apache]
  [Web App] -> [MySQL] : <<local>>
}

package "Client" {
  [Webbrowser] . [Javascript]
}

[Web App] -up-> [Space] : <<OAuth>>
[Webbrowser] -up-> HTTP : <<https>>
@enduml

@startuml example-package-diagram
package Main #eafaf1 {
  class MyDialog
}

package BusinessService  #fdedec {
  class MyService
  package Interfaces #fadbd8 {
    interface MyRepository <<interface>>
  }
}

package LocalTestData #ebf5fb {
  class DictionaryRepository
  class TestData
}

package DbMsSqlServer #ebf5fb {
  class MsSqlRepository
}

'package Typen {
'  class Student
'  class SubjectMark
'}
' namespace with auto package variant
class Typen.Student
class Typen.SubjectMark


Main -> BusinessService : <<import>>
Main ..> LocalTestData : <<import>>
Main ..> DbMsSqlServer : <<import>>
'MyService --( MyRepository
DictionaryRepository --() MyRepository
MsSqlRepository --() MyRepository

'Typen <.. Main : <<import>>
'Typen <.. BusinessService : <<import>>
'Typen <.. LocalTestData : <<import>>
'Typen <.. DbMsSqlServer : <<import>>

note bottom of Typen: Data types for students, subjects and marks\nare required in all packages
@enduml

@startuml example-sequence-diagram

'skinparam responseMessageBelowArrow true
'autonumber

actor User as u01
participant "UI Class" as c01
participant "Controller Class" as c02
participant "Work Class" as c03 #LightSalmon
database "SQL Server" as db01 #LightGray

u01 -> c01: Do Work
activate c01
note left: user requests data

c01 -> c02: Create Request
activate c02

c02 -> c03: Do Work
activate c03 #LightSalmon

c03 -> db01: Request Data
'|||
db01 --> c03: Send Data

c03 -> c03: Work
note right
processes data
- calculate
- filter and sort
end note

c03 --> c02: Work Done
destroy c03

c02 --> c01: Request Created
deactivate c02

c01 --> u01: Done
deactivate c01

@enduml

@startuml example-erm-diagram
' diagram direction
left to right direction
' hide the (E) in the entity name
hide circle
' avoid problems with angled crows feet
skinparam linetype ortho
' Remove shadows
skinparam shadowing false

entity Address {
  * <&key> **id** : char(5)
  --
  * street : varchar(255)
  * zipCode : char(5)
  * city : varchar(255)
  * country : varchar(255)
  ...
}

entity Student {
  * <&key> **id** : char(5)
  --
  * firstName : varchar(255)
  * lastName : varchar(255)
  ...
}

entity Subject {
  * <&key> **id** : char(2)
  --
  * name : varchar(255)
  ...
}

entity Mark {
  '* <&key> **studentId** : char(5) <<FK>>
  '* <&key> **subjectId** : char(2) <<FK>>
  --
  mark : float
  ...
}

Address ||--|{ Student
Student }o--o{ Subject
(Student, Subject) .. Mark

'note bottom of Mark : composite primary key,\nrefers to Student.id and Subject.id
@enduml

@startuml example-erm-diagram
' diagram direction
left to right direction
' hide the (E) in the entity name
hide circle
' avoid problems with angled crows feet
skinparam linetype ortho
' Remove shadows
skinparam shadowing false

entity Address {
  * <&key> **id** : char(5)
  --
  * street : varchar(255)
  * zipCode : char(5)
  * city : varchar(255)
  * country : varchar(255)
  ...
}

entity Student {
  * <&key> **id** : char(5)
  --
  * firstName : varchar(255)
  * lastName : varchar(255)
  ...
}

entity Subject {
  * <&key> **id** : char(2)
  --
  * name : varchar(255)
  ...
}

entity Mark {
  --
  mark : float
  ...
}

diamond r1
diamond r2

' Notation: Funktionalität/Kardinalität und (min/max)

Address "**1** (1,*)" -- r1
r1 -- "**n** (1,1)" Student

Student "**n** (0,*)" -- r2
r2 -- "**m** (0,*)" Subject

r2 - Mark

@enduml

@startuml example-erm-diagram
' diagram direction
left to right direction
' hide the (E) in the entity name
hide circle
' avoid problems with angled crows feet
skinparam linetype ortho
' Remove shadows
skinparam shadowing false

entity Address {
  * <&key> **id** : char(5)
  --
  * street : varchar(255)
  * zipCode : char(5)
  * city : varchar(255)
  * country : varchar(255)
  ...
}

entity Student {
  * <&key> **id** : char(5)
  --
  * firstName : varchar(255)
  * lastName : varchar(255)
  * addressID : char(5) <<FK>>
  ...
}

entity Subject {
  * <&key> **id** : char(2)
  --
  * name : varchar(255)
  ...
}

entity Mark {
  * <&key> **studentId** : char(5) <<FK>>
  * <&key> **subjectId** : char(2) <<FK>>
  --
  mark : float
  ...
}

Address ||--|{ Student
Student ||--o{ Mark
Mark }o--|| Subject

@enduml