rspec-retry 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 008b1a27e8172edef3f280100e8c09e5ff1de464
-  data.tar.gz: 1f3fd40fb38f9153c54cdef670afbe11c28fef63
+  metadata.gz: 08f3170cb5eb3a96fbf45a6facaac88f02261c99
+  data.tar.gz: a7831c2d528f9fb89f04aba2da2d0caf989741a3
 SHA512:
-  metadata.gz: 40448141b2e12f26154857e1d01405f0f1ea419bd0098d773f5a56f13e566d1d19192e07b23498008c4c248a0de5edf6d397b3a9a9139192417846af1d64d8ea
-  data.tar.gz: be2f5439c48af600527aedb9bce67e846c13a62005eb153aca13ef6279146da41815f6e0520b7d3674e290f8e679ac2134365b53e973c0d678685f878aa2b287
+  metadata.gz: 345abf819be3c81a57da26220b46c6d19441d012350d101ff97ecec3d98e1d6d9f552ecb18e62600827fb3beb76911937a13e15f097ad1338e4a25650e4c7ce0
+  data.tar.gz: 21c46735aac3ae909c27b162b65eff164a4a7bb36233efdf55f65b6fcfbd3bd35a3775b58dbbb5a870ce8c09369559f75ccd52f9eccef90ba00e9ce46fd1693a

data/README.md

@@ -30,6 +30,11 @@ RSpec.configure do |config|
   config.verbose_retry = true
   # show exception that triggers a retry if verbose_retry is set to true
   config.display_try_failure_messages = true
+
+  # run retry only on features
+  config.around :each, :js do |ex|
+    ex.run_with_retry retry: 3
+  end
 end
 ```
 
@@ -48,6 +53,10 @@ end
 # RSpec::Retry: 3rd try ./spec/lib/random_spec.rb:49
 ```
 
+### Calling `run_with_retry` programmatically
+
+You can call `ex.run_with_retry(opts)` on an individual example.
+
 ## Configuration
 
 - __:verbose_retry__(default: *false*) Print retry status

data/changelog.md

@@ -1,3 +1,8 @@
+# 0.4.5 - 2015-11-4
+## enhancements
+retry can be called programmatically (thanks, @dwbutler / #45)
+
+
 # 0.4.4 - 2015-9-9
 ## bugfixes
 fix gem permissions to be readable (thanks @jdelStrother / #42)

data/gemfiles/rspec_3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    rspec-retry (0.4.4)
+    rspec-retry (0.4.5)
       rspec-core
 
 GEM

data/gemfiles/rspec_3.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    rspec-retry (0.4.4)
+    rspec-retry (0.4.5)
       rspec-core
 
 GEM

data/lib/rspec/retry.rb

@@ -4,7 +4,7 @@ require 'rspec_ext/rspec_ext'
 
 module RSpec
   class Retry
-    def self.apply
+    def self.setup
       RSpec.configure do |config|
         config.add_setting :verbose_retry, :default => false
         config.add_setting :default_retry_count, :default => 1
@@ -18,64 +18,114 @@ module RSpec
         # 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.
-        fetch_current_example = RSpec.respond_to?(:current_example) ?
-          proc { RSpec.current_example } : proc { |context| context.example }
-
         config.around(:each) do |ex|
-          example = fetch_current_example.call(self)
+          ex.run_with_retry
+        end
+      end
+    end
+
+    attr_reader :context, :ex
 
-          retry_count = [
-            (
-              ENV['RSPEC_RETRY_RETRY_COUNT'] ||
+    def initialize(ex, opts = {})
+      @ex = ex
+      @ex.metadata.merge!(opts)
+      current_example.attempts ||= 0
+    end
+
+    # context.example is deprecated, but RSpec.current_example is not
+    # available until RSpec 3.0.
+    def current_example
+      RSpec.respond_to?(:current_example) ?
+        RSpec.current_example : @ex.example
+    end
+
+    def retry_count
+      [
+          (
+          ENV['RSPEC_RETRY_RETRY_COUNT'] ||
               ex.metadata[:retry] ||
               RSpec.configuration.default_retry_count
-            ).to_i,
-            1
-          ].max
-
-          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?
-
-          retry_count.times do |i|
-            if RSpec.configuration.verbose_retry?
-              if i > 0
-                message = "RSpec::Retry: #{RSpec::Retry.ordinalize(i + 1)} try #{example.location}"
-                message = "\n" + message if i == 1
-                RSpec.configuration.reporter.message(message)
-              end
-            end
-            example.clear_exception
-            ex.run
-
-            break if example.exception.nil?
-
-            if exceptions_to_retry.any?
-              break unless exceptions_to_retry.any? do |exception_klass|
-                example.exception.is_a?(exception_klass)
-              end
-            end
-
-            if RSpec.configuration.verbose_retry? && RSpec.configuration.display_try_failure_messages?
-              if i != (retry_count-1)
-                try_message = "#{RSpec::Retry.ordinalize(i + 1)} Try error in #{example.location}:\n #{example.exception.to_s} \n"
-                RSpec.configuration.reporter.message(try_message)
-              end
-            end
-
-            self.clear_lets if clear_lets
-            sleep sleep_interval if sleep_interval.to_i > 0
+          ).to_i,
+          1
+      ].max
+    end
+
+    def attempts
+      current_example.attempts ||= 0
+    end
+
+    def attempts=(val)
+      current_example.attempts = val
+    end
+
+    def clear_lets
+      !ex.metadata[:clear_lets_on_failure].nil? ?
+          ex.metadata[:clear_lets_on_failure] :
+          RSpec.configuration.clear_lets_on_failure
+    end
+
+    def sleep_interval
+      ex.metadata[:retry_wait] ||
+          RSpec.configuration.default_sleep_interval
+    end
+
+    def exceptions_to_retry
+      ex.metadata[:exceptions_to_retry] ||
+          RSpec.configuration.exceptions_to_retry
+    end
+
+    def verbose_retry?
+      RSpec.configuration.verbose_retry?
+    end
+
+    def display_try_failure_messages?
+      RSpec.configuration.display_try_failure_messages?
+    end
+
+    def run
+      example = current_example
+
+      loop do
+        if verbose_retry?
+          if attempts > 0
+            message = "RSpec::Retry: #{ordinalize(attempts + 1)} try #{example.location}"
+            message = "\n" + message if attempts == 1
+            RSpec.configuration.reporter.message(message)
           end
         end
+
+        example.clear_exception
+        ex.run
+
+        self.attempts += 1
+
+        break if example.exception.nil?
+
+        break if attempts >= retry_count
+
+        if exceptions_to_retry.any?
+          break unless exceptions_to_retry.any? do |exception_klass|
+            example.exception.is_a?(exception_klass)
+          end
+        end
+
+        if verbose_retry? && display_try_failure_messages?
+          if attempts != (retry_count-1)
+            try_message = "#{ordinalize(attempts + 1)} Try error in #{example.location}:\n #{example.exception.to_s} \n"
+            RSpec.configuration.reporter.message(try_message)
+          end
+        end
+
+        example.example_group_instance.clear_lets if clear_lets
+
+        sleep sleep_interval if sleep_interval.to_i > 0
       end
     end
 
+    private
+
     # borrowed from ActiveSupport::Inflector
-    def self.ordinalize(number)
+    def ordinalize(number)
       if (11..13).include?(number.to_i % 100)
         "#{number}th"
       else
@@ -90,4 +140,4 @@ module RSpec
   end
 end
 
-RSpec::Retry.apply
+RSpec::Retry.setup

data/lib/rspec/retry/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   class Retry
-    VERSION = "0.4.4"
+    VERSION = "0.4.5"
   end
 end

data/lib/rspec_ext/rspec_ext.rb

@@ -1,9 +1,17 @@
 module RSpec
   module Core
     class Example
+      attr_accessor :attempts
+
       def clear_exception
         @exception = nil
       end
+
+      class Procsy
+        def run_with_retry(opts = {})
+          RSpec::Retry.new(self, opts).run
+        end
+      end
     end
   end
 end

data/spec/lib/rspec/retry_spec.rb

@@ -120,4 +120,20 @@ describe RSpec::Retry do
       expect(let_based_on_control).to be(!@control)
     end
   end
+
+  describe 'running example.run_with_retry in an around filter', retry: 2 do
+    before(:each) { count_up }
+    before(:all) do
+      set_expectations([false, false, true])
+    end
+
+    it 'allows retry options to be overridden', :overridden do
+      expect(RSpec.current_example.metadata[:retry]).to eq(3)
+    end
+
+    it 'uses the overridden options', :overridden do
+      expect(true).to be(shift_expectation)
+      expect(count).to eq(3)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -8,4 +8,9 @@ end
 
 RSpec.configure do |config|
   config.verbose_retry = true
+  config.display_try_failure_messages = true
+
+  config.around :each, :overridden do |ex|
+    ex.run_with_retry retry: 3
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-retry
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Yusuke Mito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core