def_retry 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc55787b57b63d7d02f818fcc08844d0ff435568
-  data.tar.gz: 81dac9e37930cb37d7de3cfe35da89f97b7e99d1
+  metadata.gz: 506e2b27bc48952be087188682123b8c47f4254f
+  data.tar.gz: c9e8cd16b09b01c64f3a306bddc25a0de38c6c9b
 SHA512:
-  metadata.gz: 487af13048562ddb668f83b5e57e7465368efd4135c05a10d89c487cb82ecdce4d8626011d04606af7fd533127c35fa26019ecbdcba3e53833a1852e1e200ce2
-  data.tar.gz: 4199234a1a2d4ef18302619a48844fadaebb098d9f22b9cf908caa12f83a14f21952fcb99e535b0a3c22b40c0c286b0183ba75e97d612f308ad7fa9571578b8b
+  metadata.gz: 19f1ee109469b9b9032c1b5ce44ea8ef9e934fc6013d90e211ce9738c21b5fbde082308a77188efc05178fd73453d4f955aafc42b27bf60b63100ed1bc6ff8fa
+  data.tar.gz: e74bd32c7a9cd1cb2082730759196cff27cf7d9863b8c98108ed31f1b3d79f3dfdfda972339153c1500d6f4c7bb4dcf5edc7fac89167e0ba5cdb5fa52b36cdf9

data/README.md

@@ -32,22 +32,24 @@ require 'def_retry'
 class ApiWrapper
   include DefRetry
 
-  def_retry :get_data, on: ApiError do
+  def_retry :get_data, on: ApiError do |*args|
     do_api_call
   end
 end
 ```
 
-This will define an instance method named `:get_data` and rescue the exception
+This will define an instance method named `get_data` and rescue the exception
 `ApiError` and retry the block:
 
 ```ruby
-do
+do |*args|
   do_api_call
 end
 ```
 3 times (the default).
 
+Any arguments passed to the `get_data(*args)` method will get passed to the block.
+
 ### Retrying a block of code
 
 ```ruby
@@ -85,21 +87,23 @@ end
 ### Create a Retrier with default options
 
 ```ruby
-require 'def_retry'
-
+# config/intializers/retrier.rb
 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 },
+  on_retry: ->(exception, try_count) { Logger.debug exception },
+  on_ensure: ->(value, try_count) { Logger.debug value, try_count },
   sleep: :exponential,
-
+  re_raise: false
 })
+
+# later...
+Retrier.run { do_api_call }
 ```
 
 ### Options
 
-These apply to `.def_retry`, `#retryable`, and `DefRetry.retry`:
+These apply to `.def_retry`, `#retryable`, `DefRetry.retry`, and `DefRetry::Retrier.new`:
   - `: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`).

data/lib/def_retry.rb

@@ -14,8 +14,8 @@ module DefRetry
 
   module ClassMethods
     def def_retry(name, options = {}, &block)
-      define_method name do
-        DefRetry.retry options, &block
+      define_method name do |*args|
+        DefRetry.retry options.merge(args: args), &block
       end
     end
   end

data/lib/def_retry/retrier.rb

@@ -8,6 +8,7 @@ module DefRetry
     }
 
     def initialize(options)
+      @args      = options.fetch :args, []
       @tries     = options.fetch :tries, DEFAULT_TRIES
       @on_retry  = options.fetch :on_retry, ->(e, n) {}
       @on_ensure = options.fetch :on_ensure, ->(r, n) {}
@@ -17,13 +18,13 @@ module DefRetry
       begin
         @sleep = SLEEP_STRATEGIES.fetch @sleep if @sleep.is_a? Symbol
       rescue KeyError
-        raise ArgumentError, "The :sleep option must be a Proc or one of: #{SLEEP_STRATEGIES.keys.join(', ')}"
+        raise ArgumentError, "The :sleep option must be an Integer, a Proc, or a Symbol: #{SLEEP_STRATEGIES.keys.join(', ')}"
       end
 
       begin
         @exceptions = Array options.fetch(:on)
       rescue KeyError
-        raise ArgumentError, 'You must specify which :exceptions to retry on'
+        raise ArgumentError, 'You must specify which exceptions to retry :on'
       end
     end
 
@@ -32,7 +33,7 @@ module DefRetry
       @return = nil
 
       begin
-        @return = block.call
+        @return = block.call *@args
       rescue *@exceptions => e
         @try_count += 1
         run_sleep_strategy if @sleep

data/lib/def_retry/version.rb

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

data/spec/def_retry_spec.rb

@@ -10,17 +10,15 @@ class MockRetryable
 end
 
 describe DefRetry do
-  let(:mock_retryable) { MockRetryable }
-
   context '.def_retry' do
     it 'defines an instance method' do
-      expect(mock_retryable.new).to respond_to :api_call
+      expect(MockRetryable.new).to respond_to :api_call
     end
   end
 
   context '#retryable' do
     it "returns the block's value" do
-      mocked = mock_retryable.new
+      mocked = MockRetryable.new
       expect(mocked.retryable(on: Exception) { 2 + 2 }).to be 4
     end
   end

data/spec/retrier_spec.rb

@@ -13,7 +13,7 @@ describe DefRetry::Retrier do
   context '#new' do
     it 'requires exceptions to be specified' do
       expect {
-        DefRetry::Retrier.new({}, -> {})
+        DefRetry::Retrier.new({})
       }.to raise_error ArgumentError
     end
 
@@ -97,7 +97,7 @@ describe DefRetry::Retrier do
 
       retrier.run &block_exception
       expect(@exception).to be_kind_of Exception
-      expect(@retry_count).to be 3 # default limit
+      expect(@retry_count).to be 3 # default :tries
     end
 
     it 'passes the return value and retry count to on_ensure' do
@@ -111,7 +111,7 @@ describe DefRetry::Retrier do
 
       retrier.run { :ran }
       expect(@value).to be :ran
-      expect(@retry_count).to be 0 # default limit
+      expect(@retry_count).to be 0
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: def_retry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Diego Salazar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: The Retry Pattern in a gem.