retries 0.0.1 → 0.0.2

data/README.md

@@ -1,11 +1,12 @@
 # Retries
 
-Retries is a small gem that provides a single function, `with_retries`, to evaluate a block with randomized,
+Retries is a gem that provides a single function, `with_retries`, to evaluate a block with randomized,
 truncated, exponential backoff.
 
-There are similar projects out there (see [here](https://github.com/afazio/retry_block) and
-[here](https://bitbucket.org/amanking/retry_this/wiki/Home)) but these will require you to implement the
-backoff scheme yourself. If you don't need randomized exponential backoff, you should check out those gems.
+There are similar projects out there (see [retry_block](https://github.com/afazio/retry_block) and
+[retry_this](https://bitbucket.org/amanking/retry_this/wiki/Home), for example) but these will require you to
+implement the backoff scheme yourself. If you don't need randomized exponential backoff, you should check out
+those gems.
 
 ## Installation
 
@@ -19,7 +20,6 @@ or a flaky service. Here's how you can try it three times before failing:
 
 ``` ruby
 require "retries"
-
 with_retries(:max_tries => 3) { do_the_thing }
 ```
 
@@ -82,6 +82,18 @@ seconds:
 with_retries(:max_tries => 10, :base_sleep_seconds => 0.1, :max_sleep_seconds => 2.0) { do_the_thing }
 ```
 
+### Testing
+
+In tests, you may wish to test that retries are being performed without any delay for sleeping:
+
+``` ruby
+Retries.sleep_enabled = false
+with_retries(:max_tries => 100) { raise "Boo!" } # Now this fails fast
+```
+
+Of course, this will mask any errors to the `:base_sleep_seconds` and `:max_sleep_seconds` parameters, so use
+with caution.
+
 ## Issues
 
 File tickets here on Github.
@@ -93,6 +105,11 @@ To run the tests: first clone the repo, then
     $ bundle install
     $ bundle exec rake test
 
+## Authors
+
+* Harry Robertson
+* Caleb Spare
+
 ## License
 
 Retries is released under the [MIT License](http://opensource.org/licenses/mit-license.php/).

data/lib/retries.rb

@@ -1,5 +1,15 @@
 require "retries/version"
 
+class Retries
+  class << self
+    # You can use this to turn off all sleeping in with_retries. This can be useful in tests. Defaults to
+    # `true`.
+    attr_accessor :sleep_enabled
+  end
+end
+
+Retries.sleep_enabled = true
+
 module Kernel
   # Runs the supplied code block an retries with an exponential backoff.
   #
@@ -36,15 +46,19 @@ module Kernel
     rescue *exception_types_to_rescue => exception
       raise exception if attempts >= max_tries
       handler.call(exception, attempts) if handler
-      # The sleep time is an exponentially-increasing function of base_sleep_seconds. But, it never exceeds
-      # max_sleep_seconds.
-      sleep_seconds = [base_sleep_seconds * (2 ** (attempts - 1)), max_sleep_seconds].min
-      # Randomize to a random value in the range sleep_seconds/2 .. sleep_seconds
-      sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
-      # But never sleep less than base_sleep_seconds
-      sleep_seconds = [base_sleep_seconds, sleep_seconds].max
-      sleep sleep_seconds
+      # Don't sleep at all if sleeping is disabled (used in testing).
+      if Retries.sleep_enabled
+        # The sleep time is an exponentially-increasing function of base_sleep_seconds. But, it never exceeds
+        # max_sleep_seconds.
+        sleep_seconds = [base_sleep_seconds * (2 ** (attempts - 1)), max_sleep_seconds].min
+        # Randomize to a random value in the range sleep_seconds/2 .. sleep_seconds
+        sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
+        # But never sleep less than base_sleep_seconds
+        sleep_seconds = [base_sleep_seconds, sleep_seconds].max
+        sleep sleep_seconds
+      end
       retry
     end
   end
 end
+

data/lib/retries/version.rb

@@ -1,3 +1,3 @@
-module Retries
-  VERSION = "0.0.1"
+class Retries
+  VERSION = "0.0.2"
 end

data/test/retries_test.rb

@@ -1,5 +1,6 @@
 require "scope"
 require "minitest/autorun"
+require "timeout"
 
 $:.unshift File.join(File.dirname(__FILE__), "../lib")
 require "retries"
@@ -8,6 +9,10 @@ class CustomErrorA < RuntimeError; end
 class CustomErrorB < RuntimeError; end
 
 class RetriesTest < Scope::TestCase
+  setup do
+    Retries.sleep_enabled = true
+  end
+
   context "with_retries" do
     should "retry until successful" do
       tries = 0
@@ -69,5 +74,16 @@ class RetriesTest < Scope::TestCase
       assert_equal 4, tries
       assert_equal 3, exception_handler_run_times
     end
+
+    should "not sleep if Retries.sleep_enabled is false" do
+      Retries.sleep_enabled = false
+      assert_raises(RuntimeError) do # If we get a Timeout::Error, this won't pass.
+        Timeout.timeout(2) do
+          with_retries(:max_tries => 10, :base_sleep_seconds => 100, :max_sleep_seconds => 10000) do
+            raise "blah"
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retries
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19157880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19157880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: scope
-  requirement: &19157420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19157420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &19156980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19156980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &19156540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19156540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Retries is a gem for retrying blocks with randomized exponential backoff.
 email:
 - caleb@ooyala.com
@@ -92,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Retries is a gem for retrying blocks with randomized exponential backoff.