attempt 0.1.2 → 0.2.0

data/CHANGES

@@ -1,3 +1,11 @@
+== 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.
+* Fixed a packaging bug.
+* Refactored the attempt.gemspec file a bit.
+* Added the 'gem' task to the Rakefile.
+
 == 0.1.2 - 1-Aug-2009
 * License changed to Artistic 2.0.
 * Added test-unit as a development dependency.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the attempt library (non-gem)"
+task :install do
+   cp 'lib/attempt.rb', Config::CONFIG['sitelibdir'], :verbose => true
+end
+
+desc 'Build the gem'
+task :gem do
+   spec = eval(IO.read('attempt.gemspec'))
+   Gem::Builder.new(spec).build
+
+desc "Install the attempt library as a gem"
+task :install_gem => [:gem] do
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.warning = true
+   t.verbose = true
+end

data/attempt.gemspec

@@ -0,0 +1,28 @@
+require 'rubygems'
+
+Gem::Specification.new do |gem|
+   gem.name      = 'attempt'
+   gem.version   = '0.2.0'
+   gem.author    = 'Daniel J. Berger'
+   gem.license   = 'Artistic 2.0'
+   gem.email     = 'djberg96@gmail.com'
+   gem.homepage  = 'http://www.rubyforge.org/projects/shards'
+   gem.summary   = 'A thin wrapper for begin + rescue + sleep + retry'
+   gem.test_file = 'test/test_attempt.rb'
+   gem.has_rdoc  = true
+   gem.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.extra_rdoc_files  = ['README','CHANGES','MANIFEST']
+   gem.rubyforge_project = 'shards'
+
+   gem.add_dependency('structured_warnings')
+   gem.add_development_dependency('test-unit', '>= 2.0.3')
+
+   gem.description = <<-EOF
+      The attempt library provides a thin wrapper for the typical
+      begin/rescue/sleep/retry dance. Use this in order to robustly
+      handle blocks of code that could briefly flake out, such as a socket
+      or database connection, where it's often better to try again after
+      a brief period rather than fail immediately.
+   EOF
+end

data/lib/attempt.rb

@@ -1,7 +1,16 @@
 require 'timeout'
+require 'structured_warnings'
 
+# The Attempt class encapsulates methods related to multiple attempts at
+# running the same method before actually failing.
 class Attempt
-   VERSION = '0.1.2'
+   
+   # The version of the attempt library.
+   VERSION = '0.2.0'
+
+   # Warning raised if an attempt fails before the maximum number of tries
+   # has been reached.
+   class Warning < StandardWarning; end
    
    # Number of attempts to make before failing.  The default is 3.
    attr_accessor :tries
@@ -46,6 +55,12 @@ class Attempt
       yield self if block_given?
    end
    
+   # Attempt to perform the operation in the provided block up to +tries+
+   # times, sleeping +interval+ between each try.
+   #
+   # You will not typically use this method directly, but the Kernel#attempt
+   # method instead.
+   #
    def attempt
       count = 1
       begin
@@ -59,7 +74,7 @@ class Attempt
          if @tries > 0
             msg = "Error on attempt # #{count}: #{error}; retrying"
             count += 1
-            warn msg if @warnings
+            warn Warning, msg if @warnings
             @log.puts msg if @log
             @interval += @increment if @increment
             sleep @interval

data/test/test_attempt.rb

@@ -3,6 +3,8 @@
 #
 # 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 'rubygems'
 gem 'test-unit'
@@ -23,7 +25,7 @@ class TC_Attempt < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal('0.1.2', Attempt::VERSION)
+      assert_equal('0.2.0', Attempt::VERSION)
    end
    
    def test_attempt_basic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: attempt
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-01 00:00:00 -06:00
+date: 2009-09-26 00:00:00 -06:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: structured_warnings
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
   type: :development
@@ -22,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.0.3
     version: 
-description: "      The attempt library provides a thin wrapper for the typical\n      begin/rescue/sleep/retry dance. This is used by programmers to robustly\n      handle flaky connections where it's often better to try again rather\n      than fail immediately.\n"
+description: "      The attempt library provides a thin wrapper for the typical\n      begin/rescue/sleep/retry dance. Use this in order to robustly\n      handle blocks of code that could briefly flake out, such as a socket\n      or database connection, where it's often better to try again after\n      a brief period rather than fail immediately.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -33,11 +43,13 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
-- lib/attempt.rb
-- test/test_attempt.rb
-- README
+- attempt.gemspec
 - CHANGES
+- lib/attempt.rb
 - MANIFEST
+- Rakefile
+- README
+- test/test_attempt.rb
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
 licenses: