Class: ActionLogic::ActionContext

Inherits:
OpenStruct
  • Object
show all
Defined in:
lib/action_logic/action_context.rb

Constant Summary collapse

SUCCESS = 
:success
FAILURE = 
:failure
HALTED = 
:halted

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ActionContext

Returns a new instance of ActionContext.



9
10
11
12
 
# File 'lib/action_logic/action_context.rb', line 9

def initialize(params = {})
  params[:status] ||= SUCCESS
  super(params)
end

Instance Method Details

#fail!(message = "") ⇒ Object 



19
20
21
 
# File 'lib/action_logic/action_context.rb', line 19

def fail!(message = "")
  update!(FAILURE, message)
end

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/action_logic/action_context.rb', line 31

def failure?
  self.status == FAILURE
end

#halt!(message = "") ⇒ Object 



23
24
25
 
# File 'lib/action_logic/action_context.rb', line 23

def halt!(message = "")
  update!(HALTED, message)
end

#halted? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/action_logic/action_context.rb', line 35

def halted?
  self.status == HALTED
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/action_logic/action_context.rb', line 27

def success?
  self.status == SUCCESS
end

#update!(status, message) ⇒ Object 



14
15
16
17
 
# File 'lib/action_logic/action_context.rb', line 14

def update!(status, message)
  self.status = status
  self.message = message
end