simple_pipeline 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 677d2ff5729eb15c9fd13f634606d462279001de
-  data.tar.gz: 781a8d2a9772234ce73be2ba1d42c87b75ff6ecc
+  metadata.gz: a4a484ac10baf55839867a7e23333575331af1f2
+  data.tar.gz: fa4e96d7ef40d54df3d08b274c167a2c21a1e57d
 SHA512:
-  metadata.gz: 4545e19ba08add3987a1cd729c478917098d754df9557a3fe79f15309df96fa40a71c4a6ffe9fc5b8f0c20c68bded8a00adb3f7800ebf617ef9d69e8b9499e56
-  data.tar.gz: 84e0c38fa8984b5843c861d6f5fcffd3ed4053cce508273d4b6fb483b680b0045c7c8ef5a0e7a3e85041095bde656f5541eb7d692104ffce20f192af2b770437
+  metadata.gz: be5125980ed3f7164f294d2db6a431c0f72769af801308ac95654d85e3fb76bcec280d0c092b30b88e6fc37cd3c52eafa0244a7246567a44bf0258dfc3f708aa
+  data.tar.gz: bc1d2a74e196b4101067f409b9d7e0e69c9ea4941814f08fa69776b46ff170423f9b5e853e8cbe6f7b1298758b505c46b230aedf4677e21e6faa0b8ceeeec641

data/README.md

@@ -32,7 +32,7 @@ payload = {:some_key => some_value}
 pipeline.process payload
 ```
 
-**SimplePipeline** will call the ```process``` method on each of the pipes in the order that they were added to the pipeline.
+**SimplePipeline** will call the ```process``` method on each of the pipes in the order that they were added to the pipeline. As long as the pipes don't maintain state, you can call ```SimplePipeline#process``` as many times as you want, potentially with each run working with a different payload object.
 
 ## Pipes
 
@@ -46,6 +46,24 @@ class Pipe1
 end
 ```
 
+If your object does not have a ```process``` method, you can still use it as a pipe, but you will need to explicitly state the method to invoke when adding the pipe to the pipeline. Likewise, the specified method must accept a single payload argument.
+
+```ruby
+class AlternatePipe
+    def execute (input)
+        # Do something with the input
+    end
+    
+    def invoke (param1, param2)
+        # Do something else
+    end
+end
+
+pipeline.add AlternativePipe.new, :process_method => :execute # => OK
+
+pipeline.add AlternativePipe.new, :process_method => :invoke # => throws ArgumentError
+```
+
 ## Payload
 
 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.
@@ -116,7 +134,11 @@ pipeline.add pipe, :continue_on_error? => [ArgumentError, NameError]
 pipeline.add pipe, :continue_on_error? => Exception
 ```
 
-After the pipeline finishes executing, you can call ```pipeline.errors``` to get an Array of errors that were caught during execution.
+After the pipeline finishes executing, you can call ```SimplePipeline#errors``` to get an Array of errors that were caught during execution. This Array will clear itself if the pipeline is run again.
+
+```ruby
+pipeline.errors # => Array of errors caught during last run
+```
 
 ## Related Projects
 

data/lib/simple_pipeline/validation.rb

@@ -0,0 +1,24 @@
+class SimplePipeline
+    module Validation
+        class Error < StandardError; end
+
+        def self.included (base)
+            base.extend(ClassMethods)
+            base.class_variable_set(:@@validations, [])
+        end
+
+        module ClassMethods
+            def validate (validation_lambda)
+                raise ArgumentException "invalid validation - expect lambda instead of #{validation_lambda.class}" unless (validation_lambda.is_a? Proc) && validation_lambda.lambda?
+
+                self.class_variable_get(:@@validations) << validation_lambda
+            end
+        end
+
+        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)
+            end
+        end
+    end
+end

data/lib/simple_pipeline/version.rb

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

data/lib/simple_pipeline.rb

@@ -1,4 +1,5 @@
 require "simple_pipeline/timeout"
+require "simple_pipeline/validation"
 require "simple_pipeline/version"
 
 
@@ -8,12 +9,12 @@ class SimplePipeline
 
     def initialize
         @pipe_order = []
-        @pipe_config = {}
+        @pipe_options = {}
         @errors = []
     end
 
-    def add (pipe, params = {})
-        process_method = params[:process_method] || :process 
+    def add (pipe, options = {})
+        process_method = options[:process_method] || :process 
 
         begin
             raise ArgumentError, "invalid pipe - incorrect number of arguments for #{process_method}() method (should be 1)" unless pipe.class.instance_method(process_method).arity == 1
@@ -22,7 +23,7 @@ class SimplePipeline
         end
 
         @pipe_order << pipe
-        @pipe_config[pipe] = params
+        @pipe_options[pipe] = options
 
         return pipe
     end
@@ -32,8 +33,11 @@ class SimplePipeline
     end
 
     def process (payload)
+        @errors.clear
+
         @pipe_order.each do |pipe|
             begin
+                validate_payload(pipe, payload)
                 invoke_process_with_timeout(pipe, payload, get_timeout(pipe))
             rescue
                 raise $! unless continue_on_error?($!, pipe)
@@ -47,7 +51,7 @@ class SimplePipeline
     private
 
     def continue_on_error? (e, pipe)
-        config_value = @pipe_config[pipe][:continue_on_error?]
+        config_value = @pipe_options[pipe][:continue_on_error?]
 
         return false if config_value.nil? || config_value == false
         return true if config_value == true
@@ -70,12 +74,16 @@ class SimplePipeline
     end
 
     def get_process_method (pipe)
-        @pipe_config[pipe][:process_method] || :process
+        @pipe_options[pipe][:process_method] || :process
     end
 
     def get_timeout (pipe)
-        timeout = @pipe_config[pipe][:timeout]
+        timeout = @pipe_options[pipe][:timeout]
         timeout = pipe.timeout if timeout.nil? && (pipe.is_a? SimplePipeline::Timeout)
         return timeout 
     end
+
+    def validate_payload (pipe, payload)
+       pipe.validate(payload) if (pipe.is_a? SimplePipeline::Validation) 
+    end
 end

data/spec/simple_pipeline_spec.rb

@@ -38,6 +38,18 @@ class ExceptionPipe
     end
 end
 
+class ValidationPipe
+    include SimplePipeline::Validation
+
+    validate ->(payload) { payload[:must_exist] }
+    validate ->(payload) { payload[:must_be_false] == false }
+    validate ->(payload) { payload[:a][:b] == 1 }
+
+    def process (payload)
+        payload[:test_value] *= 10
+    end
+end
+
 describe SimplePipeline do
     it "should support three normal pipes" do
         pipeline = SimplePipeline.new
@@ -132,4 +144,26 @@ describe SimplePipeline do
 
         expect(payload[:test_value]).to eq 100
     end
+
+    it "should support pipes with payload validation" do
+        pipeline = SimplePipeline.new
+        pipeline.add ValidationPipe.new
+
+        payload = {:test_value => 10}
+
+        expect {
+            pipeline.process(payload)
+        }.to raise_error(SimplePipeline::Validation::Error)
+
+        payload = {
+            :test_value => 10,
+            :must_exist => "abc",
+            :must_be_false => false,
+            :a => {:b => 1}
+        }
+
+        pipeline.process(payload)
+        
+        expect(payload[:test_value]).to eq 100
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jonathan Wong
@@ -53,6 +53,7 @@ files:
 - Rakefile
 - lib/simple_pipeline.rb
 - lib/simple_pipeline/timeout.rb
+- lib/simple_pipeline/validation.rb
 - lib/simple_pipeline/version.rb
 - simple_pipeline.gemspec
 - spec/simple_pipeline_spec.rb