simple_pipeline 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4a484ac10baf55839867a7e23333575331af1f2
-  data.tar.gz: fa4e96d7ef40d54df3d08b274c167a2c21a1e57d
+  metadata.gz: 6e8e98e95e1f7dbcaa85aa81e4dffaec77bec74f
+  data.tar.gz: 8f2bc427a69debdb7f1f8a54ad8326a489ed8573
 SHA512:
-  metadata.gz: be5125980ed3f7164f294d2db6a431c0f72769af801308ac95654d85e3fb76bcec280d0c092b30b88e6fc37cd3c52eafa0244a7246567a44bf0258dfc3f708aa
-  data.tar.gz: bc1d2a74e196b4101067f409b9d7e0e69c9ea4941814f08fa69776b46ff170423f9b5e853e8cbe6f7b1298758b505c46b230aedf4677e21e6faa0b8ceeeec641
+  metadata.gz: 960562193e326990d0f585313f41fface19e7747c5c6c5c0da95fefb8b95d6f623b4748fca48cf8fd784a869a03fda85adc633ed7cd2f502d4931dc1e90633d8
+  data.tar.gz: 0a0ace2501e408a758045a399c2a869f681c6540c26fcae9d90ce701892c1708aedb9d702743c3cbf0d89542399a597d48c40260dd48d2aa07e90db8750dd9e7

data/README.md

@@ -68,9 +68,34 @@ pipeline.add AlternativePipe.new, :process_method => :invoke # => throws Argumen
 
 The **payload** can be an Array, Hash, or any other Ruby object. Individual pipes have the responsibility to know what to do with the payload that is passed into the ```process``` method.
 
+**SimplePipeline** supports an easy way to validate the contents of the current payload prior to the execution of a pipe. You can use the ```SimplePipeline::Validation``` mixin and specify validation rules via lambdas, which will be checked prior to processing the pipe. If any of the validation rules fail (i.e. the lambda returns false or raises an error), a ```SimplePipeline::Validation::Error``` will be raised.
+
+```ruby
+class ValidatedPipe
+    include SimplePipeline::Validation
+
+    validate ->(x) { x[:a] }            # x[:a] must exist 
+    validate ->(x) { x[:b] == 1 }       # x[:b] must be equal to 1 
+    validate ->(x) { x[:c].nil? }       # x[:c] must not exist
+    validate ->(x) { x[:d][:e] < 5 }    # You can even do complex things like this
+
+    def process (payload)
+        # Do something
+    end
+end
+
+pipeline = SimplePipeline.new
+pipeline.add ValidatedPipe.new
+
+payload = {:a => some_value}
+
+# Will throw a SimplePipeline::Validation::Error because not all validation rules are satisfied
+pipeline.process payload
+```
+
 ## Timeout
 
-You can use the **SimplePipeline::Timeout** mixin to enforce a timeout value (in seconds) for a pipe. If the execution of the ```process``` method exceeds the specified timeout value, a ```Timeout::Error``` will be thrown.
+You can use the ```SimplePipeline::Timeout``` mixin to enforce a timeout value (in seconds) for a pipe. If the execution of the ```process``` method exceeds the specified timeout value, a ```Timeout::Error``` will be thrown.
 
 ```ruby
 class TimeoutPipe

data/lib/simple_pipeline/validation.rb

@@ -17,7 +17,11 @@ class SimplePipeline
 
         def validate (payload)
             self.class.class_variable_get(:@@validations).each do |validation_lambda|
-                raise SimplePipeline::Validation::Error.new "#{self.class} - #{payload}" unless validation_lambda.call(payload)
+                begin
+                    raise SimplePipeline::Validation::Error.new "#{self.class} - #{payload}" unless validation_lambda.call(payload)
+                rescue
+                    raise SimplePipeline::Validation::Error.new "#{self.class} - #{payload}"
+                end
             end
         end
     end

data/lib/simple_pipeline/version.rb

@@ -1,3 +1,3 @@
 class SimplePipeline
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
 end

data/spec/simple_pipeline_spec.rb

@@ -42,8 +42,8 @@ class ValidationPipe
     include SimplePipeline::Validation
 
     validate ->(payload) { payload[:must_exist] }
-    validate ->(payload) { payload[:must_be_false] == false }
     validate ->(payload) { payload[:a][:b] == 1 }
+    validate ->(payload) { payload[:must_be_false] == false }
 
     def process (payload)
         payload[:test_value] *= 10
@@ -149,7 +149,10 @@ describe SimplePipeline do
         pipeline = SimplePipeline.new
         pipeline.add ValidationPipe.new
 
-        payload = {:test_value => 10}
+        payload = {
+            :test_value => 10,
+            :must_exist => "it does"
+        }
 
         expect {
             pipeline.process(payload)
@@ -157,7 +160,7 @@ describe SimplePipeline do
 
         payload = {
             :test_value => 10,
-            :must_exist => "abc",
+            :must_exist => "it does",
             :must_be_false => false,
             :a => {:b => 1}
         }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jonathan Wong