easy_retry 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1628eebabfc2dd25f53d106aa0c665b20c2cc804ee7ff66a7372e784b02594d
-  data.tar.gz: 0a1c561a8b510b25c580f4a6df1e3d2af2b913459c30c8c44d30d7985203bb96
+  metadata.gz: 830b86bc6808d551a48e8cf1c12618ad9de85798f1528bf99c7cab98a609353a
+  data.tar.gz: 7c633deca8936603e22f2673cf5dde56c5b934565ed04cdf50452e69c2b2688f
 SHA512:
-  metadata.gz: 8ace3d6f0a2e94bcc8e29cf04c9bf1b93a8e5e6d17a45c6b21d50d191a3279d50815f7f805aa21665aa114724ea6d064a9ade21e2939582464798ba6d01bf5d9
-  data.tar.gz: 839d5afade1c5e160fb2c7c181f7b952f30bd147246c3956b268ad0039e3343bab1ba8b4a90b197e3cc0565cc193cdce77780c94ec6b8c7147d4ed3eaeda3652
+  metadata.gz: 57b5e797ced529a355a651b81860377394ce12231435857ebc036b34022b84db369c7338a2a390bdcc8eb2de5fad017f749038c651c034ee5069cbf96bbe507a
+  data.tar.gz: 4ac048a61a96bdee00821f5f9d3109320a519610feb0ba4f060c5358bbd36090d71db1d8c3bbc39a87b23444e7ec3a2af5aac13d77e5cb06d1efe225f9beadda

data/CHANGELOG.md

@@ -1,10 +1,14 @@
 ## [Unreleased]
 
-## [1.0.6] - TBD
+## [Released]
 
-- Allow configuration of logger
+## [1.0.7] - 2022-11-23
 
-## [Released]
+- Log the error class rather than `Error`.
+
+## [1.0.6] - 2022-11-22
+
+- 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.7)
+      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/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 "#{e.class.name}: #{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.7"
 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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: easy_retry
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Robin Goudeketting, Peter Duijnstee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
-dependencies: []
+date: 2022-11-23 00:00:00.000000000 Z
+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
@@ -27,8 +41,9 @@ files:
 - LICENSE.txt
 - README.md
 - 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

data/easy_retry.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/easy_retry/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'easy_retry'
-  spec.version = EasyRetry::VERSION
-  spec.authors = ['Robin Goudeketting, Peter Duijnstee']
-  spec.email = ['robin@goudeketting.nl']
-
-  spec.summary = 'Easily retry a block of code a predetermined number of times'
-  spec.description = 'Easily retry a block of code a predetermined number of times'
-  spec.homepage = 'https://github.com/GoudekettingRM/easy_retry'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/GoudekettingRM/easy_retry'
-  spec.metadata['changelog_uri'] = 'https://github.com/GoudekettingRM/easy_retry/blob/main/CHANGELOG.md'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = 'exe'
-  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"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end