Class: DMTool::Result

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/dmtool/result.rb

Constant Summary collapse

Success = 
DMTool::Result.new(success: true, failure: false, critical: false, symbol: :success)
Failure = 
DMTool::Result.new(success: false, failure: true, critical: false, symbol: :failure)
NilResult = 
DMTool::Result.new(success: false, failure: false, critical: false, symbol: :nil_result)
CriticalSuccess = 
DMTool::Result.new(success: true, failure: false, critical: true, symbol: :critical_success)
CriticalFailure = 
DMTool::Result.new(success: false, failure: true, critical: true, symbol: :critical_failure)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success: false, failure: false, critical: false, symbol: :nil_result) ⇒ Result

Returns a new instance of Result.



4
5
6
7
8
9
 
# File 'lib/dmtool/result.rb', line 4

def initialize(success: false, failure: false, critical: false, symbol: :nil_result)
  @success = success
  @failure = failure
  @critical = critical
  @symbol = symbol
end

Instance Attribute Details

#critical ⇒ Object (readonly) Also known as: critical?

Returns the value of attribute critical.



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

def critical
  @critical
end

#failure ⇒ Object (readonly) Also known as: failure?

Returns the value of attribute failure.



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

def failure
  @failure
end

#success ⇒ Object (readonly) Also known as: success?

Returns the value of attribute success.



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

def success
  @success
end

#symbol ⇒ Object (readonly) Also known as: to_sym

Returns the value of attribute symbol.



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

def symbol
  @symbol
end

Instance Method Details

#+(other) ⇒ Object 



45
46
47
 
# File 'lib/dmtool/result.rb', line 45

def +(other)
  self.to_i + other.to_i
end

#<=>(other) ⇒ Object 



49
50
51
 
# File 'lib/dmtool/result.rb', line 49

def <=>(other)
  self.to_i <=> other.to_i
end

#coerce(other) ⇒ Object 



41
42
43
 
# File 'lib/dmtool/result.rb', line 41

def coerce(other)
  [other, self.to_i]
end

#critical_failure ⇒ Object Also known as: critical_failure? 



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

def critical_failure
  critical? && failure?
end

#critical_success ⇒ Object Also known as: critical_success? 



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

def critical_success
  critical? && success?
end

#to_i ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/dmtool/result.rb', line 33

def to_i
  val = 0
  val += 1 if success?
  val -=1 if failure?
  val *=2 if critical?
  val
end

#to_s ⇒ Object 



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

def to_s
  "#{to_sym}"
end