Class: Bundler::Retry

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/retry.rb

Overview

General purpose class for retrying code that may fail

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, exceptions = nil, retries = self.class.default_retries, opts = {}) ⇒ Retry

Returns a new instance of Retry.



24
25
26
27
28
29
30
31
32
 
# File 'lib/bundler/retry.rb', line 24

def initialize(name, exceptions = nil, retries = self.class.default_retries, opts = {})
  @name = name
  @retries = retries
  @exceptions = Array(exceptions) || []
  @total_runs = @retries + 1 # will run once, then upto attempts.times
  @base_delay = opts[:base_delay] || self.class.default_base_delay
  @max_delay = opts[:max_delay] || 60.0
  @jitter = opts[:jitter] || 0.5
end

Class Attribute Details

.default_base_delay ⇒ Object

Returns the value of attribute default_base_delay.



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

def default_base_delay
  @default_base_delay
end

Instance Attribute Details

#current_run ⇒ Object

Returns the value of attribute current_run.



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

def current_run
  @current_run
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#total_runs ⇒ Object

Returns the value of attribute total_runs.



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

def total_runs
  @total_runs
end

Class Method Details

.default_attempts ⇒ Object Also known as: attempts 



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

def default_attempts
  default_retries + 1
end

.default_retries ⇒ Object 



16
17
18
 
# File 'lib/bundler/retry.rb', line 16

def default_retries
  Bundler.settings[:retry]
end

Instance Method Details

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



34
35
36
37
38
39
40
 
# File 'lib/bundler/retry.rb', line 34

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