trailblazer-circuit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a7e34849fb98696e6c453bbe8177d90b3932ecd
-  data.tar.gz: 5c2d5ab3e575f380fda9f2976bddd77d2a5b9fb1
+  metadata.gz: 72877a8ce955ec1dc23b9f100bda0974e1bcd40f
+  data.tar.gz: c71ca90a053245f55c75573bea74584b2056f14c
 SHA512:
-  metadata.gz: 9e64cefc10dfc6606ebe9be18cc918145ba4b1a4a62854b35a00e97b0dc26233a85d81e39b96f0534dc469f763c6796618b1350480bea30ec566f3c1a45ef1f1
-  data.tar.gz: c71327201a57cddb155d70c5cb6e1bbb67daf040a988be09045831c2e93900e05072689f564ad0de1a1a6eafc837d4f5a956a269259f5fe09f9fc1b08684fdf0
+  metadata.gz: 4f8fa59da9c333fefdf5c5b37a273d520bbfc346c4d2d80a1455447b7bd85e878a523112e58e4a231ac220969b33e12428902c4fe8ab9155a615c0c093ade6a3
+  data.tar.gz: e4aef9035fe3a68b81fda3f178e6e37ac9fb9f04fe20b64e5de4cdd850e04b2214d398b9b1439c7d568634a43709ced757f7201174abce5a8fddae74f645fb19

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.0.2
+
+* Make `flow_options` an immutable data structure just as `options`. It now needs to be returned from a `#call`.
+
 # 0.0.1
 
 * First release into an unsuspecting world. 🚀

data/lib/trailblazer/circuit/activity.rb

@@ -16,24 +16,16 @@ module Trailblazer
       end
     end
 
-    # DSL
-    #  Conveniently build an Activity with Circuit instance and
-    # all its signals/events.
-    def self.Activity(name=:default, events={}, end_events=nil, implementation=false, &block)
+    # Builder for an Activity with Circuit instance and events.
+    def self.Activity(name=:default, events={}, &block)
       # default events:
       start   = events[:start] || { default: Start.new(:default) }
       _end    = events[:end]   || { default: End.new(:default) }
 
-      events = { start: start }.merge(events)
-      events = { end:   _end  }.merge(events)
-
-      end_events ||= _end.values
+      events = { start: start, end: _end }.merge(events)
 
       evts = Events(events)
-      circuit = Circuit(name, evts, end_events, &block)
-
-      # DISCUSS: remove this!
-      circuit = implementation.(circuit) if implementation
+      circuit = Circuit(name, evts, _end.values, &block)
 
       Activity.new(circuit, evts)
     end

data/lib/trailblazer/circuit/testing.rb

@@ -0,0 +1,42 @@
+module MiniTest::Assertions
+  def assert_activity_inspect(text, subject)
+    Trailblazer::Circuit::ActivityInspect(subject).must_equal text
+  end
+
+  def assert_event_inspect(text, subject)
+    Trailblazer::Circuit::EndInspect(subject).must_equal(text)
+  end
+end
+
+
+Trailblazer::Circuit::Activity.infect_an_assertion :assert_activity_inspect, :must_inspect
+Trailblazer::Circuit::End.infect_an_assertion      :assert_event_inspect,    :must_inspect_end_fixme
+
+class Trailblazer::Circuit
+  def self.EndInspect(event)
+    event.instance_eval { "#<#{self.class.to_s.split("::").last}: #{@name} #{@options}>" }
+  end
+
+  def self.ActivityInspect(activity, strip: ["AlterTest::"])
+    strip += ["Trailblazer::Circuit::"]
+    stripped = ->(target) { strip_for(target, strip) }
+
+    map, _ = activity.circuit.to_fields
+
+    content = map.collect do |task, connections|
+      bla =
+      connections.collect do |direction, target|
+        target_str = target.kind_of?(End) ? EndInspect(target) : stripped.(target)
+        "#{stripped.(direction)}=>#{target_str}"
+      end.join(", ")
+      task_str = task.kind_of?(End) ? EndInspect(task) : stripped.(task)
+      "#{task_str}=>{#{bla}}"
+    end.join(", ")
+    "{#{content}}"
+  end
+
+  def self.strip_for(target, strings)
+    strings.each { |stripped| target = target.to_s.gsub(stripped, "") }
+    target
+  end
+end

data/lib/trailblazer/circuit/trace.rb

@@ -4,15 +4,18 @@ module Trailblazer
 
     # Every `activity.call` is considered nested
     class Trace
+      # Trace is passed in as the `:runner` into Circuit#call and is called per task.
       def call(activity, direction, args, debug:raise, stack:raise, **flow_options)
         activity_name, _ = debug[activity]
         activity_name ||= activity
 
-        Run.(activity, direction, args, stack:[], **flow_options).tap do |direction, outgoing_options, **flow_options| # TODO: USE KW ARG FOR :stack
-          # raise activity_name.inspect if flow_options[:stack].nil? # TODO: remove this.
-          # TODO: fix the inspect, we need a snapshot, deep-nested.
-          stack << [activity_name, activity, direction, outgoing_options, outgoing_options.inspect, flow_options[:stack].any? ? flow_options[:stack] : nil ]
-        end
+        # Use Circuit::Run to actually call the task.
+        direction, options, _flow_options = Run.(activity, direction, args, flow_options.merge(stack: []))
+
+        # TODO: fix the inspect, we need a snapshot, deep-nested.
+        stack << [activity_name, activity, direction, options, options.inspect, _flow_options[:stack].any? ? _flow_options[:stack] : nil ]
+
+        return direction, options, _flow_options.merge(stack: stack, debug: debug)
       end
     end # Trace
   end

data/lib/trailblazer/circuit/version.rb

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

data/lib/trailblazer/circuit.rb

@@ -1,48 +1,43 @@
 require "trailblazer/circuit/version"
 
-# Start, Suspend, Resume, End can return something other than the next symbol?
-# Nested could replace options with local options
-
-
 module Trailblazer
-  # Circuit executes ties, finds next step and stops when reaching a Stop signal (or derived from).
+  # 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.
   #
-  #   circuit.()
-  #
-  # Cicuit doesn't know anything about contexts, options, etc. tasks: what steps follows? call it!
-	class Circuit
+  #   result = circuit.(start_at, *args)
+  class Circuit
     def initialize(map, stop_events, name)
       @name        = name
       @map         = map
       @stop_events = stop_events
     end
 
-        # the idea is to always have a breakpoint state that has only one outgoing edge. we then start from
-    # that vertix. it's up to the caller to test if the "persisted" state == requested state.
-    # activity: where to start
     Run = ->(activity, direction, *args) { activity.(direction, *args) }
 
-    def call(activity, args, runner: Run, **o) # DISCUSS: should start activity be @activity and we omit it here?
+    # 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)
       # TODO: args
-      direction = nil
+      direction    = nil
+      flow_options = { runner: runner, debug: @name }.merge(o) # DISCUSS: make this better?
 
       loop do
-        # puts "[#{@name}]. #{activity}"
-        direction, args  = runner.(activity, direction, args, runner: runner, debug: @name, **o)
+        direction, args, flow_options = runner.( activity, direction, args, flow_options )
 
-        # last task in a process is always either its Stop or its Suspend.
-        return [ direction, args, **o ] if @stop_events.include?(activity)
+        # Stop execution of the circuit when we hit a stop event (< End). This could be an activity's End of Suspend.
+        return [ direction, args, flow_options ] if @stop_events.include?(activity)
 
         activity = next_for(activity, direction) do |next_activity, in_map|
-          # puts "[#{@name}]...`#{activity}`[#{direction}] => #{next_activity}"
-
           raise IllegalInputError.new("#{@name} #{activity}") unless in_map
-          # last activity didn't emit knowns signal, it's not connected.
           raise IllegalOutputSignalError.new("from #{@name};;#{activity}"+ direction.inspect) unless next_activity
         end
       end
     end
 
+    # Returns the circuit's components.
     def to_fields
       [ @map, @stop_events, @name]
     end
@@ -66,28 +61,14 @@ module Trailblazer
     class IllegalOutputSignalError < RuntimeError
     end
 
-    def Right
-      Right
-    end
-
-    def Left
-      Left
-    end
-
+    # End event is just another callable task.
+    # Any instance of subclass of End will halt the circuit's execution when hit.
     class End
       def initialize(name, options={})
         @name    = name
         @options = options
       end
 
-      def to_s
-        %{#<End: #{@name} #{@options.inspect}>}
-      end
-
-      def inspect
-        to_s
-      end
-
       def call(direction, *args)
         [ self, *args ]
       end
@@ -95,27 +76,25 @@ module Trailblazer
 
     class Start < End
       def call(direction, *args)
-        [Right, *args]
+        [ Right, *args ]
       end
+    end
 
-      def to_s
-        %{#<Start: #{@name} #{@options.inspect}>}
-      end
+    # Builder for Circuit::End when defining the Activity's circuit.
+    def self.End(name, options={})
+      End.new(name, options)
     end
 
-    # # run a nested process.
+    # Builder for running a nested process from a specific `start_at` position.
     def self.Nested(activity, start_with=activity[:Start])
-      # TODO: currently, we only support only 1 start event. you can use multiple in BPMN.
-      # "The BPMN standard allows for multiple start and end events to be used at the same process level. "
       ->(start_at, options, *args) {
-         # puts "@@@@@ #{options.inspect}"
         activity.(start_with, options, *args)
       }
     end
 
-    class Direction; end
+    class Direction;         end
 		class Right < Direction; end
-    class Left < Direction;  end
+    class Left  < Direction; end
   end
 end
 

data/trailblazer-circuit.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "raise"
 
   spec.required_ruby_version = '>= 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-circuit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: raise
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,6 +86,7 @@ files:
 - lib/trailblazer/circuit/alter.rb
 - lib/trailblazer/circuit/present.rb
 - lib/trailblazer/circuit/task.rb
+- lib/trailblazer/circuit/testing.rb
 - lib/trailblazer/circuit/trace.rb
 - lib/trailblazer/circuit/version.rb
 - trailblazer-circuit.gemspec