attempt 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50246b73fb46376da7117edb646bcf0e729f02ae64bf1282d4f352af4c738b47
-  data.tar.gz: 37037458bafef3d5bc310f4fb4d856af3bd4058cbdeaeaee9af6fde67bf62b5b
+  metadata.gz: 9f4489fdcd16a1e4fd93187cf684afc4eb42b9d1b35987372ce099b0081ab938
+  data.tar.gz: 0d359e069dded75e7e0871c1903f5950275b5f033e22490ea3358c55e8883df0
 SHA512:
-  metadata.gz: b592f0a5df1a9d9a01ce5ec50661fdf4541bab52de11a1c8dff501f55035f072ad9b88c0f53ba7546d509cb4042027cf12a7ad4972b85c124e3f940d8b283b84
-  data.tar.gz: 0ca007e3d8bdb894e5d2991685dfc00cb3fcf5eb8f4e29205b06d0c862827495ba991d767ff49ea1656c3372d9e0186973a26b7733a8b19ccf7f52085182742d
+  metadata.gz: 61728e4d946893471d103dfa8f2114212bf9438774b6636cff3744186fe0c99f7e48687969abe8627aa48b4cdb0d7203666978ded8bae2b3ba9d4f1e2616d57b
+  data.tar.gz: a34ac935d3fde78fed37884e93f9019c015a106c15f741732fedd2184c298eb1233ab23f967dfb85bfa6eaf1bb873d6e208730c20cf59cf40bbf101122f5c1a5

data/{CHANGES → CHANGES.md}

@@ -1,40 +1,53 @@
-== 0.6.0 - 17-Sep-2020
+## 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
+## 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
+## 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.
@@ -42,16 +55,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/{MANIFEST → MANIFEST.md}

@@ -1,7 +1,7 @@
-* CHANGES
+* CHANGES.md
 * LICENSE
-* MANIFEST
-* README
+* MANIFEST.md
+* README.md
 * Gemfile
 * Rakefile
 * attempt.gemspec

data/README.md

@@ -0,0 +1,84 @@
+## 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
+
+Apache-2.0
+
+## Copyright
+
+(C) 2006-2020, Daniel J. Berger
+All Rights Reserved
+
+## Author
+
+Daniel J. Berger

data/attempt.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'attempt'
-  spec.version    = '0.6.0'
+  spec.version    = '0.6.1'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -12,8 +12,6 @@ Gem::Specification.new do |spec|
   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',

data/lib/attempt.rb

@@ -6,7 +6,7 @@ require 'structured_warnings'
 class Attempt
 
   # The version of the attempt library.
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.6.1'.freeze
 
   # Warning raised if an attempt fails before the maximum number of tries
   # has been reached.

data/spec/attempt_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Attempt do
   end
 
   example "version constant is set to expected value" do
-    expect(Attempt::VERSION).to eq('0.6.0')
+    expect(Attempt::VERSION).to eq('0.6.1')
     expect(Attempt::VERSION).to be_frozen
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attempt
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: structured_warnings
@@ -88,16 +88,13 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- CHANGES
+- CHANGES.md
 - Gemfile
 - LICENSE
-- MANIFEST
-- README
+- MANIFEST.md
+- README.md
 - Rakefile
 - attempt.gemspec
 - certs/djberg96_pub.pem

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
-  Apache-2.0
-
-== Copyright
-  (C) 2006-2020, Daniel J. Berger
-  All Rights Reserved
-
-== Author
-  Daniel J. Berger