Class: PrettyPrint::Text

Inherits:

Object

• Object
• PrettyPrint::Text

Defined in:

lib/prettyprint.rb

Overview

The Text class is the means by which to collect strings from objects.

This class is intended for internal use of the PrettyPrint buffers.

Instance Attribute Summary

• #width ⇒ Object readonly

  The total width of the objects included in this Text object.

Instance Method Summary

• #add(obj, width) ⇒ Object

  Include obj in the objects to be pretty printed, and increment this Text object’s total width by width.

• #initialize ⇒ Text constructor

  Creates a new text object.

• #output(out, output_width) ⇒ Object

  Render the String text of the objects that have been added to this Text object.

Constructor Details

#initialize ⇒ Text

Creates a new text object.

This constructor takes no arguments.

The workflow is to append a PrettyPrint::Text object to the buffer, and being able to call the buffer.last() to reference it.

As there are objects, use PrettyPrint::Text#add to include the objects and the width to utilized by the String version of this object.

# File 'lib/prettyprint.rb', line 330

def initialize
  @objs = []
  @width = 0
end

Instance Attribute Details

#width ⇒ Object (readonly)

The total width of the objects included in this Text object.

# File 'lib/prettyprint.rb', line 336

def width
  @width
end

Instance Method Details

#add(obj, width) ⇒ Object

Include obj in the objects to be pretty printed, and increment this Text object’s total width by width

# File 'lib/prettyprint.rb', line 348

def add(obj, width)
  @objs << obj
  @width += width
end

#output(out, output_width) ⇒ Object

Render the String text of the objects that have been added to this Text object.

Output the text to out, and increment the width to output_width

# File 'lib/prettyprint.rb', line 341

def output(out, output_width)
  @objs.each {|obj| out << obj}
  output_width + @width
end