Class: Arbitrium::Result

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success, message, object = nil) ⇒ Result

Returns a new instance of Result.



13
14
15
16
17
18
19
 
# File 'lib/arbitrium/result.rb', line 13

def initialize(success, message, object = nil)
  @success = success
  @message = message
  @object  = object

  raise 'Error! Incorrect data types for arguments expected (boolean, string, object)!' unless valid?
end

Instance Attribute Details

#message ⇒ Object (readonly)

Returns the value of attribute message.



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

def message
  @message
end

#object ⇒ Object (readonly)

Returns the value of attribute object.



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

def object
  @object
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



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

def success
  @success
end

Class Method Details

.default_failure(object = nil) ⇒ Object 



9
10
11
 
# File 'lib/arbitrium/result.rb', line 9

def self.default_failure(object = nil)
  new(false, 'Failed to complete.', object)
end

.default_success(object = nil) ⇒ Object 



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

def self.default_success(object = nil)
  new(true, 'Completed successfully.', object)
end

Instance Method Details

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/arbitrium/result.rb', line 25

def failed?
  !successful?
end

#successful? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/arbitrium/result.rb', line 21

def successful?
  self.success
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/arbitrium/result.rb', line 29

def valid?
  check_validity
end