tretry 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71ba2c226763f1363857d05720eb04841030f571
+  data.tar.gz: 76af0ef9b710a8f2bdd216daba264a285e220191
+SHA512:
+  metadata.gz: 8a0610e6ccb3124759ec5d40813dd5dd578c03db96704f4e8d1db8be7437f506d120e46557235a8666e898800c952135306e45ebcd6a85c4afc2854753033015
+  data.tar.gz: 35780677e337ba22211de5a2dbb3f6138363ce804c2a27dd5ac60a997ce8cac4410c378c7196833c15932d87cccea7e51ff6d2c020354e25212f30c5d8cd8411

data/Gemfile

@@ -11,3 +11,5 @@ group :development do
   gem "bundler", ">= 1.0.0"
   gem "jeweler", "~> 1.8.4"
 end
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,16 +1,48 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.1)
+      simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.4)
+    docile (1.1.5)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    git (1.2.8)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (3.3.1)
+    highline (1.6.21)
+    jeweler (1.8.8)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.7.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    json (1.8.1)
+    jwt (1.0.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
@@ -20,12 +52,18 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.0.0)
+  codeclimate-test-reporter
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)

data/README.md

@@ -0,0 +1,43 @@
+[![Build Status](https://api.shippable.com/projects/540e7b9e3479c5ea8f9ec25b/badge?branchName=master)](https://app.shippable.com/projects/540e7b9e3479c5ea8f9ec25b/builds/latest)
+[![Code Climate](https://codeclimate.com/github/kaspernj/tretry/badges/gpa.svg)](https://codeclimate.com/github/kaspernj/tretry)
+[![Test Coverage](https://codeclimate.com/github/kaspernj/tretry/badges/coverage.svg)](https://codeclimate.com/github/kaspernj/tretry)
+
+# tretry
+
+## Installation
+
+```ruby
+gem 'tretry'
+```
+
+## Usage
+
+### Simple retry three times (which is the default)
+```ruby
+Tretry.try do
+  # do something that might randomly fail.
+end
+```
+
+### Retry with options
+```ruby
+Tretry.try(tries: 3, timeout: 1.5, errors: [SomeCustomError], wait: 1) do
+  # do something.
+end
+```
+
+## Contributing to tretry
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/tretry.rb

@@ -1,93 +1,140 @@
 #A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.
 class Tretry
+  attr_reader :fails
+  attr_accessor :timeout, :tries, :wait
+
   #Valid keys that can be given as argument for the method 'try'.
   VALID_KEYS = [:tries, :timeout, :wait, :interrupt, :exit, :errors, :return_error]
-  
+
   #===Runs a block of code a given amount of times until it succeeds.
   #===Examples
   #  res = Tretry.try(:tries => 3) do
   #     #something that often fails
   #  end
-  #  
+  #
   #  puts "Tries: '#{res[:tries]}'."
   #  puts "Result: '#{res[:result}'."
   def self.try(args = {}, &block)
-    #Validate given arguments and set various variables.
-    raise "No block was given." if !block
-    raise "Expected argument to be a hash." if !args.is_a?(Hash)
-    
-    args.each do |key, val|
-      raise "Invalid key: '#{key}'." if !VALID_KEYS.include?(key)
-    end
-    
-    args[:tries] = 3 if !args[:tries]
-    tries = []
-    error = nil
-    res = nil
-    
-    args[:tries].to_i.downto(1) do |count|
-      error = nil
-      dobreak = false
-      
+    Tretry.new(args).try(&block)
+  end
+
+  def initialize(args = {})
+    @args = args
+    @fails = []
+    @before_retry = []
+
+    parse_arguments
+  end
+
+  def before_retry(&block)
+    @before_retry << block
+  end
+
+  def try(&block)
+    raise "No block given." unless block
+    @block = block
+
+    @tries.times do |count|
+      @count = count
+
+      unless first_try?
+        # Sleep for a given amount of time if the 'wait'-argument is given.
+        sleep(@wait) if @wait
+
+        call_before_retry(error: @error)
+        @error = nil
+      end
+
       begin
-        if args[:timeout]
-          #If a timeout-argument has been given, then run the code through the timeout.
-          begin
-            require "timeout"
-            Timeout.timeout(args[:timeout]) do
-              res = block.call
-              dobreak = true
-              break
-            end
-          rescue Timeout::Error => e
-            doraise = e if count <= 1
-            error = e
-            sleep(args[:wait]) if args[:wait] and !doraise
-          end
+        # If a timeout-argument has been given, then run the code through the timeout.
+        if @timeout
+          try_with_timeout
         else
-          #Else call block normally.
-          res = block.call
-          dobreak = true
-          break
+          # Else call block normally.
+          @res = @block.call
+          @dobreak = true
         end
       rescue Exception => e
-        if e.class == Interrupt
-          raise e if !args.key?(:interrupt) or args[:interrupt]
-        elsif e.class == SystemExit
-          raise e if !args.key?(:exit) or args[:exit]
-        elsif count <= 1 or (args.key?(:errors) and args[:errors].index(e.class) == nil)
-          doraise = e
-        elsif args.key?(:errors) and args[:errors].index(e.class) != nil
-          #given error was in the :errors-array - do nothing. Maybe later it should be logged and returned in a stats-hash or something? - knj
-        end
-        
-        error = e
-        
-        #Sleep for a given amount of time if the 'wait'-argument is given.
-        sleep(args[:wait]) if args[:wait] and !doraise
+        handle_error(e)
       end
-      
-      if doraise
-        if args[:return_error]
-          tries << {:error => error}
+
+      if @doraise
+        if @args[:return_error]
+          @fails << {error: @error}
           return {
-            :tries => tries,
-            :error => true
+            fails: @fails,
+            error: true
           }
         else
-          raise e
+          raise @error
         end
-      elsif error
-        tries << {:error => error}
+      elsif @error
+        @fails << {error: @error}
       end
-      
-      break if dobreak
+
+      break if @dobreak
     end
-    
+
     return {
-      :tries => tries,
-      :result => res,
-      :error => false
+      fails: @fails,
+      result: @res,
+      error: false
     }
   end
-end
+
+private
+
+  def parse_arguments
+    #Validate given arguments and set various variables.
+    raise "Expected argument to be a hash." unless @args.is_a?(Hash)
+
+    @args.each do |key, val|
+      raise "Invalid key: '#{key}'." unless VALID_KEYS.include?(key)
+    end
+
+    @args[:tries] ||= 3
+    @tries = @args[:tries].to_i
+    @wait = @args[:wait] ? @args[:wait] : nil
+    @timeout = @args[:timeout] ? @args[:timeout].to_f : nil
+  end
+
+  def try_with_timeout
+    begin
+      require "timeout"
+      Timeout.timeout(@timeout) do
+        @res = @block.call
+        @dobreak = true
+      end
+    rescue Timeout::Error => e
+      handle_error(e)
+    end
+  end
+
+  def handle_error(e)
+    if e.class == Interrupt
+      raise e if !@args.key?(:interrupt) || @args[:interrupt]
+    elsif e.class == SystemExit
+      raise e if !@args.key?(:exit) || @args[:exit]
+    elsif last_try? || (@args.key?(:errors) && !@args[:errors].include?(e.class))
+      @doraise = e
+    elsif @args.key?(:errors) && @args[:errors].index(e.class) != nil
+      #given error was in the :errors-array - do nothing. Maybe later it should be logged and returned in a stats-hash or something? - knj
+    end
+
+    @error = e
+  end
+
+  def call_before_retry(args)
+    @before_retry.each do |before_retry_block|
+      before_retry_block.call(args)
+    end
+  end
+
+  def last_try?
+    (@count + 1) >= @tries
+  end
+
+  def first_try?
+    @count == 0
+  end
+end

data/shippable.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+archive: true
+rvm:
+  - 2.1.2
+script:
+  - CODECLIMATE_REPO_TOKEN=9281604f9c3825e8a4aa4883a69461c037e15b7cadce8ce846a154c183b1a1a3 bundle exec rspec
+notifications:
+   email: false

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
@@ -8,5 +11,5 @@ require 'tretry'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
+
 end

data/spec/tretry_spec.rb

@@ -1,47 +1,78 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Tretry" do
-  it "should be able to run blocks" do
-    try = 0
-    res = Tretry.try(:tries => 5) do
-      try += 1
-      raise "Test #{try}" if try < 5
-      "kasper"
+  context "#try" do
+    it "should be able to run blocks" do
+      try = 0
+      res = Tretry.try(tries: 5) do
+        try += 1
+        raise "Test #{try}" if try < 5
+        "kasper"
+      end
+
+      res[:error].should eq false
+      res[:result].should eq "kasper"
     end
-    
-    raise "Expected error to be false but it wasnt: '#{res[:error]}'." if res[:error] != false
-    raise "Expected result to be 'kasper' but it wasnt: '#{res[:result]}'." if res[:result] != "kasper"
-  end
-  
-  it "should be able to do waits between tries" do
-    try = 0
-    time_start = Time.now.to_f
-    res = Tretry.try(:tries => 5, :wait => 0.1) do
-      try += 1
-      raise "Test #{try}" if try < 5
-      "kasper"
+
+    it "should be able to do waits between tries" do
+      try = 0
+      time_start = Time.now.to_f
+      res = Tretry.try(tries: 5, wait: 0.1) do
+        try += 1
+        raise "Test #{try}" if try < 5
+        "kasper"
+      end
+
+      time_end = Time.now.to_f
+      time_elap = time_end - time_start
+      time_elap.should > 0.4
+    end
+
+    it "should be able to do timeouts with tries" do
+      try = 0
+      res = Tretry.try(tries: 5, timeout: 0.1) do
+        try += 1
+        sleep 0.5 if try < 5
+        "kasper"
+      end
+
+      res[:error].should eq false
+      res[:result].should eq "kasper"
+      res[:fails].length.should eq 4
+
+      res[:fails].each do |err|
+        err[:error].is_a?(Timeout::Error).should eq true
+      end
     end
-    
-    time_end = Time.now.to_f
-    time_elap = time_end - time_start
-    
-    raise "Expected time to be more than 0.4 sec but it wasnt: '#{time_elap}'." if time_elap < 0.4
   end
-  
-  it "should be able to do timeouts with tries" do
-    try = 0
-    res = Tretry.try(:tries => 5, :timeout => 0.1) do
-      try += 1
-      sleep 0.5 if try < 5
-      "kasper"
+
+  it "#before_retry" do
+    before_retry_count = 0
+    try_count = 0
+
+    try = Tretry.new
+
+    try.before_retry do
+      before_retry_count += 1
+    end
+
+    try.try do
+      try_count += 1
+      raise "test" if try_count < 3
     end
-    
-    raise "Expected error to be false but it wasnt: '#{res[:error]}'." if res[:error] != false
-    raise "Expected result to be 'kasper' but it wasnt: '#{res[:result]}'." if res[:result] != "kasper"
-    raise "Expected number of errors to be 4 but it wasnt: '#{res[:tries].length}'." if res[:tries].length != 4
-    
-    res[:tries].each do |err|
-      raise "Expected error to be 'Timeout::Error' but it wasnt: '#{err[:error].class.name}'." if !err[:error].is_a?(Timeout::Error)
+
+    before_retry_count.should eq 2
+
+    try.fails.each do |try_i|
+      try_i[:error].is_a?(RuntimeError).should eq true
     end
   end
+
+  it "should raise an error if fails" do
+    expect {
+      Tretry.try do
+        raise "fail"
+      end
+    }.to raise_error(RuntimeError)
+  end
 end

data/tretry.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: tretry 0.0.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "tretry"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Kasper Johansen"]
+  s.date = "2014-11-21"
+  s.description = "A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more."
+  s.email = "k@spernj.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/tretry.rb",
+    "shippable.yml",
+    "spec/spec_helper.rb",
+    "spec/tretry_spec.rb",
+    "tretry.gemspec"
+  ]
+  s.homepage = "http://github.com/kaspernj/tretry"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.0"
+  s.summary = "A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

metadata

@@ -1,113 +1,116 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tretry
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Kasper Johansen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-30 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.12"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *id004
-description: A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: A library for doing retries in Ruby with timeouts, analysis of errors,
+  waits between tries and more.
 email: k@spernj.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
-- .document
-- .rspec
+- README.md
+files:
+- ".document"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/tretry.rb
+- shippable.yml
 - spec/spec_helper.rb
 - spec/tretry_spec.rb
-has_rdoc: true
+- tretry.gemspec
 homepage: http://github.com/kaspernj/tretry
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3966091872588483067
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.4.0
 signing_key: 
-specification_version: 3
-summary: A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.
+specification_version: 4
+summary: A library for doing retries in Ruby with timeouts, analysis of errors, waits
+  between tries and more.
 test_files: []
-

data/README.rdoc

@@ -1,19 +0,0 @@
-= tretry
-
-Description goes here.
-
-== Contributing to tretry
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
-further details.
-