Dooble is a marble diagram generator from text. It eases the documentation of ReactiveX standard and custom operators, in a consitent way.
pip install dooble
A sphinx plugin is also available:
pip install sphinxcontrib-dooble
The text grammar allows to easilly define observables and operators. The map operator with an input observable and an output observable is described the following way:
--1--2--3--4-->
[ map(i: i*2) ]
--2--4--6--8-->
save this text in a file named map.txt and then render it to an image:
dooble --input map.txt --output map.png
The generated image looks like this:
Higher order observables can also be documented easilly:
--a-b-c---d-e-f-->
[ window ]
--+-------+------>
+d-e-f-|
+a-b-c-|
save this text in a file named window.txt and then render it to an image:
dooble --input window.txt --output window.png
The generated image looks like this:
For operators that take several observables as input, it is possible to label them:
--1--2--3--*
a-7-8-|
[ catch(a) ]
--1--2--3--7-8-|
save this text in a file named catch.txt and then render it to an image:
dooble --input catch.txt --output catch.png
The generated image looks like this:
- Each text line represents either an observable, or an operator
- Observables are defined with dash lines
- If an Observable starts with a letter, this letter is considered as a label
- Each character represent a time span
- Character
|
indicates an observable completion - Character
*
indicates an observable error - Character
>
indicates an observable continutation - The
+
character is used to define anchors of higher order observables - operators start with a
[
and end with a]
The full grammar is the following one (in tatsu pseudo ebnf syntax):
@@grammar::dooble
start = { layer } $ ;
layer
=
| obs:observable
| op:operator
;
observable = {skipspan}* [prefix] {lifetime}* completion ;
operator = '[' description ']' ;
prefix = '+' | label ;
label = /[a-z]/ ;
lifetime
=
| ts:timespan
| item:item
;
completion = /[>|*]/ ;
skipspan = ' ' ;
timespan = '-' ;
item = /[a-zA-Z0-9+.,]+/ ;
description = /[a-zA-Z0-9,:+*() <>_]+/ ;