updated asciidoctor plugin versions.

updated locations to default convensions.
open-jumpco · Sep 4, 2019 · 3bebfbf · 3bebfbf
1 parent e61b2b7
commit 3bebfbf
Show file tree

Hide file tree

Showing 39 changed files with 30 additions and 16 deletions.
diff --git a/README.adoc b/README.adoc
@@ -39,7 +39,7 @@ Then we use the DSL to declare a definition of a statemachine matching the diagr
 
 ==== State Diagram
 
-image::src/doc/asciidoc/turnstile_fsm.png[Turnstile state diagram]
+image::src/docs/asciidoc/turnstile-fsm.png[Turnstile state diagram]
 
 ==== State Table
 
@@ -121,7 +121,11 @@ class TurnstileFSM(turnstile: Turnstile) {
     fun coin() = fsm.sendEvent(TurnstileEvents.COIN)
     fun pass() = fsm.sendEvent(TurnstileEvents.PASS)
     companion object {
-        private val definition = stateMachine(TurnstileStates.values().toSet(), TurnstileEvents::class, Turnstile::class) {
+        private val definition = stateMachine(
+            TurnstileStates.values().toSet(),
+            TurnstileEvents::class,
+            Turnstile::class
+        ) {
             initial {
             if (locked)
                 TurnstileStates.LOCKED

diff --git a/build.gradle b/build.gradle
@@ -5,9 +5,10 @@ plugins {
     id 'org.jetbrains.dokka' version '0.9.18'
     id 'maven-publish'
     id 'signing'
-    id 'org.asciidoctor.convert' version '2.2.0'
+    id 'org.asciidoctor.convert' version '2.3.0'
     id 'org.jlleitschuh.gradle.ktlint' version '8.2.0'
     id 'org.jlleitschuh.gradle.ktlint-idea' version '8.2.0'
+    id 'com.cosminpolifronie.gradle.plantuml' version '1.6.0'
 }
 
 repositories {
@@ -30,7 +31,6 @@ apply from: "$rootProject.projectDir/gradle/publish.gradle"
 def useTarget = project.ext.useTarget
 
 
-
 kotlin {
     sourceSets {
         commonTest {
@@ -64,3 +64,7 @@ ktlint {
         include("**/kotlin/**")
     }
 }
+
+plantUml {
+    render input: 'src/docs/plantuml/*.plantuml', output: 'src/docs/asciidoc', format: 'png', withMetadata: false
+}
diff --git a/gradle/docs.gradle b/gradle/docs.gradle
@@ -54,8 +54,6 @@ dokka {
 }
 
 asciidoctor {
-    sourceDir = file('src/doc/asciidoc')
-    outputDir = file('build/docs')
     sources {
         include 'index.adoc'
     }
@@ -79,7 +77,7 @@ task docs(type: Zip, dependsOn: [asciidoctor, dokka]) {
     archiveClassifier = 'doc'
     duplicatesStrategy = DuplicatesStrategy.EXCLUDE
 
-    from(file('build/docs/html5'))
+    from(file('build/asciidoc/html5'))
 
     from(file('build/javadoc')) {
         into('javadoc')

diff --git a/src/doc/asciidoc/paying_turnstile_fsm.png b/src/doc/asciidoc/paying_turnstile_fsm.png
diff --git a/src/doc/asciidoc/statemachine_classes.png b/src/doc/asciidoc/statemachine_classes.png
diff --git a/src/doc/asciidoc/statemachine_model.png b/src/doc/asciidoc/statemachine_model.png
diff --git a/src/doc/asciidoc/statemachine_packaged.png b/src/doc/asciidoc/statemachine_packaged.png
diff --git a/src/doc/asciidoc/statemachine_sequence.png b/src/doc/asciidoc/statemachine_sequence.png
diff --git a/src/doc/asciidoc/turnstile_sequence.png b/src/doc/asciidoc/turnstile_sequence.png
diff --git a/src/doc/asciidoc/useless_fsm.png b/src/doc/asciidoc/useless_fsm.png
diff --git a/src/doc/asciidoc/docinfo-footer.html → src/docs/asciidoc/docinfo-footer.html b/src/doc/asciidoc/docinfo-footer.html → src/docs/asciidoc/docinfo-footer.html
diff --git a/src/doc/asciidoc/docinfo.html → src/docs/asciidoc/docinfo.html b/src/doc/asciidoc/docinfo.html → src/docs/asciidoc/docinfo.html
diff --git a/src/doc/asciidoc/documentation.adoc → src/docs/asciidoc/documentation.adoc b/src/doc/asciidoc/documentation.adoc → src/docs/asciidoc/documentation.adoc
@@ -87,7 +87,7 @@ Automatic transitions will be executed if the specific state applies after the e
 
 The state can be any type but we have been using `enum class` in all samples.
 
-image::statemachine_sequence.png[FSM sequence]
+image::statemachine-sequence.png[FSM sequence]
 
 When sendEvent is called the state machine applies the event to the current state map.
 The current state map is usually top-level state map unless you have defined named maps and used a push transition.
@@ -162,7 +162,9 @@ The top level element is `stateMachine` either by using the function
 [source,kotlin]
 ----
 // using builder function
-val definition = StateMachineBuilder<StateEnum,EventEnum,ContextType>(StateEnum.values().toSet()).stateMachine {
+val definition = StateMachineBuilder<StateEnum, EventEnum, ContextType>(
+    StateEnum.values().toSet()
+).stateMachine {
     default { // global defaults
     }
     initial { // initial state expression
@@ -175,7 +177,11 @@ val definition = StateMachineBuilder<StateEnum,EventEnum,ContextType>(StateEnum.
     }
 }.build()
 // using global function
-val definition = stateMachine(StateEnum.values().toSet(), EventEnum::class,ContextType::class) {
+val definition = stateMachine(
+    StateEnum.values().toSet(),
+    EventEnum::class,
+    ContextType::class
+) {
     default { // global defaults
     }
     initial { // initial state expression
@@ -239,7 +245,7 @@ Example:
 [source,kotlin]
 ----
 entry { fromState, targetState, args ->
-    println("Entering:$targetState from $fromState with ${args.toList()}")
+    entryAction()
 }
 ----
 
@@ -255,7 +261,7 @@ Example:
 [source,kotlin]
 ----
 exit { fromState, targetState, args ->
-    println("Exiting:$fromState to $targetState with ${args.toList()}")
+    exitAction()
 }
 ----
 ==== `transition`

diff --git a/src/doc/asciidoc/index.adoc → src/docs/asciidoc/index.adoc b/src/doc/asciidoc/index.adoc → src/docs/asciidoc/index.adoc
diff --git a/src/doc/asciidoc/kfsm.adoc → src/docs/asciidoc/kfsm.adoc b/src/doc/asciidoc/kfsm.adoc → src/docs/asciidoc/kfsm.adoc
@@ -5,7 +5,7 @@ We want to ensure that the `lock()` function is only called when the lock is not
 Then we use the DSL to declare a definition of a statemachine matching the diagram:
 
 ==== State Diagram
-image::turnstile_fsm.png[LockStateDiagram]
+image::turnstile-fsm.png[LockStateDiagram]
 
 ==== State Table
 
@@ -164,7 +164,7 @@ fsm.coin()
 
 link:https://github.com/open-jumpco/kfsm-samples[Samples]
 
-image::statemachine_model.png[StateMachineModel]
+image::statemachine-model.png[StateMachineModel]
 
 === Advanced Features
 We can add arguments to events and use named state maps with push / pop and automatic transitions.
@@ -188,12 +188,12 @@ If we update the turnstile to include the value of the coin in the coin event we
 A named state where decisions regarding coins are made.
 We push to `coins` with COINS state and then the automatic states will be triggered if the guards are met.
 
-image::paying_turnstile_fsm.png[Paying Turnstile]
+image::paying-turnstile-fsm.png[Paying Turnstile]
 
 ==== State Table
 
 |===
-|Start State |Event |Guard| End State | Action
+|Start State |Event |Guard Expression | End State | Action
 
 |LOCKED
 |PASS
@@ -292,7 +292,9 @@ class PayingTurnstile(
 
 }
 ----
+
 ==== States and Events
+
 [source,kotlin]
 ----
 enum class PayingTurnstileStates {

diff --git a/src/docs/asciidoc/lock-fsm.png b/src/docs/asciidoc/lock-fsm.png
diff --git a/src/doc/asciidoc/lock_fsm.png → src/docs/asciidoc/lock_fsm.png b/src/doc/asciidoc/lock_fsm.png → src/docs/asciidoc/lock_fsm.png
diff --git a/src/docs/asciidoc/paying-turnstile-fsm.png b/src/docs/asciidoc/paying-turnstile-fsm.png
diff --git a/src/docs/asciidoc/sample-fsm.png b/src/docs/asciidoc/sample-fsm.png
diff --git a/src/docs/asciidoc/statemachine-classes.png b/src/docs/asciidoc/statemachine-classes.png
diff --git a/src/docs/asciidoc/statemachine-model.png b/src/docs/asciidoc/statemachine-model.png
diff --git a/src/docs/asciidoc/statemachine-packaged.png b/src/docs/asciidoc/statemachine-packaged.png
diff --git a/src/docs/asciidoc/statemachine-sequence.png b/src/docs/asciidoc/statemachine-sequence.png
diff --git a/src/docs/asciidoc/turnstile-fsm.png b/src/docs/asciidoc/turnstile-fsm.png
diff --git a/src/doc/asciidoc/turnstile-scxml.xml → src/docs/asciidoc/turnstile-scxml.xml b/src/doc/asciidoc/turnstile-scxml.xml → src/docs/asciidoc/turnstile-scxml.xml
diff --git a/src/docs/asciidoc/turnstile-sequence.png b/src/docs/asciidoc/turnstile-sequence.png
diff --git a/src/doc/asciidoc/turnstile_fsm.png → src/docs/asciidoc/turnstile_fsm.png b/src/doc/asciidoc/turnstile_fsm.png → src/docs/asciidoc/turnstile_fsm.png
diff --git a/src/doc/asciidoc/turnstile_scxml.png → src/docs/asciidoc/turnstile_scxml.png b/src/doc/asciidoc/turnstile_scxml.png → src/docs/asciidoc/turnstile_scxml.png
diff --git a/src/docs/asciidoc/useless-fsm.png b/src/docs/asciidoc/useless-fsm.png
diff --git a/src/doc/plantuml/lock-fsm.plantuml → src/docs/plantuml/lock-fsm.plantuml b/src/doc/plantuml/lock-fsm.plantuml → src/docs/plantuml/lock-fsm.plantuml
diff --git a/...oc/plantuml/paying-turnstile-fsm.plantuml → ...cs/plantuml/paying-turnstile-fsm.plantuml b/...oc/plantuml/paying-turnstile-fsm.plantuml → ...cs/plantuml/paying-turnstile-fsm.plantuml
diff --git a/src/doc/plantuml/sample-fsm.plantuml → src/docs/plantuml/sample-fsm.plantuml b/src/doc/plantuml/sample-fsm.plantuml → src/docs/plantuml/sample-fsm.plantuml
diff --git a/...oc/plantuml/statemachine-classes.plantuml → ...cs/plantuml/statemachine-classes.plantuml b/...oc/plantuml/statemachine-classes.plantuml → ...cs/plantuml/statemachine-classes.plantuml
diff --git a/src/doc/plantuml/statemachine-model.plantuml → ...docs/plantuml/statemachine-model.plantuml b/src/doc/plantuml/statemachine-model.plantuml → ...docs/plantuml/statemachine-model.plantuml
diff --git a/...c/plantuml/statemachine-packaged.plantuml → ...s/plantuml/statemachine-packaged.plantuml b/...c/plantuml/statemachine-packaged.plantuml → ...s/plantuml/statemachine-packaged.plantuml
diff --git a/...c/plantuml/statemachine_sequence.plantuml → ...s/plantuml/statemachine-sequence.plantuml b/...c/plantuml/statemachine_sequence.plantuml → ...s/plantuml/statemachine-sequence.plantuml
diff --git a/src/doc/plantuml/turnstile-fsm.plantuml → src/docs/plantuml/turnstile-fsm.plantuml b/src/doc/plantuml/turnstile-fsm.plantuml → src/docs/plantuml/turnstile-fsm.plantuml
diff --git a/src/doc/plantuml/turnstile_sequence.plantuml → ...docs/plantuml/turnstile-sequence.plantuml b/src/doc/plantuml/turnstile_sequence.plantuml → ...docs/plantuml/turnstile-sequence.plantuml
diff --git a/src/doc/plantuml/useless-fsm.plantuml → src/docs/plantuml/useless-fsm.plantuml b/src/doc/plantuml/useless-fsm.plantuml → src/docs/plantuml/useless-fsm.plantuml