tretry 0.0.1 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ec5ecfe155371b1b3c9698118b3d1d01c6136125c94dc136925ae1473e234a6
+  data.tar.gz: 497ed8ab7b1bff0ae9f9c5025fab65b086459f6aa55b73fdfaf624a8a62ef875
+SHA512:
+  metadata.gz: f28e16cff32efb56d911ad726f2f23d8d8aebe1ad602ca364b9321caf67fc793528afe73a828ae97c5c503163a348aa38ef3dab8c9ac18a28644be68097db052
+  data.tar.gz: c40a00b1dbb9afa773e438dfdef671d4a614f5da4b852266ac80d6d1e6595238d14c688c6c4586cbffd7a383568aa233f52126c9b2aa99dec712278f57d99624

data/Rakefile

@@ -1,49 +1,23 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.warn e.message
+  $stderr.warn "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
+task default: :spec

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,93 +1,128 @@
-#A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.
+# A library for doing retries in Ruby with timeouts, analysis of errors, waits between tries and more.
 class Tretry
-  #Valid keys that can be given as argument for the method 'try'.
-  VALID_KEYS = [:tries, :timeout, :wait, :interrupt, :exit, :errors, :return_error]
-  
+  autoload :Result, "#{__dir__}/tretry/result"
+
+  attr_accessor :error, :errors, :exit, :fails, :interrupt, :return_error, :timeout, :tries, :wait
+
   #===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
-      
+  def self.try(**args, &block)
+    Tretry.new(**args).try(&block)
+  end
+
+  def initialize(errors: nil, exit: true, interrupt: true, return_error: nil, timeout: nil, tries: 3, wait: nil)
+    self.errors = errors
+    self.exit = exit
+    self.fails = []
+    self.interrupt = interrupt
+    @before_retry = []
+    self.return_error = return_error
+    self.timeout = timeout
+    self.tries = tries
+    self.wait = wait
+  end
+
+  def before_retry(&block)
+    @before_retry << block
+  end
+
+  def try(&block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    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)
+        self.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
-        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
+          # Else call block normally.
+          @res = @block.call
+          @dobreak = true
         end
-        
-        error = e
-        
-        #Sleep for a given amount of time if the 'wait'-argument is given.
-        sleep(args[:wait]) if args[:wait] and !doraise
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        handle_error(e)
       end
-      
-      if doraise
-        if args[:return_error]
-          tries << {:error => error}
-          return {
-            :tries => tries,
-            :error => true
-          }
-        else
-          raise e
+
+      if @doraise
+        if return_error
+          fails << {error: error}
+
+          return Tretry::Result.new(
+            fails: fails,
+            error: true
+          )
         end
+
+        raise error
       elsif error
-        tries << {:error => error}
+        fails << {error: error}
       end
-      
-      break if dobreak
+
+      break if @dobreak
     end
-    
-    return {
-      :tries => tries,
-      :result => res,
-      :error => false
-    }
+
+    Tretry::Result.new(
+      fails: fails,
+      result: @res,
+      error: false
+    )
+  end
+
+private
+
+  def try_with_timeout
+    require "timeout"
+    Timeout.timeout(timeout) do
+      @res = @block.call
+      @dobreak = true
+    end
+  rescue Timeout::Error => e
+    handle_error(e)
+  end
+
+  def handle_error(error) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    if error.instance_of?(Interrupt)
+      raise error if interrupt
+    elsif error.instance_of?(SystemExit)
+      raise error if self.exit
+    elsif last_try? || (errors && !errors.include?(error.class))
+      @doraise = error
+    elsif errors&.include?(error.class) # rubocop:disable Lint/EmptyConditionalBody
+      # 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
+
+    self.error = error
+  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.zero?
   end
-end
+end

metadata

@@ -1,113 +1,118 @@
---- !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.4
 platform: ruby
-authors: 
-- Kasper Johansen
+authors:
+- Kasper Stöckel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-30 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2022-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.13
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.8.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.11.0
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rdoc
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.12"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.8.4
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   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: '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.rdoc
-files: 
-- .document
-- .rspec
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
+files:
 - Rakefile
-- VERSION
 - lib/tretry.rb
-- spec/spec_helper.rb
-- spec/tretry_spec.rb
-has_rdoc: true
+- lib/tretry/result.rb
 homepage: http://github.com/kaspernj/tretry
-licenses: 
+licenses:
 - MIT
+metadata:
+  rubygems_mfa_required: 'true'
 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: '2.6'
+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: 3.0.3.1
 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/.document

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

data/.rspec

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

data/Gemfile

@@ -1,13 +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

data/Gemfile.lock

@@ -1,31 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      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)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.0.0)
-  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.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.
-

data/VERSION

@@ -1 +0,0 @@
-0.0.1

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$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,47 +0,0 @@
-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"
-    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"
-    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"
-    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)
-    end
-  end
-end