trailblazer-activity 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee1dccefcc5ecdb9c4a24901de3e68ae14542b29
-  data.tar.gz: cb17a9035ef5193301f01f58659a156616c1d42e
+  metadata.gz: e6d5b085e32a6c4333c666ce48975f2b99180ef8
+  data.tar.gz: 611e2db6f13e3e5ff629df25a584b5cfca347244
 SHA512:
-  metadata.gz: 92fc5d5969bf80a125d284d7615152655fbeb5af46dd1cac3e9927962a88eb751504976806336cbdcab55b577504e07494a27348a60bb25b565b36e60e42f9c2
-  data.tar.gz: d58607ae4df287ed931770f30a2c6017ebf693a28d252326605940f0f6c6c03da8441c5fe66af6abf56c21c6123719b2aafbae43a820aaf27390631314817990
+  metadata.gz: a9a7f0ce9ac2c94d618a8fdc933354b7228f9d63050f43f8adeac26afc165ba798ac9a8fe9e414648004ef00b07f20ac8c2881c630f22f915ba9d178eab5d78c
+  data.tar.gz: 20863cf5baab210d02c72eea6afb0da2c1151d0182c33a0158d69141d9ba20e83ca019aec0d38e83c37443672decbeeac6f52be4835af5e8a1f0680cbc523e00

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.1.3
+
+* Introduce `Activity#outputs` and ditch `#end_events`.
+
 # 0.1.2
 
 * Consistent return values for all graph operations: `node, edge`.

data/lib/trailblazer/activity.rb

@@ -86,7 +86,15 @@ module Trailblazer
     end
 
     def end_events
-      @circuit.to_fields[1]
+      outputs.keys
+    end
+
+    # Returns a hash mapping the circuit {Event} to its meta data.
+    #
+    #   activity.outputs #=> { #<End ..> => { role: :success }, #<End ..> => { role: :failure } }
+    def outputs
+      # DISCUSS: add more meta data?
+      ::Hash[ graph.find_all { |node| graph.successors(node).size == 0 }.collect { |node| [ node[:_wrapped], { role: node[:role] } ] } ]
     end
 
     # @private
@@ -97,9 +105,6 @@ module Trailblazer
     private
 
     def to_circuit(graph)
-      end_events = graph.find_all { |node| graph.successors(node).size == 0 } # Find leafs of graph.
-        .collect { |n| n[:_wrapped] } # unwrap the actual End event instance from the Node.
-
       Circuit.new(graph.to_h( include_leafs: false ), end_events, {})
     end
 

data/lib/trailblazer/activity/graph.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Trailblazer
   # Note that Graph is a superset of a real directed graph. For instance, it might contain detached nodes.
   # == Design
@@ -6,7 +8,7 @@ module Trailblazer
   module Activity::Graph
     # Task => { name: "Nested{Task}", type: :subprocess, boundary_events: { Circuit::Left => {} }  }
 
-    # TODO: make Edge, Node, Start Hash::Immutable ?
+    # Edge keeps references to its peer nodes via the `:source` and `:target` options.
     class Edge
       def initialize(data)
         @data = data.freeze
@@ -21,6 +23,7 @@ module Trailblazer
       end
     end
 
+    # Node does only save meta data, and has *no* references to edges.
     class Node < Edge
     end
 
@@ -30,31 +33,7 @@ module Trailblazer
         super
       end
 
-      # Single entry point for adding nodes and edges to the graph.
-      # @return target Node
-      # @return edge Edge the edge created connecting source and target.
-      def connect_for!(source, edge_args, target, old_edge:nil)
-        edge = Edge(source, edge_args, target)
-
-        self[:graph][source][edge] = target
-
-        self[:graph][source].delete(old_edge) # FIXME: shouldn't be here
-
-        return target, edge
-      end
-
-      def add!(node_args)
-        new_node = Node(*node_args)
-
-        raise IllegalNodeError.new("The ID `#{new_node[:id]}` has been added before.") if find_all( new_node[:id] ).any?
-
-        self[:graph][new_node] = {}
-        new_node
-      end
-
-      private :connect_for!, :add!
-
-      # Builds a node from the provided `:target` arguments.
+      # Builds a node from the provided `:target` arguments and attaches it via `:edge` to `:source`.
       # @param target: Array wrapped, options
       def attach!(target:raise, edge:raise, source:self)
         target = add!(target)
@@ -63,8 +42,8 @@ module Trailblazer
       end
 
       def connect!(target:raise, edge:raise, source:self)
-        target = target.kind_of?(Node) ? target : (find_all { |_target| _target[:id] == target }[0] || raise( "#{target} not found")) # FIXME: only needed for recompile_activity.
-        source = source.kind_of?(Node) ? source : (find_all { |_source| _source[:id] == source }[0] || raise( "#{source} not found"))
+        target = target.kind_of?(Node) ? target : (find_all(target)[0] || raise( "#{target} not found")) # FIXME: only needed for recompile_activity.
+        source = source.kind_of?(Node) ? source : (find_all(source)[0] || raise( "#{source} not found"))
 
         connect_for!(source, edge, target)
       end
@@ -73,15 +52,11 @@ module Trailblazer
         old_node = find_all(old_node)[0] || raise( "#{old_node} not found") unless old_node.kind_of?(Node) # FIXME: do we really need this?
         new_node = add!(node)
 
-        incoming_tuples = predecessors(old_node)
-        rewired_incoming_connections = incoming_tuples.find_all { |(node, edge)| incoming.(edge) }
+        incoming_edges = predecessors(old_node)
+        rewired_edges  = incoming_edges.find_all { |(node, edge)| incoming.(edge) }
 
         # rewire old_task's predecessors to new_task.
-        if rewired_incoming_connections.any? # the opposite happens when we're inserting "before" an orphaned node.
-          rewired_incoming_connections.each { |node, edge|
-            node, edge = connect_for!(node, [edge[:_wrapped], edge.to_h], new_node, old_edge: edge)
-          }
-        end
+        rewired_edges.each { |left_node, edge| reconnect!(left_node, edge, new_node) }
 
         # connect new_task --> old_task.
         if outgoing
@@ -98,16 +73,6 @@ module Trailblazer
         nodes.find_all(& block || ->(node) { node[:id] == id })
       end
 
-      def Edge(source, (wrapped, options), target) # FIXME: test required id. test source and target
-        id   = "#{source[:id]}-#{wrapped}-#{target[:id]}"
-        edge = Edge.new(options.merge( _wrapped: wrapped, id: id, source: source, target: target ))
-      end
-
-      # @private
-      def Node(wrapped, id:raise("No ID was provided for #{wrapped}"), **options)
-        Node.new( options.merge( id: id, _wrapped: wrapped ) )
-      end
-
       def predecessors(target_node)
         self[:graph].each_with_object([]) do |(node, connections), ary|
           connections.each { |edge, target| target == target_node && ary << [node, edge] }
@@ -133,6 +98,54 @@ module Trailblazer
 
         hash
       end
+
+      # @private
+      def Node(wrapped, id:raise("No ID was provided for #{wrapped}"), **options)
+        Node.new( options.merge( id: id, _wrapped: wrapped ) )
+      end
+
+    private
+
+      # Single entry point for adding nodes and edges to the graph.
+      # @private
+      # @return target Node
+      # @return edge Edge the edge created connecting source and target.
+      def connect_for!(source, edge_args, target)
+        edge = Edge(source, edge_args, target)
+
+        self[:graph][source][edge] = target
+
+        return target, edge
+      end
+
+      # Removes edge.
+      # @private
+      def unconnect!(node, edge)
+        self[:graph][node].delete(edge)
+      end
+
+      # @private
+      # Create a Node and add it to the graph, without connecting it.
+      def add!(node_args)
+        new_node = Node(*node_args)
+
+        raise IllegalNodeError.new("The ID `#{new_node[:id]}` has been added before.") if find_all( new_node[:id] ).any?
+
+        self[:graph][new_node] = {}
+        new_node
+      end
+
+      # @private
+      def reconnect!(left_node, edge, new_node)
+        unconnect!(left_node, edge) # dump the old edge.
+        connect_for!(left_node, [ edge[:_wrapped], edge.to_h ], new_node)
+      end
+
+      # @private
+      def Edge(source, (wrapped, options), target) # FIXME: test required id. test source and target
+        id   = "#{source[:id]}-#{wrapped}-#{target[:id]}"
+        edge = Edge.new(options.merge( _wrapped: wrapped, id: id, source: source, target: target ))
+      end
     end
 
     def self.Start(wrapped, graph:{}, **data, &block)

data/lib/trailblazer/activity/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Activity
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-activity
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: The main element for Trailblazer's BPMN-compliant workflows.