Class: ShellStrike::Result

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

Instance Method Summary collapse

Constructor Details

#initialize(success_value, message = '', error_type = nil) ⇒ Result

Initialises a new Result object, used to represent whether a task was successful.

Parameters:

  • success_value (Boolean) —

    whether the action was successful.

  • message (String) (defaults to: '') —

    a message explaining the result.

  • error_type (Symbol, nil) (defaults to: nil) —

    a symbol representing the type of failure.



6
7
8
9
10
 
# File 'lib/shell_strike/result.rb', line 6

def initialize(success_value, message = '', error_type = nil)
  @success_value = success_value
  @message = message
  @error_type = error_type
end

Instance Method Details

#error_type ⇒ Symbol?

Returns a symbol representing the type of error that occurred; or nil if #success? is true.

Returns:

  • (Symbol, nil) —

    a symbol representing the type of error that occurred; or nil if #success? is true



27
28
29
30
31
 
# File 'lib/shell_strike/result.rb', line 27

def error_type
  return nil if success?

  @error_type
end

#message ⇒ String

Returns a message explaining the result.

Returns:

  • (String) —

    a message explaining the result.



22
23
24
 
# File 'lib/shell_strike/result.rb', line 22

def message
  @message
end

#success? ⇒ Boolean

Whether the success_value is set to true

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/shell_strike/result.rb', line 13

def success?
  @success_value
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/shell_strike/result.rb', line 17

def valid?
  success?
end