easy_retry 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c38067f87c684be6a9f709ec44bd993a6ac511998f0c946747143256d88fbe7c
-  data.tar.gz: a2ffb08ccca6d6a9abea4b4ba962b1fad80f356ec848e468523240edea2cf56c
+  metadata.gz: f8a0431c79ed41fca0259b18f9e168981590f4cc6371ab9e87def6539ab973c0
+  data.tar.gz: '08e27ce1c40d16f298e0819bc169030801ab3ca2434f6c23c8af6883c22f4a15'
 SHA512:
-  metadata.gz: bd8bd03df3327dc40e163bdb594e06e1b5d35da04ec569699a5ded179515ab7e1e2757ab2e204d3bcaa53dff77601dc0924fee4e9e40b195c495f07dd91c9ae1
-  data.tar.gz: fcaae7e8ddfa04c0e58e7511e751feb67c699300b77d1cd52d5f94c3fae18fe872e1b10543d54480ecfe380cbcceb8f20eb708f53b700ee5b32bf8ac78d0b7ef
+  metadata.gz: 69451e39a83b916f610693a987de7bbdc5964f28aa2c1cff8bde674b4967c57766b15182d2ab37f54b0ab640d8280b5deb72209ccda0f69e8147dd0dcf7ef358
+  data.tar.gz: 5951fc0c51e11bc8d21a6d729af1c51da95c439e1429b271693e1c7e62b341277beb81ba2a41dfd3085fb8128356cf8a99452671d80a5ae1f301ac7135764483

data/.rubocop.yml

@@ -4,11 +4,9 @@ AllCops:
 
 Style/StringLiterals:
   Enabled: true
-  EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   Enabled: true
-  EnforcedStyle: double_quotes
 
 Layout/LineLength:
   Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [Released]
+
+## [1.0.6] - 2022-11-22
+
+- Allow configuration of logger
+
+## [1.0.5] - 2022-11-22
+
+- Raise before sleeping to not sleep for try^2 seconds before raising on the last try.
+- Allow passing of single error
+- Expand ReadMe
+
 ## [1.0.4] - 2022-11-17
 
 - Bugfix for EasyRetry to work in Rails _and_ non-Rails projects

data/Gemfile

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in easy_retry.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'
 
-gem "pry"
+gem 'pry'
 
-gem "simplecov", require: false
+gem 'simplecov', require: false
+
+gem 'logger'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    easy_retry (1.0.4)
+    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

@@ -1,5 +1,7 @@
 ![Specs](https://github.com/goudekettingrm/easy_retry/actions/workflows/main.yml/badge.svg)
 
+<a href="https://www.buymeacoffee.com/goudekettingrm" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-blue.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
 # EasyRetry
 
 <i>Easily retry a block of code a predetermined number of times.</i>
@@ -67,6 +69,59 @@ The code above will not rescue from the `ActiveRecord::RecordInvalid` error and
   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
+```
+
+This will generate the same output.
+
+## Block results
+
+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
+
+  puts result
+```
+
+The code above will produce the following output.
+
+```
+  Error: Woops (1/2)
+  => "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.
@@ -79,7 +134,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_retry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/easy_retry/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/GoudekettingRM/easy_retry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/GoudekettingRM/easy_retry/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -87,4 +142,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the EasyRetry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/easy_retry/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the EasyRetry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/GoudekettingRM/easy_retry/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/easy_retry.gemspec

@@ -0,0 +1,37 @@
+# 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']
+
+  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
+end

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.4"
+  VERSION = '1.0.6'
 end

data/lib/easy_retry.rb

@@ -1,38 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "easy_retry/version"
-
-# 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?
-
-    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
-
-      sleep current_try * current_try
-
-      current_try += 1
+require_relative 'easy_retry/core'
+require_relative 'easy_retry/version'
+require_relative 'easy_retry/configuration'
+
+# EasyRetry core module
+module EasyRetry
+  class << self
+    def configuration
+      @configuration ||= EasyRetry::Configuration.new
+    end
 
-      raise e if current_try > max_retry
+    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.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Robin Goudeketting, Peter Duijnstee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
-dependencies: []
+date: 2022-11-22 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
@@ -19,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -26,7 +41,10 @@ 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