Class: ServiceObjects::Message

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/service_objects/message.rb

Overview

Describes messages published by service objects

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#priority ⇒ Float (readonly)

The priority level for the message

If priority hasn’t been set on initialization, sets it to -1.0 for errors, or 0.0 otherwise.

Returns:

  • (Float) 


29
30
31
32
 
# File 'lib/service_objects/message.rb', line 29

def priority
  return @custom_priority.to_f if @custom_priority
  type == "error" ? -1.0 : 0.0
end

#text ⇒ String (readonly)

The text of the message

Returns:

  • (String) 


20
21
22
 
# File 'lib/service_objects/message.rb', line 20

def text
  @text
end

#type ⇒ String (readonly)

The type of the message

Returns:

  • (String) 


14
15
16
 
# File 'lib/service_objects/message.rb', line 14

def type
  @type
end

Class Method Details

.initialize(type:, text:, priority: nil) ⇒ ServiceObjects::Message

Constructs and freezes the message object

Examples:

Message.new type: "info", text: "foo", priority: 3

Parameters:

  • type (#to_s)
  • text (#to_s)
  • priority (#to_f) (defaults to: nil) —

    optional custom priority of the message (the less the higher)

Returns:



48
49
50
51
52
53
 
# File 'lib/service_objects/message.rb', line 48

def initialize(type:, text:, priority: nil)
  @type = type.to_s.freeze
  @text = text.to_s.freeze
  @custom_priority = priority
  freeze
end

Instance Method Details

#<=>(other) ⇒ -1, ...

Compares the message with the other object

Parameters:

  • other (Object)

Returns:

  • (-1, 0, 1) —

    if the argument is a message

  • (nil) —

    if the other object is not a message



75
76
77
78
79
80
 
# File 'lib/service_objects/message.rb', line 75

def <=>(other)
  return unless other.is_a? self.class
  [:priority, :type, :text]
    .map { |key| __compare_to__ other, by: key }
    .detect { |value| value } || 0
end

#==(other) ⇒ true, false

Checks equality of the message to the other object

Parameters:

  • other (Object)

Returns:

  • (true) —

    if messages has the same attributes

  • (false) —

    if the other object is not a message or has different argument(s)



63
64
65
 
# File 'lib/service_objects/message.rb', line 63

def ==(other)
  (self <=> other) == 0
end

#inspect ⇒ String

A human-readable representation of the message

Returns:

  • (String) 


99
100
101
102
103
104
105
106
 
# File 'lib/service_objects/message.rb', line 99

def inspect
  %W(
    #<ServiceObjects::Message:#{ object_id }
    type=\"#{ type }\"
    text=\"#{ text }\"
    priority=#{ priority }>
  ).join(" ")
end

#new(type: , text: , priority: ) ⇒ ServiceObjects::Message

Constructs and freezes the message object

Examples:

Message.new type: "info", text: "foo", priority: 3

Parameters:

  • type (#to_s) (defaults to: )
  • text (#to_s) (defaults to: )
  • priority (#to_f) (defaults to: ) —

    optional custom priority of the message (the less the higher)

Returns:



48
49
50
51
52
53
 
# File 'lib/service_objects/message.rb', line 48

def initialize(type:, text:, priority: nil)
  @type = type.to_s.freeze
  @text = text.to_s.freeze
  @custom_priority = priority
  freeze
end

#to_h ⇒ Hash

Converts the message object to hash

Returns:

  • (Hash) 


85
86
87
 
# File 'lib/service_objects/message.rb', line 85

def to_h
  { type: type, text: text }
end

#to_json ⇒ String

Converts the message object to json

Returns:

  • (String) 


92
93
94
 
# File 'lib/service_objects/message.rb', line 92

def to_json
  to_h.to_json
end