Class: ActionMan::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/action_man/result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status, params: {}, errors: {}, output: nil) ⇒ Result

Returns a new instance of Result.



17
18
19
20
21
22
# File 'lib/action_man/result.rb', line 17

def initialize(status, params: {}, errors: {}, output: nil)
  @status = status.to_sym
  @params = params
  @errors = errors
  @output = output
end

Instance Attribute Details

#errorsObject (readonly)

Returns the value of attribute errors.



5
6
7
# File 'lib/action_man/result.rb', line 5

def errors
  @errors
end

#outputObject (readonly)

Returns the value of attribute output.



5
6
7
# File 'lib/action_man/result.rb', line 5

def output
  @output
end

#paramsObject (readonly)

Returns the value of attribute params.



5
6
7
# File 'lib/action_man/result.rb', line 5

def params
  @params
end

#statusObject (readonly)

Returns the value of attribute status.



5
6
7
# File 'lib/action_man/result.rb', line 5

def status
  @status
end

Class Method Details

.failure(errors: {}, output: nil) ⇒ Object



12
13
14
# File 'lib/action_man/result.rb', line 12

def failure(errors: {}, output: nil)
  new(:failure, errors:, output:)
end

.success(params: {}, output: nil) ⇒ Object



8
9
10
# File 'lib/action_man/result.rb', line 8

def success(params: {}, output: nil)
  new(:success, params:, output:)
end

Instance Method Details

#failure?Boolean

Returns:

  • (Boolean)


28
29
30
# File 'lib/action_man/result.rb', line 28

def failure?
  @status == :failure
end

#success?Boolean

Returns:

  • (Boolean)


24
25
26
# File 'lib/action_man/result.rb', line 24

def success?
  @status == :success
end