Class: Outcome

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success, result, messages = [], errors = [], warnings = []) ⇒ Outcome

Initializes an Outcome instance @param success indicates if process was successful. @param result the return value of the process. Anything you want to return @param[Array<String>, optional] messages messages as Array of strings, optional @param[Array<String>, optional] errors errors as Array of strings, optional @param[Array<String>, optional] warnings warnings as Array of strings, optional



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

def initialize(success, result, messages = [], errors = [], warnings = [])
  @success, @result, @messages, @errors, @warnings = success, result, messages, errors, warnings
end

Instance Attribute Details

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



3
4
5
 
# File 'lib/outcome.rb', line 3

def errors
  @errors
end

#messages ⇒ Object (readonly)

Returns the value of attribute messages.



3
4
5
 
# File 'lib/outcome.rb', line 3

def messages
  @messages
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



3
4
5
 
# File 'lib/outcome.rb', line 3

def result
  @result
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



3
4
5
 
# File 'lib/outcome.rb', line 3

def success
  @success
end

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



3
4
5
 
# File 'lib/outcome.rb', line 3

def warnings
  @warnings
end

Instance Method Details

#fail? ⇒ Boolean

Returns:

  • (Boolean) 


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

def fail?
  !@success
end

#messages_to_html ⇒ Object 



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

def messages_to_html
  @messages.join('<br/>')
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/outcome.rb', line 15

def success?
  @success
end