easy_retry 1.0.7 → 1.0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 830b86bc6808d551a48e8cf1c12618ad9de85798f1528bf99c7cab98a609353a
-  data.tar.gz: 7c633deca8936603e22f2673cf5dde56c5b934565ed04cdf50452e69c2b2688f
+  metadata.gz: 1dd6fbeba47923f12a6c9ec7fce4f67f7369a612790756b1ba2459492282199f
+  data.tar.gz: aecd43808908c13e591ae1b7a248eebe864d2195959f27a39b87e9142075a548
 SHA512:
-  metadata.gz: 57b5e797ced529a355a651b81860377394ce12231435857ebc036b34022b84db369c7338a2a390bdcc8eb2de5fad017f749038c651c034ee5069cbf96bbe507a
-  data.tar.gz: 4ac048a61a96bdee00821f5f9d3109320a519610feb0ba4f060c5358bbd36090d71db1d8c3bbc39a87b23444e7ec3a2af5aac13d77e5cb06d1efe225f9beadda
+  metadata.gz: 172f6145588b03f8240d809e58e9fe390f093f0f81cadb589fa5d50cbf56c0ab2e076446425fb4cf552790eda81338baf796da8b7879e7b71bb7c84e014500b8
+  data.tar.gz: b150f796f511124b0b05abfbc7fa7a6d4c621703d0b1fe6acbc7e141130b9dd44d5215a5210ad438ed6b419b0cb47a88a0ba59128a697c39852a27aeb6c0de5c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Released]
 
+## [1.0.8] - 2022-12-13
+
+- Add delay configuration
+
 ## [1.0.7] - 2022-11-23
 
 - Log the error class rather than `Error`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_retry (1.0.7)
+    easy_retry (1.0.8)
       logger (~> 1.5.1)
 
 GEM
@@ -11,11 +11,11 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    json (2.6.2)
-    logger (1.5.1)
+    json (2.6.3)
+    logger (1.5.2)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -33,11 +33,11 @@ GEM
     rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.40.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -47,7 +47,7 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)

data/README.md

@@ -28,24 +28,24 @@ Or install it yourself as:
 
 If you're not using Bundler, you'll need to require the gem in your code:
 ```rb
-  require 'easy_retry'
+require 'easy_retry'
 ```
 
 ### Basic Example
 
 ```rb
-  4.tries do |try|
-    raise 'Something went wrong' if try < 4
-    puts "Success!"
-  end
+4.tries do |try|
+  raise 'Something went wrong' if try < 4
+  puts "Success!"
+end
 ```
 
 The code above will produce the following output:
 
 ```
-  Error: Something went wrong (1/4)
-  Error: Something went wrong (2/4)
-  Error: Something went wrong (3/4)
+  RuntimeError: Something went wrong (1/4)
+  RuntimeError: Something went wrong (2/4)
+  RuntimeError: Something went wrong (3/4)
   Success!
 ```
 
@@ -54,29 +54,28 @@ The code above will produce the following output:
 Sometimes you want to only retry your code if a specific exception is raised. You can do this by passing a list of exceptions to the #tries method:
 
 ```rb
-  4.tries(rescue_from: [ZeroDivisionError, ArgumentError]) do |try|
-    raise ZeroDivisionError if try < 2
-    raise ActiveRecord::RecordInvalid if try < 4
-    puts "Success!"
-  end
+4.tries(rescue_from: [ZeroDivisionError, ArgumentError]) do |try|
+  raise ZeroDivisionError, 'Whoops' if try < 2
+  raise ActiveRecord::RecordInvalid if try < 4
+  puts "Success!"
+end
 ```
 
 The code above will not rescue from the `ActiveRecord::RecordInvalid` error and produce the following output:
 
 ```
-  Error: ZeroDivisionError (1/4)
+  ZeroDivisionError: Whoops (1/4)
   ActiveRecord::RecordInvalid: Record invalid
-  from (pry):16:in `block in __pry__'
 ```
 
 Passing an array is not necessary if you need to only rescue from a single error
 
 ```rb
-  4.tries(rescue_from: ZeroDivisionError) do |try|
-    raise ZeroDivisionError if try < 2
-    raise ActiveRecord::RecordInvalid if try < 4
-    puts "Success!"
-  end
+4.tries(rescue_from: ZeroDivisionError) do |try|
+  raise ZeroDivisionError if try < 2
+  raise ActiveRecord::RecordInvalid if try < 4
+  puts "Success!"
+end
 ```
 
 This will generate the same output.
@@ -86,19 +85,54 @@ This will generate the same output.
 EasyRetry gives you back the result of the first time the block you passed successfully runs. This can be useful when you need to use the result of the block for other tasks that you do not necessarily want to place in the block.
 
 ```rb
-  result = 2.tries do |try|
-    raise 'Woops' if try < 2
-    "This is try number #{try}"
-  end
+result = 2.tries do |try|
+  raise 'Woops' if try < 2
+  "This is try number #{try}"
+end
 
-  puts result
+puts result
 ```
 
 The code above will produce the following output.
 
 ```
-  Error: Woops (1/2)
-  => "This is try number 2"
+RuntimeError: Woops (1/2)
+=> "This is try number 2"
+```
+
+## Custom delay
+
+EasyRetry allows you to set the delay algorithm you want to use every time you call the `#tries` method. The following predefined options exist: `:none`, `:by_try`, `:default`, `:exponential`.
+
+__*:none*__
+
+After a try fails, EasyRetry will not wait and try again immediately.
+
+__*:by_try*__
+
+After a try fails, EasyRetry will wait an equal amount of seconds to current try that failed. I.e. 1 second for try one, 2 for try two, 3 for try three, etc.
+
+__*:default*__
+
+After a try fails, EasyRetry will wait _n^2_, where _n_ is the current try that failed.
+
+__*:exponential*__
+
+After a try fails, EasyRetry will wait _2^n_, where _n_ is the current try that failed.
+
+### Usage
+You can use the predefined delay algorithms as follows:
+```rb
+3.tries(delay: :none) do
+  raise StandardError
+end
+```
+
+You can also define a custom lambda function if the predefined options are not meeting your needs. You can use it like this:
+```rb
+3.tries(delay: ->(current_try) { sleep current_try * 9.81 }) do
+  raise StandardError
+end
 ```
 
 ## Configuration
@@ -106,9 +140,9 @@ The code above will produce the following output.
 You can configure EasyRetry by adding an initializer as follows:
 
 ```rb
-  EasyRetry.configure do |config|
-    # configuration options
-  end
+EasyRetry.configure do |config|
+  # configuration options
+end
 ```
 
 ### Logger
@@ -116,21 +150,34 @@ You can configure EasyRetry by adding an initializer as follows:
 By default, EasyRetry uses [logger](https://rubygems.org/gems/logger) for logging errors. You can add your custom logger in the configuration using the `config.logger` option.
 
 ```rb
-  # For Example, using Rails.logger
-  config.logger = Rails.logger
+# For Example, using Rails.logger
+config.logger = Rails.logger
 ```
 
 NB: The logger should follow Rails Logger conventions.
 
+### Default Delay Algorithm
+By default the `:default` delay algorithm (_n^2_) is used, what's in a name you could say. You can configure the default delay algorithm through the config as follows:
+
+```rb
+config.delay_algorithm = :default # Or :none, :by_try, :exponential
+```
+
+Of course, also here you can instead use a custom lambda delay:
+
+```rb
+config.delay_algorithm = ->(current_try) { sleep current_try * 9.81 }
+```
+
 ## Retry delay
 
 The delay for each retry is based on the iteration count. The delay after each failed attempt is _n^2_, where _n_ is the current iteration that failed. E.g. after the first try, EasyRetry waits 1 second, after the second try it waits 4 seconds, then 9, then 16, then 25, then 36, etc.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `be rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/easy_retry/configuration.rb

@@ -5,10 +5,11 @@ require 'logger'
 module EasyRetry
   # Configuration class
   class Configuration
-    attr_accessor :logger
+    attr_accessor :logger, :delay_algorithm
 
     def initialize
       @logger = Logger.new($stdout)
+      @delay_algorithm = :default
     end
   end
 end

data/lib/easy_retry/core.rb

@@ -3,7 +3,7 @@
 # Extend the Numeric class with a #tries method
 class Numeric
   # rubocop:disable Metrics/MethodLength
-  def tries(rescue_from: [StandardError])
+  def tries(rescue_from: [StandardError], delay: EasyRetry.delay_algorithm)
     raise ArgumentError, 'No block given' unless block_given?
 
     rescue_from = Array(rescue_from)
@@ -16,11 +16,9 @@ class Numeric
 
       break
     rescue *rescue_from => e
-      EasyRetry.logger.info "#{e.class.name}: #{e.message} (#{current_try}/#{max_retry})"
+      log_failed_try(e, current_try, max_retry)
 
-      raise if current_try >= max_retry
-
-      sleep current_try * current_try
+      call_delay(delay, current_try)
 
       current_try += 1
     end
@@ -30,4 +28,23 @@ class Numeric
   # rubocop:enable Metrics/MethodLength
 
   alias try tries
+
+  private
+
+  def call_delay(delay, current_try)
+    return delay.call(current_try) if delay.is_a?(Proc)
+
+    EasyRetry.delay_options[delay].call(current_try)
+  end
+
+  def log_failed_try(error, current_try, max_retry)
+    message = error.message == error.class.name ? ' ' : ": #{error.message} "
+
+    if current_try >= max_retry
+      EasyRetry.logger.info "FAILED Permanently after #{max_retry} tries; #{error.class.name}#{message}".strip
+      raise
+    else
+      EasyRetry.logger.info "#{error.class.name}#{message}(Try Number #{current_try}/#{max_retry})"
+    end
+  end
 end

data/lib/easy_retry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyRetry
-  VERSION = "1.0.7"
+  VERSION = '1.0.8.1'
 end

data/lib/easy_retry.rb

@@ -18,5 +18,18 @@ module EasyRetry
     def logger
       configuration.logger
     end
+
+    def delay_algorithm
+      configuration.delay_algorithm
+    end
+
+    def delay_options
+      {
+        none: ->(_try_number) {},
+        by_try: ->(try_number) { sleep try_number },
+        default: ->(try_number) { sleep try_number * try_number },
+        exponential: ->(try_number) { sleep 2**try_number }
+      }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_retry
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8.1
 platform: ruby
 authors:
 - Robin Goudeketting, Peter Duijnstee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Easily retry a block of code a predetermined number of times
 email:
 - robin@goudeketting.nl