Class: ObjectIdentifier::StringFormatter::Collection

Inherits:

Object

• Object
• ObjectIdentifier::StringFormatter::Collection

Defined in:

lib/object_identifier/formatters/string_formatter.rb

Overview

ObjectIdentifier::StringFormatter::Collection formats a collection-specific identification String, which will also necessarily be composed of Item identification Strings.

Instance Attribute Summary

• #objects ⇒ Object readonly

  Returns the value of attribute objects.

• #parameters ⇒ Object readonly

  Returns the value of attribute parameters.

Instance Method Summary

• #call ⇒ String

  Build a comma-separated list of formatted item Strings representing the given objects.

• #initialize(objects, parameters) ⇒ Collection constructor

  A new instance of Collection.

Constructor Details

#initialize(objects, parameters) ⇒ Collection

Returns a new instance of Collection.

Parameters:

• objects (Object, [Object, ...]) —

  the object(s) to be interrogated for String values to be added to the output String

• parameters (ObjectIdentifier::Parameters)

# File 'lib/object_identifier/formatters/string_formatter.rb', line 44

def initialize(objects, parameters)
  @objects = objects
  @parameters = parameters
end

Instance Attribute Details

#objects ⇒ Object (readonly)

Returns the value of attribute objects.

# File 'lib/object_identifier/formatters/string_formatter.rb', line 38

def objects
  @objects
end

#parameters ⇒ Object (readonly)

Returns the value of attribute parameters.

# File 'lib/object_identifier/formatters/string_formatter.rb', line 38

def parameters
  @parameters
end

Instance Method Details

#call ⇒ String

Build a comma-separated list of formatted item Strings representing the given objects.

Returns:

• (String)

# File 'lib/object_identifier/formatters/string_formatter.rb', line 53

def call
  parts = objects.first(limit).map! { |obj| format_item(obj) }
  parts << "... (#{truncated_objects_count} more)" if truncated?
  parts.join(", ")
end