attempt 0.5.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d3a19c0af424d2b75bea45b426104ce8975948ad978e71b8fb27aaad902feeb
-  data.tar.gz: bf8d228e1f539cd01877013452dab333f2af8fc315c70cac1a016abcd7960875
+  metadata.gz: c954f55aef2408950c9aeafde149fa2562576e62af9f6a0215f6dc90bec184eb
+  data.tar.gz: 1951edd8ffc473008f37850504fda990593721378c26c84c3375f9c58df868ef
 SHA512:
-  metadata.gz: 065e16dfce9c78d505a81b220e77d5ac0d5855606a4b10b90f2a8fd3dd1d12f7bd83a42268d9e2e2b43db8adaad7506a05cf7ddaba97117ba215c736c6eea3bf
-  data.tar.gz: 29180b07080e2ee8201ef1ac29b9f266b290ee37ac06ccaa27e79c196548afcc8f8daaf3f9535d8eaeb4cc519bdff9572afa0fbee406ce8e09c37eb864cc962a
+  metadata.gz: 687f808427b5c2a686c89892af635b5528886207c6bf0a38036c0b4cceb92592a2a89579301083eb7a3ca01e297878e02ccf57148504e4fb10f1188ebf1841c4
+  data.tar.gz: '028d54de4b4602f76d2ffae474c1f1bdc2835604aac33d24cc503cdd250661839bb6eefcf15a7e8fa0d5e25af401cf5a91ff144213c2599551f3d28d38788972'

data/{CHANGES → CHANGES.md}

@@ -1,31 +1,56 @@
-== 0.5.0 - 2-Jun-2020
+## 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.
+
+## 0.6.0 - 17-Sep-2020
+
+* Switched from test-unit to rspec and rewrote the specs.
+
+## 0.5.1 - 28-Aug-2020
+
+* Added a Gemfile.
+* Updated Rakefile to clean .lock files.
+* Bumped structured_warnings version to 0.4.0 so that it works with Ruby 2.7.
+  Thanks go to Alexey Zapriy for the spot.
+
+## 0.5.0 - 2-Jun-2020
+
 * Switched to Apache-2.0 license, added LICENSE file.
 * Updated cert again.
 
-== 0.4.0 - 5-Sep-2017
+## 0.4.0 - 5-Sep-2017
+
 * Switched constructor to use keyword arguments.
 * Replaced Timeout with SafeTimeout and added the safe_timeout dependency.
 * The :log option now accepts either an IO or Logger object.
 * Updated cert.
 
-== 0.3.2 - 4-Apr-2017
+## 0.3.2 - 4-Apr-2017
+
 * Fix metadata key names.
 
-== 0.3.1 - 4-Apr-2017
+## 0.3.1 - 4-Apr-2017
+
 * Added some metadata to the gemspec.
 
-== 0.3.0 - 27-Mar-2017
+## 0.3.0 - 27-Mar-2017
+
 * The structured_warnings gem requirement was updated to 0.3.0 or later. This
   is necessary if you are using Ruby 2.4 or later.
 * The VERSION string is now frozen.
 * Updated the certs file.
 
-== 0.2.1 - 13-Dec-2015
+## 0.2.1 - 13-Dec-2015
+
 * This gem is now signed.
 * Updates to the Rakefile and gemspec.
 * Added a caveat regarding the timeout module to the README.
 
-== 0.2.0 - 26-Sep-2009
+## 0.2.0 - 26-Sep-2009
+
 * Now requires and uses the structured_warnings gem. If a block of code fails
   prior to reaching the maximum number of tries, and warnings are on, then
   an Attempt::Warning is raised.
@@ -33,16 +58,19 @@
 * Refactored the attempt.gemspec file a bit.
 * Added the 'gem' task to the Rakefile.
 
-== 0.1.2 - 1-Aug-2009
+## 0.1.2 - 1-Aug-2009
+
 * License changed to Artistic 2.0.
 * Added test-unit as a development dependency.
 * Test file renamed to more closely follow Ruby style.
 * Gemspec updates, including addition of license.
 
-== 0.1.1 - 31-Jul-2007
+## 0.1.1 - 31-Jul-2007
+
 * Added a Rakefile with tasks for testing and installation.
 * Removed the install.rb file, since installation is now handled by the Rakefile.
 * Some minor doc updates.
 
-== 0.1.0 - 9-Jun-2006
+## 0.1.0 - 9-Jun-2006
+
 * Initial commit

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 'test-unit', '~> 3.0'
-  end
-end
+source 'https://rubygems.org'
+gemspec

data/{MANIFEST → MANIFEST.md}

@@ -1,10 +1,10 @@
-* CHANGES
+* CHANGES.md
 * LICENSE
-* MANIFEST
-* README
+* MANIFEST.md
+* README.md
 * Gemfile
 * Rakefile
 * attempt.gemspec
 * certs/djberg96_pub.pem
 * lib/attempt.rb
-* test/test_attempt.rb
+* spec/attempt_spec.rb

data/README.md

@@ -0,0 +1,76 @@
+## Description
+A thin wrapper for begin + rescue + sleep + retry.
+
+## Installation
+`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.
+
+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){ ... }
+}
+```
+
+## 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
+work than you expect. 
+
+Also, this library uses the timeout library internally, which has some
+known issues. See Future Plans, below.
+
+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 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
+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-2022, Daniel J. Berger
+All Rights Reserved
+
+## Author
+Daniel J. Berger

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 CLEAN.include('**/*.gem', '**/*.rbc', '**/*.lock')
 
@@ -8,9 +8,9 @@ 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, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the attempt gem"
@@ -20,10 +20,7 @@ namespace :gem do
   end
 end
 
-Rake::TestTask.new do |t|
-  task :test => :clean
-  t.warning = true
-  t.verbose = true
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/attempt.gemspec

@@ -2,29 +2,27 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'attempt'
-  spec.version    = '0.5.1'
+  spec.version    = '0.6.2'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/attempt'
   spec.summary    = 'A thin wrapper for begin + rescue + sleep + retry'
-  spec.test_file  = 'test/test_attempt.rb'
+  spec.test_file  = 'spec/attempt_spec.rb'
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
   
-  spec.extra_rdoc_files  = ['README','CHANGES','MANIFEST']
-
   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',
+    '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'
   }
 
+  spec.add_development_dependency('rake')
   spec.add_dependency('structured_warnings', '~> 0.4.0')
   spec.add_dependency('safe_timeout', '~> 0.0.5')
-
-  spec.add_development_dependency('test-unit')
+  spec.add_dependency('rspec', '~> 3.9')
 
   spec.description = <<-EOF
     The attempt library provides a thin wrapper for the typical

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.5.1'.freeze
+  VERSION = '0.6.2'
 
   # 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

@@ -0,0 +1,67 @@
+#####################################################################
+# attempt_spec.rb
+#
+# Tests for the attempt library. You should run this test case via
+# the 'rake test' Rakefile task (or just 'rake').
+#
+# TODO: Test that an Attempt::Warning is raised.
+#####################################################################
+require 'rspec'
+require 'attempt'
+require 'stringio'
+
+RSpec.describe Attempt do
+  before(:all) do
+    $stderr = StringIO.new
+  end
+
+  before do
+    @tries    = 2
+    @interval = 0.1
+    @timeout  = 0.1
+    $value    = 0
+  end
+
+  example "version constant is set to expected value" do
+    expect(Attempt::VERSION).to eq('0.6.2')
+    expect(Attempt::VERSION).to be_frozen
+  end
+
+  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)
+  end
+
+  example "attempt retries the number of times specified with interval" do
+    expect{
+      attempt(tries: @tries, interval: @interval){ $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 and timeout" do
+    expect{
+      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
+    expect{ attempt(tries: 1, interval: 1, timeout: @timeout){ sleep 5 } }.to raise_error(Timeout::Error)
+  end
+
+  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.5.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,8 +35,22 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date:
+date: 2022-06-02 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: structured_warnings
   requirement: !ruby/object:Gem::Requirement
@@ -66,19 +80,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.5
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 description: |2
       The attempt library provides a thin wrapper for the typical
       begin/rescue/sleep/retry dance. Use this in order to robustly
@@ -88,30 +102,24 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
+- CHANGES.md
+- Gemfile
 - LICENSE
-- test
-- test/test_attempt.rb
-- CHANGES
-- MANIFEST
-- README
+- MANIFEST.md
+- README.md
 - Rakefile
-- certs
+- attempt.gemspec
 - certs/djberg96_pub.pem
-- lib
 - lib/attempt.rb
-- Gemfile
-- attempt.gemspec
+- spec/attempt_spec.rb
 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
+  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
 post_install_message:
@@ -129,9 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: A thin wrapper for begin + rescue + sleep + retry
 test_files:
-- test/test_attempt.rb
+- spec/attempt_spec.rb

data/README

@@ -1,72 +0,0 @@
-== Description
-  A thin wrapper for begin + rescue + sleep + retry.
-
-== Installation
-  gem install attempt   
-
-== Synopsis
-  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){ ... }
-  }
-   
-  # 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
-  work than you expect. 
-
-  Also, this library uses the timeout library internally, which has some
-  known issues. See Future Plans, below.
-
-  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.
-
-== 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
-  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
-  Artistic 2.0
-
-== Copyright
-  (C) 2006-2020, Daniel J. Berger
-  All Rights Reserved
-
-== Author
-  Daniel J. Berger

data/test/test_attempt.rb

@@ -1,69 +0,0 @@
-#####################################################################
-# test_attempt.rb
-#
-# Test case for the attempt library. You should run this test case
-# via the 'rake test' Rakefile task.
-#
-# TODO: Test that an Attempt::Warning is raised.
-#####################################################################
-require 'test-unit'
-require 'attempt'
-require 'stringio'
-
-class TC_Attempt < Test::Unit::TestCase
-  def self.startup
-    $stderr = StringIO.new
-  end
-
-  def setup
-    @tries    = 2
-    @interval = 0.1
-    @timeout  = 0.1
-    $value    = 0
-  end
-
-  test "version constant is set to expected value" do
-    assert_equal('0.5.1', Attempt::VERSION)
-    assert_true(Attempt::VERSION.frozen?)
-  end
-
-  test "attempt works as expected without arguments" do
-    assert_nothing_raised{ attempt{ 2 + 2 } }
-  end
-
-  test "attempt retries the number of times specified" do
-    assert_nothing_raised{ attempt(tries: @tries){ $value += 1; raise if $value < 2 } }
-    assert_equal(2, $value)
-  end
-
-  test "attempt retries the number of times specified with interval" do
-    assert_nothing_raised{
-      attempt(tries: @tries, interval: @interval){ $value += 1; raise if $value < 2 }
-    }
-  end
-
-  test "attempt retries the number of times specified with interval and timeout" do
-    assert_nothing_raised{
-      attempt(tries: @tries, interval: @interval, timeout: @timeout){ $value += 1; raise if $value < 2 }
-    }
-  end
-
-  test "attempt raises a timeout error if timeout value is exceeded" do
-    assert_raises(Timeout::Error){ attempt(tries: 1, interval: 1, timeout: @timeout){ sleep 5 } }
-  end
-
-  test "attempt raises exception as expected" do
-    assert_raises(RuntimeError){ attempt(tries: 2, interval: 2){ raise } }
-  end
-
-  def teardown
-    @tries    = nil
-    @interval = nil
-    @timeout  = nil
-    $value    = 0
-  end
-
-  def self.shutdown
-    $stderr = STDERR
-  end
-end