trailblazer-developer 0.0.8 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ca80026aa28f6e54a1a4b97e9efd20408cacdf0e5b80528856ffffa7ac29870
-  data.tar.gz: '069c09bff5551db399917d7e4c97a3d9698d281bb2d4efe3b9961f4daab13277'
+  metadata.gz: dcc1a32164a4c3e26c3d72450e416d8c3259002f2ce94782c808e4c041cb7847
+  data.tar.gz: fb0bede8fcfed4c533dec425f9f92b8188fd4df6ce82c39543d21d7440b7c1fc
 SHA512:
-  metadata.gz: 04c2f24488f25194553750235358290248ffd041df2d75ce839a78df28bccef2630ae7501756225ef597f1a97588a2ac98cdd80184d5080cddcc345141410452
-  data.tar.gz: 31dfb2eac96ee7b0fa29339ed350ffcdb77297ca4b605ac8f1ac1297f4e05bbf7f126e559f312719590397bb421cd17f2e14dcfe0cbba41656732df0acbe5351
+  metadata.gz: d6661e0492929cf37bbf40afbbd61d79308f113005040a61515801d72b7731adce960245d618ccb5a7db4903e082f5ae1b2a60fe139006f978e4f13ab02cf4a7
+  data.tar.gz: b7b1581c7733ca0066eafb8877c06d9ca7175854c56d8fa62509f384881c772a84b7dce4ba4dacd547710d4a3c1ed04da9dc9d15f7571e8852fb8c11778d4f35

data/README.md

@@ -4,7 +4,7 @@ _Developer tools for Trailblazers._
 
 ## Documentation
 
-Find the complete documentation on the project website: [http://trb.to/2.1#developer]
+Find the complete documentation on the project website: [http://2019.trailblazer.to/2.1/docs/developer.html]
 
 ## Summary
 

data/lib/trailblazer/developer.rb

@@ -7,8 +7,11 @@ module Trailblazer
 end
 
 require "trailblazer/developer/wtf"
+require "trailblazer/developer/wtf/renderer"
 require "trailblazer/developer/trace"
 require "trailblazer/developer/trace/present"
+require "trailblazer/developer/trace/focusable"
+require "trailblazer/developer/trace/inspector"
 require "trailblazer/developer/generate"
 require "trailblazer/developer/render/circuit"
 require "trailblazer/developer/render/linear"

data/lib/trailblazer/developer/CHANGES.md

@@ -1,3 +1,27 @@
+# 0.0.13
+
+* Allow focusing on selected variables for all steps in wtf
+* Fix declarative deprecation warning
+
+# 0.0.12
+
+* Revert Hash#compact usage to support Rubies <= 2.4
+
+# 0.0.11
+
+* Allow injecting custom data collector in Trace API, to collect custom input/output ctx of task nodes.
+* Allow focusing on specfic steps and ctx variables in Dev.wtf?
+* Allow custom inspection while tracing using Inspector definations
+
+# 0.0.10
+
+* Make Generate::Pipeline an activity for better customization/extendability.
+
+# 0.0.9
+
+* `Render.strip` is now a class method.
+* Added the `.type` field to the `data` field in `Generate`.
+
 # 0.0.8
 
 * Fix `Introspect` references.

data/lib/trailblazer/developer/generate.rb

@@ -1,4 +1,5 @@
 require "representable/hash"
+require "trailblazer/activity/dsl/linear" # Railway.
 
 module Trailblazer
   module Developer
@@ -16,7 +17,7 @@ module Trailblazer
           collection :elements, class: Element do
             property :id
             property :type
-            collection :linksTo, class: Arrow, default: [] do
+            collection :linksTo, class: Arrow, default: -> { [] } do
               property :target
               property :label
               property :message
@@ -30,26 +31,27 @@ module Trailblazer
       end
 
       def call(hash)
-        elements = transform_from_hash(hash)
-
-        compute_intermediate(elements)
+        signal, (ctx, _) = Activity::TaskWrap.invoke(Pipeline, hash: hash)
+        ctx[:intermediate]
       end
 
-      def transform_from_hash(hash, parser: Representer::Activity)
-        parser.new(OpenStruct.new).from_hash(hash).elements
+      def transform_from_hash(ctx, hash:, parser: Representer::Activity, **)
+        ctx[:elements] = parser.new(OpenStruct.new).from_hash(hash).elements
       end
 
-      def find_start_events(elements)
-        elements.find_all { |el| el.type == "Event" }
+      def find_start_events(ctx, elements:, **)
+        ctx[:start_events] = elements.find_all { |el| el.type == "Event" }
       end
 
-      def compute_intermediate(elements, find_start_events: method(:find_start_events))
-        start_events = find_start_events.(elements)
+      def compute_intermediate(ctx, elements:, start_events:, **)
         end_events   = elements.find_all { |el| el.type == "EndEventTerminate" } # DISCUSS: is it really called TERMINATE?
 
         inter = Activity::Schema::Intermediate
 
-        wiring = elements.collect { |el| [inter.TaskRef(el.id, el.data), el.linksTo.collect { |arrow| inter.Out(semantic_for(arrow.to_h), arrow.target) } ] }
+        wiring = elements.collect { |el|
+          data = data_for(el)
+
+          [inter.TaskRef(el.id, data), el.linksTo.collect { |arrow| inter.Out(semantic_for(arrow.to_h), arrow.target) } ] }
         wiring = Hash[wiring]
 
         # end events need this stupid special handling
@@ -63,11 +65,15 @@ module Trailblazer
         ])
         # pp wiring
 
-        inter.new(wiring, end_events.collect(&:id), start_events.collect(&:id))
+        ctx[:intermediate] = inter.new(wiring, end_events.collect(&:id), start_events.collect(&:id))
       end
 
       # private
 
+      def data_for(element)
+        {type: element.type}.merge(element.data)
+      end
+
       # We currently use the {:label} field of an arrow to encode an output semantic.
       # The {:symbol_style} part will be filtered out as semantic. Defaults to {:success}.
       def semantic_for(label:nil, **)
@@ -79,6 +85,12 @@ module Trailblazer
       def extract_semantic(label)
         label.to_sym
       end
+
+      class Pipeline < Trailblazer::Activity::Railway
+        step Generate.method(:transform_from_hash),   id: :transform_from_hash
+        step Generate.method(:find_start_events),     id: :find_start_events
+        step Generate.method(:compute_intermediate),  id: :compute_intermediate
+      end
     end
   end
 end

data/lib/trailblazer/developer/render/circuit.rb

@@ -42,13 +42,13 @@ module Trailblazer
         end
 
         def inspect_end(task)
-          class_name = strip(task.class)
+          class_name = Render::Circuit.strip(task.class)
           options    = task.to_h
 
           "#<#{class_name}/#{options[:semantic].inspect}>"
         end
 
-        def strip(string)
+        def self.strip(string)
           string.to_s.sub("Trailblazer::Activity::", "")
         end
       end

data/lib/trailblazer/developer/trace.rb

@@ -17,16 +17,23 @@ module Trailblazer::Developer
 
       alias_method :invoke, :call
 
-      def arguments_for_call(activity, (options, flow_options), **circuit_options)
-        tracing_flow_options = {
+      def arguments_for_call(activity, (options, original_flow_options), **original_circuit_options)
+        default_flow_options = {
           stack: Trace::Stack.new,
+
+          input_data_collector: Trace.method(:default_input_data_collector),
+          output_data_collector: Trace.method(:default_output_data_collector),
         }
 
-        tracing_circuit_options = {
+        flow_options = { **default_flow_options, **Hash( original_flow_options ) }
+
+        default_circuit_options = {
           wrap_runtime:  ::Hash.new(Trace.merge_plan), # DISCUSS: this overrides existing {:wrap_runtime}.
         }
 
-        return activity, [ options, tracing_flow_options.merge(flow_options) ], circuit_options.merge(tracing_circuit_options)
+        circuit_options = { **original_circuit_options, **default_circuit_options }
+
+        return activity, [ options, flow_options ], circuit_options
       end
     end
 
@@ -42,38 +49,45 @@ module Trailblazer::Developer
       )
     end
 
+    # It's important to understand that {flow[:stack]} is mutated by design. This is needed so
+    # in case of exceptions we still have a "global" trace - unfortunately Ruby doesn't allow
+    # us a better way.
     # taskWrap step to capture incoming arguments of a step.
-    def capture_args(wrap_config, original_args)
-      original_args = capture_for(wrap_config[:task], *original_args)
+    def capture_args(wrap_config, ((ctx, flow), circuit_options))
+      flow[:stack].indent!
 
-      return wrap_config, original_args
+      flow[:stack] << Entity::Input.new(
+        wrap_config[:task],
+        circuit_options[:activity],
+        flow[:input_data_collector].call(wrap_config, [ctx, flow], circuit_options)
+      ).freeze
+
+      return wrap_config, [[ctx, flow], circuit_options]
     end
 
     # taskWrap step to capture outgoing arguments from a step.
-    def capture_return(wrap_config, original_args)
-      (original_options, original_flow_options, _) = original_args[0]
-
-      original_flow_options[:stack] << Entity::Output.new(
-        wrap_config[:task], {}, wrap_config[:return_signal]
+    def capture_return(wrap_config, ((ctx, flow), circuit_options))
+      flow[:stack] << Entity::Output.new(
+        wrap_config[:task],
+        {},
+        flow[:output_data_collector].call(wrap_config, [ctx, flow], circuit_options)
       ).freeze
 
-      original_flow_options[:stack].unindent!
+      flow[:stack].unindent!
 
-
-      return wrap_config, original_args
+      return wrap_config, [[ctx, flow], circuit_options]
     end
 
-    # It's important to understand that {flow[:stack]} is mutated by design. This is needed so
-    # in case of exceptions we still have a "global" trace - unfortunately Ruby doesn't allow
-    # us a better way.
-    def capture_for(task, (ctx, flow), activity:, **circuit_options)
-      flow[:stack].indent!
+    def default_input_data_collector(wrap_config, (ctx, _), circuit_options)
+      graph = Trailblazer::Activity::Introspect::Graph(circuit_options[:activity])
+      task  = wrap_config[:task]
+      name  = (node = graph.find { |node| node[:task] == task }) ? node[:id] : task
 
-      flow[:stack] << Entity::Input.new(
-        task, activity, [ctx, ctx.inspect]
-      ).freeze
+      { ctx: ctx, task_name: name }
+    end
 
-      return [ctx, flow], circuit_options.merge(activity: activity)
+    def default_output_data_collector(wrap_config, (ctx, _), _)
+      { ctx: ctx, signal: wrap_config[:return_signal] }
     end
 
     # Structures used in {capture_args} and {capture_return}.
@@ -115,6 +129,8 @@ module Trailblazer::Developer
 
     # Mutable/stateful per design. We want a (global) stack!
     class Stack
+      attr_reader :top
+
       def initialize
         @nested  = Level.new
         @stack   = [ @nested ]
@@ -129,8 +145,10 @@ module Trailblazer::Developer
         @stack.pop
       end
 
-      def <<(args)
-        current << args
+      def <<(entity)
+        @top = entity
+
+        current << entity
       end
 
       def to_a

data/lib/trailblazer/developer/trace/focusable.rb

@@ -0,0 +1,80 @@
+require 'hirb'
+
+module Trailblazer
+  module Developer
+    module Trace
+
+      module Focusable
+        module_function
+
+        # Get inspect of {focus_on.variables} or current {ctx}
+        def capture_variables_from(ctx, focus_on:, inspector: Trace::Inspector, **flow_options)
+          # ctx keys to be captured, for example [:current_user, :model, ....]
+          variables = (selected = focus_on[:variables]).any? ? selected : ctx.keys
+
+          variables.each_with_object({}) do |variable, result|
+            if variable.is_a?(Proc) # To allow deep key access from ctx
+              result[:Custom]   = inspector.(variable.call(ctx), **flow_options)
+            else
+              result[variable]  = inspector.(ctx[variable], **flow_options)
+            end
+          end
+        end
+
+        # Generate Hirb's vertical table nodes from captured ctx of each step
+        # |-- some step name
+        # |   |-- ********** Input **********
+        #    message: "WTF!"
+        #        seq: []
+        # |   `-- ********** Output **********
+        #    message: "WTF!"
+        #        seq: [:a]
+        def tree_nodes_for(level, input:, output:, **options)
+          # TODO: Reverting `Hash#compact` usage as it is not supported in Ruby <= 2.4
+          # Once the support is droped, revert actual code with below and remove entity check.
+          # input_output_nodes = { Input: input, Output: output }.compact.collect do |table_header, entity|
+
+          input_output_nodes = { Input: input, Output: output }.collect do |table_header, entity|
+            next unless entity
+            next unless Array( entity.data[:focused_variables] ).any?
+
+            table = vertical_table_for(entity.data[:focused_variables], table_header: table_header)
+            Present::TreeNodes::Node.new(level + 1, table, input, output, options).freeze
+          end
+
+          input_output_nodes.compact
+        end
+
+        # @private
+        def vertical_table_for(focused_variables, table_header:)
+          patched_vertical_table.render(
+            Array[ focused_variables ],
+            description: nil,
+            table_header: table_header, # Custom option, not from Hirb
+          )
+        end
+
+        # Overrding `Hirb::Helpers::VerticalTable#render_rows` because there is no option
+        # to customize vertical table's row header :(
+        # We need it to print if given entity is Input/Output
+        #
+        # @private
+        def patched_vertical_table
+          table = Class.new(Hirb::Helpers::VerticalTable)
+
+          table.send(:define_method, :render_rows) do
+            longest_header = Hirb::String.size (@headers.values.sort_by {|e| Hirb::String.size(e) }.last || '')
+            stars = "*" * [(longest_header + (longest_header / 2)), 3].max
+
+            @rows.map do |row|
+              "#{stars} #{@options[:table_header]} #{stars}\n" +
+                @fields.map{ |f| "#{Hirb::String.rjust(@headers[f], longest_header)}: #{row[f]}" }.join("\n")
+            end
+          end
+
+          table
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/developer/trace/inspector.rb

@@ -0,0 +1,48 @@
+module Trailblazer
+  module Developer
+    module Trace
+
+      # This module does the inspection of given `ctx` with deep traversal.
+      # It only gets called when focusing is going on (i.e. focus_on API).
+      module Inspector
+        module_function
+
+        def call(value, default_inspector: method(:default_inspector), **)
+          return hash_inspector(value, default_inspector: default_inspector) if value.is_a?(Hash)
+          return array_inspector(value, default_inspector: default_inspector) if value.is_a?(Array)
+
+          default_inspector.(value)
+        end
+
+        def hash_inspector(value, default_inspector:)
+          Hash[
+            value.collect do |key, nested_value|
+              [key, call(nested_value, default_inspector: default_inspector)]
+            end
+          ]
+        end
+
+        def array_inspector(value, default_inspector:)
+          value.collect do |nested_value|
+            call(nested_value, default_inspector: default_inspector)
+          end
+        end
+
+        # To avoid additional query that AR::Relation#inspect makes,
+        # we're calling AR::Relation#to_sql to get plain SQL string instead.
+        def activerecord_relation_inspector(value)
+          { query: value.to_sql }
+        end
+
+        def default_inspector(value)
+          if defined?(ActiveRecord) && value.is_a?(ActiveRecord::Relation)
+            return activerecord_relation_inspector(value)
+          end
+
+          value.inspect
+        end
+      end
+
+    end
+  end
+end

data/lib/trailblazer/developer/trace/present.rb

@@ -1,15 +1,12 @@
-require 'trailblazer/activity'
+require 'hirb'
 
 module Trailblazer::Developer
   module Trace
     module Present
       module_function
 
-      INDENTATION = "   |".freeze
-      STEP_PREFIX = "-- ".freeze
-
       def default_renderer(task_node:, **)
-        [ task_node[:level], %{#{task_node[:name]}} ]
+        [ task_node.level, %{#{task_node.value}} ]
       end
 
       def call(stack, level: 1, tree: [], renderer: method(:default_renderer), **options)
@@ -23,29 +20,14 @@ module Trailblazer::Developer
           renderer.(task_node: task_node, position: position, tree: tree)
         end
 
-        render_tree_for(nodes)
-      end
-
-      def render_tree_for(nodes)
-        nodes.map { |level, node|
-          indentation = INDENTATION * (level -1)
-          indentation = indentation[0...-1] + "`" if level == 1 || /End./.match(node) # start or end step
-          indentation + STEP_PREFIX + node
-        }.join("\n")
+        Hirb::Console.format_output(nodes, class: :tree, type: :directory, multi_line_nodes: true)
       end
 
       def tree_for(stack, level, tree:, **options)
         stack.each do |lvl| # always a Stack::Task[input, ..., output]
           input, output, nested = Trace::Level.input_output_nested_for_level(lvl)
 
-          task = input.task
-
-          graph = Trailblazer::Activity::Introspect::Graph(input.activity)
-
-          name = (node = graph.find { |node| node[:task] == task }) ? node[:id] : task
-          name ||= task # FIXME: bullshit
-
-          tree << { level: level, input: input, output: output, name: name, **options }
+          tree.push(*TreeNodes.for(level, options.merge(input: input, output: output)))
 
           if nested.any? # nesting
             tree_for(nested, level + 1, options.merge(tree: tree))
@@ -54,6 +36,26 @@ module Trailblazer::Developer
           tree
         end
       end
+
+      module TreeNodes
+        Node = Struct.new(:level, :value, :input, :output, :options) do
+          # Allow access to any custom key from options, eg. color_map
+          def method_missing(name, *)
+            options[name]
+          end
+        end
+
+        module_function
+
+        def for(level, input:, output:, **options)
+          nodes = Array[ Node.new(level, input.data[:task_name], input, output, options).freeze ]
+
+          focused_nodes = Trace::Focusable.tree_nodes_for(level, input: input, output: output, **options)
+          nodes += focused_nodes if focused_nodes.length > 0
+
+          nodes
+        end
+      end
     end
   end
 end

data/lib/trailblazer/developer/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Developer
-      VERSION = "0.0.8"
+      VERSION = "0.0.13"
     end
   end
 end

data/lib/trailblazer/developer/wtf.rb

@@ -12,95 +12,78 @@ module Trailblazer::Developer
   module Wtf
     module_function
 
-    COLOR_MAP = { pass: :green, fail: :brown }
-
-    SIGNALS_MAP = {
-      'Trailblazer::Activity::Right': :pass,
-      'Trailblazer::Activity::FastTrack::PassFast': :pass,
-
-      'Trailblazer::Activity::Left': :fail,
-      'Trailblazer::Activity::FastTrack::FailFast': :fail,
-    }
-
     # Run {activity} with tracing enabled and inject a mutable {Stack} instance.
     # This allows to display the trace even when an exception happened
-    def invoke(activity, (ctx, flow_options), *args)
-      flow_options ||= {} # Ruby sucks.
-
-      # this instance gets mutated with every step. unfortunately, there is
-      # no other way in Ruby to keep the trace even when an exception was thrown.
-      stack = Trace::Stack.new
-
-      _returned_stack, *returned = Trace.invoke(
-        activity,
-        [
-          ctx,
-          flow_options.merge(stack: stack)
-        ],
-        *args
+    def invoke(activity, (ctx, flow_options), *circuit_options)
+      activity, (ctx, flow_options), circuit_options = Wtf.arguments_for_trace(
+        activity, [ctx, flow_options], *circuit_options
       )
 
-      returned
+      _returned_stack, signal, (ctx, flow_options) = Trace.invoke(
+        activity, [ctx, flow_options], *circuit_options
+      )
+
+      return signal, [ctx, flow_options], circuit_options
     ensure
       puts Trace::Present.(
-        stack,
-        renderer: method(:renderer),
-        color_map: COLOR_MAP.merge( flow_options[:color_map] || {} )
+        flow_options[:stack],
+        renderer: Wtf::Renderer,
+        color_map: Wtf::Renderer::DEFAULT_COLOR_MAP.merge( flow_options[:color_map] || {} ),
       )
     end
 
-    def renderer(task_node:, position:, tree:)
-      name, level, output, color_map = task_node.values_at(:name, :level, :output, :color_map)
+    def arguments_for_trace(activity, (ctx, original_flow_options), **circuit_options)
+      default_flow_options = {
+        # this instance gets mutated with every step. unfortunately, there is
+        # no other way in Ruby to keep the trace even when an exception was thrown.
+        stack: Trace::Stack.new,
 
-      if output.nil? && tree[position.next].nil? # i.e. when exception raised
-        return [ level, %{#{fmt(fmt(name, :red), :bold)}} ]
-      end
+        input_data_collector: method(:trace_input_data_collector),
+        output_data_collector: method(:trace_output_data_collector),
+      }
 
-      if output.nil? # i.e. on entry/exit point of activity
-        return [ level, %{#{name}} ]
-      end
+      # Merge default options with flow_options as an order of precedence
+      flow_options = { **default_flow_options, **Hash( original_flow_options ) }
 
-      [ level, %{#{fmt( name, color_map[ signal_of(output.data) ] )}} ]
+      # Normalize `focus_on` param to
+      #   1. Wrap step and variable names into an array if not already
+      flow_options[:focus_on] = {
+        steps: Array( flow_options.dig(:focus_on, :steps) ),
+        variables: Array( flow_options.dig(:focus_on, :variables) ),
+      }
+
+      return activity, [ ctx, flow_options ], circuit_options
     end
 
-    def fmt(line, style)
-      return line unless style
-      String.send(style, line)
+    # Overring default input and output data collectors to collect/capture
+    #   1. inspect of focusable variables for given focusable step
+    #   2. Or inspect of focused variables for all steps
+    def trace_input_data_collector(wrap_config, (ctx, flow_options), circuit_options)
+      data = Trace.default_input_data_collector(wrap_config, [ctx, flow_options], circuit_options)
+
+      if Wtf.caputure_variables?(step_name: data[:task_name], **flow_options)
+        data[:focused_variables] = Trace::Focusable.capture_variables_from(ctx, **flow_options)
+      end
+
+      data
     end
 
-    def signal_of(entity_output)
-      entity_klass = entity_output.is_a?(Class) ? entity_output : entity_output.class
-      SIGNALS_MAP[entity_klass.name.to_sym]
+    def trace_output_data_collector(wrap_config, (ctx, flow_options), circuit_options)
+      data  = Trace.default_output_data_collector(wrap_config, [ctx, flow_options], circuit_options)
+      input = flow_options[:stack].top
+
+      if Wtf.caputure_variables?(step_name: input.data[:task_name], **flow_options)
+        data[:focused_variables] = Trace::Focusable.capture_variables_from(ctx, **flow_options)
+      end
+
+      data
     end
 
-    # Stolen from https://stackoverflow.com/questions/1489183/colorized-ruby-output
-    #
-    # TODO: this is just prototyping
-    module String
-      module_function
-      def black(str);          "\e[30m#{str}\e[0m" end
-      def red(str);            "\e[31m#{str}\e[0m" end
-      def green(str);          "\e[32m#{str}\e[0m" end
-      def brown(str);          "\e[33m#{str}\e[0m" end
-      def blue(str);           "\e[34m#{str}\e[0m" end
-      def magenta(str);        "\e[35m#{str}\e[0m" end
-      def cyan(str);           "\e[36m#{str}\e[0m" end
-      def gray(str);           "\e[37m#{str}\e[0m" end
-
-      def bg_black(str);       "\e[40m#{str}\e[0m" end
-      def bg_red(str);         "\e[41m#{str}\e[0m" end
-      def bg_green(str);       "\e[42m#{str}\e[0m" end
-      def bg_brown(str);       "\e[43m#{str}\e[0m" end
-      def bg_blue(str);        "\e[44m#{str}\e[0m" end
-      def bg_magenta(str);     "\e[45m#{str}\e[0m" end
-      def bg_cyan(str);        "\e[46m#{str}\e[0m" end
-      def bg_gray(str);        "\e[47m#{str}\e[0m" end
-
-      def bold(str);           "\e[1m#{str}\e[22m" end
-      def italic(str);         "\e[3m#{str}\e[23m" end
-      def underline(str);      "\e[4m#{str}\e[24m" end
-      def blink(str);          "\e[5m#{str}\e[25m" end
-      def reverse_color(str);  "\e[7m#{str}\e[27m" end
+    # private
+    def caputure_variables?(step_name:, focus_on:, **)
+      return true if focus_on[:steps].include?(step_name)                 # For given step
+      return true if focus_on[:steps].empty? && focus_on[:variables].any? # For selected vars but all steps
+      return false
     end
   end
 end

data/lib/trailblazer/developer/wtf/renderer.rb

@@ -0,0 +1,78 @@
+module Trailblazer::Developer
+  module Wtf
+
+    module Renderer
+      DEFAULT_COLOR_MAP = { pass: :green, fail: :brown }
+
+      SIGNALS_MAP = {
+        :'Trailblazer::Activity::Right' => :pass,
+        :'Trailblazer::Activity::FastTrack::PassFast' => :pass,
+
+        :'Trailblazer::Activity::Left' => :fail,
+        :'Trailblazer::Activity::FastTrack::FailFast' => :fail,
+      }
+
+      module_function
+
+      # tree: Array of Trace::TreeNodes::Node
+      # task_node - current Trace::TreeNodes::Node to render
+      # position - task_node's position in tree
+      def call(tree:, task_node:, position:)
+        value = value_for(tree, task_node, position)
+        [task_node.level, value]
+      end
+
+      def value_for(tree, task_node, position)
+        if task_node.output.nil? && tree[position.next].nil? # i.e. when exception raised
+          return %{#{fmt(fmt(task_node.value, :red), :bold)}}
+        end
+
+        if task_node.output.nil? # i.e. on entry/exit point of activity
+          return %{#{task_node.value}}
+        end
+
+        %{#{fmt(task_node.value, task_node.color_map[ signal_of(task_node) ])}}
+      end
+
+      def fmt(line, style)
+        return line unless style
+        String.send(style, line)
+      end
+
+      def signal_of(task_node)
+        entity_signal = task_node.output.data[:signal]
+        entity_klass = entity_signal.is_a?(Class) ? entity_signal : entity_signal.class
+
+        SIGNALS_MAP[entity_klass.name.to_sym]
+      end
+
+      # Stolen from https://stackoverflow.com/questions/1489183/colorized-ruby-output
+      #
+      # TODO: this is just prototyping
+      module String
+        module_function
+        def black(str);          "\e[30m#{str}\e[0m" end
+        def red(str);            "\e[31m#{str}\e[0m" end
+        def green(str);          "\e[32m#{str}\e[0m" end
+        def brown(str);          "\e[33m#{str}\e[0m" end
+        def blue(str);           "\e[34m#{str}\e[0m" end
+        def magenta(str);        "\e[35m#{str}\e[0m" end
+        def cyan(str);           "\e[36m#{str}\e[0m" end
+        def gray(str);           "\e[37m#{str}\e[0m" end
+
+        def bg_black(str);       "\e[40m#{str}\e[0m" end
+        def bg_red(str);         "\e[41m#{str}\e[0m" end
+        def bg_green(str);       "\e[42m#{str}\e[0m" end
+        def bg_brown(str);       "\e[43m#{str}\e[0m" end
+        def bg_blue(str);        "\e[44m#{str}\e[0m" end
+        def bg_magenta(str);     "\e[45m#{str}\e[0m" end
+        def bg_cyan(str);        "\e[46m#{str}\e[0m" end
+        def bg_gray(str);        "\e[47m#{str}\e[0m" end
+
+        def bold(str);           "\e[1m#{str}\e[22m" end
+        def italic(str);         "\e[3m#{str}\e[23m" end
+        def underline(str);      "\e[4m#{str}\e[24m" end
+      end
+    end
+  end
+end

data/trailblazer-developer.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "trailblazer-activity", ">= 0.10.0", "< 1.0.0"
   spec.add_dependency "trailblazer-activity-dsl-linear"
   spec.add_dependency "representable"
+  spec.add_dependency "hirb"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-developer
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.13
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Developer tools for Trailblazer: debugger, tracing, visual editor integration.'
 email:
 - apotonick@gmail.com
@@ -147,15 +161,17 @@ files:
 - gems.local.rb
 - lib/trailblazer/developer.rb
 - lib/trailblazer/developer/CHANGES.md
-- lib/trailblazer/developer/activity.rb
 - lib/trailblazer/developer/client.rb
 - lib/trailblazer/developer/generate.rb
 - lib/trailblazer/developer/render/circuit.rb
 - lib/trailblazer/developer/render/linear.rb
 - lib/trailblazer/developer/trace.rb
+- lib/trailblazer/developer/trace/focusable.rb
+- lib/trailblazer/developer/trace/inspector.rb
 - lib/trailblazer/developer/trace/present.rb
 - lib/trailblazer/developer/version.rb
 - lib/trailblazer/developer/wtf.rb
+- lib/trailblazer/developer/wtf/renderer.rb
 - lib/trailblazer/diagram/bpmn.rb
 - trailblazer-developer.gemspec
 homepage: http://trailblazer.to
@@ -177,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Developer tools for Trailblazer.

data/lib/trailblazer/developer/activity.rb

@@ -1,51 +0,0 @@
-module Trailblazer
-  module Developer
-    # Transforms an {Activity::Graph} into an abstract data structure that represents the graph via a
-    # well-defined API. The goal is to decouple graph internals from the presentation layer.
-    # The {Model} is usually passed into Renderer and Layouter, to render the bpmn:Diagram XML or JSON.
-    #
-    # It returns {Model} with {Task}s and {Flow}s.
-    module Activity
-      module Graph
-        class << self
-          Model = Struct.new(:id, :start_events, :end_events, :task, :sequence_flow)
-          Task  = Struct.new(:id, :name, :options, :incoming, :outgoing)
-          # DISCUSS: direction ATM is the "condition" for the BPMN rendering.
-          Flow  = Struct.new(:id, :sourceRef, :targetRef, :direction)
-
-          # @param Graph an object implementing the Activity::Graph interface
-          # @return Model Generic representation of the graph, ready for rendering.
-          def self.to_model(graph, id: "some-process") # rubocop:disable Metrics/AbcSize
-            start_events = graph.find_all("Start.default") # FIXME. this is a static assumption.
-            end_events   = graph.find_all { |node| graph.successors(node).size.zero? }
-            tasks        = graph.find_all { |_node| true }
-            tasks       -= start_events
-            tasks       -= end_events
-
-            # transform nodes into BPMN elements.
-            start_events = start_events.collect do |evt|
-              Task.new(evt[:id], evt[:id], evt, Incomings(graph, evt), Outgoings(graph, evt))
-            end
-            end_events = end_events.collect do |evt|
-              Task.new(evt[:id], evt[:id], evt, Incomings(graph, evt), Outgoings(graph, evt))
-            end
-            tasks        = tasks.collect { |evt| Task.new(evt[:id], evt[:id], evt, Incomings(graph, evt), Outgoings(graph, evt)) }
-            edges        = (start_events + end_events + tasks).collect { |task| [task.incoming, task.outgoing] }.flatten(2).uniq
-
-            Model.new(id, start_events, end_events, tasks, edges)
-          end
-
-          private
-
-          def Outgoings(graph, source)
-            graph.successors(source).collect { |target, edge| Flow.new(edge[:id], source[:id], target[:id], edge[:_wrapped]) }
-          end
-
-          def Incomings(graph, target)
-            graph.predecessors(target).collect { |source, edge| Flow.new(edge[:id], source[:id], target[:id], edge[:_wrapped]) }
-          end
-        end
-      end
-    end
-  end
-end