rspec-retry 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f84a3f3775b6c16acbc11baa98c1920f6465dd6
-  data.tar.gz: bf3b2b1fb8d7173d336c68987f29a4b8927a40bf
+  metadata.gz: 1db7f147ccb0d1a7fbb75a43d92110234719c60f
+  data.tar.gz: a544084a1ef008516ed74d783dca544729bd087e
 SHA512:
-  metadata.gz: 97b01e500f2413ddcb66c94abc0b168dbace57d96685f76540f5d6ca443bbed7b673261165e052cb432ba80e40cd79ec3007e5136c12905295d96ea2e125eb26
-  data.tar.gz: 76c096d54dac36b2383acfb7fac67222f5eb481cfd15af1193c1c23407e9b9960e552a20f678acde34ebc5021da7a98d0f238ab3c8bb67d7419593cb32ac868d
+  metadata.gz: 799571f04199b51356a85617e9cb6fb1a5bc9a7b0e745ed2449b43640e7849859da8a2caf94a0ca3a37a6b36b4f6983ee13bc416c8c126c036d04930d755e459
+  data.tar.gz: 517dcc387d8bf603bda9cbdb6bf8fd631f7b31d5f6e13aecdb07f89d25c5af3adf17ea241dd74f1e9767e356e4239ba5e7b4493326a2808bf3ddebb0939034f1

data/README.md

@@ -1,8 +1,8 @@
 # RSpec::Retry
 
-RSpec::Retry adds ``:retry`` option to rspec example.
-It is for randomly failing example.
-If example has ``:retry``, rspec retry specified times until success.
+RSpec::Retry adds a ``:retry`` option for intermittently failing rspec examples.
+If an example has the ``:retry`` option, rspec will retry the example the
+specified number of times until the example succeeds.
 
 ## Installation
 
@@ -32,12 +32,12 @@ end
 ## Usage
 
 ```ruby
-it 'should randomly success', :retry => 3 do
-  rand(2).should == 1
+it 'should randomly succeed', :retry => 3 do
+  expect(rand(2)).to eq(1)
 end
 
-it 'should succeed after a while', :retry => 3, :retry_wait=>10 do
-  command('service myservice status').should == 'started'
+it 'should succeed after a while', :retry => 3, :retry_wait => 10 do
+  expect(command('service myservice status')).to eq('started')
 end
 # run spec (following log is shown if verbose_retry options is true)
 # RSpec::Retry: 2nd try ./spec/lib/random_spec.rb:49
@@ -47,9 +47,10 @@ end
 ## Configuration
 
 - __:verbose_retry__(default: *false*) Print retry status
-- __:default_retry_count__(default: *1*) If retry count is not set in example, this value is used by default
-- __:retry_wait__(default: *0*) Seconds to wait between retries
-- __:clear_lets_on_failure__(default: *true*) Clear memoized value for ``let`` before retrying
+- __:default_retry_count__(default: *1*) If retry count is not set in an example, this value is used by default
+- __:default_sleep_interval__(default: *0*) Seconds to wait between retries
+- __:clear_lets_on_failure__(default: *true*) Clear memoized values for ``let``s before retrying
+- __:exceptions_to_retry__(default: *[]*) List of exceptions that will trigger a retry (when empty, all exceptions will)
 
 ## Contributing
 
@@ -57,4 +58,4 @@ end
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create a pull request

data/lib/rspec/retry.rb

@@ -10,6 +10,12 @@ module RSpec
         config.add_setting :default_retry_count, :default => 1
         config.add_setting :default_sleep_interval, :default => 0
         config.add_setting :clear_lets_on_failure, :default => true
+        # If a list of exceptions is provided and 'retry' > 1, we only retry if
+        # the exception that was raised by the example is in that list. Otherwise
+        # we ignore the 'retry' value and fail immediately.
+        #
+        # If no list of exceptions is provided and 'retry' > 1, we always retry.
+        config.add_setting :exceptions_to_retry, :default => []
 
         # context.example is deprecated, but RSpec.current_example is not
         # available until RSpec 3.0.
@@ -20,6 +26,7 @@ module RSpec
           example = fetch_current_example.call(self)
           retry_count = ex.metadata[:retry] || RSpec.configuration.default_retry_count
           sleep_interval = ex.metadata[:retry_wait] || RSpec.configuration.default_sleep_interval
+          exceptions_to_retry = ex.metadata[:exceptions_to_retry] || RSpec.configuration.exceptions_to_retry
 
           clear_lets = ex.metadata[:clear_lets_on_failure]
           clear_lets = RSpec.configuration.clear_lets_on_failure if clear_lets.nil?
@@ -37,6 +44,10 @@ module RSpec
 
             break if example.exception.nil?
 
+            if exceptions_to_retry.any?
+              break unless exceptions_to_retry.include?(example.exception.class)
+            end
+
             self.clear_lets if clear_lets
             sleep sleep_interval if sleep_interval.to_i > 0
           end

data/lib/rspec/retry/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   class Retry
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/rspec-retry.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/rspec/retry/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Yusuke Mito"]
   gem.email         = ["y310.1984@gmail.com"]
-  gem.description   = %q{retry randomly failing example}
-  gem.summary       = %q{retry randomly failing example}
+  gem.description   = %q{retry intermittently failing rspec examples}
+  gem.summary       = %q{retry intermittently failing rspec examples}
   gem.homepage      = "http://github.com/y310/rspec-retry"
 
   gem.files         = `git ls-files`.split($\)
@@ -14,7 +14,12 @@ Gem::Specification.new do |gem|
   gem.name          = "rspec-retry"
   gem.require_paths = ["lib"]
   gem.version       = RSpec::Retry::VERSION
-  gem.add_runtime_dependency %{rspec}
+  gem.add_runtime_dependency %{rspec-core}
+  gem.add_development_dependency %q{rspec}
   gem.add_development_dependency %q{guard-rspec}
-  gem.add_development_dependency %q{pry-debugger}
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2')
+    gem.add_development_dependency %q{pry-debugger}
+  else
+    gem.add_development_dependency %q{pry-byebug}
+  end
 end

data/spec/lib/rspec/retry_spec.rb

@@ -21,7 +21,7 @@ describe RSpec::Retry do
 
   context 'no retry option' do
     it 'should work' do
-      true.should be true
+      expect(true).to be(true)
     end
   end
 
@@ -32,8 +32,8 @@ describe RSpec::Retry do
       before(:all) { set_expectations([false, false, true]) }
 
       it 'should run example until :retry times', :retry => 3 do
-        true.should == shift_expectation
-        count.should == 3
+        expect(true).to be(shift_expectation)
+        expect(count).to eq(3)
       end
     end
 
@@ -41,8 +41,24 @@ describe RSpec::Retry do
       before(:all) { set_expectations([false, true, false]) }
 
       it 'should stop retrying if  example is succeeded', :retry => 3 do
-        true.should == shift_expectation
-        count.should == 2
+        expect(true).to be(shift_expectation)
+        expect(count).to eq(2)
+      end
+    end
+
+    describe "with a list of exceptions", :retry => 2, :exceptions_to_retry => [NoMethodError] do
+      context "the example throws an exception contained in the retry list" do
+        it "retries the maximum number of times" do
+          raise NoMethodError unless count > 1
+          expect(count).to eq(2)
+        end
+      end
+
+      context "the example fails (with an exception not in the retry list)" do
+        it "only runs once" do
+          set_expectations([false])
+          expect(count).to eq(1)
+        end
       end
     end
   end
@@ -59,11 +75,11 @@ describe RSpec::Retry do
     end
 
     it 'should clear the let when the test fails so it can be reset', :retry => 2 do
-      let_based_on_control.should == false
+      expect(let_based_on_control).to be(false)
     end
 
     it 'should not clear the let when the test fails', :retry => 2, :clear_lets_on_failure => false do
-      let_based_on_control.should == !@control
+      expect(let_based_on_control).to be(!@control)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 require 'rspec'
 require 'rspec/retry'
-require 'pry-debugger'
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2')
+  require "pry-debugger"
+else
+  require "pry-byebug"
+end
 
 RSpec.configure do |config|
   config.verbose_retry = true

metadata

@@ -1,65 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: rspec-retry
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yusuke Mito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   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'
 - !ruby/object:Gem::Dependency
-  name: pry-debugger
+  name: pry-byebug
   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: retry randomly failing example
+description: retry intermittently failing rspec examples
 email:
 - y310.1984@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -80,20 +94,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: retry randomly failing example
+summary: retry intermittently failing rspec examples
 test_files:
 - spec/lib/rspec/retry_spec.rb
 - spec/spec_helper.rb
+has_rdoc: