easy_retry 1.0.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d203deefb007c887481fc2b29f63da4582422c7fc20604acd9c9b88c0092f20c
-  data.tar.gz: 64667abb6f3c5b3ef6a1cefbfe6bb2dbb0de5e0d09ed2b76f31a2a74e591d456
+  metadata.gz: b1628eebabfc2dd25f53d106aa0c665b20c2cc804ee7ff66a7372e784b02594d
+  data.tar.gz: 0a1c561a8b510b25c580f4a6df1e3d2af2b913459c30c8c44d30d7985203bb96
 SHA512:
-  metadata.gz: a6ccf3c01e0b0fc33db703542107377e4c07088d38cd41657bcbd5ee0281098c94f4b93d07b2792e3c349b2030adb1045ea88a4cb56bd51ad4a4aeeee2eb2c2b
-  data.tar.gz: 0bafb03fbf2c70833483f494fd12cfd0b206d38599119568be5a3e70c1f6a7882548315124d7071ef0261d834069e9d0595462468673465e54fadec6182d8ad8
+  metadata.gz: 8ace3d6f0a2e94bcc8e29cf04c9bf1b93a8e5e6d17a45c6b21d50d191a3279d50815f7f805aa21665aa114724ea6d064a9ade21e2939582464798ba6d01bf5d9
+  data.tar.gz: 839d5afade1c5e160fb2c7c181f7b952f30bd147246c3956b268ad0039e3343bab1ba8b4a90b197e3cc0565cc193cdce77780c94ec6b8c7147d4ed3eaeda3652

data/.rubocop.yml

@@ -1,13 +1,12 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  NewCops: enable
+  TargetRubyVersion: 2.6.0
 
 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,25 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-11-17
+## [1.0.6] - TBD
+
+- Allow configuration of logger
+
+## [Released]
+
+## [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
+
+## [1.0.2] - 2022-11-17
+
+- Improve the setup of the project
+
+## [1.0.0] - 2022-11-16
 
 - Initial release

data/Gemfile

@@ -1,12 +1,16 @@
 # 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 'simplecov', require: false

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    easy_retry (1.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  easy_retry!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  simplecov
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -1,3 +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>
@@ -65,6 +69,38 @@ 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"
+```
+
 ## 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.
@@ -77,7 +113,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
 
@@ -85,4 +121,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,38 @@
+# 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

data/lib/easy_retry/version.rb

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

data/lib/easy_retry.rb

@@ -1,28 +1,39 @@
 # frozen_string_literal: true
 
-require_relative "easy_retry/version"
+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?
 
+    rescue_from = Array(rescue_from)
     max_retry = self
     current_try = 1
+    result = nil
 
     loop do
-      yield(current_try)
+      result = yield(current_try)
 
       break
-    rescue *rescue_from => error
-      Rails.logger.error "Error: #{error.message} (#{current_try}/#{max_retry})"
+    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).seconds
+      raise if current_try >= max_retry
 
-      current_try += 1
+      sleep current_try * current_try
 
-      raise error if current_try > max_retry
+      current_try += 1
     end
+
+    result
   end
+  # rubocop:enable Metrics/MethodLength
 
   alias try tries
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_retry
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
 platform: ruby
 authors:
 - Robin Goudeketting, Peter Duijnstee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies: []
 description: Easily retry a block of code a predetermined number of times
 email:
@@ -19,12 +19,15 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- easy_retry.gemspec
 - lib/easy_retry.rb
 - lib/easy_retry/version.rb
 - sig/easy_retry.rbs
@@ -35,6 +38,7 @@ metadata:
   homepage_uri: https://github.com/GoudekettingRM/easy_retry
   source_code_uri: https://github.com/GoudekettingRM/easy_retry
   changelog_uri: https://github.com/GoudekettingRM/easy_retry/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: