trailblazer-circuit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72877a8ce955ec1dc23b9f100bda0974e1bcd40f
-  data.tar.gz: c71ca90a053245f55c75573bea74584b2056f14c
+  metadata.gz: 760ef971087c4983eb7d4f624bca5d78130be9b2
+  data.tar.gz: f763cd9f2193d16440514a183cb0935955d2158a
 SHA512:
-  metadata.gz: 4f8fa59da9c333fefdf5c5b37a273d520bbfc346c4d2d80a1455447b7bd85e878a523112e58e4a231ac220969b33e12428902c4fe8ab9155a615c0c093ade6a3
-  data.tar.gz: e4aef9035fe3a68b81fda3f178e6e37ac9fb9f04fe20b64e5de4cdd850e04b2214d398b9b1439c7d568634a43709ced757f7201174abce5a8fddae74f645fb19
+  metadata.gz: 8d6ae7c2daa02a06ae5db0846cb78068cb09b8d489ff2ec5b8ad5d3e2308e055051cb4b0e9d25be64c2709650619f434d78b910852d8d046631a8fa4af94002f
+  data.tar.gz: b306b440d01b1aa11c3faf587ef7970603dc58b95a3c4636eda3a76bad486c32c363db8a2ca449fd069396dbf12d8a2c052267a4cbadeaa0380ce4ac19075493

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.0.3
+
+* Make the first argument to `#Activity` (`@name`) always a Hash where `:id` is a reserved key for the name of the circuit.
+
 # 0.0.2
 
 * Make `flow_options` an immutable data structure just as `options`. It now needs to be returned from a `#call`.

data/lib/trailblazer/circuit/activity.rb

@@ -34,15 +34,14 @@ module Trailblazer
       Circuit.new(yield(events), end_events, name)
     end
 
-    # DSL
-    #   events[:Start]
-    #
-    # :private:
+    # @data structure to hold events for an activity, keyed by type, then name.
+    # @api private
     def self.Events(events)
       evts = Struct.new(*events.keys) do # [Start, End, Resume]
         def [](event, name=:default)
           cfg = super(event.downcase)
-          cfg[name] or raise "[Circuit] Event `#{event}.#{name} unknown."
+          cfg[name.to_sym] or raise "[Circuit] Event `#{event}.#{name} unknown."
+          # DISCUSS: the event type's events should also be a Struct to avoid :symbol vs. string.
         end
       end
 

data/lib/trailblazer/circuit/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Circuit
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/trailblazer/circuit.rb

@@ -2,9 +2,18 @@ require "trailblazer/circuit/version"
 
 module Trailblazer
   # Running a Circuit instance will run all tasks sequentially depending on the former's result.
-  # Each task is called and retrieves the former task's return value.
+  # Each task is called and retrieves the former task's return values.
+  #
+  # Note: Please use #Activity as a public circuit builder.
+  #
+  # @param map         [Hash] Defines the wiring.
+  # @param stop_events [Array] Tasks that stop execution of the circuit.
+  # @param name        [Hash] Names for tracing, debugging and exceptions. `:id` is a reserved key for circuit name.
   #
   #   result = circuit.(start_at, *args)
+  #
+  # @see Activity
+  # @api semi-private
   class Circuit
     def initialize(map, stop_events, name)
       @name        = name
@@ -17,22 +26,24 @@ module Trailblazer
     # Runs the circuit. Stops when hitting a End event or subclass thereof.
     # This method throws exceptions when the return value of a task doesn't match
     # any wiring.
+    #
     # @param activity A task from the circuit where to start
     # @param args An array of options passed to the first task.
-    def call(activity, args, runner: Run, **o)
+    def call(activity, args, runner: Run, **flow_options)
       # TODO: args
       direction    = nil
-      flow_options = { runner: runner, debug: @name }.merge(o) # DISCUSS: make this better?
+      flow_options = { runner: runner, debug: @name }.merge(flow_options) # DISCUSS: make this better?
 
       loop do
         direction, args, flow_options = runner.( activity, direction, args, flow_options )
 
-        # Stop execution of the circuit when we hit a stop event (< End). This could be an activity's End of Suspend.
+        # Stop execution of the circuit when we hit a stop event (< End). This could be an activity's End or Suspend.
         return [ direction, args, flow_options ] if @stop_events.include?(activity)
 
         activity = next_for(activity, direction) do |next_activity, in_map|
-          raise IllegalInputError.new("#{@name} #{activity}") unless in_map
-          raise IllegalOutputSignalError.new("from #{@name};;#{activity}"+ direction.inspect) unless next_activity
+          activity_name = @name[activity] || activity # TODO: this must be implemented only once, somewhere.
+          raise IllegalInputError.new("#{@name[:id]} #{activity_name}") unless in_map
+          raise IllegalOutputSignalError.new("from #{@name[:id]}: `#{activity_name}`===>[ #{direction.inspect} ]") unless next_activity
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-circuit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler