carry_out 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97d5a6e2a244532804c0d40120e5e77830799af7
-  data.tar.gz: cf7c9b3f5b5bf11ab0a154899b6d94ebc688b240
+  metadata.gz: 843167a029617226c13a57a276b2fcaa345361d7
+  data.tar.gz: 45b888c850b7642fc713c3bbb466d6eddc56ea38
 SHA512:
-  metadata.gz: 7c731815764352c2d284f02274aed7d0a926e45990e48326f6969068bbeacbc2b150047167c6c766746483a1239fa263c73f7c8aa21327d79e32b72bd4b54c0a
-  data.tar.gz: 60d00e1d0e4aee269bd15e1fbf967cb059a0de2a230d18c82fa0920add98dae0c5fbb4792122d1755d915c3f920a4accb2264153cdb562a24721defb10ce2f93
+  metadata.gz: 181d2e3bd653dd716f659354461aa67c44edc8cb33f02f57f636995dd88c3bfc9a6e8e2030f945e24eb5fad859759c9fdfde76fc28ab0d1335ff8f488f3739cd
+  data.tar.gz: 8d3c0141281a011d4575f8af64b6bbcc09ad29fee8138a7241ce5bcca5569d330038bc6d6a172351a6c65026c6426ddefb5d25d00172cc3d6380da56e9d1942a

data/README.md

@@ -105,7 +105,7 @@ A unit may wish to provide the syntactic sugar while ensuring the underlying ins
 
 Plan executions return a `CarryOut::Result` object that contains any artifacts returned by units (in `Result#artifacts`), along with any errors raised (in `Result#errors`).  If `errors` is empty, `Result#success?` will return `true`.
 
-Parameter blocks can be used to pass result artifacts on to subsequent execution units in the plan.
+References via `CarryOut#get` or via blocks can be used to pass result artifacts on to subsequent execution units in the plan.
 
 ```ruby
 class AddToCart < CarryOut::Unit
@@ -127,11 +127,12 @@ end
 ```
 ```ruby
 plan = CarryOut
-    .will(AddToCart, as: :cart)
-    .items([ item1, item2, item3])
-    .then(CalculateSubtotal, as: :invoice)
-    .items { |refs| refs[:cart][:contents] }
-    
+  .will(AddToCart, as: :cart)
+  .items([ item1, item2, item3])
+  .then(CalculateSubtotal, as: :invoice)
+  .items(CarryOut.get(:cart, :contents) 
+  # or .items { |refs| refs[:cart][:contents] }
+
 plan.execute do |result|
   puts "Subtotal: #{result.artifacts[:invoice][:subtotal]}"
 end
@@ -144,7 +145,7 @@ end
 ```ruby
 plan = CarryOut
   .will(SayHello)
-  .to { |refs| refs[:name] }
+  .to(CarryOut.get(:name))
 
 plan.execute(name: 'John')
 ```
@@ -171,7 +172,7 @@ end
 plan = CarryOut
   .within(FileContext.new("path/to/file"))  # Expects instance, not class
   .will(DoAThing)
-    .with_file { |refs| refs[:file] }
+  .with_file(CarryOut.get(:file))
 ```
 
 The wrapping context can also be a block.
@@ -208,14 +209,16 @@ Use the `if` or `unless` directive to conditionally execute a unit.
 
 ```ruby
 plan = CarryOut
-    .will(SayHello)
-    .if { |refs| refs[:audible] }
+  .will(SayHello)
+  .if { |refs| refs[:audible] }
+  # or .if(CarryOut.get(:audible))
 ```
 
 ```ruby
 plan = CarryOut
-    .will(SayHello)
-    .unless { |refs| refs[:silenced] }
+  .will(SayHello)
+  .unless { |refs| refs[:silenced] }
+  # or .unless(CarryOut.get(:silenced))
 ```
 
 ## Motivation

data/lib/carry_out/plan_node.rb

@@ -8,12 +8,8 @@ module CarryOut
     end
 
     def method_missing(method, *args, &block)
-      if args.length <= 1 || (args.length == 0 && !block.nil?)
-        if @unitClass.instance_methods.include?(method)
-          @messages << { method: method, argument: args.first || true, block: block }
-        else
-          raise NoMethodError.new("#{@unitClass} instances do not respond to `#{method}'", method, *args)
-        end
+      if is_parameter_method?(*args, &block)
+        append_message(method, *args, &block)
       else
         super
       end
@@ -45,5 +41,26 @@ module CarryOut
     def next=(value)
       @next = value.to_sym
     end
+
+    private
+      def append_message(method, *args, &block)
+        if @unitClass.instance_methods.include?(method)
+          if args.first.kind_of?(Reference)
+            if block.nil?
+              @messages << { method: method, block: args.first }
+            else
+              raise ArgumentError.new("References and blocks are mutually exclusive")
+            end
+          else
+            @messages << { method: method, argument: args.first || true, block: block }
+          end
+        else
+          raise NoMethodError.new("#{@unitClass} instances do not respond to `#{method}'", method, *args)
+        end
+      end
+      
+      def is_parameter_method?(*args, &block)
+        args.length <= 1 || (args.length == 0 && !block.nil?)
+      end
   end
 end

data/lib/carry_out/reference.rb

@@ -0,0 +1,22 @@
+module CarryOut
+  class Reference
+
+    def initialize(*args)
+      @key_path = args
+    end
+
+    def call(context)
+      result = context
+      @key_path.each do |key|
+        if context.respond_to?(:has_key?) && context.has_key?(key)
+          result = context[key]
+        else
+          result = nil
+          break
+        end
+      end
+
+      result
+    end
+  end
+end

data/lib/carry_out/version.rb

@@ -1,3 +1,3 @@
 module CarryOut
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/carry_out.rb

@@ -3,11 +3,16 @@ require "carry_out/version"
 require "carry_out/error"
 require "carry_out/plan"
 require "carry_out/plan_node"
+require "carry_out/reference"
 require "carry_out/result"
 require "carry_out/unit"
 require "carry_out/unit_error"
 
 module CarryOut
+  def self.get(*args)
+    Reference.new(*args)
+  end
+
   def self.will(*args)
     Plan.new(*args)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carry_out
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Ryan Fields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - lib/carry_out/error.rb
 - lib/carry_out/plan.rb
 - lib/carry_out/plan_node.rb
+- lib/carry_out/reference.rb
 - lib/carry_out/result.rb
 - lib/carry_out/unit.rb
 - lib/carry_out/unit_error.rb