there_was_an_attempt 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e525a2b1fb1e190e2fd35989b49077232c2e996b0b832a25509b6d818ed79e32
-  data.tar.gz: 226466479816e907a096a653c81f3d6dd040d8baeabbf86f0f3bb6698ae69295
+  metadata.gz: 2703f0a8bc92d3f13e8419a4989a7cf3ab9ca20b7f5923bdbb3072459465e348
+  data.tar.gz: b6dc17d9d1476b699bfc3104eb6a21c6c42aed09fadd2b62672ac0d08ace1663
 SHA512:
-  metadata.gz: f2709f0c45a7597f3abf26fa46b5a94ee853749fe9e38179e07bc9238bfeeb9245f8def95f1d2b72c101eea00ce654e580670efca2f0002c3bb516cab7914dff
-  data.tar.gz: cf860e73837100965fe5cfa944c87f1eb39b561fe3ec158a70537621faf06ce25450e010fed6fd4b8f2c2e679f513a9294d18fe81ad05e442f3da53ad27f799f
+  metadata.gz: b6c89412698c889b751d3e4177d10e32b98cc2fa498ad782cbe77923af920b4ac3e75173e9ccf03ba52ba9683bf20b6e41bc597c85ff010a020a3e75200fb8f3
+  data.tar.gz: 7adbd39f2e23b1e5ea1191aa8acbdbb107600f4ad2475cdc2777cca305344591e5b82ca91c8d7abec5c5802d3c4a7519ac99b1a52b902e16f09e1373c4d7ff90

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+2.0.0
+
+  * Added ability to specify a conditional retry, useful for only reattempting when its safe to do so.
+    * By default retries will always be attempted.
+  * Moved to keyword arguments for initialisation to support future features, this is a breaking change.
+  * Organised default arguments for future expansion.
+
 1.0.0
 
   * Initial release to support need for backoff in [Bellroy](https://bellroy.com/) projects.

data/README.md

@@ -1,6 +1,6 @@
 ![There was an attempt](https://user-images.githubusercontent.com/2643026/78128526-ff02ec80-740d-11ea-9226-40b15c437518.png)
 
-# There was an attempt
+# There was an attempt [![Gem Version](https://badge.fury.io/rb/there_was_an_attempt.svg)](https://badge.fury.io/rb/there_was_an_attempt) ![RSpec](https://github.com/samuelgiles/there_was_an_attempt/workflows/RSpec/badge.svg)
 
 A small utility designed to be used alongside [Dry::Monads::Result](https://dry-rb.org/gems/dry-monads/) to repeatedly attempt an operation sleeping between failed attempts.
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-Without any arguments given to the constructor a basic exponential backoff interval (2, 4, 8, 16 to be precise) is used with `sleep` being used to wait, as a nicety this is available as `.attempt`:
+Without any arguments given to the constructor a basic backoff interval (2, 4, 8, 16 to be precise) is used with `sleep` being used to wait, as a nicety this is available as `.attempt`:
 
 ```ruby
 # Shortcut for: ThereWasAnAttempt.new.attempt

data/lib/there_was_an_attempt.rb

@@ -3,12 +3,22 @@
 require 'there_was_an_attempt/version'
 
 class ThereWasAnAttempt
-  BACKOFF_INTERVALS_IN_SECONDS = [2, 4, 8, 16].freeze
-  DEFAULT_WAIT = ->(seconds) { sleep(seconds) }.freeze
+  module Intervals
+    DEFAULT = [2, 4, 8, 16].freeze
+  end
+
+  module Wait
+    WITH_SLEEP = ->(seconds) { sleep(seconds) }.freeze
+  end
 
-  def initialize(intervals = BACKOFF_INTERVALS_IN_SECONDS, wait = DEFAULT_WAIT)
+  module Reattempt
+    ALWAYS = -> (failure) { true }.freeze
+  end
+
+  def initialize(intervals: Intervals::DEFAULT, wait: Wait::WITH_SLEEP, reattempt: Reattempt::ALWAYS)
     @intervals = intervals
     @wait = wait
+    @reattempt = reattempt
   end
 
   def self.attempt(&block)
@@ -18,7 +28,7 @@ class ThereWasAnAttempt
   def attempt(&block)
     @intervals.map do |seconds|
       result = block.call
-      break [result] if result.success?
+      break [result] if result.success? || !reattempt?(result.failure)
 
       result.or { |failure| wait(seconds); Dry::Monads::Failure(failure) }
     end.last
@@ -29,4 +39,8 @@ class ThereWasAnAttempt
   def wait(seconds)
     @wait.call(seconds)
   end
+
+  def reattempt?(failure)
+    @reattempt.call(failure)
+  end
 end

data/lib/there_was_an_attempt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ThereWasAnAttempt
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: there_was_an_attempt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Samuel Giles
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - sam@samuelgil.es
 executables: []
@@ -92,7 +92,7 @@ metadata:
   homepage_uri: https://github.com/samuelgiles/there_was_an_attempt
   source_code_uri: https://github.com/samuelgiles/there_was_an_attempt
   changelog_uri: https://github.com/samuelgiles/there_was_an_attempt/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A small utility to repeatedly attempt an operation sleeping between failed
   attempts.