#146 Implement transitions alias

handler/core/docs/asciidoc/dataobjects.adoc

@@ -129,6 +129,10 @@ Sets a node factory name to <code>SubtasksNodeFactory.NAME</code> and configures
 |[[node]]`@node`|`link:dataobjects.html#NodeOptions[NodeOptions]`|+++
 Node options define a node factory and its configuration.
 +++
+|[[on]]`@on`|`link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
+Alias for "onTransitions".
+ See link
++++
 |[[onTransitions]]`@onTransitions`|`link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
 The outgoing graph node edges, called transitions. A transition is named graph edge that
  defines the next graph node in fragment's processing.

handler/core/handler/common/customTask.conf

@@ -0,0 +1,25 @@
+tasks {
+  success-task {
+    action = success-action
+  }
+}
+
+nodeFactories = [
+  {
+    factory = action
+    config {
+      actions {
+        success-action {
+          factory = test-action
+          config {
+            transition = _success
+            body = "custom"
+          }
+        }
+      }
+    }
+  }
+  {
+    factory = subtasks
+  }
+]

handler/core/handler/common/failingTask.conf

@@ -0,0 +1,24 @@
+tasks {
+  failing-task {
+    action = failing-action
+  }
+}
+
+nodeFactories = [
+  {
+    factory = action
+    config {
+      actions {
+        failing-action {
+          factory = test-action
+          config {
+            transition = not-existing-transition
+          }
+        }
+      }
+    }
+  }
+  {
+    factory = subtasks
+  }
+]

handler/core/handler/common/successTask.conf

@@ -0,0 +1,25 @@
+tasks {
+  success-task {
+    action = success-action
+  }
+}
+
+nodeFactories = [
+  {
+    factory = action
+    config {
+      actions {
+        success-action {
+          factory = test-action
+          config {
+            transition = _success
+            body = "success"
+          }
+        }
+      }
+    }
+  }
+  {
+    factory = subtasks
+  }
+]

handler/core/handler/common/successTaskWithHtmlBody.conf

@@ -0,0 +1,25 @@
+tasks {
+  success-task {
+    action = success-action
+  }
+}
+
+nodeFactories = [
+  {
+    factory = action
+    config {
+      actions {
+        success-action {
+          factory = test-action
+          config {
+            transition = _success
+            body = "<div>success</div>"
+          }
+        }
+      }
+    }
+  }
+  {
+    factory = subtasks
+  }
+]

handler/core/handler/consumerFactoryFound.conf

@@ -0,0 +1,12 @@
+taskFactories = [
+  {
+    factory = default
+    config { include required(classpath("handler/common/successTask.conf")) }
+  }
+]
+
+consumerFactories = [
+  {
+    factory = testConsumer
+  }
+]

handler/core/handler/consumerFactoryNameNotDefined.conf

@@ -0,0 +1,4 @@
+consumerFactories = [
+  {
+  }
+]

handler/core/handler/consumerFactoryNotFound.conf

@@ -0,0 +1,5 @@
+consumerFactories = [
+  {
+    factory = invalid
+  }
+]

handler/core/handler/fragmentWithFailingTask.conf

@@ -0,0 +1,6 @@
+taskFactories = [
+  {
+    factory = default
+    config { include required(classpath("handler/common/failingTask.conf")) }
+  }
+]

handler/core/handler/fragmentWithHtmlConsumer.conf

@@ -0,0 +1,18 @@
+taskFactories = [
+  {
+    factory = default
+    config { include required(classpath("handler/common/successTask.conf")) }
+  }
+]
+
+consumerFactories = [
+  {
+    factory = fragmentHtmlBodyWriter
+    config {
+      condition {
+        param = debug
+      }
+      fragmentTypes = [ "snippet" ]
+    }
+  }
+]

handler/core/handler/fragmentWithSuccessTask.conf

@@ -0,0 +1,6 @@
+taskFactories = [
+  {
+    factory = default
+    config { include required(classpath("handler/common/successTask.conf")) }
+  }
+]

handler/core/handler/manyTaskFactoriesWithTheSameName.conf

@@ -0,0 +1,13 @@
+taskFactories = [
+  {
+    factory = default
+    config {include required(classpath("handler/common/successTask.conf"))}
+  }
+  {
+    factory = default
+    config {include required(classpath("handler/common/customTask.conf"))}
+    config {
+      taskNameKey = task
+    }
+  }
+]

handler/core/handler/singleTaskFactoryWithFailingTask.conf

@@ -0,0 +1,6 @@
+taskFactories = [
+  {
+    factory = default
+    config { include required(classpath("handler/common/failingTask.conf")) }
+  }
+]

handler/core/handler/singleTaskFactoryWithSuccessTask.conf

@@ -0,0 +1,6 @@
+taskFactories = [
+  {
+    factory = default
+    config { include required(classpath("handler/common/successTask.conf")) }
+  }
+]

handler/core/handler/taskFactoryNameNotDefined.conf

@@ -0,0 +1,4 @@
+taskFactories = [
+  {
+  }
+]

handler/core/handler/taskFactoryNotFound.conf

@@ -0,0 +1,5 @@
+taskFactories = [
+  {
+    factory = invalid
+  }
+]

handler/core/src/main/java/io/knotx/fragments/task/factory/GraphNodeOptions.java

@@ -115,6 +115,18 @@ public GraphNodeOptions setOnTransitions(Map<String, GraphNodeOptions> onTransit
     return this;
   }
 
+  /**
+   * Alias for "onTransitions".
+   * See {@link #setOnTransitions(Map) setOnTransitions}
+   *
+   * @param on - map of possible transitions
+   * @return reference to this, so the API can be used fluently
+   */
+  public GraphNodeOptions setOn(Map<String, GraphNodeOptions> on) {
+    this.onTransitions = on;
+    return this;
+  }
+
   /**
    * Sets a node factory name to {@code ActionNodeFactory.NAME} and configures the action.
    *

handler/core/src/test/java/io/knotx/fragments/task/factory/GraphNodeOptionsTest.java

@@ -17,8 +17,7 @@
 
 import static io.knotx.fragments.HoconLoader.verify;
 import static io.knotx.fragments.api.FragmentResult.SUCCESS_TRANSITION;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 import io.knotx.fragments.task.factory.node.action.ActionNodeConfig;
 import io.knotx.fragments.task.factory.node.action.ActionNodeFactory;
@@ -27,6 +26,8 @@
 import io.vertx.core.Vertx;
 import io.vertx.core.json.JsonObject;
 import io.vertx.junit5.VertxExtension;
+
+import java.util.Map;
 import java.util.Optional;
 import java.util.function.Consumer;
 import org.junit.jupiter.api.DisplayName;
@@ -86,6 +87,16 @@ void expectTransitionSuccessWithNodeBThenNodeC(Vertx vertx) throws Throwable {
     }, vertx);
   }
 
+  @Test
+  @DisplayName("Expect 'on' to alias 'onTransitions'")
+  void expectAssignedTransitions(Vertx vertx) throws Throwable {
+    verify("task/factory/taskWithTransitions-alias.conf", config -> {
+      GraphNodeOptions graphNodeOptions = new GraphNodeOptions(config);
+      Map<String, GraphNodeOptions> transitions = graphNodeOptions.getOnTransitions();
+
+      assertFalse(transitions.isEmpty());
+    }, vertx);
+  }
 
   private Consumer<JsonObject> validateActionNode() {
     return config -> {

handler/core/src/test/resources/task/factory/taskWithTransitions-alias.conf

@@ -0,0 +1,7 @@
+# node & transitions
+action = a
+on {
+  _success {
+    action = b
+  }
+}