carry_out 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 543d46be1752e9734d13693aac9feffc8723eee0
-  data.tar.gz: 03d4914f2f692cde520ee6988098e665ba2d80e5
+  metadata.gz: 470d51ab2b48b338a7a9c74cf337e1a646d5e757
+  data.tar.gz: be8a202ea585bfdc718185e93d7ce3f81605a11e
 SHA512:
-  metadata.gz: ac4aaf4de3a8a1a107cad42305b6b3f40f29059c650b0f7055c653d0c7519b6e5719f334f543f9c0c1113f5528c64a8aa3bc4d5b4e79881a463435d425e0eba2
-  data.tar.gz: 20f606a99d159642d18bc0eefbc47b099de04be5a45264b2059ec008e7391603a81c0cbebcd002eca27a4f96e5556f6755dc2e44375b1a0e9a548a13095efe80
+  metadata.gz: 57f102be31ffdc49a2b846211bc2586a588654b1a3a663b5073ed884cf3a95b81c58ad1b1e9699d0c8baee5fc8ef47f070cebbdb5393cc3f9357db4d85871f88
+  data.tar.gz: 054240040fb465c6ea0e1b8e526c2d7e4a325ad72b373a508e199b42e1fb0035c2ffc713114eefabd2e08687827cb8324898eaeeaa8a104704c82d86171d894c

data/README.md

@@ -2,7 +2,7 @@
 
 CarryOut connects units of logic into workflows.  Each unit can extend the DSL with parameter methods.  Artifacts and errors are collected as the workflow executes and are returned in a result bundle upon completion.
 
-[![Build Status](https://travis-ci.org/ryanfields/carry_out.svg?branch=master)](https://travis-ci.org/ryanfields/carry_out) [![Coverage Status](https://coveralls.io/repos/github/ryanfields/carry_out/badge.svg?branch=master)](https://coveralls.io/github/ryanfields/carry_out?branch=master)
+[![Gem Version](https://badge.fury.io/rb/carry_out.svg)](https://badge.fury.io/rb/carry_out) [![Build Status](https://travis-ci.org/ryanfields/carry_out.svg?branch=master)](https://travis-ci.org/ryanfields/carry_out) [![Coverage Status](https://coveralls.io/repos/github/ryanfields/carry_out/badge.svg?branch=master)](https://coveralls.io/github/ryanfields/carry_out?branch=master)
 
 ## Installation
 
@@ -137,9 +137,23 @@ plan.execute do |result|
 end
 ```
 
-### Wrapping the Execution Context
+### Initial Artifacts
 
-Contexts can be "baked into" a plan for purposes such as ensuring files get closed, or keeping the entire plan within a database transaction.
+`Plan#execute` accepts a hash that will seed the initial result artifacts.
+
+```ruby
+plan = CarryOut
+  .will(SayHello)
+  .to { |refs| refs[:name] }
+
+plan.execute(name: 'John')
+```
+
+### Wrapping Execution
+
+Plan execution can be wrapped for purposes such as ensuring files get closed or to run the plan inside a database transaction.  Wrapping also provides an alternative mechanism for injecting initial artifacts into the plan result.
+
+If `Plan#execute` is passed an initial artifact hash, and a wrapper injects an artifact hash, the two will be merged.  The wrapper hash will get priority.
 
 ```ruby
 class FileContext
@@ -177,16 +191,16 @@ Wrapper contexts will always be applied to an entire plan.  If a plan has multip
 A plan can be used in place of a `CarryOut::Unit`.  This allows plans to be reused as part of larger strategies.
 
 ```ruby
-inner_plan = CarryOut.will(SayHello)
+say_hello = CarryOut.will(SayHello)
 
-outer_plan = CarryOut
+plan = CarryOut
   .will(DisplayBanner)
-  .then(inner_plan)
+  .then(say_hello)
 ```
 
 Passing a plan to `#then` works similar to passing a `CarryOut::Unit` class or instance.  If the `as` option is added, the inner plan's result artifacts will be added to the outer plan's result at the specified key.
 
-**One caveat to be aware of**:  There is no way to specify parameters for an embedded plan.  If an embedded plan depends on an external context, `CarryOut#within` is sufficient to work around this limitation.  However, there is currently no way for an inner plan to access an outer plan's artifacts.  This is considered a bug and will be fixed in a future release.
+**One caveat to be aware of**:  There is no way to specify initial artifacts for an embedded plan.  If an embedded plan depends on an external context, `CarryOut#within` is sufficient to work around this limitation.  However, there is currently no way for an inner plan to access an outer plan's artifacts.  This is considered a bug and will be fixed in a future release.
 
 ## Motivation
 

data/lib/carry_out/plan.rb

@@ -12,19 +12,19 @@ module CarryOut
       end
     end
 
-    def execute(&block)
+    def execute(context = nil, &block)
       if @wrapper
         if @wrapper.respond_to?(:execute)
-          @wrapper.execute do |context|
-            execute_internal(Result.new(context), &block)
+          @wrapper.execute do |wrapper_context|
+            execute_internal(Result.new(context, wrapper_context), &block)
           end
         else
-          @wrapper.call(Proc.new do |context|
-            execute_internal(Result.new(context), &block)
-          end)
+          @wrapper.call(Proc.new { |wrapper_context|
+            execute_internal(Result.new(context, wrapper_context), &block)
+          })
         end
       else
-        execute_internal(&block)
+        execute_internal(Result.new(context), &block)
       end
     end
 

data/lib/carry_out/result.rb

@@ -1,8 +1,8 @@
 module CarryOut
   class Result
 
-    def initialize(hash = nil)
-      @artifacts = Hash[hash] unless hash.nil?
+    def initialize(*args)
+      @artifacts = args.compact.reduce(&:merge) || Hash.new
     end
 
     def add(group, object)

data/lib/carry_out/version.rb

@@ -1,3 +1,3 @@
 module CarryOut
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carry_out
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ryan Fields