#117 labels for nodes implemented

task/factory/default/docs/asciidoc/dataobjects.adoc

@@ -89,6 +89,9 @@ Sets a node factory name to <code>ActionNodeFactory.NAME</code> and configures t
 |[[actions]]`@actions`|`Array of link:dataobjects.html#GraphNodeOptions[GraphNodeOptions]`|+++
 Sets a node factory name to <code>SubtasksNodeFactory.NAME</code> and configures subgraphs.
 +++
+|[[label]]`@label`|`String`|+++
+Sets human readable graph node label
++++
 |[[node]]`@node`|`link:dataobjects.html#NodeOptions[NodeOptions]`|+++
 Node options define a node factory and its configuration.
 +++

task/factory/default/src/main/java/io/knotx/fragments/task/factory/generic/GraphNodeOptions.java

@@ -15,6 +15,7 @@
  */
 package io.knotx.fragments.task.factory.generic;
 
+import com.google.common.base.Objects;
 import io.knotx.fragments.task.factory.generic.node.NodeOptions;
 import io.knotx.fragments.task.factory.generic.node.action.ActionNodeConfig;
 import io.knotx.fragments.task.factory.generic.node.action.ActionNodeFactory;
@@ -25,7 +26,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Optional;
 
 /**
@@ -35,6 +35,7 @@
 public class GraphNodeOptions {
 
   private NodeOptions node;
+  private String label;
   private Map<String, GraphNodeOptions> onTransitions;
 
   public GraphNodeOptions(NodeOptions nodeOptions, Map<String, GraphNodeOptions> transitions) {
@@ -88,6 +89,24 @@ public GraphNodeOptions setNode(NodeOptions node) {
     return this;
   }
 
+  /**
+   * @return graph node label
+   */
+  public String getLabel() {
+    return label;
+  }
+
+  /**
+   * Sets human readable graph node label
+   *
+   * @param label graph node label
+   * @return reference to this, so the API can be used fluently
+   */
+  public GraphNodeOptions setLabel(String label) {
+    this.label = label;
+    return this;
+  }
+
   /**
    * It specifies the next graph node for the given transition. If no graph edge is defined, then an
    * empty value is returned.
@@ -164,19 +183,21 @@ public boolean equals(Object o) {
       return false;
     }
     GraphNodeOptions that = (GraphNodeOptions) o;
-    return Objects.equals(node, that.node) &&
-        Objects.equals(onTransitions, that.onTransitions);
+    return Objects.equal(node, that.node) &&
+        Objects.equal(label, that.label) &&
+        Objects.equal(onTransitions, that.onTransitions);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(node, onTransitions);
+    return Objects.hashCode(node, label, onTransitions);
   }
 
   @Override
   public String toString() {
     return "GraphNodeOptions{" +
         "node=" + node +
+        ", label='" + label + '\'' +
         ", onTransitions=" + onTransitions +
         '}';
   }

task/factory/default/src/test/java/io/knotx/fragments/task/factory/generic/GraphNodeOptionsTest.java

@@ -87,6 +87,20 @@ void expectTransitionSuccessWithNodeBThenNodeC(Vertx vertx) throws Throwable {
     }, vertx);
   }
 
+  @Test
+  @DisplayName("Expect nodes with properly configured labels")
+  void expectTaskWithProperlyConfiguredLabels(Vertx vertx) throws Throwable {
+    verify("conf/taskWithLabels.conf", config -> {
+      GraphNodeOptions graphNodeOptions = new GraphNodeOptions(config);
+      assertEquals("a-label", graphNodeOptions.getLabel());
+      Optional<GraphNodeOptions> nodeB = graphNodeOptions.get(SUCCESS_TRANSITION);
+      assertTrue(nodeB.isPresent());
+      assertEquals("b-label", nodeB.get().getLabel());
+      Optional<GraphNodeOptions> nodec = nodeB.get().get(SUCCESS_TRANSITION);
+      assertTrue(nodec.isPresent());
+      assertEquals("c-label", nodec.get().getLabel());
+    }, vertx);
+  }
 
   private Consumer<JsonObject> validateActionNode() {
     return config -> {

task/factory/default/src/test/resources/conf/taskWithLabels.conf

@@ -0,0 +1,15 @@
+# node & transitions
+action = a
+label = a-label
+onTransitions {
+  _success {
+    action = b
+    label = b-label
+    onTransitions {
+      _success {
+        action = c
+        label = c-label
+      }
+    }
+  }
+}