trailblazer-activity 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be148af716c8a5bd21b666b22bf75bf2210854b4c710cfa69a26505b1725710d
-  data.tar.gz: 39f836d460d3dae33f9905103b4f6efdd57049ebdc9290ed21e441cefd0cb9dd
+  metadata.gz: 511b5b1197ad392755eaf1fb930a5b6080561ef25e85199ac1afecdeeeafc998
+  data.tar.gz: 58cae3a0c236f26a9f05a671b75618d51ff5075422e7eb796be3b4230a25fe17
 SHA512:
-  metadata.gz: 1dc6d49f7436922ea378c4af9604242dec98ff08aa29d5c2f156b7569cbf2e2704380f6050a659dec7d9f28471d3194b3c2c4bd61ef4dfecf3657d1e6a98dfbc
-  data.tar.gz: 8b214a0952c72650665bd2413254d526bbab9fce4920b3b2fa25aced774994ca49a96bed66ef1ef4d6adc09c63d78ef604abef94205d1ee5edb09bcd544d66fe
+  metadata.gz: 4123c5d0e4647a683f16811e36beba43ca4f88cd5abd6e325b8a340961c7a219d90aa9ba73543aa9dd0d21a4eebb7b13925d227036b5f12a30e5ca2ec1bff966
+  data.tar.gz: a463bcf78493d8f31f13141a66be05f260d95f7c7f55af0e7f0aa58be0a59b5585c4ffbaadee78c465ca807f9d21788f4c98dc195b19538f74c973b29b5cd2af

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 0.7.1
+
+* Alias `Trace.call` to `Trace.invoke` for consistency.
+* Allow injecting your own stack into `Trace.invoke`. This enables us to provide tracing even when there's an exception (due to, well, mutability).
+* Minor changes in `Trace::Present` so that "unfinished" stacks can also be rendered.
+* `Trace::Present.tree` is now private and superseded by `Present.call`.
+
 # 0.7.0
 
 * Remove `DSL::Helper`, "helper" methods now sit directly in the `DSL` namespace.

data/lib/trailblazer/activity/present.rb

@@ -2,38 +2,56 @@ require "hirb"
 
 module Trailblazer
   class Activity < Module
+
+    # Task < Array
+    # [ input, ..., output ]
+
     module Trace
       # TODO: make this simpler.
       module Present
         module_function
 
-        def tree(stack, level=1, tree=[])
+        def call(stack, level=1, tree=[])
+          tree(stack.to_a, level, tree)
+        end
+
+        def tree(stack, level, tree)
           tree_for(stack, level, tree)
 
           Hirb::Console.format_output(tree, class: :tree, type: :directory)
         end
 
         def tree_for(stack, level, tree)
-          stack.each do |captured, *returned|
-            task = captured.task
+          stack.each do |task| # always a Stack::Task[input, ..., output]
+            input, output, nested = input_output_nested_for_task(task)
+
+            task = input.task
 
-            graph = Introspect::Graph(captured.activity)
+            graph = Introspect::Graph(input.activity)
 
             name = (node = graph.find { |node| node[:task] == task }) ? node[:id] : task
             name ||= task # FIXME: bullshit
 
-            if returned.size == 1 # flat
-              tree << [ level, name ]
-            else # nesting
-              tree << [ level, name ]
+            tree << [ level, name ]
 
-              tree_for(returned[0..-2], level + 1, tree)
+            if nested.any? # nesting
+              tree_for(nested, level + 1, tree)
             end
 
             tree
           end
         end
 
+        # DISCUSS: alternatively, we can have Task<input: output: data: >
+        def input_output_nested_for_task(task)
+          input  = task[0]
+          output = task[-1]
+
+          output, nested = output.is_a?(Entity::Output) ? [output, task-[input, output]] : [nil, task[1..-1]]
+
+          return input, output, nested
+        end
+
         def to_name(debug_item)
           track = debug_item[2]
           klass = track.class == Class ? track : track.class

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

@@ -17,9 +17,9 @@ class Trailblazer::Activity < Module
       def capture_return((wrap_config, original_args), **circuit_options)
         (original_options, original_flow_options, _) = original_args[0]
 
-        original_flow_options[:stack] << Trailblazer::Activity::Trace::Entity.new(
-          wrap_config[:task], {}, :return, wrap_config[:return_signal]
-        )
+        original_flow_options[:stack] << Trailblazer::Activity::Trace::Entity::Output.new(
+          wrap_config[:task], {}, wrap_config[:return_signal]
+        ).freeze
 
         original_flow_options[:stack].unindent!
 
@@ -33,9 +33,9 @@ class Trailblazer::Activity < Module
       def capture_for(task, (ctx, flow), activity:, **circuit_options)
         flow[:stack].indent!
 
-        flow[:stack] << Trailblazer::Activity::Trace::Entity.new(
-          task, activity, :args, nil, {}
-        )
+        flow[:stack] << Trailblazer::Activity::Trace::Entity::Input.new(
+          task, activity
+        ).freeze
 
         return [ctx, flow], circuit_options.merge(activity: activity)
       end

data/lib/trailblazer/activity/trace.rb

@@ -5,47 +5,63 @@ module Trailblazer
     #   stack, _ = Trailblazer::Activity::Trace.(activity, activity[:Start], { id: 1 })
     #   puts Trailblazer::Activity::Present.tree(stack) # renders the trail.
     #
-    # Hooks into the TaskWrap.
+    # Hooks into the taskWrap.
     module Trace
-      # {:argumenter} API
-      # FIXME: needs Introspect.arguments_for_call
-      # FIXME: needs TaskWrap.arguments_for_call
-      def self.arguments_for_call(activity, (options, flow_options), **circuit_options)
-        tracing_flow_options = {
-          stack:         Trace::Stack.new,
-        }
-
-        tracing_circuit_options = {
-          wrap_runtime:  ::Hash.new(Trace.wirings), # FIXME: this still overrides existing :wrap_runtime.
-        }
-
-        return activity, [ options, flow_options.merge(tracing_flow_options) ], circuit_options.merge(tracing_circuit_options)
-      end
+      class << self
+        # {:argumenter} API
+        # FIXME: needs Introspect.arguments_for_call
+        # FIXME: needs TaskWrap.arguments_for_call
+        def arguments_for_call(activity, (options, flow_options), **circuit_options)
+          tracing_flow_options = {
+            stack:         Trace::Stack.new,
+          }
 
-      def self.call(activity, (options, flow_options), circuit_options={})
-        activity, (options, flow_options), circuit_options = Trace.arguments_for_call( activity, [options, flow_options], circuit_options ) # only run once for the entire circuit!
-        last_signal, (options, flow_options) =
-          Activity::TaskWrap.invoke(activity, [options, flow_options], circuit_options)
+          tracing_circuit_options = {
+            wrap_runtime:  ::Hash.new(Trace.wirings), # FIXME: this still overrides existing :wrap_runtime.
+          }
 
-        return flow_options[:stack].to_a, last_signal, [options, flow_options]
-      end
+          return activity, [ options, tracing_flow_options.merge(flow_options) ], circuit_options.merge(tracing_circuit_options)
+        end
+
+        def call(activity, (options, flow_options), circuit_options={})
+          activity, (options, flow_options), circuit_options = Trace.arguments_for_call( activity, [options, flow_options], circuit_options ) # only run once for the entire circuit!
+
+          last_signal, (options, flow_options) =
+            Activity::TaskWrap.invoke(activity, [options, flow_options], circuit_options)
+
+          return flow_options[:stack], last_signal, [options, flow_options]
+        end
 
-      private
+        alias_method :invoke, :call
 
-      # Insertions for the trace tasks that capture the arguments just before calling the task,
-      # and before the TaskWrap is finished.
-      #
-      # Note that the TaskWrap steps are implemented in Activity::TaskWrap::Trace.
-      def self.wirings
-        Module.new do
-          extend Activity::Path::Plan()
+        # Insertions for the trace tasks that capture the arguments just before calling the task,
+        # and before the TaskWrap is finished.
+        #
+        # Note that the TaskWrap steps are implemented in Activity::TaskWrap::Trace.
+        #
+        # @private
+        def wirings
+          Module.new do
+            extend Activity::Path::Plan()
 
-          task TaskWrap::Trace.method(:capture_args),   id: "task_wrap.capture_args",   before: "task_wrap.call_task"
-          task TaskWrap::Trace.method(:capture_return), id: "task_wrap.capture_return", before: "End.success", group: :end
+            task TaskWrap::Trace.method(:capture_args),   id: "task_wrap.capture_args",   before: "task_wrap.call_task"
+            task TaskWrap::Trace.method(:capture_return), id: "task_wrap.capture_return", before: "End.success", group: :end
+          end
         end
       end
 
-      Entity = Struct.new(:task, :activity, :type, :value, :value2)
+      Entity = Struct.new(:task, :activity, :data)
+      class Entity::Input < Entity
+      end
+
+      class Entity::Output < Entity
+      end
+
+      class Task < Array
+        def inspect
+          %{<Task>#{super}}
+        end
+      end
 
       # Mutable/stateful per design. We want a (global) stack!
       class Stack
@@ -55,7 +71,7 @@ module Trailblazer
         end
 
         def indent!
-          current << indented = []
+          current << indented = Task.new
           @stack << indented
         end
 

data/lib/trailblazer/activity/version.rb

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

data/trailblazer-activity.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nick Sutterer"]
   spec.email         = ["apotonick@gmail.com"]
 
-  spec.summary       = %q{The main element for Trailblazer's BPMN-compliant workflows.}
-  spec.description   = %q{The main element for Trailblazer's BPMN-compliant workflows. Used in Trailblazer's Operation to implement the Railway.}
-  spec.homepage      = "http://trailblazer.to/gems/workflow"
+  spec.summary       = %q{Define and run any desired circuit of business logic.}
+  spec.description   = %q{Define and run any desired circuit of business logic. Used in Trailblazer's Operation to implement the railway.}
+  spec.homepage      = "http://trailblazer.to"
   spec.licenses      = ["MIT"]
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-activity
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb
@@ -94,8 +94,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The main element for Trailblazer's BPMN-compliant workflows. Used in
-  Trailblazer's Operation to implement the Railway.
+description: Define and run any desired circuit of business logic. Used in Trailblazer's
+  Operation to implement the railway.
 email:
 - apotonick@gmail.com
 executables: []
@@ -155,7 +155,7 @@ files:
 - lib/trailblazer/activity/version.rb
 - lib/trailblazer/circuit.rb
 - trailblazer-activity.gemspec
-homepage: http://trailblazer.to/gems/workflow
+homepage: http://trailblazer.to
 licenses:
 - MIT
 metadata: {}
@@ -178,5 +178,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: The main element for Trailblazer's BPMN-compliant workflows.
+summary: Define and run any desired circuit of business logic.
 test_files: []