Merge pull request #166 from cosmicpython/tweakdiags

Mess about with plantuml diagram styling.

Author: hjwp

chapter_01_domain_model.asciidoc

@@ -122,9 +122,15 @@ image::images/allocation_context_diagram.png[]
 ----
 [plantuml, allocation_context_diagram]
 @startuml Allocation Context Diagram
-!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml
 !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Context.puml
 
+skinparam roundCorner 20
+skinparam Padding 2
+skinparam wrapWidth 200
+skinparam default {
+    FontName Guardian Sans Cond Regular
+}
+
 System(systema, "Allocation", "Allocates stock to customer orders")
 
 Person(customer, "Customer", "Wants to buy furniture")
@@ -145,8 +151,6 @@ Rel_U(warehouse, customer, "Dispatches goods to")
 @enduml
 ----
 
-//TODO: illustration text is cut off
-
 For the purposes of this book, we're imagining a situation where the business
 decides to implement an exciting new way of allocating stock.  Until now, the
 business has been presenting stock and lead times based on what is physically
@@ -455,20 +459,26 @@ class Batch:
 image::images/model_diagram.png[]
 [role="image-source"]
 ----
-[ditaa, model_diagram]
-+=====================+
-| Batch               |
-+---------------------+
-| reference           |
-| sku                 |
-| eta                 |
-| _purchased_quantity |       +=============+
-| _allocations ------------->>| OrderLine   |
-+---------------------+       +-------------+
-                              | order_id    |
-                              | sku         |
-                              | qty         |
-                              +-------------+
+[plantuml, model_diagram, config=plantuml.cfg]
+
+left to right direction
+hide empty members
+
+class Batch {
+    reference
+    sku
+    eta
+    _purchased_quantity
+    _allocations
+}
+
+class OrderLine {
+    order_id
+    sku
+    qty
+}
+
+Batch::_allocations o-- OrderLine
 ----
 
 

chapter_02_repository.asciidoc

@@ -9,16 +9,16 @@ allowing us to decouple our model layer from the data layer.  We'll see a
 concrete example of how this simplifying abstraction makes our system more
 testable by hiding the complexities of the database.
 
-<<chapter_02_class_diagram>> shows a little preview of what we're going to
+<<repository_class_diagram>> shows a little preview of what we're going to
 build: a `Repository` class that sits between `SqlAlchemy` (our ORM) and our
 Domain Model's `Batch` classes.
 
-[[chapter_02_class_diagram]]
+[[repository_class_diagram]]
 .Batch, Repository and SqlAlchemy
-image::images/chapter_02_class_diagram.png[]
+image::images/repository_class_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, chapter_02_class_diagram]
+[plantuml, repository_class_diagram, config=plantuml.cfg]
 @startuml
 
 package allocation {

chapter_04_service_layer.asciidoc

@@ -17,36 +17,34 @@ By the end of this chapter, we'll have added a Flask API that will talk to
 the Service Layer, which will serve as the entrypoint to our Domain Model.
 By making the service layer depend on the `AbstractRepository`, we'll be
 able to unit test it using `FakeRepository`, and then run it in real life
-using `SqlAlchemyRepository`.  <<chapter_03_class_diagram>> is a class
+using `SqlAlchemyRepository`.  <<service_layer_class_diagram>> is a class
 diagram showing where we're heading.
 
-[[chapter_03_class_diagram]]
+[[service_layer_class_diagram]]
 .Our target architecture for the end of this chapter
-image::images/chapter_03_class_diagram.png[]
+image::images/service_layer_class_diagram.png[]
 
 [role="image-source"]
 ----
-[plantuml, chapter_03_class_diagram]
+[plantuml, service_layer_class_diagram, config=plantuml.cfg]
 @startuml
+hide empty members
+left to right direction
 
-package api {
+package "Flask API" as api {
 
-  class Flask {
-    allocate_endpoint()
+  class "allocate_endpoint()" as allocate_endpoint {
   }
+  hide allocate_endpoint circle
 }
 
-package sqlalchemy {
-  class Session {
-    query()
-    add()
-  }
-}
 
 package allocation {
 
-  class services {
-    allocate(line, repository, session)
+  package services {
+    class "allocate(line, repository, session)" as allocate {
+    }
+    hide allocate circle
   }
 
   abstract class AbstractRepository {
@@ -61,7 +59,7 @@ package allocation {
 
 
   class FakeRepository {
-    batches: List<Batch>
+    batches: List[Batch]
   }
 
   class BatchRepository {
@@ -70,14 +68,22 @@ package allocation {
 
 }
 
-services -> AbstractRepository: uses
+package sqlalchemy {
+  class Session {
+    query()
+    add()
+  }
+}
+
+
+allocate -> AbstractRepository: uses
 AbstractRepository -> Batch : stores
 
 AbstractRepository <|-- FakeRepository : implements
 AbstractRepository <|-- BatchRepository : implements
-Flask --> services : invokes
+allocate_endpoint --> allocate : invokes
 
-BatchRepository ---> Session : abstracts
+BatchRepository --> Session : abstracts
 @enduml
 ----
 

chapter_06_aggregate.asciidoc

@@ -18,21 +18,27 @@ service (<<chapter_08_before_diagram>>):
 image::images/before_aggregates_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, before_aggregates_diagram]
+[plantuml, before_aggregates_diagram, config=plantuml.cfg]
 @startuml
 
-class services {
-    allocate()
+package "Service Layer" as services {
+    class "allocate()" as allocate {
+    }
 }
 
+hide allocate circle
+hide allocate members
+
 
-package domain_model {
+package "Domain Model" as domain_model {
 
   class Batch {
   }
 
-  class allocate {
+  class "allocate()" as allocate_domain_service {
   }
+    hide allocate_domain_service circle
+    hide allocate_domain_service members
 }
 
 
@@ -45,7 +51,7 @@ package repositories {
 }
 
 services -> BatchRepository: list all batches
-services --> allocate: allocate(orderline, batches)
+services --> allocate_domain_service: allocate(orderline, batches)
 
 @enduml
 ----
@@ -59,15 +65,19 @@ allocate against (<<after_aggregates_diagram>>):
 image::images/after_aggregates_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, after_aggregates_diagram]
+[plantuml, after_aggregates_diagram, config=plantuml.cfg]
 @startuml
 
-class services {
-    allocate()
+package "Service Layer" as services {
+    class "allocate()" as allocate {
+    }
 }
 
+hide allocate circle
+hide allocate members
+
 
-package domain_model {
+package "Domain Model" as domain_model {
 
   class Product {
     allocate()
@@ -87,8 +97,8 @@ package repositories {
 }
 
 services -> ProductRepository: get me the product for this sku
-services --> Product: allocate(orderline)
-Product o-- Batch: has
+services --> Product: product.allocate(orderline)
+Product o- Batch: has
 
 @enduml
 ----
@@ -480,7 +490,7 @@ with `version=4`, and the other update will be rejected.
 image::images/version_numbers_sequence_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, version_numbers_sequence_diagram]
+[plantuml, version_numbers_sequence_diagram, config=plantuml.cfg]
 @startuml
 
 entity Model

chapter_08_all_messagebus.asciidoc

@@ -466,7 +466,7 @@ back to our existing handler for allocation, to be re-allocated.
 image::images/reallocation_sequence_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, reallocation_sequence_diagram]
+[plantuml, reallocation_sequence_diagram, config=plantuml.cfg]
 @startuml
 API -> MessageBus : BatchQuantityChanged event
 

chapter_10_external_events.asciidoc

@@ -72,21 +72,20 @@ we've named our system after a noun, _batches_, instead of _allocation_).
 image::images/batches_context_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, batches_context_diagram]
+[plantuml, batches_context_diagram, config=plantuml.cfg]
 @startuml Batches Context Diagram
-!includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4.puml
 !includeurl https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Context.puml
 
-System(batches, "Batches", "Knows about available stock")
+skinparam roundCorner 20
 
+System(batches, "Batches", "Knows about available stock")
 Person(customer, "Customer", "Wants to buy furniture")
-
 System(orders, "Orders", "Knows about customer orders")
 System(warehouse, "Warehouse", "Knows about shipping instructions")
 
-Rel(customer, orders, "Places order with")
-Rel(orders, batches, "Reserves stock with")
-Rel(batches, warehouse, "Sends instructions to")
+Rel_R(customer, orders, "Places order with")
+Rel_D(orders, batches, "Reserves stock with")
+Rel_D(batches, warehouse, "Sends instructions to")
 
 @enduml
 ----
@@ -105,7 +104,7 @@ order, we want to update the customer record to flag them as a VIP.
 image::images/command_flow_diagram_1.png[]
 [role="image-source"]
 ----
-[plantuml, command_flow_diagram_1]
+[plantuml, command_flow_diagram_1, config=plantuml.cfg]
 @startuml
 
 actor Customer
@@ -180,7 +179,7 @@ should own this process, as shown in <<command_flow_diagram_2>>?
 image::images/command_flow_diagram_2.png[]
 [role="image-source"]
 ----
-[plantuml, command_flow_diagram_2]
+[plantuml, command_flow_diagram_2, config=plantuml.cfg]
 @startuml
 
 actor w as "Warehouse worker"
@@ -221,7 +220,7 @@ right after we take a user's order for 3 MISBEGOTTEN-RUG,
 image::images/command_flow_diagram_with_error.png[]
 [role="image-source"]
 ----
-[plantuml, command_flow_diagram_with_error]
+[plantuml, command_flow_diagram_with_error, config=plantuml.cfg]
 @startuml
 
 actor Customer
@@ -344,11 +343,13 @@ Our new flow will look like this:
 
 [[reallocation_sequence_diagram_with_redis]]
 .Sequence diagram for reallocation flow
-image::images/reallocation_sequence_diagram.png[]
+image::images/reallocation_sequence_diagram_with_redis.png[]
 [role="image-source"]
 ----
-[plantuml, reallocation_sequence_diagram]
+[plantuml, reallocation_sequence_diagram_with_redis, config=plantuml.cfg]
+
 @startuml
+
 Redis -> MessageBus : BatchQuantityChanged event
 
 group BatchQuantityChanged Handler + Unit of Work 1

chapter_11_cqrs.asciidoc

@@ -497,7 +497,7 @@ to update the read model, which the GET/read operation can use.
 image::images/read_model_sequence_diagram.png[]
 [role="image-source"]
 ----
-[plantuml, read_model_sequence_diagram]
+[plantuml, read_model_sequence_diagram, config=plantuml.cfg]
 @startuml
 actor User order 1
 boundary Flask order 2

diagrams/Allocation Context Diagram.png

@@ -0,0 +1,49 @@
+skinparam default {
+    FontName Guardian Sans Cond Regular
+    FontSize 18
+    FontColor Black
+}
+
+skinparam class {
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam package {
+    FontName Guardian Sans Cond Light
+}
+
+skinparam sequencelifeline {
+    BorderColor RoyalBlue
+}
+skinparam arrow {
+    Color RoyalBlue
+}
+skinparam participant {
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam entity {
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam collections {
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam database {
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam boundary {
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam actor {
+    Color DeepSkyBlue
+    BackgroundColor Lavender
+    BorderColor RoyalBlue
+}
+skinparam sequencegroupheader {
+    FontName Guardian Sans Cond Light
+}
+skinparam padding 4