Class: Kapnismology::BaseResult

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

Overview

This is the base class for all types of results. It is useful to be able to test if the object is of a correct result type. It also have methods to add information and serialize it.

Direct Known Subclasses

NullResult, Result, Success

Instance Method Summary collapse

Instance Method Details

#add_extra_messages(messages) ⇒ Object 



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

def add_extra_messages(messages)
  @extra_messages = (messages || []).compact.flatten
  self
end

#passed? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/kapnismology/result.rb', line 23

def passed?
  !!@passed
end

#to_hash ⇒ Object 



6
7
8
 
# File 'lib/kapnismology/result.rb', line 6

def to_hash
  { passed: passed?, data: @data, message: @message, extra_messages: @extra_messages }
end

#to_s(name) ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/kapnismology/result.rb', line 10

def to_s(name)
  <<-eos
#{format_passed(passed?)}: #{name}
#{format_extra_messages(@extra_messages)}#{Terminal.bold(@message)}
   #{@data}
eos
end