pipe-ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a145f9639825143a1da34eba1c5445d795cef91
-  data.tar.gz: f39bf8a5a57a07d07a9fa629c610635c0da72f7b
+  metadata.gz: 3360d89c8d7925a9c69a3fe6e0549722890e1235
+  data.tar.gz: b95e816b5f0a74e3712f3553f8c91f00bb93a0ec
 SHA512:
-  metadata.gz: c9843754ada38925ac8503bac0ea3ac246a7b5a77c16a9a7bd20131a636dc6d979a3cf349e90fd9f7bee9d1e3b8606fd2739a3218dd71643f58d9bd9570a9ba0
-  data.tar.gz: c32f267b6717d7d90f5a8737a7046a029599e2d5e95e673fa3e22dac4b62c81be4089271ad602f678259a9a4e86fc42d229806720c2a5e63259692c8218aeeae
+  metadata.gz: 87cf0cbe09d6660cb55ff502f19d7acf6cac4eb09aa7c89c94e72432fdb8f8cf29df32a9778ff0989f61c837b514c77da8f4868404a2ec039b6af271fcf1e87a
+  data.tar.gz: 221cd32905cfc0081a6b99f27071811140ef5e18800dd6fa46a0f745f46da451d8f719fad15a3087c7994b5a51990878deba4ecea4a87169b8288102d3785809

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -151,26 +151,35 @@ stopped.
 
 ## Skipping / Stopping Execution
 
-Prior to the execution of each method in the `through` array,
-`Pipe::Config#break?` is called with the current value of `subject`. If it
-returns truthy, execution will be stopped and the current value of subject
-will be returned. A falsey response will allow the execution to move forward.
+At the beginning of each iteration, `Pipe::Config#stop_on` is called. If it
+returns truthy, execution will be stopped and the current value of subject will
+be returned. A falsey response will allow the execution to move forward.
 
-If the break test allows us to move forward, `Pipe::Config#skip?` will be called
-with the current value of `subject`. Truthy responses from this method will
-cause the existing value of subject to be carried to the next method without
-executing the current specified method. Falsey responses will allow normal
-execution of the currently specified method.
+If not stopped, `Pipe::Config#skip_on` will be called. Truthy responses will
+cause the current value of subject to be passed to the next iteration without
+calling the method specified in the current iteration. Falsey responses will
+allow the specified method to be called.
 
-## Testing
-
-I'll be adding tests in in the very near future. In the meantime, use at your
-own risk :)
+Both skip_on and stop_on will receive three arguments when they're called, the
+current value of subject, the method to be called on this iteration and the
+value of `#through`.
 
 ## Contributing
 
+First: please check out our [style guides](https://github.com/teamsnap/guides/tree/master/ruby)...
+we will hold you to them :)
+
 1. Fork it ( https://github.com/[my-github-username]/pipe-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+3. Make sure you're green (`bundle exec rspec`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## Testing
+
+`bundle exec rspec`
+
+We like to have good coverage of each major feature. Before contributing with a
+PR, please make sure you've added tests and are fully green.
+

data/lib/pipe/config.rb

@@ -19,28 +19,30 @@ module Pipe
       error_handlers << block if block_given?
     end
 
-    def break?(subj)
-      stop_on.call(subj)
-    rescue ArgumentError
-      stop_on.call
+    def break?(*args)
+      stop_on.call(*args) ? true : false
     end
 
     def raise_on_error?
       raise_on_error ? true : false
     end
 
-    def skip?(subj)
-      skip_on.call(subj)
-    rescue ArgumentError
-      skip_on.call
+    def skip?(*args)
+      skip_on.call(*args) ? true : false
     end
 
     def skip_on=(val)
-      @skip_on = (val.respond_to?(:call) ? val : lambda { |obj| val })
+      @skip_on = as_proc(val)
     end
 
     def stop_on=(val)
-      @stop_on = (val.respond_to?(:call) ? val : lambda { |obj| val })
+      @stop_on = as_proc(val)
+    end
+
+    private
+
+    def as_proc(val)
+      val.respond_to?(:call) ? val : proc { val }
     end
   end
 end

data/lib/pipe/iterator.rb

@@ -31,7 +31,7 @@ module Pipe
       if config.raise_on_error?
         Error.process(
           :data => { :subject => subject },
-          :error => e,
+          :error => error,
           :namespace => IterationError,
         )
       end

data/lib/pipe/reducer.rb

@@ -10,7 +10,7 @@ module Pipe
     def reduce
       through.reduce(subject) { |subj, method|
         begin
-          break subj if config.break?(subj)
+          break subj if config.break?(subj, method, through)
 
           process(subj, method)
         rescue => e
@@ -41,7 +41,7 @@ module Pipe
     end
 
     def process(subj, method)
-      if config.skip?(subj)
+      if config.skip?(subj, method, through)
         subj
       else
         context.send(method, subj)

data/lib/pipe/version.rb

@@ -1,3 +1,3 @@
 module Pipe
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/pipe-ruby.gemspec

@@ -17,7 +17,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = "~> 2.1"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry"
 end

data/spec/pipe/config_spec.rb

@@ -0,0 +1,131 @@
+require "spec_helper"
+
+describe Pipe::Config do
+  describe "defaults" do
+    it "sets error handlers to a blank array" do
+      expect(Pipe::Config.new.error_handlers).to eq([])
+    end
+
+    it "sets raise_on_error to true" do
+      expect(Pipe::Config.new.raise_on_error).to eq(true)
+    end
+
+    it "sets skip_on to a proc which returns false" do
+      expect(Pipe::Config.new.skip_on.call).to eq(false)
+    end
+
+    it "sets stop_on to a proc which returns false" do
+      expect(Pipe::Config.new.stop_on.call).to eq(false)
+    end
+  end
+
+  describe "#error_handler" do
+    context "when passed a block" do
+      it "adds the block to the error_handlers array" do
+        config = Pipe::Config.new
+        block = proc { "error handler" }
+
+        expect{ config.error_handler(&block) }
+          .to change{ config.error_handlers.size }
+          .by(1)
+
+        expect(config.error_handlers.last).to eq(block)
+      end
+    end
+  end
+
+  describe "#break?" do
+    it "returns a truthy version of the result of calling stop_on" do
+      config = Pipe::Config.new(:stop_on => proc { 1 })
+      result = config.break?("")
+      expect(result).to eq(true)
+      config = Pipe::Config.new(:stop_on => proc { nil })
+      result = config.break?("")
+      expect(result).to eq(false)
+    end
+
+    it "passes the first argument to stop_on" do
+      config = Pipe::Config.new
+      arg = Object.new
+
+      expect(config.stop_on).to receive(:call).with(arg)
+      config.break?(arg)
+    end
+  end
+
+  describe "#raise_on_error?" do
+    it "returns a truthy version of raise_on_error" do
+      config = Pipe::Config.new
+      config.raise_on_error = nil
+      expect(config.raise_on_error?).to eq(false)
+      config.raise_on_error = true
+      expect(config.raise_on_error?).to eq(true)
+      config.raise_on_error = "yes"
+      expect(config.raise_on_error?).to eq(true)
+    end
+  end
+
+  describe "#skip?" do
+    it "returns a truthy version of the result of calling skip_on" do
+      config = Pipe::Config.new(:skip_on => proc { 42 })
+      result = config.skip?("", "", "", "")
+      expect(result).to eq(true)
+      config = Pipe::Config.new(:skip_on => proc { false })
+      result = config.skip?("", "", "", "")
+      expect(result).to eq(false)
+    end
+
+    it "passes it's arguments to skip_on" do
+      config = Pipe::Config.new
+
+      expect(config.skip_on).to receive(:call).with(1,2,3,4)
+      config.skip?(1,2,3,4)
+    end
+  end
+
+  describe "#skip_on=" do
+    describe "when the value passed is a proc" do
+      it "assigns the value as is" do
+        val = proc { nil }
+        config = Pipe::Config.new
+
+        config.skip_on = val
+        expect(config.skip_on).to eq(val)
+      end
+    end
+
+    describe "when the value passed is not a proc" do
+      it "wraps the value in a proc prior to assignment" do
+        val = "not a proc"
+        config = Pipe::Config.new
+
+        config.skip_on = val
+        expect(config.skip_on).to be_a(Proc)
+        expect(config.skip_on.call).to eq(val)
+      end
+    end
+  end
+
+  describe "#stop_on=" do
+    describe "when the value passed is a proc" do
+      it "assigns the value as is" do
+        val = proc { nil }
+        config = Pipe::Config.new
+
+        config.stop_on = val
+        expect(config.stop_on).to eq(val)
+      end
+    end
+
+    describe "when the value passed is not a proc" do
+      it "wraps the value in a proc prior to assignment" do
+        val = "not a proc"
+        config = Pipe::Config.new
+
+        config.stop_on = val
+        expect(config.stop_on).to be_a(Proc)
+        expect(config.stop_on.call).to eq(val)
+      end
+    end
+  end
+end

data/spec/pipe/error_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+Namespace = Module.new
+
+describe Pipe::Error do
+  describe ".process" do
+    it "re-renders the error under the namespace passed" do
+      begin
+        begin
+          not_a_method(:boom)
+        rescue => e
+          Pipe::Error.process(:error => e, :namespace => Namespace)
+        end
+      rescue => e
+        @err = e
+      end
+
+      expect(@err.class.name).to eq("Namespace::NoMethodError")
+    end
+
+    it "adds the original error class to the message" do
+      begin
+        begin
+          not_a_method(:boom)
+        rescue => e
+          Pipe::Error.process(:error => e, :namespace => Namespace)
+        end
+      rescue => e
+        @err = e
+      end
+
+      expect(@err.message).to match(Regexp.new("NoMethodError"))
+    end
+
+    it "adds the data passed to the message" do
+      data = {:one => 1, :two => 2}
+      begin
+        begin
+          not_a_method(:boom)
+        rescue => e
+          Pipe::Error.process(
+            :data => data,
+            :error => e,
+            :namespace => Namespace
+          )
+        end
+      rescue => e
+        @err = e
+      end
+
+      expect(@err.message).to match(Regexp.new("#{data}"))
+    end
+  end
+end

data/spec/pipe/iterator_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+describe Pipe::Iterator do
+  describe "#iterate" do
+    it "passes config, context and through to Reducer for each subject" do
+      subjects = [1, 2]
+      config = Pipe::Config.new
+      context = Object.new
+      through = [:to_s, :to_sym]
+      iterator = Pipe::Iterator.new(
+        :config => config,
+        :context => context,
+        :subjects => subjects,
+        :through => through
+      )
+
+      subjects.each do |subject|
+        expect(Pipe::Reducer).to receive(:new).with(
+          :config => config,
+          :context => context,
+          :subject => subject,
+          :through => through
+        ).and_return(double(:reduce => true))
+      end
+
+      iterator.iterate
+    end
+
+    describe "when an error occurs" do
+      describe "and Config#raise_on_error is set to false" do
+        it "does not raise" do
+          dub = Object.new
+          dub.singleton_class.send(:define_method, :reduce) do
+            raise StandardError, "fail"
+          end
+          iterator = Pipe::Iterator.new(
+            :config => Pipe::Config.new(:raise_on_error => false),
+            :context => Object.new,
+            :subjects => [Object.new],
+            :through => [:to_s]
+          )
+          expect(Pipe::Reducer).to receive(:new).and_return(dub)
+
+          expect{ iterator.iterate }.to_not raise_error
+        end
+
+        it "returns an array of the original items" do
+          dub = Object.new
+          dub.singleton_class.send(:define_method, :reduce) do
+            raise StandardError, "fail"
+          end
+          subjects = [Object.new, Object.new]
+          iterator = Pipe::Iterator.new(
+            :config => Pipe::Config.new(:raise_on_error => false),
+            :context => Object.new,
+            :subjects => subjects,
+            :through => [:to_s]
+          )
+          expect(Pipe::Reducer)
+            .to receive(:new)
+            .and_return(dub)
+            .exactly(2).times
+
+          expect(iterator.iterate).to eq(subjects)
+        end
+      end
+
+      describe "and Config#raise_on_error is set to true" do
+        it "raises" do
+          dub = Object.new
+          dub.singleton_class.send(:define_method, :reduce) do
+            raise StandardError, "fail"
+          end
+          iterator = Pipe::Iterator.new(
+            :config => Pipe::Config.new(:raise_on_error => true),
+            :context => Object.new,
+            :subjects => [Object.new],
+            :through => [:to_s]
+          )
+          expect(Pipe::Reducer).to receive(:new).and_return(dub)
+
+          expect{ iterator.iterate }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/pipe/reducer_spec.rb

@@ -0,0 +1,160 @@
+require "spec_helper"
+
+describe Pipe::Reducer do
+  describe "#reduce" do
+    it "calls each method in #through, passing #subject as the first arg" do
+      context = Class.new do
+        def stringify(subj)
+          subj.to_s
+        end
+
+        def symbolize(subj)
+          subj.to_sym
+        end
+      end.new
+      subject = Object.new
+      str_subject = subject.to_s
+      through = [:stringify, :symbolize]
+      reducer = Pipe::Reducer.new(
+        :config => Pipe::Config.new,
+        :context => context,
+        :subject => subject,
+        :through => through
+      )
+
+      expect(subject).to receive(:to_s).and_return(str_subject)
+      expect(str_subject).to receive(:to_sym)
+
+      reducer.reduce
+    end
+
+    it "returns the resulting value" do
+      context = Class.new do
+        def stringify(subj)
+          subj.to_s
+        end
+
+        def symbolize(subj)
+          subj.to_sym
+        end
+      end.new
+      subject = Object.new
+      through = [:stringify, :symbolize]
+      reducer = Pipe::Reducer.new(
+        :config => Pipe::Config.new,
+        :context => context,
+        :subject => subject,
+        :through => through
+      )
+
+      expect(reducer.reduce).to eq(subject.to_s.to_sym)
+    end
+
+    it "breaks when told to and returns the current altered value of subject" do
+      config = Pipe::Config.new(
+        :stop_on => proc { |_, method|
+          method == :downcase
+        }
+      )
+      context = Class.new do
+        def downcase(subj)
+          subj.downcase
+        end
+
+        def stringify(subj)
+          subj.to_s
+        end
+
+        def symbolize(subj)
+          subj.to_sym
+        end
+      end.new
+      subject = Object.new
+      through = [:stringify, :downcase, :symbolize]
+      reducer = Pipe::Reducer.new(
+        :config => config,
+        :context => context,
+        :subject => subject,
+        :through => through
+      )
+
+      expect(reducer.reduce).to eq(subject.to_s)
+    end
+
+    it "skips when told to" do
+      config = Pipe::Config.new(
+        :skip_on => proc { |_, method|
+          method == :downcase
+        }
+      )
+      context = Class.new do
+        def downcase(subj)
+          subj.downcase
+        end
+
+        def stringify(subj)
+          subj.to_s
+        end
+
+        def symbolize(subj)
+          subj.to_sym
+        end
+      end.new
+      subject = Object.new
+      through = [:stringify, :downcase, :symbolize]
+      reducer = Pipe::Reducer.new(
+        :config => config,
+        :context => context,
+        :subject => subject,
+        :through => through
+      )
+
+      expect(reducer.reduce).to eq(subject.to_s.to_sym)
+    end
+
+    it "calls the error handlers when a raise occurs" do
+      handler1 = Proc.new {}
+      handler2 = Proc.new {}
+      config = Pipe::Config.new(:error_handlers => [handler1, handler2])
+      context = Class.new do
+        ExpectedError = Class.new(StandardError)
+
+        def bomb
+          raise ExpectedError, "BOOM!"
+        end
+      end
+
+      expect(handler1).to receive(:call)
+      expect(handler2).to receive(:call)
+
+      expect{
+        Pipe::Reducer.new(
+          :config => config,
+          :context => context,
+          :subject => Object.new,
+          :through => [:bomb]
+        ).reduce
+      }.to raise_error
+    end
+
+    it "honors Config#raise_on_error" do
+      config = Pipe::Config.new(:raise_on_error => false)
+      context = Class.new do
+        AnotherExpectedError = Class.new(StandardError)
+
+        def bomb
+          raise AnotherExpectedError, "BOOM!"
+        end
+      end
+
+      expect{
+        Pipe::Reducer.new(
+          :config => config,
+          :context => context,
+          :subject => Object.new,
+          :through => [:bomb]
+        ).reduce
+      }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "pry"
+require "pipe"
+
+module VerifyAndResetHelpers
+  def verify(object)
+    RSpec::Mocks.proxy_for(object).verify
+  end
+
+  def reset(object)
+    RSpec::Mocks.proxy_for(object).reset
+  end
+end
+
+RSpec.configure do |config|
+  config.order = "random"
+
+  config.include VerifyAndResetHelpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipe-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Matthews
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: ''
 email:
 - oss@teamsnap.com
@@ -46,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -59,6 +88,11 @@ files:
 - lib/pipe/reducer.rb
 - lib/pipe/version.rb
 - pipe-ruby.gemspec
+- spec/pipe/config_spec.rb
+- spec/pipe/error_spec.rb
+- spec/pipe/iterator_spec.rb
+- spec/pipe/reducer_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -69,9 +103,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -83,4 +117,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of the UNIX pipe
-test_files: []
+test_files:
+- spec/pipe/config_spec.rb
+- spec/pipe/error_spec.rb
+- spec/pipe/iterator_spec.rb
+- spec/pipe/reducer_spec.rb
+- spec/spec_helper.rb