Refined DCB code and updated docs.

Author: johnbywater

.github/workflows/runtests.yaml

@@ -47,6 +47,9 @@ jobs:
         PGPASSWORD=postgres psql -c "ALTER DATABASE eventsourcing OWNER TO eventsourcing;" -U postgres -h localhost
         PGPASSWORD=postgres psql eventsourcing -c "CREATE SCHEMA myschema AUTHORIZATION eventsourcing" -U postgres -h localhost
 
+    - name: Start UmaDB
+      run: make start-umadb
+
     - name: Install Poetry
       run: make install-poetry
 
@@ -62,6 +65,10 @@ jobs:
     - name: Benchmark
       run: make benchmark
 
+    - name: Stop UmaDB
+      run: make stop-umadb
+
+
 #    - name: Coveralls
 #      uses: AndreMiras/coveralls-python-action@develop
 #      with:

Makefile

@@ -242,3 +242,13 @@ docs-pdf:
 # .PHONY: ramdisk
 # ramdisk:
 # 	diskutil erasevolume HFS+ 'RAM Disk' `hdiutil attach -nobrowse -nomount ram://204800`
+
+.PHONY: start-umadb
+start-umadb:
+	docker run --rm -d --name my-umadb -p 50051:50051 umadb/umadb:latest
+	sleep 1
+
+
+.PHONY: stop-umadb
+stop-umadb:
+	docker stop my-umadb

docs/topics/dcb.rst

@@ -70,15 +70,14 @@ Example systems
 
 .. _Dynamic consistency boundaries:
 
-Dynamic consistency boundaries
-==============================
+DCB examples
+============
 
 .. toctree::
    :maxdepth: 2
 
-   examples/coursebooking
-   examples/coursebooking-dcb
-   examples/coursebooking-dcb-postgres-tt
-   examples/coursebooking-dcb-umadb
-   examples/coursebooking-dcb-refactored
-   examples/coursebooking-dcb-slices
+   examples/dcb-enrolment-introduction
+   examples/dcb-enrolment-with-basic-objects
+   examples/dcb-enrolment-with-enduring-objects
+   examples/dcb-enrolment-with-vertical-slices
+   examples/dcb-enrolment-speedrun

docs/topics/examples.rst

@@ -35,7 +35,7 @@ Application
 -----------
 
 The :class:`~examples.aggregate10.application.DogSchool` application in this example uses the
-:class:`~examples.aggregate9.msgspecstructs.MsgspecApplication` class
+:class:`~examples.aggregate9.msgpack.MsgspecApplication` class
 from :doc:`example 9 </topics/examples/aggregate9>`.
 
 .. literalinclude:: ../../../examples/aggregate10/application.py

docs/topics/examples/aggregate10.rst

@@ -53,21 +53,21 @@ The benchmarks were done with pytest-benchmark.
      - 296 (0.21x)
 
 
-Msgspec mapper
---------------
+MessagePack mapper
+------------------
 
-The :class:`~examples.aggregate9.msgspecstructs.MsgspecMapper` class is a :ref:`mapper<Mapper>` that supports
+The :class:`~examples.aggregate9.msgpack.MessagePackMapper` class is a :ref:`mapper<Mapper>` that supports
 msgspec structs. It is responsible for converting domain model objects to Python bytes objects, and for
 reconstructing model objects from Python bytes objects.
 
-.. literalinclude:: ../../../examples/aggregate9/msgspecstructs.py
-    :pyobject: MsgspecMapper
+.. literalinclude:: ../../../examples/aggregate9/msgpack.py
+    :pyobject: MessagePackMapper
 
-The :class:`~examples.aggregate9.msgspecstructs.MsgspecApplication` class is a
+The :class:`~examples.aggregate9.msgpack.MsgspecApplication` class is a
 subclass of the library's :class:`~eventsourcing.application.Application` class
-which is configured to use :class:`~examples.aggregate9.msgspecstructs.MsgspecMapper`.
+which is configured to use :class:`~examples.aggregate9.msgpack.MessagePackMapper`.
 
-.. literalinclude:: ../../../examples/aggregate9/msgspecstructs.py
+.. literalinclude:: ../../../examples/aggregate9/msgpack.py
     :pyobject: MsgspecApplication
 
 
@@ -91,7 +91,7 @@ Application
 -----------
 
 The :class:`~examples.aggregate9.application.DogSchool` application in this example uses the
-:class:`~examples.aggregate9.msgspecstructs.MsgspecApplication`. It must receive the new events that are returned
+:class:`~examples.aggregate9.msgpack.MsgspecApplication`. It must receive the new events that are returned
 by the aggregate command methods, and pass them to its :func:`~eventsourcing.application.Application.save`
 method. The aggregate projector function must also be supplied when reconstructing an aggregate from the
 repository, and when taking snapshots.
@@ -119,7 +119,7 @@ Code reference
     :members:
     :undoc-members:
 
-.. automodule:: examples.aggregate9.msgspecstructs
+.. automodule:: examples.aggregate9.msgpack
     :show-inheritance:
     :member-order: bysource
     :members: