retriable 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba6b290804243a8b08f6f4542f1516ca38f52205
-  data.tar.gz: 618793b8cdb2566ff83fa037252a17874d490936
+SHA256:
+  metadata.gz: 744d79bd8be89939c6d24deaf7430841d167f62a6eeb98259ea30c8af24c8018
+  data.tar.gz: 68a1900cef5b7d8455786a681660bbe3ab779c1ef9cafb274634c48b234131dc
 SHA512:
-  metadata.gz: bb9a7cc6d5661743f636d8a2aa82d5cc12f03e41e2ffe93721af71081199f696d7cf6d4dcc830da3dc0cf3bd87b0fd9fd43f1f807b173fa4389f00358132cd48
-  data.tar.gz: 6434a4c6910b02caf3f1a8d822ceb543c511168052eb6bcd0e3c496d99931951143946456d212fb0f13193e88724ce7ff3d9cac9f242a8b5910fb8a7a2d225a8
+  metadata.gz: 931cbd73e3d88e47384c1a34faf3deb71a2a87f4ab9dd21a967fb73f1a0a364e7c1b8cd0794dd71821d84a7968d739195561d71bf020bbc27af9af2e26599c1d
+  data.tar.gz: 55e596d2efb08d3cfc4aa2eb88f0db4b51589ae48b3d2ed9af6cc41e2f06ef91085b646f185818dd22474cd60c5ac91ea651fbfb9d08cf63a9e43a21867a3f91

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10

data/.github/workflows/main.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize, reopened]
+
+jobs:
+  ci:
+    # The type of runner that the job will run on
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-24.04]
+        ruby:
+          [
+            "2.3",
+            "2.4",
+            "2.5",
+            "2.6",
+            "2.7",
+            "3.0",
+            "3.1",
+            "3.2",
+            "3.3",
+            "3.4",
+            "4.0",
+            jruby,
+          ]
+    env:
+      CC_TEST_REPORTER_ID: 20a1139ef1830b4f813a10a03d90e8aa179b5226f75e75c5a949b25756ebf558
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v6
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: ruby version
+        run: ruby -v
+
+      - name: Run rspec
+        run: bundle exec rspec

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,22 +1,22 @@
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
 Style/Documentation:
   Enabled: false
 
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
-Style/TrailingCommaInLiteral:
-  EnforcedStyleForMultiline: comma
-
-Style/InheritException:
+Lint/InheritException:
   Enabled: false
 
-Style/IndentArray:
+Layout/FirstArrayElementIndentation:
   Enabled: false
 
-Style/IndentHash:
+Layout/FirstHashElementIndentation:
   Enabled: false
 
 Style/NegatedIf:
@@ -28,8 +28,8 @@ Metrics/ClassLength:
 Metrics/ModuleLength:
   Enabled: false
 
-Metrics/LineLength:
-  Enabled: false
+Layout/LineLength:
+  Max: 120
 
 Metrics/MethodLength:
   Enabled: false
@@ -39,3 +39,6 @@ Metrics/BlockLength:
 
 Metrics/AbcSize:
   Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false

data/CHANGELOG.md

@@ -1,116 +1,141 @@
-## HEAD
+# HEAD
+
+## 3.2.0
+
+- Require ruby 2.3+.
+- Fix: Ensure `tries` value is overridden by `intervals` parameter if both are provided and add a test for this. This is always what the README stated but the code didn't actually do it.
+- Fix: Some rubocop offenses.
+
+## 3.1.2
+
+- Replace `minitest` gem with `rspec`
+- Fancier README
+- Remove unnecessary short circuit in `randomize` method
 
 ## 3.1.1
 
-* Fix typo in contexts exception message.
-* Fix updating the version in the library.
+- Fix typo in contexts exception message.
+- Fix updating the version in the library.
 
 ## 3.1.0
 
-* Added [contexts feature](https://github.com/kamui/retriable#contexts). Thanks to @apurvis.
+- Added [contexts feature](https://github.com/kamui/retriable#contexts). Thanks to @apurvis.
 
 ## 3.0.2
 
-* Add configuration and options validation.
+- Add configuration and options validation.
 
 ## 3.0.1
-* Add `rubocop` linter to enforce coding styles for this library. Also, fix rule violations.
-* Removed `attr_reader :config` that caused a warning. @bruno-
-* Clean up Rakefile testing cruft. @bruno-
-* Use `.any?` in the `:on` hash processing. @apurvis
+
+- Add `rubocop` linter to enforce coding styles for this library. Also, fix rule violations.
+- Removed `attr_reader :config` that caused a warning. @bruno-
+- Clean up Rakefile testing cruft. @bruno-
+- Use `.any?` in the `:on` hash processing. @apurvis
 
 ## 3.0.0
-* Require ruby 2.0+.
-* Breaking Change: `on` with a `Hash` value now matches subclassed exceptions. Thanks @apurvis!
-* Remove `awesome_print` from development environment.
+
+- Require ruby 2.0+.
+- Breaking Change: `on` with a `Hash` value now matches subclassed exceptions. Thanks @apurvis!
+- Remove `awesome_print` from development environment.
 
 ## 2.1.0
 
-* Fix bug #17 due to confusing the initial try as a retry.
-* Switch to `Minitest` 5.6 expect syntax.
+- Fix bug #17 due to confusing the initial try as a retry.
+- Switch to `Minitest` 5.6 expect syntax.
 
 ## 2.0.2
 
-* Change required_ruby_version in gemspec to >= 1.9.3.
+- Change required_ruby_version in gemspec to >= 1.9.3.
 
 ## 2.0.1
 
-* Add support for ruby 1.9.3.
+- Add support for ruby 1.9.3.
 
 ## 2.0.0
 
-* Require ruby 2.0+.
-* Time intervals default to randomized exponential backoff instead of fixed time intervals. The delay between retries grows with every attempt and there's a randomization factor added to each attempt.
-* `base_interval`, `max_interval`, `rand_factor`, and `multiplier` are new arguments that are used to generate randomized exponential back off time intervals.
-* `interval` argument removed.
-* Accept `intervals` array argument to provide your own custom intervals.
-* Allow configurable defaults via `Retriable#configure` block.
-* Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or array of `Regexp` pattern(s) to match against exception messages for retrial.
-* Raise, not return, on max elapsed time.
-* Check for elapsed time after next interval is calculated and it goes over the max elapsed time.
-* Support early termination via `max_elapsed_time` argument.
+- Require ruby 2.0+.
+- Time intervals default to randomized exponential backoff instead of fixed time intervals. The delay between retries grows with every attempt and there's a randomization factor added to each attempt.
+- `base_interval`, `max_interval`, `rand_factor`, and `multiplier` are new arguments that are used to generate randomized exponential back off time intervals.
+- `interval` argument removed.
+- Accept `intervals` array argument to provide your own custom intervals.
+- Allow configurable defaults via `Retriable#configure` block.
+- Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or array of `Regexp` pattern(s) to match against exception messages for retrial.
+- Raise, not return, on max elapsed time.
+- Check for elapsed time after next interval is calculated and it goes over the max elapsed time.
+- Support early termination via `max_elapsed_time` argument.
 
 ## 2.0.0.beta5
-* Change `:max_tries` back to `:tries`.
+
+- Change `:max_tries` back to `:tries`.
 
 ## 2.0.0.beta4
-* Change #retry back to #retriable. Didn't like the idea of defining a method that is also a reserved word.
-* Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or array of `Regexp` pattern(s) to match against exception messages for retrial.
+
+- Change #retry back to #retriable. Didn't like the idea of defining a method that is also a reserved word.
+- Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or array of `Regexp` pattern(s) to match against exception messages for retrial.
 
 ## 2.0.0.beta3
-* Accept `intervals` array argument to provide your own custom intervals.
-* Refactor the exponential backoff code into it's own class.
-* Add specs for exponential backoff, randomization, and config.
+
+- Accept `intervals` array argument to provide your own custom intervals.
+- Refactor the exponential backoff code into it's own class.
+- Add specs for exponential backoff, randomization, and config.
 
 ## 2.0.0.beta2
-* Raise, not return, on max elapsed time.
-* Check for elapsed time after next interval is calculated and it goes over the max elapsed time.
-* Add specs for `max_elapsed_time` and `max_interval`.
+
+- Raise, not return, on max elapsed time.
+- Check for elapsed time after next interval is calculated and it goes over the max elapsed time.
+- Add specs for `max_elapsed_time` and `max_interval`.
 
 ## 2.0.0.beta1
-* Require ruby 2.0+.
-* Default to random exponential backoff, removes the `interval` option. Exponential backoff is configurable via arguments.
-* Allow configurable defaults via `Retriable#configure` block.
-* Change `Retriable.retriable` to `Retriable.retry`.
-* Support early termination via `max_elapsed_time` argument.
+
+- Require ruby 2.0+.
+- Default to random exponential backoff, removes the `interval` option. Exponential backoff is configurable via arguments.
+- Allow configurable defaults via `Retriable#configure` block.
+- Change `Retriable.retriable` to `Retriable.retry`.
+- Support early termination via `max_elapsed_time` argument.
 
 ## 1.4.1
-* Fixes non kernel mode bug. Remove DSL class, move `#retriable` into Retriable module. Thanks @mkrogemann.
+
+- Fixes non kernel mode bug. Remove DSL class, move `#retriable` into Retriable module. Thanks @mkrogemann.
 
 ## 1.4.0
-* By default, retriable doesn't monkey patch `Kernel`. If you want this functionality,
-you can `require 'retriable/core_ext/kernel'.
-* Upgrade minitest to 5.x.
-* Refactor the DSL into it's own class.
+
+- By default, retriable doesn't monkey patch `Kernel`. If you want this functionality,
+  you can `require 'retriable/core_ext/kernel'.
+- Upgrade minitest to 5.x.
+- Refactor the DSL into it's own class.
 
 ## 1.3.3.1
-* Allow sleep parameter to be a proc/lambda to allow for exponential backoff.
+
+- Allow sleep parameter to be a proc/lambda to allow for exponential backoff.
 
 ## 1.3.3
-* sleep after executing the retry block, so there's no wait on the first call (molfar)
+
+- sleep after executing the retry block, so there's no wait on the first call (molfar)
 
 ## 1.3.2
-* Clean up option defaults.
-* By default, rescue StandardError and Timeout::Error instead of [Exception](http://www.mikeperham.com/2012/03/03/the-perils-of-rescue-exception).
+
+- Clean up option defaults.
+- By default, rescue StandardError and Timeout::Error instead of [Exception](http://www.mikeperham.com/2012/03/03/the-perils-of-rescue-exception).
 
 ## 1.3.1
-* Add `rake` dependency for travis-ci.
-* Update gemspec summary and description.
+
+- Add `rake` dependency for travis-ci.
+- Update gemspec summary and description.
 
 ## 1.3.0
 
-* Rewrote a lot of the code with inspiration from [attempt](https://rubygems.org/gems/attempt).
-* Add timeout option to the code block.
-* Include in Kernel by default, but allow require 'retriable/no_kernel' to load a non kernel version.
-* Renamed `:times` option to `:tries`.
-* Renamed `:sleep` option to `:interval`.
-* Renamed `:then` option to `:on_retry`.
-* Removed other callbacks, you can wrap retriable in a begin/rescue/else/ensure block if you need that functionality. It avoids the need to define multiple Procs and makes the code more readable.
-* Rewrote most of the README
+- Rewrote a lot of the code with inspiration from [attempt](https://rubygems.org/gems/attempt).
+- Add timeout option to the code block.
+- Include in Kernel by default, but allow require 'retriable/no_kernel' to load a non kernel version.
+- Renamed `:times` option to `:tries`.
+- Renamed `:sleep` option to `:interval`.
+- Renamed `:then` option to `:on_retry`.
+- Removed other callbacks, you can wrap retriable in a begin/rescue/else/ensure block if you need that functionality. It avoids the need to define multiple Procs and makes the code more readable.
+- Rewrote most of the README
 
 ## 1.2.0
 
-* Forked the retryable-rb repo.
-* Extend the Kernel module with the retriable method so you can use it anywhere without having to include it in every class.
-* Update gemspec, Gemfile, and Raketask.
-* Remove echoe dependency.
+- Forked the retryable-rb repo.
+- Extend the Kernel module with the retriable method so you can use it anywhere without having to include it in every class.
+- Update gemspec, Gemfile, and Raketask.
+- Remove echoe dependency.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"retriable" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["jack@jackchu.com"](mailto:"jack@jackchu.com").

data/Gemfile

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in retriable.gemspec
 gemspec
 
 group :test do
-  # gem "ruby_gntp"
-  gem "codeclimate-test-reporter", require: false
-  gem "minitest-focus"
+  gem "rspec", "~> 3.0"
   gem "simplecov", require: false
 end
 
@@ -16,4 +15,5 @@ end
 
 group :development, :test do
   gem "pry"
+  gem "rake", "~> 13.0"
 end