carry_out 0.2.5 → 0.2.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjE4NTNlZDZmZWRiYTE0NjM5N2IzYzJiMzZhNTg4MTM4YmEyMTUzNQ==
-  data.tar.gz: !binary |-
-    ZTVjYjZiZDgxZDRkZTQ2MWNiYjExZmNkYTI3Y2Q3YzQ3YWI0NjkxNg==
+SHA1:
+  metadata.gz: 97d5a6e2a244532804c0d40120e5e77830799af7
+  data.tar.gz: cf7c9b3f5b5bf11ab0a154899b6d94ebc688b240
 SHA512:
-  metadata.gz: !binary |-
-    OGIyZDgzYTJmNDQyNDQ4MTYzODEyNWNiNGFjMTgzMzcwODIyMDRkZWFhYjQx
-    MmY4NWI5M2I0M2EyODRmZTkyNzYxMTJjZWJjMDgzNzliOTRlMDI0YmRmMzJh
-    YmRiNjc2YjQxMGEwZWIwNDI1NmM0NDAwZTk0ZmIzYzE2ZmExYjA=
-  data.tar.gz: !binary |-
-    OTM3MjE5ZTRjMDkwZjQzODk1NGUwOGJkYTA4ZDU0OGY0MzFlYWM2NGNlYTJi
-    OTVhOWI4NjVjYTBhYTM0MjRlNDRkOGY1ZGFlMTc3Mjg1MzM0ZDI1OWExY2Q0
-    NWI1NGJhZWZhYjUzNWFmNDEwMGQ4ZjQ4ZjUxMjBhMDI1ZmM2M2M=
+  metadata.gz: 7c731815764352c2d284f02274aed7d0a926e45990e48326f6969068bbeacbc2b150047167c6c766746483a1239fa263c73f7c8aa21327d79e32b72bd4b54c0a
+  data.tar.gz: 60d00e1d0e4aee269bd15e1fbf967cb059a0de2a230d18c82fa0920add98dae0c5fbb4792122d1755d915c3f920a4accb2264153cdb562a24721defb10ce2f93

data/.travis.yml

@@ -3,3 +3,7 @@ language: ruby
 rvm:
   - 2.3.1
 before_install: gem install bundler -v 1.12.5
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/README.md

@@ -202,6 +202,22 @@ Passing a plan to `#then` works similar to passing a `CarryOut::Unit` class or i
 
 **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.
 
+### Conditional Units
+
+Use the `if` or `unless` directive to conditionally execute a unit.
+
+```ruby
+plan = CarryOut
+    .will(SayHello)
+    .if { |refs| refs[:audible] }
+```
+
+```ruby
+plan = CarryOut
+    .will(SayHello)
+    .unless { |refs| refs[:silenced] }
+```
+
 ## 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/plan.rb

@@ -28,6 +28,15 @@ module CarryOut
       end
     end
 
+    def if(&block)
+      raise NoMethodError("Conditional execution must be applied to a unit") unless @previously_added_node
+
+      guards = node_meta(@previously_added_node)[:guards] ||= []
+      guards << block
+
+      self
+    end
+
     def will(*args)
       self.then(*args)
     end
@@ -37,6 +46,12 @@ module CarryOut
       self
     end
 
+    def unless(&block)
+      self.if { |refs| !block.call(refs) }
+      
+      self
+    end
+
     def method_missing(method, *args, &block)
       if @previously_added_node
         @previously_added_node.send(method, *args, &block)
@@ -71,16 +86,8 @@ module CarryOut
         id = @initial_node_key
 
         until (node = @nodes[id]).nil? do
-          publish_to = @node_meta[id][:as]
-
-          begin
-            node_result = node.execute(result.artifacts)
-            result.add(publish_to, node_result) unless publish_to.nil?
-          rescue UnitError => error
-            result.add(publish_to || id, CarryOut::Error.new(error.error.message, error.error))
-            break
-          end
-
+          execute_node(node, result) if guard_node(node, result.artifacts)
+          break unless result.success?
           id = node.next
         end
 
@@ -91,10 +98,31 @@ module CarryOut
         result
       end
 
+      def execute_node(node, result)
+        meta = node_meta(node)
+        publish_to = meta[:as]
+
+        begin
+          node_result = node.execute(result.artifacts)
+          result.add(publish_to, node_result) unless publish_to.nil?
+        rescue UnitError => error
+          result.add(publish_to || id, CarryOut::Error.new(error.error.message, error.error))
+        end
+      end
+
       def generate_node_name
         id = @next_node_id ||= 1
         @next_node_id += 1
         "node_#{id}".to_sym
       end
+
+      def guard_node(node, artifacts)
+        guards = node_meta(node)[:guards]
+        guards.nil? || guards.map { |guard| guard.call(artifacts) }.all?
+      end
+
+      def node_meta(node)
+        @node_meta[@nodes.key(node)]
+      end
   end
 end

data/lib/carry_out/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carry_out
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Ryan Fields
@@ -14,70 +14,71 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    CarryOut connects units of logic into workflows.  Each unit can
-  extend\n    the DSL with parameter methods.  Artifacts and errors are collected
-  as\n    the workflow executes and are returned in a result bundle upon completion.\n"
+description: |2
+      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.
 email:
 - ryan.fields@twoleftbeats.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -104,17 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Compose units of logic into an executable workflow.