trailblazer-activity 0.11.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1af98988b1c0739296afe5fdcc67174fda97f1bcccfcc3e75adb8a06e3043e3
-  data.tar.gz: 9f35640842440b53054d77e8f479010c715218db81f3be35d821bb0567442b95
+  metadata.gz: 26bd7483c314f6fda4c424cb35a9923b139194882639e0324c1f3877b267ed3d
+  data.tar.gz: 414ec2f07eb06318f7fb7fab7aadbef9bbf34cdbb76fad866936ede20ad55937
 SHA512:
-  metadata.gz: b186be55e37823824fb426d108aa5a4b8df2f2972b7a43e46e021bf33330ec75c89f07b5a6d5d6f3377a57b5d93c59f8cf6f966caf257ca2b1c81d7dfba095c1
-  data.tar.gz: 24b6b30334a3f610b95ebe781d9b1993db45e529bc5040174f16728ef05c35df135236296cc2daf67090fdee8dcaa84356341a3c86b4cdc14478e38bc22ae2cb
+  metadata.gz: a75f9f5d4ac9367540c058b749bf411a52f38e077e90df8d256c1bbfbf9aa697cc0b1b3c8be5b5d2f1fe35ef287976afa2f4ed3eb5b8abba5adf8c152810242b
+  data.tar.gz: 2bbad5b09c667363ce8f0f59105b48ffbba688ff78bb8b664b57fc89414742c2513f155b2a13a967da3614463808d4837243aa616684805d460b84f44b51efc2

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,24 @@
+# 0.12.1
+
+* Allow injecting `:wrap_static` into `TaskWrap.invoke`.
+
+# 0.12.0
+
+* Support for Ruby 3.0.
+
+# 0.11.5
+
+* Bug fix: `:output` filter from `TaskWrap::VariableMapping` wasn't returning the correct `flow_options`. If the wrapped task changed
+  its `flow_options`, the original one was still returned from the taskWrap run, not the updated one.
+
+# 0.11.4
+
+* Introduce the `config_wrap:` option in `Intermediate.call(intermediate, implementation, config_merge: {})` to allow injecting data into the activity's `:config` field.
+
+# 0.11.3
+
+* Allow `Testing.def_task` & `Testing.def_tasks` to return custom signals
+
 # 0.11.2
 
 * Updrading `trailblazer-context` version :drum:

data/Gemfile

@@ -1,10 +1,5 @@
 source "https://rubygems.org"
-
-# Specify your gem's dependencies in workflow.gemspec
 gemspec
 
-gem "benchmark-ips"
-gem "minitest-line"
-
-# gem "trailblazer-context", path: "../trailblazer-context"
 # gem "trailblazer-developer", path: "../trailblazer-developer"
+# gem "trailblazer-context", github: "trailblazer/trailblazer-context", branch: "ruby-3"

data/lib/trailblazer/activity/introspect.rb

@@ -68,6 +68,20 @@ module Trailblazer
       def self.Graph(*args)
         Graph.new(*args)
       end
+
+      def self.render_task(proc)
+        if proc.is_a?(Method)
+
+          receiver = proc.receiver
+          receiver = receiver.is_a?(Class) ? (receiver.name || "#<Class:0x>") : (receiver.name || "#<Module:0x>") #"#<Class:0x>"
+
+          return "#<Method: #{receiver}.#{proc.name}>"
+        elsif proc.is_a?(Symbol)
+          return proc.to_s
+        end
+
+        proc.inspect
+      end
     end # Introspect
   end
 end

data/lib/trailblazer/activity/schema/intermediate.rb

@@ -12,14 +12,16 @@ class Trailblazer::Activity
       # Compiles a {Schema} instance from an {intermediate} structure and
       # the {implementation} object references.
       #
-      # Intermediate structure, Implementation, calls extensions, passes {}config # TODO
-      def self.call(intermediate, implementation)
-        config_default = {wrap_static: Hash.new(TaskWrap.initial_wrap_static)}.freeze # DISCUSS: this really doesn't have to be here, but works for now and we want it in 99%.
+      # Intermediate structure, Implementation, calls extensions, passes {config} # TODO
+      def self.call(intermediate, implementation, config_merge: {})
+        config_default = {wrap_static: Hash.new(TaskWrap.initial_wrap_static)} # DISCUSS: this really doesn't have to be here, but works for now and we want it in 99%.
+        config         = config_default.merge(config_merge)
+        config.freeze
 
         circuit = circuit(intermediate, implementation)
         nodes   = node_attributes(intermediate, implementation)
         outputs = outputs(intermediate.stop_task_ids, nodes)
-        config  = config(implementation, config: config_default)
+        config  = config(implementation, config: config)
         Schema.new(circuit, outputs, nodes, config)
       end
 

data/lib/trailblazer/activity/task_builder.rb

@@ -5,7 +5,7 @@ module Trailblazer
     # Output signal binary: true=>Right, false=>Left.
     # Passes through all subclasses of Direction.~~~~~~~~~~~~~~~~~
     def self.Binary(user_proc)
-      Task.new(Trailblazer::Option::KW( user_proc ), user_proc)
+      Task.new(Trailblazer::Option(user_proc), user_proc)
     end
 
     # Translates the return value of the user step into a valid signal.
@@ -28,16 +28,16 @@ module Trailblazer
 
       def call( (ctx, flow_options), **circuit_options )
         # Execute the user step with TRB's kw args.
-        result = @task.( ctx, **circuit_options ) # circuit_options contains :exec_context.
+        result = @task.(ctx, keyword_arguments: ctx.to_hash, **circuit_options) # circuit_options contains :exec_context.
 
         # Return an appropriate signal which direction to go next.
-        signal = Activity::TaskBuilder.binary_signal_for( result, Activity::Right, Activity::Left )
+        signal = Activity::TaskBuilder.binary_signal_for(result, Activity::Right, Activity::Left)
 
-        return signal, [ ctx, flow_options ]
+        return signal, [ctx, flow_options]
       end
 
-      def inspect
-        %{#<Trailblazer::Activity::TaskBuilder::Task user_proc=#{@user_proc}>}
+      def inspect # TODO: make me private!
+        %{#<Trailblazer::Activity::TaskBuilder::Task user_proc=#{Trailblazer::Activity::Introspect.render_task(@user_proc)}>}
       end
       alias_method :to_s, :inspect
     end

data/lib/trailblazer/activity/task_wrap.rb

@@ -13,11 +13,14 @@ module Trailblazer
       module_function
 
       # Compute runtime arguments necessary to execute a taskWrap per task of the activity.
-      def invoke(activity, args, wrap_runtime: {}, **circuit_options)
+      # This method is the top-level entry, called only once for the entire activity graph.
+      def invoke(activity, args, wrap_runtime: {}, wrap_static: initial_wrap_static, **circuit_options)
         circuit_options = circuit_options.merge(
           runner:       TaskWrap::Runner,
           wrap_runtime: wrap_runtime,
-          activity:     {wrap_static: {activity => initial_wrap_static}, nodes: {}}, # for Runner. Ideally we'd have a list of all static_wraps here (even nested).
+          # This {:activity} structure is currently (?) only needed in {TaskWrap.wrap_static_for}, where we
+          # access {activity[:wrap_static]} to compile the effective taskWrap.
+          activity:     {wrap_static: {activity => wrap_static}, nodes: {}}, # for Runner. Ideally we'd have a list of all static_wraps here (even nested).
         )
 
         # signal, (ctx, flow), circuit_options =
@@ -43,6 +46,9 @@ module Trailblazer
           @merge = merge
         end
 
+        # Compile-time:
+        # Gets called via the {Normalizer} and represents an {:extensions} item.
+        # Adds/alters the activity's {wrap_static}.
         def call(config:, task:, **)
           before_pipe = State::Config.get(config, :wrap_static, task.circuit_task)
 

data/lib/trailblazer/activity/task_wrap/call_task.rb

@@ -6,9 +6,11 @@ class Trailblazer::Activity
     def self.call_task(wrap_ctx, original_args)
       task = wrap_ctx[:task]
 
+      original_arguments, original_circuit_options = original_args
+
       # Call the actual task we're wrapping here.
       # puts "~~~~wrap.call: #{task}"
-      return_signal, return_args = task.(*original_args)
+      return_signal, return_args = task.(original_arguments, **original_circuit_options)
 
       # DISCUSS: do we want original_args here to be passed on, or the "effective" return_args which are different to original_args now?
       wrap_ctx = wrap_ctx.merge( return_signal: return_signal, return_args: return_args )

data/lib/trailblazer/activity/task_wrap/runner.rb

@@ -17,7 +17,7 @@ class Trailblazer::Activity
 
         # We save all original args passed into this Runner.call, because we want to return them later after this wrap
         # is finished.
-        original_args = [ args, circuit_options ]
+        original_args = [args, circuit_options]
 
         # call the wrap {Activity} around the task.
         wrap_ctx, _ = task_wrap_pipeline.(wrap_ctx, original_args) # we omit circuit_options here on purpose, so the wrapping activity uses the default, plain Runner.

data/lib/trailblazer/activity/task_wrap/variable_mapping.rb

@@ -38,7 +38,7 @@ class Trailblazer::Activity
       end
 
       # {input.call()} is invoked in the circuit.
-      # `original_args` are the actual args passed to the wrapped task: [ [options, ..], circuit_options ]
+      # `original_args` are the actual args passed to the wrapped task: [ [ctx, ..], circuit_options ]
       #
       def call(wrap_ctx, original_args)
         # let user compute new ctx for the wrapped task.
@@ -57,7 +57,7 @@ class Trailblazer::Activity
 
       # Invoke the @filter callable with the original circuit interface.
       def apply_filter((ctx, original_flow_options), original_circuit_options)
-        @filter.([ctx, original_flow_options], original_circuit_options) # returns {new_ctx}.
+        @filter.([ctx, original_flow_options], **original_circuit_options) # returns {new_ctx}.
       end
     end
 
@@ -73,12 +73,14 @@ class Trailblazer::Activity
       def call(wrap_ctx, original_args)
         (original_ctx, original_flow_options), original_circuit_options = original_args
 
-        returned_ctx, _ = wrap_ctx[:return_args]  # this is the Context returned from {call}ing the wrapped user task.
-        original_ctx    = wrap_ctx[@id]           # grab the original ctx from before which was set in the {:input} filter.
+        return_args = wrap_ctx[:return_args]
+
+        returned_ctx, returned_flow_options = wrap_ctx[:return_args]  # this is the Context returned from {call}ing the wrapped user task.
+        original_ctx                        = wrap_ctx[@id]           # grab the original ctx from before which was set in the {:input} filter.
         # let user compute the output.
-        output_ctx = @filter.(returned_ctx, [original_ctx, original_flow_options], original_circuit_options)
+        output_ctx = @filter.(returned_ctx, [original_ctx, returned_flow_options], **original_circuit_options)
 
-        wrap_ctx = wrap_ctx.merge( return_args: [output_ctx, original_flow_options] )
+        wrap_ctx = wrap_ctx.merge( return_args: [output_ctx, returned_flow_options] )
 
         # and then pass on the "new" context.
         return wrap_ctx, original_args

data/lib/trailblazer/activity/testing.rb

@@ -27,7 +27,9 @@ module Trailblazer
       Module.new do
         define_singleton_method(name) do | (ctx, flow_options), ** |
           ctx[:seq] << name
-          return Activity::Right, [ctx, flow_options]
+          signal = ctx.key?(name) ? ctx[name] : Activity::Right
+
+          return signal, [ctx, flow_options]
         end
       end.method(name)
     end
@@ -38,9 +40,9 @@ module Trailblazer
         names.each do |name|
           define_method(name) do | (ctx, flow_options), ** |
             ctx[:seq] << name
-            result = ctx.key?(name) ? ctx[name] : true
+            signal = ctx.key?(name) ? ctx[name] : Activity::Right
 
-            return (result ? Activity::Right : Activity::Left), [ctx, flow_options]
+            return signal, [ctx, flow_options]
           end
         end
       end
@@ -60,10 +62,6 @@ module Trailblazer
           Success = Activity::End(:success)
         end
 
-        def Cct(activity)
-          Trailblazer::Developer::Render::Circuit.(activity)
-        end
-
         # TODO: Remove this once all it's references are removed
         def implementing
           Implementing
@@ -141,9 +139,19 @@ module Trailblazer
 
         def assert_circuit(schema, circuit)
           cct = Cct(schema)
+
           cct = cct.gsub("#<Trailblazer::Activity::TaskBuilder::Task user_proc=", "<*")
           assert_equal %{#{circuit}}, cct
         end
+
+      def Cct(activity)
+        Trailblazer::Developer::Render::Circuit.(activity, inspect_task: Trailblazer::Activity::Testing.method(:render_task))
+      end
+    end
+
+    # Use this in {#Cct}.
+    def self.render_task(proc)
+      Activity::Introspect.render_task(proc)
     end
   end
 end

data/lib/trailblazer/activity/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Activity
-      VERSION = '0.11.2'.freeze
+      VERSION = '0.12.1'.freeze
     end
   end
 end

data/trailblazer-activity.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-context", ">= 0.3.1", "< 0.4.0"
+  spec.add_dependency "trailblazer-context", ">= 0.4.0", "< 0.5.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-line"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "trailblazer-developer", ">= 0.0.7"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-activity
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-context
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,8 +107,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-before_install: gem install bundler
-cache: bundler
-rvm:
-  - ruby-head
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-jobs:
-  allow_failures:
-    - rvm: ruby-head