simple_pipeline 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4919357b1935895facfb4607f74def1253c1dea
-  data.tar.gz: 5dace42d21950ae0f05c21d39d338d09f58d0d2d
+  metadata.gz: '0841cc3eab093abcc6a954e3d24c1153de824d02'
+  data.tar.gz: 46f0b23b29b62843bbefbe73615ac318c1082214
 SHA512:
-  metadata.gz: 51a6fe55e765bd7d78114cc8d3d77aa7eaac165105292e79e57f64f6d80367b7de3173e25591244b4aa9412d0c38ffc88e24926446a2865d037f4efff2bc6f9e
-  data.tar.gz: 6fa5f5a13a1834194fda4cbef8701c80be10817c648d3f97c1d6a5d51417f5b35e247a3d2f6f9a5c54ee1d59085574302976ef19049e75418fa20a9c8572046b
+  metadata.gz: dc93171e985aa842a237ddce20c0ab935d5bcb776a63153e3ca6429018435e8cae0dff833641ea6c39b6c6184d838df00d26610707b80acd731ec762cbe20015
+  data.tar.gz: eb66c3a879ef980ab1679a8e6b5150cc9c0680ac85d6664a1f5d255f40e92fa9a051d4771116a9bc956f143c1459c1657c28e478c36125c6356ed3a78486d143

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--format doc
 --require spec_helper

data/README.md

@@ -90,5 +90,9 @@ pipeline.add pipe2
 ```
 This will override the timeout value set by the class definition.
 
+## Related Projects
+
+* [PiecePipe](https://github.com/atomicobject/piece_pipe), an alternative implementation of the pipeline pattern.
+
 ## License
 **SimplePipeline** is released under the [MIT license](MIT-LICENSE).

data/lib/simple_pipeline/timeout.rb

@@ -17,12 +17,6 @@ class SimplePipeline
             @timeout_in_sec = sec
         end
 
-        def process_with_timeout (payload)
-            ::Timeout::timeout(timeout) {
-                process(payload)
-            }
-        end
-
         def timeout
             @timeout_in_sec || self.class.class_variable_get(:@@timeout_in_sec)
         end

data/lib/simple_pipeline/version.rb

@@ -1,3 +1,3 @@
-class SimplePipeline
-    VERSION = "0.0.3"
-end
+class SimplePipeline
+    VERSION = "0.0.4"
+end

data/lib/simple_pipeline.rb

@@ -1,35 +1,78 @@
-require "simple_pipeline/timeout"
-require "simple_pipeline/version"
-
-
-class SimplePipeline
-    def initialize
-        @pipes = []
-    end
-
-    def add (pipe)
-        begin
-            raise ArgumentError, "invalid pipe - incorrect number of arguments for process() method (should be 1)" unless pipe.class.instance_method(:process).arity == 1
-        rescue NameError
-            raise ArgumentError, "invalid pipe - process() method not found"
-        end
-
-        @pipes << pipe
-    end
-
-    def size
-        return @pipes.size
-    end
-
-    def process (payload)
-        @pipes.each do |pipe|
-            if pipe.is_a? SimplePipeline::Timeout
-                pipe.process_with_timeout(payload)
-            else
-                pipe.process(payload)
-            end
-        end
-    end
-
-    alias :length :size
+require "simple_pipeline/timeout"
+require "simple_pipeline/version"
+
+
+class SimplePipeline
+
+    attr_reader :errors
+
+    def initialize
+        @pipe_order = []
+        @pipe_config = {}
+        @errors = []
+    end
+
+    def add (pipe, args = {})
+        begin
+            raise ArgumentError, "invalid pipe - incorrect number of arguments for process() method (should be 1)" unless pipe.class.instance_method(:process).arity == 1
+        rescue NameError
+            raise ArgumentError, "invalid pipe - process() method not found"
+        end
+
+        @pipe_order << pipe
+        @pipe_config[pipe] = args
+
+        return pipe
+    end
+
+    def size
+        return @pipe_order.size
+    end
+
+    def process (payload)
+        @pipe_order.each do |pipe|
+            begin
+                timeout = @pipe_config[pipe][:timeout]
+
+                if timeout.nil? && (pipe.is_a? SimplePipeline::Timeout)
+                    timeout = pipe.timeout
+                end
+
+                if timeout.nil?
+                    pipe.process(payload)
+                else
+                    process_with_timeout(pipe, payload, timeout)                    
+                end
+            rescue
+                raise $! unless continue_on_error?($!, @pipe_config[pipe][:continue_on_error?])
+                @errors << $!
+            end
+        end
+    end
+
+    alias :length :size
+
+    private
+
+    def continue_on_error? (e, config_value)
+        return false if config_value.nil? || config_value == false
+        return true if config_value == true
+        
+        if (config_value.is_a? Class) && (e.is_a? config_value)
+            return true
+        end
+
+        if config_value.is_a? Array
+            config_value.each { |klass| return true if (klass.is_a? Class) && (e.is_a? klass) }
+        end
+
+        return false
+    end
+
+
+    def process_with_timeout (pipe, payload, timeout)
+        ::Timeout::timeout(timeout) {
+            pipe.process(payload)
+        }
+    end
 end

data/spec/simple_pipeline_spec.rb

@@ -22,6 +22,18 @@ class TimeoutPipe
     end
 end
 
+class TimeoutPipe2
+    def process (payload)
+        sleep 10 # seconds
+    end
+end
+
+class ExceptionPipe
+    def process (payload)
+        raise ArgumentError.new "Something bad happened"
+    end
+end
+
 describe SimplePipeline do
     it "should support three normal pipes" do
         pipeline = SimplePipeline.new
@@ -49,7 +61,7 @@ describe SimplePipeline do
         }.to raise_error(ArgumentError)
     end
 
-    it "should support pipes with timeout" do
+    it "should support pipes with timeout values" do
         pipeline = SimplePipeline.new
         pipe = TimeoutPipe.new
         pipeline.add pipe
@@ -61,5 +73,44 @@ describe SimplePipeline do
         expect {
             pipeline.process({})
         }.to raise_error(Timeout::Error)
+
+        pipeline = SimplePipeline.new
+        pipeline.add TimeoutPipe2.new, :timeout => 1
+
+        expect {
+            pipeline.process({})
+        }.to raise_error(Timeout::Error)
+    end
+
+    it "should support pipes with continue_on_error => true" do
+        pipeline = SimplePipeline.new
+        pipeline.add TestPipe.new
+        pipeline.add ExceptionPipe.new
+        pipeline.add TestPipe.new
+
+        payload = {:test_value => 10}
+
+        expect {
+            pipeline.process(payload)
+        }.to raise_error(ArgumentError)
+
+        expect(payload[:test_value]).to eq 100
+        expect(pipeline.errors.size).to eq 0
+
+        pipeline = SimplePipeline.new
+        pipeline.add TestPipe.new
+        pipeline.add ExceptionPipe.new, :continue_on_error? => true
+        pipeline.add ExceptionPipe.new, :continue_on_error? => ArgumentError
+        pipeline.add ExceptionPipe.new, :continue_on_error? => StandardError
+        pipeline.add ExceptionPipe.new, :continue_on_error? => [ArgumentError]
+        pipeline.add ExceptionPipe.new, :continue_on_error? => [RuntimeError, StandardError]
+        pipeline.add TestPipe.new
+
+        payload = {:test_value => 10}
+
+        pipeline.process(payload)
+
+        expect(payload[:test_value]).to eq 1000
+        expect(pipeline.errors.size).to eq 5
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jonathan Wong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-03 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec