trailblazer-circuit 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b52e8d764a309e9a8977564a19ddf387c236aea0
-  data.tar.gz: ae086ee946f06831f4f513bbaae68292864787c4
+  metadata.gz: 51251c5182357e83918081e911da91c2ead537d0
+  data.tar.gz: 4f3087460b00f9e90b0d9584fde259d14cc20f2b
 SHA512:
-  metadata.gz: e76bc0e1ce8ea6a5a14563826947b81ea3223b2cbc8aee0b1f9fd1d54d7414fd43f1f8a8a071500fb9b308bda1c1654d852c9084aa880f5d9f87123a15eb7a95
-  data.tar.gz: 7d423b1259a76f6717a84f9aee5b3d23c0ae4696eaea6efb5e415002411683b65f73dd59f16549270b6aa640ce36beb9f7505fb5204a4581b520139ceb72857e
+  metadata.gz: ef71bb646ac59d02d36a71644e7dd47cbbb91498495f03abe2a06853a0a4a050862fab8c985d2c0caeb0ae3e9aeab2dc1d5124731408d846b0bd769d8fffb650
+  data.tar.gz: dc0a566ee9e12352a7fa2c1accda1eb443967e10ab2f162752e8e15b223a1b7dd31f8d9f3b93c58f4178991c46f3e180a00c7d20098bb11638c1a45f11408ab1

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.0.8
+
+* Make `Trailblazer::Option` and `Trailblazer::Option::KW` a mix of lambda and object so it's easily extendable.
+
 # 0.0.7
 
 * It is now `Trailblazer::Args`.

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem "minitest-line"
+gem "benchmark-ips"

data/lib/trailblazer/circuit/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Circuit
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/lib/trailblazer/circuit.rb

@@ -120,7 +120,7 @@ end
 
 require "trailblazer/circuit/activity"
 require "trailblazer/circuit/task"
-require "trailblazer/circuit/args"
+require "trailblazer/option"
 require "trailblazer/circuit/alter"
 require "trailblazer/circuit/trace"
 require "trailblazer/circuit/present"

data/lib/trailblazer/option.rb

@@ -0,0 +1,79 @@
+# TODO: test all this, for christ's sake.
+
+module Trailblazer
+  # @note This might go to trailblazer-args along with `Context` at some point.
+  def self.Option(proc)
+    Option.build(Option, proc)
+  end
+
+  class Option
+    # Generic builder for a callable "option".
+    # @param call_implementation [Class, Module] implements the process of calling the proc
+    #   while passing arguments/options to it in a specific style (e.g. kw args, step interface).
+    # @return [Proc] when called, this proc will evaluate its option (at run-time).
+    def self.build(call_implementation, proc)
+      if proc.is_a? Symbol
+        ->(*args) { call_implementation.evaluate_method(proc, *args) }
+      else
+        ->(*args) { call_implementation.evaluate_callable(proc, *args) }
+      end
+    end
+
+    # A call implementation invoking `proc.(*args)` and plainly forwarding all arguments.
+    # Override this for your own step strategy (see KW#call!).
+    # @private
+    def self.call!(proc, *args)
+      proc.(*args)
+    end
+
+    # Note that both #evaluate_callable and #evaluate_method drop most of the args.
+    # If you need those, override this class.
+    # @private
+    def self.evaluate_callable(proc, *args)
+      call!(proc, *args)
+    end
+
+    # Make the context's instance method a "lambda" and reuse #call!.
+    # @private
+    def self.evaluate_method(proc, *args, exec_context:raise, **flow_options)
+      call!(exec_context.method(proc), *args)
+    end
+
+    # Returns a {Proc} that, when called, invokes the `proc` argument with keyword arguments.
+    # This is known as "step (call) interface".
+    #
+    # This is commonly used by `Operation::step` to wrap the argument and make it
+    # callable in the circuit.
+    #
+    #   my_proc = ->(options, **kws) { options["i got called"] = true }
+    #   task    = Trailblazer::Option::KW(my_proc)
+    #   task.(options = {})
+    #   options["i got called"] #=> true
+    #
+    # Alternatively, you can pass a symbol and an `:exec_context`.
+    #
+    #   my_proc = :some_method
+    #   task    = Trailblazer::Option::KW(my_proc)
+    #
+    #   class A
+    #     def some_method(options, **kws)
+    #       options["i got called"] = true
+    #     end
+    #   end
+    #
+    #   task.(options = {}, exec_context: A.new)
+    #   options["i got called"] #=> true
+    def self.KW(proc)
+      Option.build(KW, proc)
+    end
+
+    class KW < Option
+      # A different call implementation that calls `proc` with a "step interface".
+      #   your_code.(options, **options)
+      # @private
+      def self.call!(proc, options, *)
+        proc.(options, **options.to_hash) # Step interface: (options, **)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-circuit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,6 @@ files:
 - lib/trailblazer/circuit.rb
 - lib/trailblazer/circuit/activity.rb
 - lib/trailblazer/circuit/alter.rb
-- lib/trailblazer/circuit/args.rb
 - lib/trailblazer/circuit/present.rb
 - lib/trailblazer/circuit/task.rb
 - lib/trailblazer/circuit/testing.rb
@@ -106,6 +105,7 @@ files:
 - lib/trailblazer/circuit/version.rb
 - lib/trailblazer/circuit/wrap.rb
 - lib/trailblazer/context.rb
+- lib/trailblazer/option.rb
 - trailblazer-circuit.gemspec
 homepage: http://trailblazer.to/gems/workflow
 licenses: []

data/lib/trailblazer/circuit/args.rb

@@ -1,57 +0,0 @@
-module Trailblazer
-  # @note This might go to trailblazer-args along with `Context` at some point.
-  class Args
-    class << self
-      # Returns a {Proc} that, when called, invokes the `proc` argument with keyword arguments.
-      # This is known as "step (call) interface".
-      #
-      # This is commonly used by `Operation::step` to wrap the argument and make it
-      # callable in the circuit.
-      #
-      #   my_proc = ->(options, **kws) { options["i got called"] = true }
-      #   task    = Trailblazer::Args::KW(my_proc)
-      #   task.(options = {})
-      #   options["i got called"] #=> true
-      #
-      # Alternatively, you can pass a symbol and an `:exec_context`.
-      #
-      #   my_proc = :some_method
-      #   task    = Trailblazer::Args::KW(my_proc)
-      #
-      #   class A
-      #     def some_method(options, **kws)
-      #       options["i got called"] = true
-      #     end
-      #   end
-      #
-      #   task.(options = {}, exec_context: A.new)
-      #   options["i got called"] #=> true
-      def KW(proc)
-        if proc.is_a? Symbol
-          ->(*args) { call_method!(proc, *args) }
-        else
-          ->(*args) { call_callable!(proc,   *args) }
-        end
-      end
-
-      private
-
-      # Calls `proc` with a "step" interface.
-      # Override this for your own step strategy.
-      def call!(proc, options)
-        proc.(options, **options.to_hash) # Step interface: (options, **)
-      end
-
-      # Note that both #call_callable! and #call_method! drop most of the args.
-      # If you need those, override this class.
-      def call_callable!(proc, options, *)
-        call!(proc, options)
-      end
-
-      # Make the context's instance method a "lambda" and reuse #call!.
-      def call_method!(proc, options, exec_context:raise, **)
-        call!(exec_context.method(proc), options)
-      end
-    end
-  end
-end