attempt 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f4489fdcd16a1e4fd93187cf684afc4eb42b9d1b35987372ce099b0081ab938
-  data.tar.gz: 0d359e069dded75e7e0871c1903f5950275b5f033e22490ea3358c55e8883df0
+  metadata.gz: bc6bbb832eed33acf584990eca716d23081ee12b3a507e6e47d0b8298adae3fa
+  data.tar.gz: 590719816eb1bea8e4e59607f997936eec9303efb5a7507ee11558023f3e2fb7
 SHA512:
-  metadata.gz: 61728e4d946893471d103dfa8f2114212bf9438774b6636cff3744186fe0c99f7e48687969abe8627aa48b4cdb0d7203666978ded8bae2b3ba9d4f1e2616d57b
-  data.tar.gz: a34ac935d3fde78fed37884e93f9019c015a106c15f741732fedd2184c298eb1233ab23f967dfb85bfa6eaf1bb873d6e208730c20cf59cf40bbf101122f5c1a5
+  metadata.gz: 7fe34c159cc36940f05dc8c2108a0b1be600d8c57eacfa4f9d258f2d735fbf21e0524863f3d45568c7074d9ef9825bfe972d1bea102330e0846910dd415478b0
+  data.tar.gz: 61b00a2d427952342b5cf76b2a000691c30a4f341b27a8c150059b4a465701df29904bfd2c5759de97f236156116353f0a97de4695f05ee6f6d6ceee2e8ec98c

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.6.3 - 26-Jun-2024
+* Rubocop cleanup.
+
+## 0.6.2 - 2-Jun-2022
+* The safe_timeout library is not used on MS Windows.
+
 ## 0.6.1 - 20-Oct-2020
 * Switched the README, MANIFEST and CHANGES to markdown format.
 * Fiddling with the .travis.yml file again.

data/Gemfile

@@ -1,8 +1,2 @@
-source 'https://rubygems.org' do
-  gem 'rake'
-  gem 'structured_warnings', '~> 0.4.0'
-  gem 'safe_timeout', '~> 0.0.5'
-  group 'test' do
-    gem 'rspec', '~> 3.9'
-  end
-end
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -1,42 +1,42 @@
-## Description
+[![Ruby](https://github.com/djberg96/attempt/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/attempt/actions/workflows/ruby.yml)
 
+## Description
 A thin wrapper for begin + rescue + sleep + retry.
 
 ## Installation
+`gem install attempt`
 
-gem install attempt   
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/attempt/main/certs/djberg96_pub.pem)`
 
 ## Synopsis
+```ruby
+require 'attempt'
+ 
+# Attempt to ftp to some host, trying 3 times with 30 seconds between
+# attempts before finally raising an error.
 
-```
-  require 'attempt'
-   
-  # Attempt to ftp to some host, trying 3 times with 30 seconds between
-  # attempts before finally raising an error.
+attempt(tries: 3, interval: 30){
+  Net::FTP.open(host, user, passwd){ ... }
+}
  
-  attempt(tries: 3, interval: 30){
-    Net::FTP.open(host, user, passwd){ ... }
-  }
-   
-  # Or, do things the long way...
-  code = Attempt.new do |a|
-    a.tries    = 3
-    a.interval = 30
-  end
-   
-  code.attempt{
-    Net::FTP.open(host, user, passwd){ ... }
-  }
+# Or, do things the long way...
+code = Attempt.new do |a|
+  a.tries    = 3
+  a.interval = 30
+end
+ 
+code.attempt{
+  Net::FTP.open(host, user, passwd){ ... }
+}
 ```
 
 ## Known Bugs
-
 None that I'm aware of. If you find any bugs, please log them on the project page at:
 
 https://github.com/djberg96/attempt
 
 ## Caveats
-
 Use with caution. Specifically, make sure you aren't inadvertantly
 wrapping code that already performs sleep + retry. Otherwise, you'll
 end up with a series of nested retry's that could take much longer to
@@ -49,36 +49,34 @@ As of version 0.3.0, this library requires structured_warnings 0.3.0 or
 later. This is necessary because of changes in Ruby 2.4.
 
 Update: I've switched from the timeout library in the standard library to
-the safe_timeout library which should improve things. In addition, the
-structured_warnings library requirement is now 0.4.0 or later in order to
-work with Ruby 2.7.
+the safe_timeout library on non-Windows platforms which should improve things.
+In addition, the structured_warnings library requirement is now 0.4.0 or later
+in order to work with Ruby 2.7.
 
 ## Future Plans
-
 Add the ability to set an absolute maximum number of seconds to prevent
 nested sleep/retry from delaying attempts longer than expected.
 
 Replace the timeout library with a self selecting pipe if possible.
 
 ## Acknowledgements
-
 This library is partially based on Mark Fowler's 'Attempt' Perl module.
 
-## Warranty
+## See Also
+If you're looking for a heavier but more robust solution designed for remote
+services, please take a look at gems like "circuitbox" or "faulty".
 
+## Warranty
 This package is provided "as is" and without any express or
 implied warranties, including, without limitation, the implied
 warranties of merchantability and fitness for a particular purpose.
 
 ## License
-
 Apache-2.0
 
 ## Copyright
-
-(C) 2006-2020, Daniel J. Berger
+(C) 2006-2022, Daniel J. Berger
 All Rights Reserved
 
 ## Author
-
 Daniel J. Berger

data/Rakefile

@@ -8,7 +8,7 @@ namespace :gem do
   desc 'Build the attempt gem'
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('attempt.gemspec'))
+    spec = Gem::Specification.load('attempt.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end

data/attempt.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'attempt'
-  spec.version    = '0.6.1'
+  spec.version    = '0.6.3'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -13,12 +13,19 @@ Gem::Specification.new do |spec|
   spec.cert_chain = Dir['certs/*']
   
   spec.metadata = {
-    'changelog_uri'   => 'https://github.com/djberg96/attempt/blob/master/CHANGES',
-    'source_code_uri' => 'https://github.com/djberg96/attempt/blob/master/lib/attempt.rb',
-    'bug_tracker_uri' => 'https://github.com/djberg96/attempt/issues',
-    'wiki_uri'        => 'https://github.com/djberg96/attempt/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/attempt',
+    'documentation_uri'     => 'https://github.com/djberg96/attempt/wiki',
+    'changelog_uri'         => 'https://github.com/djberg96/attempt/blob/main/CHANGES.md',
+    'source_code_uri'       => 'https://github.com/djberg96/attempt/blob/main/lib/attempt.rb',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/attempt/issues',
+    'wiki_uri'              => 'https://github.com/djberg96/attempt/wiki',
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/attempt'
   }
 
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rubocop')
+
   spec.add_dependency('structured_warnings', '~> 0.4.0')
   spec.add_dependency('safe_timeout', '~> 0.0.5')
   spec.add_dependency('rspec', '~> 3.9')

data/lib/attempt.rb

@@ -1,12 +1,18 @@
-require 'safe_timeout'
+# frozen_string_literal: true
+
+if File::ALT_SEPARATOR
+  require 'timeout'
+else
+  require 'safe_timeout'
+end
+
 require 'structured_warnings'
 
 # The Attempt class encapsulates methods related to multiple attempts at
 # running the same method before actually failing.
 class Attempt
-
   # The version of the attempt library.
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.6.3'
 
   # Warning raised if an attempt fails before the maximum number of tries
   # has been reached.
@@ -51,7 +57,7 @@ class Attempt
   # * warnings  - Boolean value that indicates whether or not errors are treated as warnings
   #               until the maximum number of attempts has been made. The default is true.
   # * timeout   - Boolean value to indicate whether or not to automatically wrap your
-  #               proc in a SafeTimeout block. The default is false.
+  #               proc in a Timeout/SafeTimeout block. The default is false.
   #
   # Example:
   #
@@ -74,18 +80,18 @@ class Attempt
   # You will not typically use this method directly, but the Kernel#attempt
   # method instead.
   #
-  def attempt
+  def attempt(&block)
     count = 1
     begin
       if @timeout
-        SafeTimeout.timeout(@timeout){ yield }
+        File::ALT_SEPARATOR ? Timeout.timeout(@timeout, &block) : SafeTimeout.timeout(@timeout, &block)
       else
         yield
       end
-    rescue @level => error
+    rescue @level => err
       @tries -= 1
       if @tries > 0
-        msg = "Error on attempt # #{count}: #{error}; retrying"
+        msg = "Error on attempt # #{count}: #{err}; retrying"
         count += 1
         warn Warning, msg if @warnings
 
@@ -102,30 +108,31 @@ class Attempt
   end
 end
 
+# Extend the Kernel module with a simple interface for the Attempt class.
 module Kernel
-   # :call-seq:
-   #    attempt(tries: 3, interval: 60, timeout: 10){ # some op }
-   #
-   # Attempt to perform the operation in the provided block up to +tries+
-   # times, sleeping +interval+ between each try. By default the number
-   # of tries defaults to 3, the interval defaults to 60 seconds, and there
-   # is no timeout specified.
-   #
-   # If +timeout+ is provided then the operation is wrapped in a Timeout
-   # block as well. This is handy for those rare occasions when an IO
-   # connection could hang indefinitely, for example.
-   #
-   # If the operation still fails the (last) error is then re-raised.
-   #
-   # This is really just a convenient wrapper for Attempt.new + Attempt#attempt.
-   #
-   # Example:
-   #
-   #    # Make 3 attempts to connect to the database, 60 seconds apart.
-   #    attempt{ DBI.connect(dsn, user, passwd) }
-   #
-   def attempt(**kwargs, &block)
-     object = Attempt.new(kwargs)
-     object.attempt(&block)
-   end
+  # :call-seq:
+  #    attempt(tries: 3, interval: 60, timeout: 10){ # some op }
+  #
+  # Attempt to perform the operation in the provided block up to +tries+
+  # times, sleeping +interval+ between each try. By default the number
+  # of tries defaults to 3, the interval defaults to 60 seconds, and there
+  # is no timeout specified.
+  #
+  # If +timeout+ is provided then the operation is wrapped in a Timeout
+  # block as well. This is handy for those rare occasions when an IO
+  # connection could hang indefinitely, for example.
+  #
+  # If the operation still fails the (last) error is then re-raised.
+  #
+  # This is really just a convenient wrapper for Attempt.new + Attempt#attempt.
+  #
+  # Example:
+  #
+  #    # Make 3 attempts to connect to the database, 60 seconds apart.
+  #    attempt{ DBI.connect(dsn, user, passwd) }
+  #
+  def attempt(**kwargs, &block)
+    object = Attempt.new(**kwargs)
+    object.attempt(&block)
+  end
 end

data/spec/attempt_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #####################################################################
 # attempt_spec.rb
 #
@@ -19,49 +21,49 @@ RSpec.describe Attempt do
     @tries    = 2
     @interval = 0.1
     @timeout  = 0.1
-    $value    = 0
+    @value    = 0
+  end
+
+  after do
+    @value = 0
+  end
+
+  after(:all) do
+    $stderr = STDERR
   end
 
-  example "version constant is set to expected value" do
-    expect(Attempt::VERSION).to eq('0.6.1')
+  example 'version constant is set to expected value' do
+    expect(Attempt::VERSION).to eq('0.6.3')
     expect(Attempt::VERSION).to be_frozen
   end
 
-  example "attempt works as expected without arguments" do
+  example 'attempt works as expected without arguments' do
     expect{ attempt{ 2 + 2 } }.not_to raise_error
   end
 
-  example "attempt retries the number of times specified" do
-    expect{ attempt(tries: @tries){ $value += 1; raise if $value < 2 } }.not_to raise_error
-    expect($value).to eq(2)
+  example 'attempt retries the number of times specified' do
+    expect{ attempt(tries: @tries){ @value += 1; raise if @value < 2 } }.not_to raise_error
+    expect(@value).to eq(2)
   end
 
-  example "attempt retries the number of times specified with interval" do
+  example 'attempt retries the number of times specified with interval' do
     expect{
-      attempt(tries: @tries, interval: @interval){ $value += 1; raise if $value < 2 }
+      attempt(tries: @tries, interval: @interval){ @value += 1; raise if @value < 2 }
     }.not_to raise_error
-    expect($value).to eq(2)
+    expect(@value).to eq(2)
   end
 
-  example "attempt retries the number of times specified with interval and timeout" do
+  example 'attempt retries the number of times specified with interval and timeout' do
     expect{
-      attempt(tries: @tries, interval: @interval, timeout: @timeout){ $value += 1; raise if $value < 2 }
+      attempt(tries: @tries, interval: @interval, timeout: @timeout){ @value += 1; raise if @value < 2 }
     }.not_to raise_error
   end
 
-  example "attempt raises a timeout error if timeout value is exceeded" do
+  example 'attempt raises a timeout error if timeout value is exceeded' do
     expect{ attempt(tries: 1, interval: 1, timeout: @timeout){ sleep 5 } }.to raise_error(Timeout::Error)
   end
 
-  example "attempt raises exception as expected" do
+  example 'attempt raises exception as expected' do
     expect{ attempt(tries: 2, interval: 2){ raise } }.to raise_error(RuntimeError)
   end
-
-  after do
-    $after = 0
-  end
-
-  after(:all) do
-    $stderr = STDERR
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attempt
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,8 +35,36 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: structured_warnings
   requirement: !ruby/object:Gem::Requirement
@@ -104,10 +132,14 @@ homepage: https://github.com/djberg96/attempt
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://github.com/djberg96/attempt/blob/master/CHANGES
-  source_code_uri: https://github.com/djberg96/attempt/blob/master/lib/attempt.rb
+  homepage_uri: https://github.com/djberg96/attempt
+  documentation_uri: https://github.com/djberg96/attempt/wiki
+  changelog_uri: https://github.com/djberg96/attempt/blob/main/CHANGES.md
+  source_code_uri: https://github.com/djberg96/attempt/blob/main/lib/attempt.rb
   bug_tracker_uri: https://github.com/djberg96/attempt/issues
   wiki_uri: https://github.com/djberg96/attempt/wiki
+  rubygems_mfa_required: 'true'
+  github_repo: https://github.com/djberg96/attempt
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -123,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A thin wrapper for begin + rescue + sleep + retry