Class | Text::Format |
In: |
lib/action_mailer/vendor/text-format-0.6.3/text/format.rb
|
Parent: | Object |
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:
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 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.
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 | = | /[.?!]['"]?$/ |
abbreviations | [RW] |
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
|
||||
body_indent | [R] |
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
|
||||
columns | [R] |
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
|
||||
extra_space | [RW] |
Indicates whether sentence terminators should be followed by a single space
(false), or two spaces (true).
|
||||
first_indent | [R] |
The number of spaces to indent the first line of a paragraph.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin INDENT text is formatted into here right margin
|
||||
format_style | [R] |
Specifies the format style. Allowable
values are:
|A paragraph that is| |left aligned.|
|A paragraph that is| | right aligned.|
|A paragraph that is| |left aligned. |
|A paragraph that| |is justified.|
|
||||
hard_margins | [RW] |
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.)
|
||||
hyphenator | [R] |
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.
|
||||
left_margin | [R] |
The number of spaces used for the left margin.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> LEFT MARGIN indent text is formatted into here right margin
|
||||
nobreak | [RW] |
Indicates whether or not the non-breaking space feature should be used.
|
||||
nobreak_regex | [RW] |
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.
|
||||
right_margin | [R] |
The number of spaces used for the right margin.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin indent text is formatted into here RIGHT MARGIN
|
||||
split_rules | [R] |
Specifies the split mode; used only when hard_margins is set to
true. Allowable values are:
repre senta ion
repr\ esen\ tati\ on
rep- re- sen- ta- tion
|
||||
split_words | [R] |
An array of words split during formatting if hard_margins is set to
true.
#split_words << Text::Format::SplitWord.new(word, first, rest) |
||||
tabstop | [R] |
Indicates the number of spaces that a single tab represents.
|
||||
tag_paragraph | [RW] |
Indicates whether the formatting of paragraphs should be done with tagged paragraphs. Useful only with
tag_text.
|
||||
tag_text | [RW] |
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.
|
||||
text | [RW] |
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.
|
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> |
Compares two Text::Format objects. All settings of the objects are compared except hyphenator. Generated results (e.g., split_words) are not compared, either.
The number of spaces to indent all lines after the first line of a paragraph. The value provided is silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin INDENT text is formatted into here right margin
Default: | 0 |
Used in: | format, paragraphs |
The total width of the format area. The margins, indentation, and text are formatted into this space. The value provided is silently converted to a positive integer.
COLUMNS <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin indent text is formatted into here right margin
Default: | 72 |
Used in: | format, paragraphs, center |
The number of spaces to indent the first line of a paragraph. The value provided is silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin INDENT text is formatted into here right margin
Default: | 4 |
Used in: | format, paragraphs |
Formats text into a nice paragraph format. The text is separated into words and then reassembled a word at a time using the settings of this Format object. If a word is larger than the number of columns available for formatting, then that word will appear on the line by itself.
If to_wrap is nil, then the value of text will be worked on.
Specifies the format style. Allowable values are:
|A paragraph that is| |left aligned.|
|A paragraph that is| | right aligned.|
|A paragraph that is| |left aligned. |
|A paragraph that| |is justified.|
Default: | Text::Format::LEFT_ALIGN |
Used in: | format, paragraphs |
The object responsible for hyphenating. It must respond to hyphenate_to(word, size) and return an array of the word hyphenated into two parts. The size is the MAXIMUM size permitted, including any hyphenation marks.
Default: | nil |
Used in: | format, paragraphs |
Indicates that the format style is full justification.
Default: | false |
Used in: | format, paragraphs |
Indicates that the format style is left alignment.
Default: | true |
Used in: | format, paragraphs |
The number of spaces used for the left margin. The value provided is silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> LEFT MARGIN indent text is formatted into here right margin
Default: | 0 |
Used in: | format, paragraphs, center |
Considers each element of text (provided or internal) as a paragraph. If first_indent is the same as body_indent, then paragraphs will be separated by a single empty line in the result; otherwise, the paragraphs will follow immediately after each other. Uses format to do the heavy lifting.
Indicates that the format style is right alignment.
Default: | false |
Used in: | format, paragraphs |
Indicates that the format style is right fill.
Default: | false |
Used in: | format, paragraphs |
The number of spaces used for the right margin. The value provided is silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin indent text is formatted into here RIGHT MARGIN
Default: | 0 |
Used in: | format, paragraphs, center |
Specifies the split mode; used only when hard_margins is set to true. Allowable values are:
repre senta ion
repr\ esen\ tati\ on
rep- re- sen- ta- tion
These values can be bitwise ORed together (e.g., SPLIT_FIXED | SPLIT_CONTINUATION) to provide fallback split methods. In the example given, an attempt will be made to split the word using the rules of SPLIT_CONTINUATION; if there is not enough room, the word will be split with the rules of SPLIT_FIXED. These combinations are also available as the following values:
Default: | Text::Format::SPLIT_FIXED |
Used in: | format, paragraphs |
Indicates the number of spaces that a single tab represents.
Default: | 8 |
Used in: | expand, unexpand, paragraphs |