carry_out 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15539f051ef8fbb7bde23ab9027e1a309b318eb6
-  data.tar.gz: 75df54ddbd00851be278a80faaa350e2483ad0c5
+  metadata.gz: 4b9327924b9bfe1b3e1bcfcf84d550d9b9128da1
+  data.tar.gz: 5f9be969be455b38060313cf57defaaea7e6b330
 SHA512:
-  metadata.gz: c9df9545f0b391a1f31471ecbc1b85a4f5257fd9399144c75d55643cb787620ac7486dc46de7ee297877779a975b7b3a1817ac14ad62b31172895f9a851c581c
-  data.tar.gz: 33bcc7bc1820b9c2dbd2bd8a084f6a8168d145e854d6ee50ad0fd0ae370ce8a8255ba0a361dadc97201b277353a5b6f1b1d283063d75935f7a3edac6702593dd
+  metadata.gz: 8f1cdd23f90dd6b0a540511597d5873b7b15ab9b395ff6c983add20694ee5b99eaa85da1dd54102d3d8bbad09aca8fd17f238da3c05dfb2b81b32e71fd912314
+  data.tar.gz: cb681e5628b28c3e9d0ba7979f8582379354fb4393113e50b5339803035c5509cdde3e6f34361606b2ef4211b4c98b6454adcc37265cd77e0d2d18e8948246fe

data/README.md

@@ -241,7 +241,7 @@ CarryOut.defaults = {
 }
 ```
 
-#### Magic will\_, then\_, and within\_
+#### will\_, then\_, and within\_ Directives
 
 The magic versions of `will`, `then`, and `within` will use the configured search strategy to convert the remaning portion of the directive into a class reference.
 
@@ -256,7 +256,7 @@ end
 plan = CarryOut.will_say_hello
 ```
 
-#### Magic returning\_as\_
+#### returning\_as\_ Directive
 
 The magic `returning_as_` directive is an alternative to passing the `as:` option to a `will`/`then` directive.  The remainder of the directive becomes the key symbol into which the unit's return value will be stored.
 
@@ -268,6 +268,45 @@ plan = CarryOut
     .message(CarryOut.get(:message))
 ```
 
+#### result\_of\_ Directive
+
+The magic `result_of_` directive is available within blocks passed to parameter methods.  The remainder of the directive becomes the context key symbol from which the value will be retreived.
+
+```ruby
+plan = CarryOut
+  .will_receive_message
+    .returning_as_message
+  .then_log
+    .message { result_of_message }
+    # instead of .message(CarryOut.get(:message)
+    # or .message { |refs| refs.message }
+```
+
+#### Example using all available magic
+
+While a contrived example, the following illustrates the improved readability of a plan when using the magic directives.
+
+```ruby
+plan = CarryOut
+  .within_order_transaction
+      .will_order_bagel
+        .flavored('everything')
+        .toasted
+        .topped_with('butter')
+        .and('strawberry cream cheese')
+        .returning_as_bagel
+      .then_order_coffee
+        .with_cream
+        .and_sugar
+      .then_calculate_order_total
+        .for { result_of_bagel }
+        .and { result_of_coffee }
+      .then_swipe_credit_card
+        .returning_as_cc
+      .then_pay
+        .with_credit_card { result_of_cc }
+```
+
 ## Motivation
 
 I've been trying to keep my Rails controllers clean, but I prefer to avoid shoving inter-model business logic inside database models.  The recommendation I most frequently run into is to move that kind of logic into something akin to service objects.  I like that idea, but I want to keep my services small and composable, and I want to separate the "what" from the "how" of my logic.

data/lib/carry_out/context.rb

@@ -0,0 +1,17 @@
+module CarryOut
+  class Context
+    MATCH_RESULT_METHOD = /^result_of_(.+)/
+
+    def initialize(context)
+      @context = context
+    end
+
+    def method_missing(method, *args, &block)
+      if MATCH_RESULT_METHOD =~ method && args.empty? && block.nil?
+        @context[$1.to_sym]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/carry_out/plan_node.rb

@@ -15,10 +15,6 @@ module CarryOut
       end
     end
 
-    def raises?(klass)
-      @unitClass.raises?(klass)
-    end
-
     def respond_to?(method)
       @unitClass.instance_methods.include?(method) || super
     end
@@ -27,7 +23,13 @@ module CarryOut
       unit = @unitClass.respond_to?(:execute) ? @unitClass : @unitClass.new
 
       @messages.each do |message|
-        arg = message[:block] ? message[:block].call(context) : message[:argument]
+        arg =
+          if message[:block]
+            Context.new(context).instance_exec(context, &message[:block])
+          else
+            message[:argument]
+          end
+
         unit.send(message[:method], arg)
       end
 
@@ -44,13 +46,13 @@ module CarryOut
 
     private
       def append_message(method, *args, &block)
+        if !args.first.nil? && !block.nil?
+          raise ArgumentError.new("Arguments, references, and blocks are mutually exclusive")
+        end
+
         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
+            @messages << { method: method, block: -> (refs) { args.first.call(refs) } }
           else
             @messages << { method: method, argument: args.first || true, block: block }
           end

data/lib/carry_out/version.rb

@@ -1,3 +1,3 @@
 module CarryOut
-  VERSION = "0.2.9"
+  VERSION = "0.2.10"
 end

data/lib/carry_out.rb

@@ -1,5 +1,6 @@
 require "carry_out/version"
 
+require "carry_out/context"
 require "carry_out/error"
 require "carry_out/plan"
 require "carry_out/plan_node"
@@ -58,12 +59,11 @@ module CarryOut
     default_carry_out.send(method, *args, &block)
   end
 
-  private
-    def self.default_options
-      @default_options ||= Hash.new
-    end
+  def self.default_options
+    @default_options ||= Hash.new
+  end
 
-    def self.default_carry_out
-      @default_carry_out ||= ConfiguredCarryOut.new(default_options)
-    end
+  def self.default_carry_out
+    @default_carry_out ||= ConfiguredCarryOut.new(default_options)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carry_out
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Ryan Fields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-26 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - bin/setup
 - carry_out.gemspec
 - lib/carry_out.rb
+- lib/carry_out/context.rb
 - lib/carry_out/error.rb
 - lib/carry_out/plan.rb
 - lib/carry_out/plan_node.rb