123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Retry

Relationships & Source Files
Inherits: Object
Defined in: lib/bundler/retry.rb

Overview

General purpose class for retrying code that may fail

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name, exceptions = nil, retries = self.class.default_retries) ⇒ Retry

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 19

def initialize(name, exceptions = nil, retries = self.class.default_retries)
  @name = name
  @retries = retries
  @exceptions = Array(exceptions) || []
  @total_runs = @retries + 1 # will run once, then upto attempts.times
end

Class Method Details

.attempts

Alias for .default_attempts.

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 12

alias_method :attempts, :default_attempts

.default_attempts Also known as: .attempts

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 9

def default_attempts
  default_retries + 1
end

.default_retries

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 14

def default_retries
  Bundler.settings[:retry]
end

Instance Attribute Details

#current_run (rw)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 6

attr_accessor :name, :total_runs, :current_run

#keep_trying?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 56

def keep_trying?
  return true  if current_run.zero?
  return false if last_attempt?
  return true  if @failed
end

#last_attempt?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 62

def last_attempt?
  current_run >= total_runs
end

#name (rw)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 6

attr_accessor :name, :total_runs, :current_run

#total_runs (rw)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 6

attr_accessor :name, :total_runs, :current_run

Instance Method Details

#attempt(&block) Also known as: #attempts

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 26

def attempt(&block)
  @current_run = 0
  @failed      = false
  @error       = nil
  run(&block) while keep_trying?
  @result
end

#attempts(&block)

Alias for #attempt.

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 33

alias_method :attempts, :attempt

#fail_attempt(e) (private)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 45

def fail_attempt(e)
  @failed = true
  if last_attempt? || @exceptions.any? {|k| e.is_a?(k) }
    Bundler.ui.info "" unless Bundler.ui.debug?
    raise e
  end
  return true unless name
  Bundler.ui.info "" unless Bundler.ui.debug? # Add new line incase dots preceded this
  Bundler.ui.warn "Retrying #{name} due to error (#{current_run.next}/#{total_runs}): #{e.class} #{e.message}", Bundler.ui.debug?
end

#run(&block) (private)

[ GitHub ]

  
# File 'lib/bundler/retry.rb', line 37

def run(&block)
  @failed = false
  @current_run += 1
  @result = block.call
rescue StandardError => e
  fail_attempt(e)
end