Module: Redstruct::Utils::Inspectable

Included in:

ConnectionProxy, Factory, Factory::Object

Defined in:

lib/redstruct/utils/inspectable.rb

Overview

Adds helper methods for calling #inspect on a custom object

Instance Method Summary

• #inspect ⇒ String (also: #to_s)

  Generates a human readable list of attributes when inspecting a custom object.

• #inspectable_attributes ⇒ Hash<String, #inspect>

  To be overloaded by the including class.

Instance Method Details

#inspect ⇒ String Also known as: to_s

Generates a human readable list of attributes when inspecting a custom object

Returns:

• (String)

# File 'lib/redstruct/utils/inspectable.rb', line 9

def inspect
  attributes = inspectable_attributes.map do |key, value|
    "#{key}: <#{value.inspect}>"
  end

  return "#{self.class.name}: #{attributes.join(', ')}"
end

#inspectable_attributes ⇒ Hash<String, #inspect>

To be overloaded by the including class

Returns:

• (Hash<String, #inspect>) —

  list of attributes that can be seen

# File 'lib/redstruct/utils/inspectable.rb', line 20

def inspectable_attributes
  {}
end