trailblazer-activity 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92e2284135d0c4f569c3b6de38647a5f4dfae359b90a6461539d67fe2a8d58fc
-  data.tar.gz: d71820d9da38a2099713bb5fd5005b4680f01c1181e4f6bb919cd84a4ec80443
+  metadata.gz: 14060aa9266dec50a2538bfddacb622d1fcefeba94b92fade757e039ea8aab4f
+  data.tar.gz: 4bcd28d5b77dc9023c43edb0d762a4ac228fa36012a275f3830f56db9e71e795
 SHA512:
-  metadata.gz: c13c41f9631224f688190808efea928dda6b6cfac0d9fa7c53edc0e77d998b3d9b27ff0f9753394f0403dc2cb0783f2731cfd4b5993cce63ba71518c83006459
-  data.tar.gz: 6c2c4ead668c87454a1129254d88cd9a9558336896e7796441f391223ca6e40b5ba4cdb8fae52c4bcc4c0d3fd8a17bfe1f48c1832f88e44a3bfaa0b05e55a21c
+  metadata.gz: 95e528103b854970aa5b168ce89e8164ae0bdd64ffa21deec24fbd05aa6ca8700d2aa252f5ee3b7b12d2ffe9e592fbb6f3424a9208aa86be96b167fb7bc0c036
+  data.tar.gz: '09e520f7372cd6d604dc5444484bc561e29e4c1462fd2298bc6d9d4d6a1571eadb37dd7150988cf94a53fe0b218a94529e0fd38e5e2fb31a57ca3ae017640dbc'

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.5.2
+
+* In `Path()`, we removed the `#path` method in favor of a cleaner `task` DSL method. We now use the default plus_poles `success` and `failure` everywhere for consistency. This means that a `task` has two outputs, and if you referenced `Output(:success)`, that would be only one of them. We're planning to have `pass` back which has one `success` plus_pole, only. This change makes the DSL wiring behavior much more consistent.
+* Changed `TaskBuilder::Builder.()` to a function `TaskBuilder::Builder()`.
+
 # 0.5.1
 
 * Include all end events without outgoing connections into `Activity.outputs`. In earlier versions, we were filtering out end events without incoming connections, which reduces the number of outputs, but might not represent the desired interface of an activity.

data/lib/trailblazer/activity/dsl/magnetic/builder/normalizer.rb

@@ -6,7 +6,7 @@ module Trailblazer
     #
     # The Normalizer sits in the `@builder`, which receives all DSL calls from the Operation subclass.
     class Normalizer
-      def self.build(task_builder: Activity::TaskBuilder::Binary, default_outputs: Builder::Path.default_outputs, pipeline: Pipeline, extension:[], **options)
+      def self.build(task_builder: Activity::TaskBuilder.method(:Binary), default_outputs: Builder::Path.default_outputs, pipeline: Pipeline, extension:[], **options)
         return new(
           default_outputs: default_outputs,
           extension:       extension,
@@ -93,10 +93,10 @@ module Trailblazer
             .merge(local_options)
         end
 
-        task Activity::TaskBuilder::Binary.( method(:normalize_for_macro) ),        id: "normalize_for_macro"
-        task Activity::TaskBuilder::Binary.( method(:split_options) ),              id: "split_options"
-        task Activity::TaskBuilder::Binary.( method(:normalize_extension_option) ), id: "normalize_extension_option"
-        task Activity::TaskBuilder::Binary.( method(:initialize_plus_poles) ),      id: "initialize_plus_poles"
+        task Activity::TaskBuilder::Binary( method(:normalize_for_macro) ),        id: "normalize_for_macro"
+        task Activity::TaskBuilder::Binary( method(:split_options) ),              id: "split_options"
+        task Activity::TaskBuilder::Binary( method(:normalize_extension_option) ), id: "normalize_extension_option"
+        task Activity::TaskBuilder::Binary( method(:initialize_plus_poles) ),      id: "initialize_plus_poles"
         # task ->((ctx, _), **) { pp ctx; [Activity::Right, [ctx, _]] }
       end
     end # Normalizer

data/lib/trailblazer/activity/dsl/magnetic/builder/path.rb

@@ -14,9 +14,12 @@ module Trailblazer
           )
         end
 
+        # In most cases, a task has a binary signal, which is why we decided to make that
+        # the default output set.
         def self.default_outputs
           {
-            success: Activity.Output(Activity::Right, :success)
+            :success => Activity.Output(Activity::Right, :success),
+            :failure => Activity.Output(Activity::Left,  :failure)
           }
         end
 

data/lib/trailblazer/activity/dsl/magnetic/builder/railway.rb

@@ -10,12 +10,6 @@ module Trailblazer
           )
         end
 
-        def self.default_outputs
-          Path.default_outputs.merge(
-            :failure => Activity.Output(Activity::Left,  :failure),
-          )
-        end
-
         # Adds the End.failure end to the Path sequence.
         # @return [Adds] list of Adds instances that can be chained or added to an existing sequence.
         def self.InitialAdds(failure_color:raise, failure_end: Activity.End(failure_color), **builder_options)

data/lib/trailblazer/activity/dsl/strategy/path.rb

@@ -11,13 +11,13 @@ module Trailblazer
         {
           builder_class:    Magnetic::Builder::Path, # we use the Activity-based Normalizer
           normalizer_class: Magnetic::Normalizer,
-          default_outputs:  Magnetic::Builder::Path.default_outputs,
+          default_outputs:  Magnetic::Builder::Path.default_outputs, # binary outputs
           extension:        [ Introspect.method(:add_introspection) ],
 
           extend:           [
-            DSL.def_dsl(:task, Magnetic::Builder::Path,    :TaskPolarizations),
+            # DSL.def_dsl(:task, Magnetic::Builder::Path,    :PassPolarizations),
             DSL.def_dsl(:_end, Magnetic::Builder::Path,    :EndEventPolarizations),
-            DSL.def_dsl(:pass, Magnetic::Builder::Railway, :PassPolarizations),
+            DSL.def_dsl(:task, Magnetic::Builder::Railway, :PassPolarizations),
           ],
         }
       end

data/lib/trailblazer/activity/dsl/strategy/railway.rb

@@ -9,7 +9,7 @@ module Trailblazer
       def self.config
         Path.config.merge(
           builder_class:   Magnetic::Builder::Railway,
-          default_outputs: Magnetic::Builder::Railway.default_outputs,
+          default_outputs: Magnetic::Builder::Path.default_outputs,
           extend:          [
             DSL.def_dsl(:step, Magnetic::Builder::Railway, :StepPolarizations),
             DSL.def_dsl(:fail, Magnetic::Builder::Railway, :FailPolarizations),

data/lib/trailblazer/activity/task_builder.rb

@@ -2,36 +2,34 @@ module Trailblazer
   module Activity::TaskBuilder
     # every step is wrapped by this proc/decider. this is executed in the circuit as the actual task.
     # Step calls step.(options, **options, flow_options)
-    # Output direction binary: true=>Right, false=>Left.
+    # Output signal binary: true=>Right, false=>Left.
     # Passes through all subclasses of Direction.~~~~~~~~~~~~~~~~~
-    module Binary
-      def self.call(user_proc)
-        Task.new( Trailblazer::Option::KW( user_proc ), user_proc )
-      end
+    def self.Binary(user_proc)
+      Task.new(Trailblazer::Option::KW( user_proc ), user_proc)
+    end
 
-      # Translates the return value of the user step into a valid signal.
-      # Note that it passes through subclasses of {Signal}.
-      def self.binary_direction_for(result, on_true, on_false)
-        result.is_a?(Class) && result < Activity::Signal ? result : (result ? on_true : on_false)
-      end
+    # Translates the return value of the user step into a valid signal.
+    # Note that it passes through subclasses of {Signal}.
+    def self.binary_signal_for(result, on_true, on_false)
+      result.is_a?(Class) && result < Activity::Signal ? result : (result ? on_true : on_false)
     end
 
     class Task
       def initialize(task, user_proc)
-        @task      = task
-        @user_proc = user_proc
+        @task            = task
+        @user_proc       = user_proc
 
         freeze
       end
 
-      def call( (options, *args), **circuit_args )
+      def call( (ctx, flow_options), **circuit_options )
         # Execute the user step with TRB's kw args.
-        result = @task.( options, **circuit_args ) # circuit_args contains :exec_context.
+        result = @task.( ctx, **circuit_options ) # circuit_options contains :exec_context.
 
         # Return an appropriate signal which direction to go next.
-        direction = Binary.binary_direction_for( result, Activity::Right, Activity::Left )
+        signal = Activity::TaskBuilder.binary_signal_for( result, Activity::Right, Activity::Left )
 
-        [ direction, [ options, *args ], **circuit_args ]
+        return signal, [ ctx, flow_options ]
       end
 
       def inspect

data/lib/trailblazer/activity/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Activity < Module
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
   end
 end

data/lib/trailblazer/circuit.rb

@@ -11,6 +11,8 @@ module Trailblazer
   #
   # @see Activity
   # @api semi-private
+  #
+  # This is the "pipeline operator"'s implementation.
   class Circuit
     def initialize(map, stop_events, name: nil, start_task: map.keys.first)
       @map         = map
@@ -33,13 +35,15 @@ module Trailblazer
     # @param flow_options Library-specific flow control data
     # @return [last_signal, options, flow_options, *args]
     #
-    # DISCUSS: returned circuit_options are ignored when calling the runner.
+    # NOTE: returned circuit_options are discarded when calling the runner.
     def call(args, task: @start_task, runner: Run, **circuit_options)
+      circuit_options = circuit_options.merge( runner: runner ).freeze # TODO: set the :runner option via arguments_for_call to save the merge?
+
       loop do
-        last_signal, args, _ignored_circuit_options = runner.(
+        last_signal, args, _discarded_circuit_options = runner.(
           task,
           args,
-          circuit_options.merge( runner: runner ) # options for runner, to be discarded.
+          circuit_options
         )
 
         # Stop execution of the circuit when we hit a stop event (< End). This could be an task's End or Suspend.
@@ -47,7 +51,7 @@ module Trailblazer
 
         task = next_for(task, last_signal) do |next_task, in_map|
           raise IllegalInputError.new("#{task}") unless in_map
-          raise IllegalOutputSignalError.new("#{@name}[#{task}][ #{last_signal.inspect} ]") unless next_task
+          raise IllegalOutputSignalError.new("<#{@name}>[#{task}][ #{last_signal.inspect} ]") unless next_task
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-activity
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb