Class: ObjectInspector::BaseFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/object_inspector/formatters/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

CombiningFormatter, TemplatingFormatter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(inspector) ⇒ BaseFormatter

Returns a new instance of BaseFormatter.

Parameters:



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

def initialize(inspector)
  @inspector = inspector
end

Instance Attribute Details

#inspector ⇒ Object (readonly)

Returns the value of attribute inspector.



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

def inspector
  @inspector
end

Instance Method Details

#call ⇒ String

Perform the formatting routine.

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


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

def call
  raise NotImplementedError
end

#flags ⇒ String, NilClass

Delegates to Inspector#flags.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



43
44
45
 
# File 'lib/object_inspector/formatters/base_formatter.rb', line 43

def flags
  @flags ||= @inspector.flags
end

#identification ⇒ String

Delegates to Inspector#identification.

Returns:

  • (String) —

    if given



35
36
37
 
# File 'lib/object_inspector/formatters/base_formatter.rb', line 35

def identification
  @identification ||= @inspector.identification
end

#info ⇒ String, NilClass

Delegates to Inspector#info.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



59
60
61
 
# File 'lib/object_inspector/formatters/base_formatter.rb', line 59

def info
  @info ||= @inspector.info
end

#issues ⇒ String, NilClass

Delegates to Inspector#issues.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



51
52
53
 
# File 'lib/object_inspector/formatters/base_formatter.rb', line 51

def issues
  @issues ||= @inspector.issues
end

#name ⇒ String, NilClass

Delegates to Inspector#name.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



67
68
69
 
# File 'lib/object_inspector/formatters/base_formatter.rb', line 67

def name
  @name ||= @inspector.name
end

#wrapped_object_inspection_result ⇒ String, NilClass

Delegates to Inspector#wrapped_object_inspection_result.

Returns:

  • (String) —

    if given

  • (NilClass) —

    if not given



27
28
29
30
 
# File 'lib/object_inspector/formatters/base_formatter.rb', line 27

def wrapped_object_inspection_result
  @wrapped_object_inspection_result ||=
    @inspector.wrapped_object_inspection_result
end