Class: YARD::I18n::Messages

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/yard/i18n/messages.rb

Overview

Acts as a container for Message objects.

Since:

  • 0.8.1

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeMessages

Creates a new container.

Since:

  • 0.8.1



11
12
13
# File 'lib/yard/i18n/messages.rb', line 11

def initialize
  @messages = {}
end

Instance Attribute Details

#messagesHash{String=>Message} (readonly, protected)

Returns the set of message objects

Returns:

Since:

  • 0.8.1



53
54
55
# File 'lib/yard/i18n/messages.rb', line 53

def messages
  @messages
end

Instance Method Details

#==(other) ⇒ Boolean

Checks if this messages list is equal to another messages list.

Parameters:

  • other (Messages)

    the container to compare.

Returns:

  • (Boolean)

    whether self and other is equivalence or not.

Since:

  • 0.8.1



45
46
47
48
# File 'lib/yard/i18n/messages.rb', line 45

def ==(other)
  other.is_a?(self.class) &&
    @messages == other.messages
end

#[](id) ⇒ Message?

Returns a registered message for the given id, or nil if no message for the ID is found.

Parameters:

  • id (String)

    the message ID to perform a lookup on.

Returns:

  • (Message, nil)

    a registered message for the given id, or nil if no message for the ID is found.

Since:

  • 0.8.1



27
28
29
# File 'lib/yard/i18n/messages.rb', line 27

def [](id)
  @messages[id]
end

#each {|message| ... } ⇒ void

This method returns an undefined value.

Enumerates each YARD::I18n::Message in the container.

Yield Parameters:

  • message (Message)

    the next message object in the enumeration.

Since:

  • 0.8.1



20
21
22
# File 'lib/yard/i18n/messages.rb', line 20

def each(&block)
  @messages.each_value(&block)
end

#register(id) ⇒ Message

Registers a YARD::I18n::Message, the mssage ID of which is id. If corresponding Message is already registered, the previously registered object is returned.

Parameters:

  • id (String)

    the ID of the message to be registered.

Returns:

  • (Message)

    the registered Message.

Since:

  • 0.8.1



37
38
39
# File 'lib/yard/i18n/messages.rb', line 37

def register(id)
  @messages[id] ||= Message.new(id)
end