block_repeater 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94ed1fef785fdbd5a8f8f6810406a6a610be84fd551886b3e8b4784b7f47402
-  data.tar.gz: 4bace96bec87f17aacbc235907af48e5dfd641f1ff2f0c4126b95dff79f04fd1
+  metadata.gz: 338c684e8ff15a822ae560f39d1de4df380f16213bb8f5fb4d1099f98b06f627
+  data.tar.gz: f02a5d355851bf5b1b089bb2a86ff5f4325a76ca260969385aee159fcc0f6e86
 SHA512:
-  metadata.gz: be8d84eacb5b9397e6c47757fb68a06bb4c039cf6632230b68e44abffbb22b6d040b45f5b238220f12d25969e028a80228479f4afb0ba2a9ddebc71bf0ccaa43
-  data.tar.gz: 61437b317664440b00db72f3b8cb3e20d4d3da18281b9c9e6a87252a29200c622036e3bd824b3d077063208b7d6ff07ca4683498bd442fae913a36ce63530afc
+  metadata.gz: 9013a8cb077a212b9896bc30d5a1d6bfc7be81f3655b25562307e369a0a6d125b8aae352a5ff0a15046b8899304d0c79c3bf5bc9e8179681bd38bb8345d32ac8
+  data.tar.gz: 1b53289cec53d69c0b3a9cce35b685567e8780c350a900e58f1abc9c3e17779d3a3528befce6583b506fe20c95a12ae4036a11b20516454a8e756141235fe6b0

data/.github/workflows/gem-push.yml

@@ -3,15 +3,13 @@ name: Ruby Gem
 on:
   push:
     branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [ '3.0', '3.1' ]
+        ruby-version: [ '3.0', '3.1', '3.2' ]
 
     steps:
       - uses: actions/checkout@v2

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+# jetbrains directories
+/.idea
+/.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    block_repeater (1.0.0)
+    block_repeater (1.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -50,6 +50,22 @@ The repeater also takes two parameters:
    repeat (delay: 0.5, times: 10){ call_database_method }.until{ |result| result.count.positive? }
  ```
 
+### Backoff method
+This is a slightly different take on the preferred `repeat` method. It retries a call whilst exponentially increasing the wait time between each iteration until a timeout is reached.
+
+```ruby
+repeat do
+  call_method
+end.until do |result|
+  result
+end.backoff(timeout: 10, initial_wait: 0.5, multiplier: 2)
+```
+
+`backoff` takes three paramaters:
+- `timeout:` is how long you want your repeater to run
+- `initial_wait:` is how long you want to pause before your first retry
+- `multiplier:` is the rate at which you increase the wait time between each iteration
+
 ### Exception Handling
 Using the `catch` method you can define how the repeater should respond to specific exception types. To do this you need to provide a list of exceptions to catch, a block of code which will be performed, and an option for how to trigger than block of code.
 
@@ -82,13 +98,13 @@ You can also define default exception handling behaviour which all repeaters in
 ```ruby
 BlockRepeater::Repeater.default_catch(exceptions: [IOError], behaviour: :defer) do |e|
   puts 'An IOError occurred'
-  e.raise
+  raise e
 end
 ```
 A common use-case for default exception handling is if using a gem such as RSpec, where you may want to handle failed expectations in a uniform manner. To do so you need define the default behaviour first, in a place such as a `env.rb` file or similar:
 ```ruby
 BlockRepeater::Repeater.default_catch(exceptions: [RSpec::Expectations::ExpectationNotMetError], behaviour: :defer) do |e|
-  e.raise
+  raise e
 end
 ```
 Then an RSpec expectation can be used in the block for the `until` method. The expectation will be attempted each try, but the exception will only be raised if it has still failed once the number or attempts has been reached.

data/lib/block_repeater/repeater.rb

@@ -45,8 +45,8 @@ module BlockRepeater
           deferred_exception = nil
         rescue *exception_types => e
           exceptions = if anticipated_exception_types.any? do |ex|
-                            e.class <= ex
-                          end
+            e.class <= ex
+          end
                          @anticipated_exceptions
                        else
                          @@default_exceptions
@@ -72,6 +72,39 @@ module BlockRepeater
       result
     end
 
+    # Retry a call whilst exponentially increasing the wait time between each iteration until a timeout is reached
+    # @param [Integer] `timeout` is the max amount wait of time you wish to try the action
+    # @param [Integer] `initial_wait` is the initial wait time to retry the action
+    # @param [Integer] `multiplier` is the rate at which you increase the wait time between each iteration
+    def backoff(timeout: 10, initial_wait: 0.1, multiplier: 2)
+      raise StandardError, 'Multiplier cannot be less than 1.1' if multiplier < 1.1
+
+      condition_met = nil
+      result = nil
+
+      current_sleep_seconds = initial_wait
+      start_time = Time.now
+
+      until current_sleep_seconds >= timeout
+        result = @repeat_block.call
+        condition_met = @condition_block.call(result) if @condition_block
+
+        duration = Time.now - start_time
+
+        break if condition_met || duration > timeout
+
+        # calculating exponential increase
+        current_sleep_seconds *= multiplier
+        # how long the total duration will be after the next sleep
+        projected_duration = current_sleep_seconds + duration
+        # if projected duration exceeds the timeout, reduce time for next sleep to allow one final call
+        current_sleep_seconds = (timeout - duration) if projected_duration > timeout
+
+        sleep(current_sleep_seconds)
+      end
+      result
+    end
+
     ##
     # Determine how to respond to exceptions raised while repeating, must be called _before_ #until
     #

data/lib/block_repeater/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockRepeater
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: block_repeater
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - William Bray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2026-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Conditionally repeat a block of code