easy_retry 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1628eebabfc2dd25f53d106aa0c665b20c2cc804ee7ff66a7372e784b02594d
-  data.tar.gz: 0a1c561a8b510b25c580f4a6df1e3d2af2b913459c30c8c44d30d7985203bb96
+  metadata.gz: f8a0431c79ed41fca0259b18f9e168981590f4cc6371ab9e87def6539ab973c0
+  data.tar.gz: '08e27ce1c40d16f298e0819bc169030801ab3ca2434f6c23c8af6883c22f4a15'
 SHA512:
-  metadata.gz: 8ace3d6f0a2e94bcc8e29cf04c9bf1b93a8e5e6d17a45c6b21d50d191a3279d50815f7f805aa21665aa114724ea6d064a9ade21e2939582464798ba6d01bf5d9
-  data.tar.gz: 839d5afade1c5e160fb2c7c181f7b952f30bd147246c3956b268ad0039e3343bab1ba8b4a90b197e3cc0565cc193cdce77780c94ec6b8c7147d4ed3eaeda3652
+  metadata.gz: 69451e39a83b916f610693a987de7bbdc5964f28aa2c1cff8bde674b4967c57766b15182d2ab37f54b0ab640d8280b5deb72209ccda0f69e8147dd0dcf7ef358
+  data.tar.gz: 5951fc0c51e11bc8d21a6d729af1c51da95c439e1429b271693e1c7e62b341277beb81ba2a41dfd3085fb8128356cf8a99452671d80a5ae1f301ac7135764483

data/CHANGELOG.md

@@ -1,10 +1,10 @@
 ## [Unreleased]
 
-## [1.0.6] - TBD
+## [Released]
 
-- Allow configuration of logger
+## [1.0.6] - 2022-11-22
 
-## [Released]
+- Allow configuration of logger
 
 ## [1.0.5] - 2022-11-22
 

data/Gemfile

@@ -14,3 +14,5 @@ gem 'rubocop', '~> 1.21'
 gem 'pry'
 
 gem 'simplecov', require: false
+
+gem 'logger'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    easy_retry (1.0.5)
+    easy_retry (1.0.6)
+      logger (~> 1.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +12,7 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     json (2.6.2)
+    logger (1.5.1)
     method_source (1.0.0)
     parallel (1.22.1)
     parser (3.1.2.1)
@@ -62,6 +64,7 @@ PLATFORMS
 
 DEPENDENCIES
   easy_retry!
+  logger
   pry
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -101,6 +101,27 @@ The code above will produce the following output.
   => "This is try number 2"
 ```
 
+## Configuration
+
+You can configure EasyRetry by adding an initializer as follows:
+
+```rb
+  EasyRetry.configure do |config|
+    # configuration options
+  end
+```
+
+### Logger
+
+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
+```
+
+NB: The logger should follow Rails Logger conventions.
+
 ## 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.

data/easy_retry.gemspec

@@ -30,8 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'logger', '~> 1.5.1'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/easy_retry/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module EasyRetry
+  # Configuration class
+  class Configuration
+    attr_accessor :logger
+
+    def initialize
+      @logger = Logger.new($stdout)
+    end
+  end
+end

data/lib/easy_retry/core.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Extend the Numeric class with a #tries method
+class Numeric
+  # rubocop:disable Metrics/MethodLength
+  def tries(rescue_from: [StandardError])
+    raise ArgumentError, 'No block given' unless block_given?
+
+    rescue_from = Array(rescue_from)
+    max_retry = self
+    current_try = 1
+    result = nil
+
+    loop do
+      result = yield(current_try)
+
+      break
+    rescue *rescue_from => e
+      EasyRetry.logger.info "Error: #{e.message} (#{current_try}/#{max_retry})"
+
+      raise if current_try >= max_retry
+
+      sleep current_try * current_try
+
+      current_try += 1
+    end
+
+    result
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  alias try tries
+end

data/lib/easy_retry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyRetry
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/easy_retry.rb

@@ -1,39 +1,22 @@
 # frozen_string_literal: true
 
+require_relative 'easy_retry/core'
 require_relative 'easy_retry/version'
+require_relative 'easy_retry/configuration'
 
-# Extend the Numeric class with a #tries method
-class Numeric
-  # rubocop:disable Metrics/MethodLength
-  def tries(rescue_from: [StandardError])
-    raise ArgumentError, 'No block given' unless block_given?
-
-    rescue_from = Array(rescue_from)
-    max_retry = self
-    current_try = 1
-    result = nil
-
-    loop do
-      result = yield(current_try)
-
-      break
-    rescue *rescue_from => e
-      if defined?(Rails)
-        Rails.logger.error "Error: #{e.message} (#{current_try}/#{max_retry})"
-      else
-        puts "Error: #{e.message} (#{current_try}/#{max_retry})"
-      end
-
-      raise if current_try >= max_retry
-
-      sleep current_try * current_try
+# EasyRetry core module
+module EasyRetry
+  class << self
+    def configuration
+      @configuration ||= EasyRetry::Configuration.new
+    end
 
-      current_try += 1
+    def configure
+      yield(configuration)
     end
 
-    result
+    def logger
+      configuration.logger
+    end
   end
-  # rubocop:enable Metrics/MethodLength
-
-  alias try tries
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_retry
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Robin Goudeketting, Peter Duijnstee
@@ -9,7 +9,21 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2022-11-22 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 description: Easily retry a block of code a predetermined number of times
 email:
 - robin@goudeketting.nl
@@ -29,6 +43,8 @@ files:
 - Rakefile
 - easy_retry.gemspec
 - lib/easy_retry.rb
+- lib/easy_retry/configuration.rb
+- lib/easy_retry/core.rb
 - lib/easy_retry/version.rb
 - sig/easy_retry.rbs
 homepage: https://github.com/GoudekettingRM/easy_retry