Class: Mu::Result::BaseResult

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

Instance Method Summary collapse

Constructor Details

#initialize(is_success: true, code: :ok, data: nil) ⇒ BaseResult

Returns a new instance of BaseResult.



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

def initialize(is_success: true, code: :ok, data: nil)
  @is_success = is_success
  @code = code
  @data = data
end

Instance Method Details

#code ⇒ Object 



16
17
18
 
# File 'lib/mu/result/base_result.rb', line 16

def code
  @code
end

#code!(value) ⇒ Object 



11
12
13
14
 
# File 'lib/mu/result/base_result.rb', line 11

def code!(value)
  @code = value
  self
end

#data ⇒ Object 



20
21
22
 
# File 'lib/mu/result/base_result.rb', line 20

def data
  @data
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/mu/result/base_result.rb', line 28

def error?
  !success?
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/mu/result/base_result.rb', line 24

def success?
  @is_success == true
end

#to_hash ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/mu/result/base_result.rb', line 42

def to_hash
  {
    code: code,
    data: data,
  }
end

#unwrap(symbol = nil) ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/mu/result/base_result.rb', line 32

def unwrap(symbol = nil)
  return data if symbol.nil?

  if !data.respond_to?(:include?) || !data.include?(symbol)
    raise StandardError.new("The symbol '#{symbol}' is not included in the result data object.")
  end

  return data[symbol]
end