Class: Text::Format

Text::Format for Ruby is copyright 2002 - 2005 by Austin Ziegler. It is available under Ruby’s licence, the Perl Artistic licence, or the GNU GPL version 2 (or at your option, any later version). As a special exception, for use with official Rails (provided by the rubyonrails.org development team) and any project created with official Rails, the following alternative MIT-style licence may be used:

Text::Format Licence for Rails and Rails Applications

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Methods

==
body_indent=
center
columns=
expand
first_indent=
format
format_style=
hyphenate_to
hyphenator=
justify?
left_align?
left_margin=
new
paragraphs
right_align?
right_fill?
right_margin=
split_rules=
tabstop=
unexpand

Classes and Modules

Class Text::Format::SplitWord

Constants

VERSION	=	'0.63'
ABBREV	=	[ 'Mr', 'Mrs', 'Ms', 'Jr', 'Sr' ]
	Local abbreviations. More can be added with Text::Format.abbreviations
LEFT_ALIGN	=	0
	Formatting values
RIGHT_ALIGN	=	1
RIGHT_FILL	=	2
JUSTIFY	=	3
SPLIT_FIXED	=	1
	Word split modes (only applies when hard_margins is true).
SPLIT_CONTINUATION	=	2
SPLIT_HYPHENATION	=	4
SPLIT_CONTINUATION_FIXED	=	SPLIT_CONTINUATION \| SPLIT_FIXED
SPLIT_HYPHENATION_FIXED	=	SPLIT_HYPHENATION \| SPLIT_FIXED
SPLIT_HYPHENATION_CONTINUATION	=	SPLIT_HYPHENATION \| SPLIT_CONTINUATION
SPLIT_ALL	=	SPLIT_HYPHENATION \| SPLIT_CONTINUATION \| SPLIT_FIXED
LEQ_RE	=	/[.?!]['"]?$/

Attributes

[RW]

abbreviations

Defines the current abbreviations as an array. This is only used if extra_space is turned on.

If one is abbreviating "President" as "Pres." (abbreviations = ["Pres"]), then the results of formatting will be as illustrated in the table below:

      extra_space  |  include?        |  !include?
        true       |  Pres. Lincoln   |  Pres.  Lincoln
        false      |  Pres. Lincoln   |  Pres. Lincoln

Default:	`{}`
Used in:	`format`, `paragraphs`

[R]

body_indent

The number of spaces to indent all lines after the first line of a paragraph.

                            columns
 <-------------------------------------------------------------->
 <-----------><------><---------------------------><------------>
  left margin  INDENT  text is formatted into here  right margin

Default:	`0`
Used in:	`format`, `paragraphs`

[R]

columns

The total width of the format area. The margins, indentation, and text are formatted into this space.

                            COLUMNS
 <-------------------------------------------------------------->
 <-----------><------><---------------------------><------------>
  left margin  indent  text is formatted into here  right margin

Default:	`72`
Used in:	`format`, `paragraphs`, `center`

[RW]

extra_space

Indicates whether sentence terminators should be followed by a single space (false), or two spaces (true).

Default:	`false`
Used in:	`format`, `paragraphs`

[R]

first_indent

The number of spaces to indent the first line of a paragraph.

                            columns
 <-------------------------------------------------------------->
 <-----------><------><---------------------------><------------>
  left margin  INDENT  text is formatted into here  right margin

Default:	`4`
Used in:	`format`, `paragraphs`

[R]

format_style

Specifies the format style. Allowable values are:

LEFT_ALIGN: Left justified, ragged right.

     |A paragraph that is|
     |left aligned.|

RIGHT_ALIGN: Right justified, ragged left.

     |A paragraph that is|
     |     right aligned.|

RIGHT_FILL: Left justified, right ragged, filled to width by spaces. (Essentially the same as LEFT_ALIGN except that lines are padded on the right.)

     |A paragraph that is|
     |left aligned.      |

JUSTIFY: Fully justified, words filled to width by spaces, except the last line.

     |A paragraph  that|
     |is     justified.|

Default:	`Text::Format::LEFT_ALIGN`
Used in:	`format`, `paragraphs`

[RW]

hard_margins

Normally, words larger than the format area will be placed on a line by themselves. Setting this to true will force words larger than the format area to be split into one or more "words" each at most the size of the format area. The first line and the original word will be placed into split_words. Note that this will cause the output to look similar to a format_style of JUSTIFY. (Lines will be filled as much as possible.)

Default:	`false`
Used in:	`format`, `paragraphs`

[R]

hyphenator

The object responsible for hyphenating. It must respond to hyphenate_to(word, size) or hyphenate_to(word, size, formatter) and return an array of the word split into two parts; if there is a hyphenation mark to be applied, responsibility belongs to the hyphenator object. The size is the MAXIMUM size permitted, including any hyphenation marks. If the hyphenate_to method has an arity of 3, the formatter will be provided to the method. This allows the hyphenator to make decisions about the hyphenation based on the formatting rules.

Default:	`nil`
Used in:	`format`, `paragraphs`

[R]

left_margin

The number of spaces used for the left margin.

                            columns
 <-------------------------------------------------------------->
 <-----------><------><---------------------------><------------>
  LEFT MARGIN  indent  text is formatted into here  right margin

Default:	`0`
Used in:	`format`, `paragraphs`, `center`

[RW]

nobreak

Indicates whether or not the non-breaking space feature should be used.

Default:	`false`
Used in:	`format`, `paragraphs`

[RW]

nobreak_regex

A hash which holds the regular expressions on which spaces should not be broken. The hash is set up such that the key is the first word and the value is the second word.

For example, if nobreak_regex contains the following hash:

  { '^Mrs?\.$' => '\S+$', '^\S+$' => '^(?:S|J)r\.$'}

Then "Mr. Jones", "Mrs. Jones", and "Jones Jr." would not be broken. If this simple matching algorithm indicates that there should not be a break at the current end of line, then a backtrack is done until there are two words on which line breaking is permitted. If two such words are not found, then the end of the line will be broken regardless. If there is a single word on the current line, then no backtrack is done and the word is stuck on the end.

Default:	`{}`
Used in:	`format`, `paragraphs`

[R]

right_margin

The number of spaces used for the right margin.

                            columns
 <-------------------------------------------------------------->
 <-----------><------><---------------------------><------------>
  left margin  indent  text is formatted into here  RIGHT MARGIN

Default:	`0`
Used in:	`format`, `paragraphs`, `center`

[R]

split_rules

Specifies the split mode; used only when hard_margins is set to true. Allowable values are:

SPLIT_FIXED: The word will be split at the number of characters needed, with no marking at all.

     repre
     senta
     ion

SPLIT_CONTINUATION: The word will be split at the number of characters needed, with a C-style continuation character. If a word is the only item on a line and it cannot be split into an appropriate size, SPLIT_FIXED will be used.

      repr\
      esen\
      tati\
      on

SPLIT_HYPHENATION: The word will be split according to the hyphenator specified in hyphenator. If there is no hyphenator specified, works like SPLIT_CONTINUATION. The example is using TeX::Hyphen. If a word is the only item on a line and it cannot be split into an appropriate size, SPLIT_CONTINUATION mode will be used.

      rep-
      re-
      sen-
      ta-
      tion

Default:	`Text::Format::SPLIT_FIXED`
Used in:	`format`, `paragraphs`

[R]

split_words

An array of words split during formatting if hard_margins is set to true.

  #split_words << Text::Format::SplitWord.new(word, first, rest)

[R]

tabstop

Indicates the number of spaces that a single tab represents.

Default:	`8`
Used in:	`expand`, `unexpand`, `paragraphs`

[RW]

tag_paragraph

Indicates whether the formatting of paragraphs should be done with tagged paragraphs. Useful only with tag_text.

Default:	`false`
Used in:	`format`, `paragraphs`

[RW]

tag_text

The array of text to be placed before each paragraph when tag_paragraph is true. When format() is called, only the first element of the array is used. When paragraphs is called, then each entry in the array will be used once, with corresponding paragraphs. If the tag elements are exhausted before the text is exhausted, then the remaining paragraphs will not be tagged. Regardless of indentation settings, a blank line will be inserted between all paragraphs when tag_paragraph is true.

Default:	`[]`
Used in:	`format`, `paragraphs`

[RW]

text

The text to be manipulated. Note that value is optional, but if the formatting functions are called without values, this text is what will be formatted.

Default:	`[]`
Used in:	All methods

Public Class methods

new(arg = nil, &block)

This constructor takes advantage of a technique for Ruby object construction introduced by Andy Hunt and Dave Thomas (see reference), where optional values are set using commands in a block.

  Text::Format.new {
      columns         = 72
      left_margin     = 0
      right_margin    = 0
      first_indent    = 4
      body_indent     = 0
      format_style    = Text::Format::LEFT_ALIGN
      extra_space     = false
      abbreviations   = {}
      tag_paragraph   = false
      tag_text        = []
      nobreak         = false
      nobreak_regex   = {}
      tabstop         = 8
      text            = nil
  }

As shown above, arg is optional. If arg is specified and is a String, then arg is used as the default value of text. Alternately, an existing Text::Format object can be used or a Hash can be used. With all forms, a block can be specified.

Reference:

"Object Construction and Blocks" <www.pragmaticprogrammer.com/ruby/articles/insteval.html>