attempt_this 0.9.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb1e8ce9d65d7e2fd649b08462f7fec5d5c275bd
+  data.tar.gz: 42f3dfabe605a339c8f0abaa32db1e93ee130532
+SHA512:
+  metadata.gz: 67d984ccaa89933fefd5fc20358c11750baaecc56f47ba10625deac47312d8d9a46a9c41b36803461d7b6b0a6150dceec8addf7ef57dfbb7f352fa3aabcea597
+  data.tar.gz: cf0c8ab119c22978d0328d930b05e34e54f89ea57b4d15b4af4c7597f068b04245ff68efdea4fe07816756eaa2c35280f648ec1f13be7c122507165aa09b18ef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attempt_this (0.9.1)
+    attempt_this (1.0.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -68,8 +68,7 @@ attempt(3.times)
 end
 ```
 
-Finally, you can store various configurations as scenarios and use them by name. This is useful when you need different approaches for specific cases (handling HTTP failures, for example). But remember that you should register your scenarios before using them:
-
+You can store various configurations as scenarios and use them by name. This is useful when you need different approaches for specific cases (handling HTTP failures, for example). But remember that you should register your scenarios before using them:
 ```ruby
 # Run this code when the application starts
 AttemptThis.attempt(5.times).with_filter(*RECOVERABLE_HTTP_ERRORS).scenario(:http)
@@ -84,4 +83,14 @@ end
 # Return values
 Calling 'attempt' will return result of the code block if there was no exception; otherwise it will return result of the default handler.
 
+# Debugging
+You may want to disable all retries and let everything fail on the very first attempt as if there was no rerty policy at all; this is useful for debugging (consider investigating an issue inside a code block that should be retried for 20 minutes before the exception surfaces). In this case you can simply disable all retry policies in your project by setting global "enabled" property:
+```ruby
+# Disable all retry policies for now...
+AttemptThis.enabled = false
+
+puts AttemptThis.enabled?
+```
+
+
 Enjoy! And feel free to contribute; just make sure you haven't broken any tests by running 'rake' from project's root.

data/attempt_this.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name				= 'attempt_this'
-  s.version			= '0.9.1'
-  s.date				= '2014-02-18'
+  s.version			= '1.0.0'
+  s.date				= '2014-04-27'
   s.summary			= 'Retry policy mix-in'
   s.description		= <<EOM
 Retry policy mix-in with configurable number of attempts, delays, exception filters, and fall back strategies.

data/lib/attempt_this/attempt_object.rb

@@ -27,6 +27,7 @@ module AttemptThis
     def attempt(block)
       # Returning self will allow chaining calls
       return self unless block
+      return block.call unless AttemptThis.enabled?
 
       last_exception = nil
       first_time = true

data/lib/attempt_this/attempt_this.rb

@@ -11,6 +11,14 @@ module AttemptThis
     impl.attempt(block)
   end
 
+  def enabled?
+    @enabled.nil? || @enabled
+  end
+
+  def enabled=(value)
+    @enabled = value
+  end
+
   # Resets all static data (scenarios). This is intended to use by tests only (to reset scenarios)
   def self.reset
     AttemptObject.reset

data/spec/attempt_spec.rb

@@ -293,4 +293,58 @@ describe AttemptThis do
       count.should eql(3)
     end
   end
-end
+
+  context 'enabled' do
+    class TestAttempt
+      include AttemptThis
+    end
+
+    subject{TestAttempt.new}
+
+    it 'should be true initially' do
+      subject.enabled?.should be_true
+    end
+
+    it 'should accept true' do
+      subject.enabled = true
+      subject.enabled?.should be_true
+    end
+
+    it 'should accept false' do
+      subject.enabled = false
+      subject.enabled?.should be_false
+    end
+
+    it 'should change from true to false' do
+      subject.enabled = true
+      subject.enabled = false
+      subject.enabled?.should be_false
+    end
+
+    it 'should change from false to true' do
+      subject.enabled = false
+      subject.enabled = true
+      subject.enabled?.should be_true
+    end
+
+    context 'when disabled' do
+      before(:each) do
+        AttemptThis.stub(:enabled?).and_return(false)
+      end
+
+      it 'should yield in the simplest case' do
+        expect{|b| attempt(3.times, &b)}.to yield_control
+      end
+
+      it 'should yield with chained calls' do
+        expect{|b| attempt(3.times).with_delay(100, &b)}.to yield_control
+      end
+
+      it 'should not retry' do
+        count = 0
+        expect{attempt(3.times) {count += 1; raise 'Test'}}.to raise_error('Test')
+        count.should eql(1)
+      end
+    end
+  end
+end

metadata

@@ -1,103 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: attempt_this
 version: !ruby/object:Gem::Version
-  version: 0.9.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Aliaksei Baturytski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Retry policy mix-in with configurable number of attempts, delays,
-  exception filters, and fall back strategies.
+description: |
+  Retry policy mix-in with configurable number of attempts, delays, exception filters, and fall back strategies.
 
-
-  See project''s home page for usage examples and more information.
-
-'
+  See project's home page for usage examples and more information.
 email: abaturytski@gmail.com
 executables: []
 extensions: []
@@ -120,26 +106,25 @@ files:
 homepage: https://github.com/aliakb/attempt_this
 licenses:
 - MIT
+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.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Retry policy mix-in
 test_files: []