retryable 1.3.1 → 1.3.2

data/LICENSE.md

@@ -1,4 +1,4 @@
-(The MIT License) 
+(The MIT License)
 
 Copyright (c) 2011 Carlo Zottmann
 

data/README.md

@@ -89,6 +89,19 @@ retryable do |retries, exception|
 end
 ```
 
+You can temporary disable retryable blocks
+--------
+
+```
+Retryble.enabled?
+=> true
+
+Retryble.disable
+
+Retryble.enabled?
+=> false
+```
+
 Installation
 -------
 

data/lib/config.rb

@@ -0,0 +1,16 @@
+module Retryable
+  @enabled = true
+  class << self; attr_accessor :enabled; end
+
+  def self.enable
+    @enabled = true
+  end
+
+  def self.disable
+    @enabled = false
+  end
+
+  def self.enabled?
+    !!@enabled
+  end
+end

data/lib/retryable.rb

@@ -1,3 +1,5 @@
+require 'version'
+require 'config'
 
 module Kernel
   def retryable(options = {}, &block)
@@ -14,6 +16,7 @@ module Kernel
     begin
       return yield retries, retry_exception
     rescue *on_exception => exception
+      raise unless Retryable.enabled?
       raise unless exception.message =~ opts[:matching]
       raise if retries+1 >= opts[:tries]
 
@@ -39,3 +42,4 @@ module Kernel
     raise ArgumentError.new("[Retryable] Invalid options: #{invalid_options.join(", ")}") unless invalid_options.empty?
   end
 end
+

data/lib/version.rb

@@ -0,0 +1,16 @@
+module Retryable
+  class Version
+    MAJOR = 1 unless defined? Twitter::Version::MAJOR
+    MINOR = 3 unless defined? Twitter::Version::MINOR
+    PATCH = 2 unless defined? Twitter::Version::PATCH
+
+    class << self
+
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH].compact.join('.')
+      end
+
+    end
+  end
+end

data/retryable.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.add_development_dependency 'bundler'
@@ -14,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.name = 'retryable'
   gem.require_paths = ["lib"]
   gem.required_rubygems_version = '>= 1.3.6'
-  gem.summary = %q{Kernel#retryable, allow for retrying of code blocks.}
+  gem.summary = gem.description
   gem.test_files = Dir.glob("spec/**/*")
-  gem.version = "1.3.1"
+  gem.version = Retryable::Version
 end

data/spec/lib/config_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Retryable do
+  it 'is enabled by default' do
+    Retryable.should be_enabled
+  end
+
+  it 'could be disabled' do
+    Retryable.disable
+    Retryable.should_not be_enabled
+  end
+
+  context 'when disabled' do
+    before do
+      Retryable.disable
+    end
+
+    it 'could be re-enabled' do
+      Retryable.enable
+      Retryable.should be_enabled
+    end
+  end
+end

data/spec/lib/retryable_spec.rb

@@ -1,26 +1,35 @@
 require 'spec_helper'
 
-describe 'retryable' do
-
+describe 'Kernel.retryable' do
   before(:each) do
+    Retryable.enable
     @attempt = 0
   end
 
-  it "should only catch StandardError by default" do
+  it 'catch StandardError only by default' do
     lambda do
       count_retryable(:tries => 2) { |tries, ex| raise Exception if tries < 1 }
     end.should raise_error Exception
     @try_count.should == 1
   end
-  
-  it "should retry on default exception" do
+
+  it 'retries on default exception' do
     Kernel.should_receive(:sleep).once.with(1)
 
     count_retryable(:tries => 2) { |tries, ex| raise StandardError if tries < 1 }
     @try_count.should == 2
   end
 
-  it "should execute *ensure* clause" do
+  it 'does not retry if disabled' do
+    Retryable.disable
+
+    lambda do
+      count_retryable(:tries => 2) { raise }
+    end.should raise_error RuntimeError
+    @try_count.should == 1
+  end
+
+  it 'executes *ensure* clause' do
     ensure_cb  = Proc.new do |retries|
       retries.should == 0
     end
@@ -28,7 +37,7 @@ describe 'retryable' do
     Kernel.retryable(:ensure => ensure_cb) { }
   end
 
-  it "should pass retry count and exception on retry" do
+  it 'passes retry count and exception on retry' do
     Kernel.should_receive(:sleep).once.with(1)
 
     count_retryable(:tries => 2) do |tries, ex| 
@@ -37,14 +46,14 @@ describe 'retryable' do
     end
     @try_count.should == 2
   end
-  
-  it "should make another try if exception is covered by :on" do
+
+  it 'makes another try if exception is covered by :on' do
     Kernel.stub!(:sleep)
     count_retryable(:on => [StandardError, ArgumentError, RuntimeError] ) { |tries, ex| raise ArgumentError if tries < 1 }
     @try_count.should == 2
   end
 
-  it "should not try on unexpected exception" do
+  it 'does not try on unexpected exception' do
     Kernel.stub!(:sleep)
     lambda do
       count_retryable(:on => RuntimeError ) { |tries, ex| raise StandardError if tries < 1 }
@@ -52,40 +61,40 @@ describe 'retryable' do
     @try_count.should == 1
   end
 
-  it "should three times" do
+  it 'retries three times' do
     Kernel.stub!(:sleep)
     count_retryable(:tries => 3) { |tries, ex| raise StandardError if tries < 2 }
     @try_count.should == 3
   end
 
-  it "should retry on default exception" do
+  it 'retries on default exception' do
     Kernel.should_receive(:sleep).once.with(1)
 
     count_retryable(:tries => 2) { |tries, ex| raise StandardError if tries < 1 }
     @try_count.should == 2
   end
 
-  it "exponential backoff scheme for :sleep option" do
+  it 'executes exponential backoff scheme for :sleep option' do
     [1, 4, 16, 64].each { |i| Kernel.should_receive(:sleep).once.ordered.with(i) }
     lambda do
       Kernel.retryable(:tries => 5, :sleep => lambda { |n| 4**n }) { raise RangeError }
     end.should raise_error RangeError
   end
 
-  it "doesn't retry any exception if :on is empty list" do
+  it 'does not retry any exception if :on is empty list' do
     lambda do
       count_retryable(:on => []) { raise }
     end.should raise_error RuntimeError
     @try_count.should == 1
   end
 
-  it "should catch an exception that matches the regex" do
+  it 'catches an exception that matches the regex' do
     Kernel.should_receive(:sleep).once.with(1)
     count_retryable(:matching => /IO timeout/) { |c,e| raise "yo, IO timeout!" if c == 0 }
     @try_count.should == 2
   end
 
-  it "should not catch an exception that doesn't match the regex" do
+  it 'does not catch an exception that does not match the regex' do
     should_not_receive :sleep
     lambda do
       count_retryable(:matching => /TimeError/) { raise "yo, IO timeout!" }
@@ -93,19 +102,9 @@ describe 'retryable' do
     @try_count.should == 1
   end
 
-  it "doesn't allow invalid options" do
+  it 'does not allow invalid options' do
     lambda do
       retryable(:bad_option => 2) { raise "this is bad" }
     end.should raise_error ArgumentError, '[Retryable] Invalid options: bad_option'
   end
-
-  private
-
-  def count_retryable *opts
-    @try_count = 0
-    return Kernel.retryable(*opts) do |*args|
-      @try_count += 1
-      yield *args
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-
 require File.dirname(__FILE__) + '/../lib/retryable'
 require 'rspec'
 
@@ -6,4 +5,12 @@ RSpec.configure do |config|
   # Remove this line if you don't want RSpec's should and should_not
   # methods or matchers
   require 'rspec/expectations'
+
+  def count_retryable(*opts)
+    @try_count = 0
+    return Kernel.retryable(*opts) do |*args|
+      @try_count += 1
+      yield *args
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retryable
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-21 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160257620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160257620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160253820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +39,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160253820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2160248540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,7 +55,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160248540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Kernel#retryable, allow for retrying of code blocks.
 email: loci.master@gmail.com
 executables: []
@@ -57,7 +72,10 @@ files:
 - README.md
 - Rakefile
 - retryable.gemspec
+- lib/config.rb
 - lib/retryable.rb
+- lib/version.rb
+- spec/lib/config_spec.rb
 - spec/lib/retryable_spec.rb
 - spec/lib/retryable_spec.rbc
 - spec/spec_helper.rb
@@ -82,11 +100,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Kernel#retryable, allow for retrying of code blocks.
 test_files:
+- spec/lib/config_spec.rb
 - spec/lib/retryable_spec.rb
 - spec/lib/retryable_spec.rbc
 - spec/spec_helper.rb