Class: Slayer::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/slayer/result.rb,
lib/slayer/compat/compat_040.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, status, message) ⇒ Result

Returns a new instance of Result.



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

def initialize(value, status, message)
  @value   = value
  @status  = status
  @message = message
end

Instance Attribute Details

#message ⇒ Object (readonly)

Returns the value of attribute message.



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

def message
  @message
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



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

def status
  @status
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



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

def value
  @value
end

Instance Method Details

#err? ⇒ Boolean

Returns:

  • (Boolean) 


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

def err?
  @err ||= false
end

#fail ⇒ Object 



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

def fail
  @err ||= true
  self
end

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
 
# File 'lib/slayer/compat/compat_040.rb', line 35

def failure?
  warn '[DEPRECATION] `failure?` is deprecated.  Please use `err?` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
  err?
end

#ok? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ok?
  !err?
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
 
# File 'lib/slayer/compat/compat_040.rb', line 30

def success?
  warn '[DEPRECATION] `success?` is deprecated.  Please use `ok?` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
  ok?
end