Class: ObjectInspector::BaseFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/object_inspector/base_formatter.rb

Overview

ObjectInspector::BaseFormatter is an abstract base class that interfaces with Inspector objects to combine the supplied #identification, #flags, #info, and #name strings into a friendly “inspect” String.

Direct Known Subclasses

DefaultFormatter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(inspector) ⇒ BaseFormatter

Returns a new instance of BaseFormatter.



11
12
13
 
# File 'lib/object_inspector/base_formatter.rb', line 11

def initialize(inspector)
  @inspector = inspector
end

Instance Attribute Details

#inspector ⇒ ObjectInspector::Inspector

Returns the current value of inspector.

Returns:



8
9
10
 
# File 'lib/object_inspector/base_formatter.rb', line 8

def inspector
  @inspector
end

Instance Method Details

#call ⇒ String

Perform the formatting routine.

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


18
19
20
 
# File 'lib/object_inspector/base_formatter.rb', line 18

def call
  raise NotImplementedError
end

#flags ⇒ String, NilClass

Delegates to Inspector#flags.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



33
34
35
 
# File 'lib/object_inspector/base_formatter.rb', line 33

def flags
  @inspector.flags
end

#identification ⇒ String

Delegates to Inspector#identification.

Returns:

  • (String) —

    if given



25
26
27
 
# File 'lib/object_inspector/base_formatter.rb', line 25

def identification
  @inspector.identification
end

#info ⇒ String, NilClass

Delegates to Inspector#info.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



41
42
43
 
# File 'lib/object_inspector/base_formatter.rb', line 41

def info
  @inspector.info
end

#name ⇒ String, NilClass

Delegates to Inspector#name.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



49
50
51
 
# File 'lib/object_inspector/base_formatter.rb', line 49

def name
  @inspector.name
end