def_retry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 922034268714241a2daa2aa5911a822df72dba30
-  data.tar.gz: be54c004348a1638ea9cca9888b8d4e1a87ee8d7
+  metadata.gz: cc55787b57b63d7d02f818fcc08844d0ff435568
+  data.tar.gz: 81dac9e37930cb37d7de3cfe35da89f97b7e99d1
 SHA512:
-  metadata.gz: 47e8447fb8f53962f7d10000907ea204638871401f3ab461aef45576ea5a312a038d788f1c62295a8707c62bef1fb02e06e041b0a3d344bef81aa4d1b08559d4
-  data.tar.gz: c2ed226eea5e857e3898c372801288c6b4571435b524c63aa0ebd2d25c70e3823a9efe6d70fd17ac5b63bcbc9d0c19cd3e998e5fc5bdd10081184be83421323f
+  metadata.gz: 487af13048562ddb668f83b5e57e7465368efd4135c05a10d89c487cb82ecdce4d8626011d04606af7fd533127c35fa26019ecbdcba3e53833a1852e1e200ce2
+  data.tar.gz: 4199234a1a2d4ef18302619a48844fadaebb098d9f22b9cf908caa12f83a14f21952fcb99e535b0a3c22b40c0c286b0183ba75e97d612f308ad7fa9571578b8b

data/README.md

@@ -82,14 +82,30 @@ DefRetry.retry on: ApiError do
 end
 ```
 
+### Create a Retrier with default options
+
+```ruby
+require 'def_retry'
+
+Retrier = DefRetry::Retrier.new({
+  on: [ApiError, Timeout],
+  tries: 7,
+  on_retry: ->(exception, try_count) { log exception },
+  on_ensure: ->(value, try_count) { log value, try_count },
+  sleep: :exponential,
+
+})
+```
+
 ### Options
 
-These apply to both `.def_retry` and `#retryable`:
-  - `:on`: A single class or an array of exception classes to be rescued
-  - `:tries`: Integer number of maximum retries to run. DefRetry will stop retrying if the retry count reaches this number
-  - `:sleep`: Either a Proc that receives the current try count as its only argument or a Symbol naming one of these sleep strategies: constant, linear, exponential (see: `DefRetry::Retrier::SLEEP_STRATEGIES`)
+These apply to `.def_retry`, `#retryable`, and `DefRetry.retry`:
+  - `:on`: A single class or an array of exception classes to be rescued.
+  - `:tries`: Integer number of maximum retries to run. DefRetry will stop retrying if the retry count reaches this number.
+  - `:sleep`: Either an Integer to pass to `sleep`, a Proc that receives the current try count as its only argument or a Symbol naming one of these sleep strategies: constant, linear, exponential (see: `DefRetry::Retrier::SLEEP_STRATEGIES`).
   - `:on_retry`: A callback to run every time a retry happens i.e. the specified exception(s) are rescued. It will receive the exception that was rescued and the current try count as arguments, respectively.
   - `:on_ensure`: A callback to run at the end before returning the block's value. It will receive the block's return value and the current try count as arguments, respectively.
+  - `:re_raise`: (default true) re raise the exception after done retrying.
 
 ## Contributing
 

data/def_retry.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
 end

data/lib/def_retry/retrier.rb

@@ -35,18 +35,20 @@ module DefRetry
         @return = block.call
       rescue *@exceptions => e
         @try_count += 1
-        sleep @sleep.call(@try_count) if @sleep
+        run_sleep_strategy if @sleep
         @on_retry.call e, @try_count
 
-        if @try_count < @tries
-          retry
-        elsif @re_raise
-          raise e
-        end
+        @try_count < @tries ? retry : (@re_raise and raise)
       ensure
         @on_ensure.call @return, @try_count
         @return
       end
     end
+
+    private
+
+    def run_sleep_strategy
+      sleep @sleep.is_a?(Fixnum) ? @sleep : @sleep.call(@try_count)
+    end
   end
 end

data/lib/def_retry/version.rb

@@ -1,3 +1,3 @@
 module DefRetry
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/retrier_spec.rb

@@ -22,7 +22,7 @@ describe DefRetry::Retrier do
         DefRetry::Retrier.new({
           on: Exception,
           sleep: :invalid
-        }, -> {})
+        })
       }.to raise_error ArgumentError
     end
   end
@@ -32,36 +32,46 @@ describe DefRetry::Retrier do
       the_block = -> { :ran }
       retrier = DefRetry::Retrier.new({
         on: Exception
-      }, the_block)
+      })
 
-      expect(retrier.run).to be :ran
+      expect(retrier.run(&the_block)).to be :ran
     end
 
-    it 'retries on exception :limit times' do
+    it 'retries on exception :tries times' do
       retrier = DefRetry::Retrier.new({
         on: Exception,
-        tries: 2
-      }, block_exception)
+        tries: 2,
+        re_raise: false
+      })
 
-      retrier.run
+      retrier.run &block_exception
       expect(@retries).to be 2
     end
 
+    it 'reraises the exception by default after done retrying' do
+      retrier = DefRetry::Retrier.new({
+        on: Exception
+      })
+
+      expect { retrier.run &block_exception }.to raise_error Exception
+    end
+
     it 'raises unspecified exceptions' do
       retrier = DefRetry::Retrier.new({
         on: ArgumentError
-      }, block_exception)
+      })
 
-      expect { retrier.run }.to raise_error Exception
+      expect { retrier.run &block_exception }.to raise_error Exception
     end
 
     it 'runs an on_retry callback' do
       retrier = DefRetry::Retrier.new({
         on: Exception,
-        on_retry: ->(e, n) { @did_retry = :yes }
-      }, block_exception)
+        on_retry: ->(e, n) { @did_retry = :yes },
+        re_raise: false
+      })
 
-      retrier.run
+      retrier.run &block_exception
       expect(@did_retry).to be :yes
     end
 
@@ -69,9 +79,9 @@ describe DefRetry::Retrier do
       retrier = DefRetry::Retrier.new({
         on: Exception,
         on_ensure: ->(r, n) { @did_ensure = :yes }
-      }, -> {})
+      })
 
-      retrier.run
+      retrier.run {}
       expect(@did_ensure).to be :yes
     end
 
@@ -81,10 +91,11 @@ describe DefRetry::Retrier do
         on_retry: ->(e, r) {
           @exception = e
           @retry_count = r
-        }
-      }, block_exception)
+        },
+        re_raise: false
+      })
 
-      retrier.run
+      retrier.run &block_exception
       expect(@exception).to be_kind_of Exception
       expect(@retry_count).to be 3 # default limit
     end
@@ -96,9 +107,9 @@ describe DefRetry::Retrier do
           @value = v
           @retry_count = r
         }
-      }, -> { :ran })
+      })
 
-      retrier.run
+      retrier.run { :ran }
       expect(@value).to be :ran
       expect(@retry_count).to be 0 # default limit
     end
@@ -111,11 +122,12 @@ describe DefRetry::Retrier do
         sleep: :constant,
         # the 1st retry will sleep for 1 second
         # the 2nd retry will sleep for 1 second
-        tries: 2
-      }, block_exception)
+        tries: 2,
+        re_raise: false
+      })
 
       start_time = Time.now.to_i
-      retrier.run
+      retrier.run &block_exception
       end_time = Time.now.to_i
 
       expect(end_time - start_time).to be 2
@@ -129,11 +141,12 @@ describe DefRetry::Retrier do
         sleep: :linear,
         # the 1st retry will sleep for 1 second
         # the 2nd retry will sleep for 2 seconds, and so on
-        tries: 2
-      }, block_exception)
+        tries: 2,
+        re_raise: false
+      })
 
       start_time = Time.now.to_i
-      retrier.run
+      retrier.run &block_exception
       end_time = Time.now.to_i
 
       expect(end_time - start_time).to be 3
@@ -147,11 +160,12 @@ describe DefRetry::Retrier do
         sleep: :exponential,
         # the 1st retry will sleep for 1**2 == 1 second
         # the 2nd retry will sleep for 2**2 == 4 seconds
-        tries: 2
-      }, block_exception)
+        tries: 2,
+        re_raise: false
+      })
 
       start_time = Time.now.to_i
-      retrier.run
+      retrier.run &block_exception
       end_time = Time.now.to_i
 
       expect(end_time - start_time).to be 5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: def_retry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Diego Salazar
@@ -28,30 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 description: Allows you to define methods that will retry on exception or declare
   blocks of code with retry.
 email: