tretry 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 71ba2c226763f1363857d05720eb04841030f571
-  data.tar.gz: 76af0ef9b710a8f2bdd216daba264a285e220191
+SHA256:
+  metadata.gz: 3f933d5081600c123053375007affe0de256d65786552eeed9f795df3db5a587
+  data.tar.gz: 97cb722fc297493e9e62df7f95aec8307f7d21904f56ec39d327426c200d8103
 SHA512:
-  metadata.gz: 8a0610e6ccb3124759ec5d40813dd5dd578c03db96704f4e8d1db8be7437f506d120e46557235a8666e898800c952135306e45ebcd6a85c4afc2854753033015
-  data.tar.gz: 35780677e337ba22211de5a2dbb3f6138363ce804c2a27dd5ac60a997ce8cac4410c378c7196833c15932d87cccea7e51ff6d2c020354e25212f30c5d8cd8411
+  metadata.gz: 6d8a9a03e39478b6174012c927e9356f63c2728d9362747f0e3345ee0d5173047e30c317d0ae67e8a3c928203d3a0f4eceedad64433faf74a738dadf881263a2
+  data.tar.gz: a9af5b8ae687177475cf3aff52a6157dc8647676bc7519ccc01fadc98799166e12b6a5c030cf2f629ce2fee3bc08e7db58aedc9782783e16e95e9fea680c98c3

data/Rakefile

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,41 +7,17 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "tretry"
-  gem.homepage = "http://github.com/kaspernj/tretry"
-  gem.license = "MIT"
-  gem.summary = %Q{A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.}
-  gem.description = %Q{A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.}
-  gem.email = "k@spernj.org"
-  gem.authors = ["Kasper Johansen"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
+require "rake"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = "spec/**/*_spec.rb"
   spec.rcov = true
 end
 
 task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tretry #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/lib/tretry/result.rb

@@ -0,0 +1,22 @@
+class Tretry::Result
+  attr_reader :error, :fails, :result
+
+  def initialize(error:, fails:, result:)
+    @error = error
+    @fails = fails
+    @result = result
+  end
+
+  def [](key)
+    case key
+    when :error
+      error
+    when :fails
+      fails
+    when :result
+      result
+    else
+      raise "Unknown key: #{key}"
+    end
+  end
+end

data/lib/tretry.rb

@@ -1,11 +1,10 @@
 #A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.
 class Tretry
+  autoload :Result, "#{__dir__}/tretry/result"
+
   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
@@ -14,16 +13,20 @@ class Tretry
   #
   #  puts "Tries: '#{res[:tries]}'."
   #  puts "Result: '#{res[:result}'."
-  def self.try(args = {}, &block)
-    Tretry.new(args).try(&block)
+  def self.try(**args, &block)
+    Tretry.new(**args).try(&block)
   end
 
-  def initialize(args = {})
-    @args = args
+  def initialize(errors: nil, exit: true, interrupt: true, return_error: nil, timeout: nil, tries: 3, wait: nil)
+    @errors = errors
+    @exit = exit
     @fails = []
+    @interrupt = interrupt
     @before_retry = []
-
-    parse_arguments
+    @return_error = return_error
+    @timeout = timeout
+    @tries = tries
+    @wait = wait
   end
 
   def before_retry(&block)
@@ -59,12 +62,12 @@ class Tretry
       end
 
       if @doraise
-        if @args[:return_error]
+        if @return_error
           @fails << {error: @error}
-          return {
+          return Tretry::Result.new(
             fails: @fails,
             error: true
-          }
+          )
         else
           raise @error
         end
@@ -75,29 +78,15 @@ class Tretry
       break if @dobreak
     end
 
-    return {
+    Tretry::Result.new(
       fails: @fails,
       result: @res,
       error: false
-    }
+    )
   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"
@@ -112,13 +101,13 @@ private
 
   def handle_error(e)
     if e.class == Interrupt
-      raise e if !@args.key?(:interrupt) || @args[:interrupt]
+      raise e if @interrupt
     elsif e.class == SystemExit
-      raise e if !@args.key?(:exit) || @args[:exit]
-    elsif last_try? || (@args.key?(:errors) && !@args[:errors].include?(e.class))
+      raise e if @exit
+    elsif last_try? || @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
+    elsif @errors&.include?(e.class)
+      # 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

metadata

@@ -1,93 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: tretry
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- Kasper Johansen
+- Kasper Stöckel
 autorequire: 
 bindir: bin
 cert_chain: []
 date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.3.13
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 3.11.0
 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:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 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
+- lib/tretry/result.rb
 homepage: http://github.com/kaspernj/tretry
 licenses:
 - MIT
@@ -107,8 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.0
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A library for doing retries in Ruby with timeouts, analysis of errors, waits

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile

@@ -1,15 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", ">= 1.0.0"
-  gem "jeweler", "~> 1.8.4"
-end
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,69 +0,0 @@
-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)
-    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.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)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    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/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2012 Kasper Johansen
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,43 +0,0 @@
-[![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 +0,0 @@
-0.0.2

data/shippable.yml

@@ -1,9 +0,0 @@
-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,15 +0,0 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'tretry'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-
-end

data/spec/tretry_spec.rb

@@ -1,78 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Tretry" do
-  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
-
-    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
-  end
-
-  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
-
-    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

@@ -1,62 +0,0 @@
-# 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
-