Class: Arq::Context

Inherits:
Hash
  • Object
show all
Defined in:
lib/arq/context.rb

Overview

Light wrapper around Hash with additional properties for action results.

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Context

Returns a new instance of Context.



6
7
8
9
 
# File 'lib/arq/context.rb', line 6

def initialize(params = {})
  super(nil)
  merge!(params)
end

Instance Method Details

#fail!(message = nil) ⇒ Object 



11
12
13
14
 
# File 'lib/arq/context.rb', line 11

def fail!(message = nil)
  @failure = true
  @message = message
end

#fail_now!(message = nil) ⇒ Object

Raises:



16
17
18
19
 
# File 'lib/arq/context.rb', line 16

def fail_now!(message = nil)
  fail!(message)
  raise Arq::FailureError
end

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/arq/context.rb', line 21

def failure?
  @failure ||= false
end

#message ⇒ Object 



29
30
31
 
# File 'lib/arq/context.rb', line 29

def message
  @message ||= ""
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/arq/context.rb', line 25

def success?
  !failure?
end