with_retries 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a246d623e3529e5e633805268c6c2677f78a3791
+  data.tar.gz: 59f954301fa56ee90c1f30b5879fa4a44c377c93
+SHA512:
+  metadata.gz: 33d7e074f2f5e025db49f12b58b3a7410b63acfdf3cd60f0d2d367a94577323a93ab65d38c3ff5d7312ccf412457cf6b41bb3cc4f8e6ba7dd8983730030d0923
+  data.tar.gz: bba2dba316f56ceee9673150a9e7c6d4f5bc8bcff00fe51f32629d634d1b9231954aae6ba95bcf736fed639ab10f63136e2ba103149f78cd9a14581a0b0b8f67

data/Guardfile

@@ -0,0 +1,69 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard 'livereload' do
+  watch(%r{app/.+\.(erb|haml)})
+  watch(%r{app/helpers/.+\.rb})
+  watch(%r{(public/|app/assets).+\.(css|js|html)})
+  watch(%r{(app/assets/.+\.css)\.s[ac]ss}) { |m| m[1] }
+  watch(%r{(app/assets/.+\.js)\.coffee}) { |m| m[1] }
+  watch(%r{config/locales/.+\.yml})
+end
+
+guard 'rails' do
+  watch('Gemfile.lock')
+  watch(%r{^(config|lib)/.*})
+end
+
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch('config/environments/test.rb')
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+  watch('test/test_helper.rb') { :test_unit }
+  watch(%r{features/support/}) { :cucumber }
+end
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch('config/environments/test.rb')
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+  watch('test/test_helper.rb') { :test_unit }
+  watch(%r{features/support/}) { :cucumber }
+end

data/README.md

@@ -1,6 +1,4 @@
-# WithRetries
-
-TODO: Write a gem description
+# with_retries
 
 ## Installation
 
@@ -18,7 +16,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# example.rb
+require 'with_retries'
+
+Boom = Class.new(RuntimeError)
+
+with_retries(Boom, attempts: 3) do
+  puts "Here I am"
+  raise Boom.new("BOOM!")
+end
+
+#=> $ ruby example.rb
+#=> Here I am
+#=> Here I am
+#=> Here I am
+#=> example.rb:8:in `block in <main>': BOOM! (Boom)
+```
 
 ## Contributing
 

data/lib/with_retries/version.rb

@@ -1,3 +1,3 @@
 module WithRetries
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/with_retries.rb

@@ -4,11 +4,23 @@ module Kernel
   def with_retries(errors, params = {}, &block)
     attempts = params[:attempts] or
       raise ArgumentError.new("Attempts parameter not provided")
+    logger = params[:logger]
 
     begin
       yield
-    rescue *errors
+    rescue *errors => e
       attempts -= 1
+
+      if logger
+        times = (attempts == 1 ? "time" : "times")
+
+        logger.warn(
+          "Attempt failed. Retrying #{attempts} more #{times}...\n" +
+          ["#{e.class}: #{e.message}:", *e.backtrace].join("\n  ") +
+          "\n"
+         )
+      end
+
       attempts > 0 ? retry : raise
     end
   end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'logger'
+require 'with_retries'

data/spec/with_retries_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Kernel do
+  describe "#with_retries" do
+    Boom = Class.new(RuntimeError)
+
+    context "when given valid parameters" do
+      it "rescues the given error" do
+        expect do
+          attempt = 0
+          with_retries(Boom, attempts: 3) do
+            attempts += 1
+            raise Boom.new if attempt < 3
+          end
+        end.to_not raise_error(Boom)
+      end
+
+      it "retries the block the given number of times" do
+        Kernel.should_receive(:raise).exactly(3).times
+
+        attempts = 0
+        with_retries(Boom, attempts: 3) do
+          attempts += 1
+          raise Boom.new if attempts < 3
+        end
+        attempts.should == 3
+      end
+
+      it "raises the exception when the number of retries has been exceeded" do
+        expect do
+          with_retries(Boom, attempts: 2) { 3.times { raise Boom.new } }
+        end.to raise_error(Boom)
+      end
+
+      it "does not retry unexpected exceptions" do
+        unexpected_error = Class.new(RuntimeError)
+        expect do
+          with_retries(Boom, attempts: 2) { raise unexpected_error.new }
+        end.to raise_error(unexpected_error)
+      end
+
+      context "when given a logger parameter" do
+        let(:logger) { Logger.new(STDOUT) }
+
+        it "logs a warning to the given logger" do
+          logger.should_receive(:warn).exactly(5).times
+
+          expect do
+            with_retries(Boom, attempts: 5, logger: logger) do
+              raise Boom.new
+            end
+          end.to raise_error
+        end
+      end
+    end
+
+    context "when not given an attempts parameter" do
+      it "raises an ArgumentError" do
+        expect do
+          with_retries(Boom) { raise Boom.new }
+        end.to raise_error(ArgumentError, "Attempts parameter not provided")
+      end
+    end
+  end
+end

data/with_retries.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec', '~> 2.14.1'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_retries
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Bryan Woods
@@ -11,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
-dependencies: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 description: Adds a with_retries method to Kernel for retrying things
 email:
 - dev@howaboutwe.com
@@ -22,35 +35,39 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/with_retries.rb
 - lib/with_retries/version.rb
+- spec/spec_helper.rb
+- spec/with_retries_spec.rb
 - with_retries.gemspec
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Maybe later
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/with_retries_spec.rb
 has_rdoc: