Class: Text::Format

Inherits:
Object show all
Defined in:
lib/action_mailer/vendor/text-format-0.6.3/text/format.rb

Overview

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.

Defined Under Namespace

Classes: SplitWord

Constant Summary collapse

VERSION = 
'0.63'
ABBREV =

Local abbreviations. More can be added with Text::Format.abbreviations

[ 'Mr', 'Mrs', 'Ms', 'Jr', 'Sr' ]
LEFT_ALIGN =

Formatting values

0
RIGHT_ALIGN = 
1
RIGHT_FILL = 
2
JUSTIFY = 
3
SPLIT_FIXED =

Word split modes (only applies when #hard_margins is true).

1
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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg = nil, &block) ⇒ Format

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>



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 963

def initialize(arg = nil, &block)
  case arg
  when Text::Format
    __create(arg.text) do
      @columns        = arg.columns
      @tabstop        = arg.tabstop
      @first_indent   = arg.first_indent
      @body_indent    = arg.body_indent
      @format_style   = arg.format_style
      @left_margin    = arg.left_margin
      @right_margin   = arg.right_margin
      @extra_space    = arg.extra_space
      @tag_paragraph  = arg.tag_paragraph
      @tag_text       = arg.tag_text
      @abbreviations  = arg.abbreviations
      @nobreak        = arg.nobreak
      @nobreak_regex  = arg.nobreak_regex
      @text           = arg.text
      @hard_margins   = arg.hard_margins
      @split_words    = arg.split_words
      @split_rules    = arg.split_rules
      @hyphenator     = arg.hyphenator
    end
    instance_eval(&block) unless block.nil?
  when Hash
    __create do
      @columns       = arg[:columns]       || arg['columns']       || @columns
      @tabstop       = arg[:tabstop]       || arg['tabstop']       || @tabstop
      @first_indent  = arg[:first_indent]  || arg['first_indent']  || @first_indent
      @body_indent   = arg[:body_indent]   || arg['body_indent']   || @body_indent
      @format_style  = arg[:format_style]  || arg['format_style']  || @format_style
      @left_margin   = arg[:left_margin]   || arg['left_margin']   || @left_margin
      @right_margin  = arg[:right_margin]  || arg['right_margin']  || @right_margin
      @extra_space   = arg[:extra_space]   || arg['extra_space']   || @extra_space
      @text          = arg[:text]          || arg['text']          || @text
      @tag_paragraph = arg[:tag_paragraph] || arg['tag_paragraph'] || @tag_paragraph
      @tag_text      = arg[:tag_text]      || arg['tag_text']      || @tag_text
      @abbreviations = arg[:abbreviations] || arg['abbreviations'] || @abbreviations
      @nobreak       = arg[:nobreak]       || arg['nobreak']       || @nobreak
      @nobreak_regex = arg[:nobreak_regex] || arg['nobreak_regex'] || @nobreak_regex
      @hard_margins  = arg[:hard_margins]  || arg['hard_margins']  || @hard_margins
      @split_rules   = arg[:split_rules] || arg['split_rules'] || @split_rules
      @hyphenator    = arg[:hyphenator] || arg['hyphenator'] || @hyphenator
    end
    instance_eval(&block) unless block.nil?
  when String
    __create(arg, &block)
  when NilClass
    __create(&block)
  else
    raise TypeError
  end
end

Instance Attribute Details

#abbreviations ⇒ Object

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



440
441
442
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 440

def abbreviations
  @abbreviations
end

#body_indent ⇒ Object

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



280
281
282
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 280

def body_indent
  @body_indent
end

#columns ⇒ Object

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



173
174
175
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 173

def columns
  @columns
end

#extra_space ⇒ Object

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

Default

false

Used in

#format, #paragraphs



425
426
427
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 425

def extra_space
  @extra_space
end

#first_indent ⇒ Object

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



254
255
256
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 254

def first_indent
  @first_indent
end

#format_style ⇒ Object

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



524
525
526
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 524

def format_style
  @format_style
end

#hard_margins ⇒ Object

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



307
308
309
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 307

def hard_margins
  @hard_margins
end

#hyphenator ⇒ Object

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



326
327
328
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 326

def hyphenator
  @hyphenator
end

#left_margin ⇒ Object

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



201
202
203
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 201

def left_margin
  @left_margin
end

#nobreak ⇒ Object

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

Default

false

Used in

#format, #paragraphs



467
468
469
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 467

def nobreak
  @nobreak
end

#nobreak_regex ⇒ Object

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



487
488
489
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 487

def nobreak_regex
  @nobreak_regex
end

#right_margin ⇒ Object

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



228
229
230
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 228

def right_margin
  @right_margin
end

#split_rules ⇒ Object

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



375
376
377
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 375

def split_rules
  @split_rules
end

#split_words ⇒ Object (readonly)

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

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



312
313
314
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 312

def split_words
  @split_words
end

#tabstop ⇒ Object

Indicates the number of spaces that a single tab represents.

Default

8

Used in

#expand, #unexpand, #paragraphs



494
495
496
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 494

def tabstop
  @tabstop
end

#tag_paragraph ⇒ Object

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

Default

false

Used in

#format, #paragraphs



447
448
449
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 447

def tag_paragraph
  @tag_paragraph
end

#tag_text ⇒ Object

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



460
461
462
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 460

def tag_text
  @tag_text
end

#text ⇒ Object

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



160
161
162
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 160

def text
  @text
end

Instance Method Details

#==(o) ⇒ Object

Compares two Text::Format objects. All settings of the objects are compared except #hyphenator. Generated results (e.g., #split_words) are not compared, either.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 135

def ==(o)
  (@text          ==  o.text)           &&
  (@columns       ==  o.columns)        &&
  (@left_margin   ==  o.left_margin)    &&
  (@right_margin  ==  o.right_margin)   &&
  (@hard_margins  ==  o.hard_margins)   &&
  (@split_rules   ==  o.split_rules)    &&
  (@first_indent  ==  o.first_indent)   &&
  (@body_indent   ==  o.body_indent)    &&
  (@tag_text      ==  o.tag_text)       &&
  (@tabstop       ==  o.tabstop)        &&
  (@format_style  ==  o.format_style)   &&
  (@extra_space   ==  o.extra_space)    &&
  (@tag_paragraph ==  o.tag_paragraph)  &&
  (@nobreak       ==  o.nobreak)        &&
  (@abbreviations ==  o.abbreviations)  &&
  (@nobreak_regex ==  o.nobreak_regex)
end

#center(to_center = nil) ⇒ Object

Centers the text, preserving empty lines and tabs.



908
909
910
911
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 908

def center(to_center = nil)
  to_center = @text if to_center.nil?
  __center([to_center].flatten)
end

#expand(to_expand = nil) ⇒ Object

Replaces all tab characters in the text with #tabstop spaces.



914
915
916
917
918
919
920
921
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 914

def expand(to_expand = nil)
  to_expand = @text if to_expand.nil?
  if to_expand.class == Array
    to_expand.collect { |te| __expand(te) }
  else
    __expand(to_expand)
  end
end

#format(to_wrap = nil) ⇒ Object

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.



888
889
890
891
892
893
894
895
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 888

def format(to_wrap = nil)
  to_wrap = @text if to_wrap.nil?
  if to_wrap.class == Array
    __format(to_wrap[0])
  else
    __format(to_wrap)
  end
end

#hyphenate_to(word, size) ⇒ Object

The default implementation of #hyphenate_to implements SPLIT_CONTINUATION.



583
584
585
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 583

def hyphenate_to(word, size)
  [word[0 .. (size - 2)] + "\\", word[(size - 1) .. -1]]
end

#justify? ⇒ Boolean

Indicates that the format style is full justification.

Default

false

Used in

#format, #paragraphs

Returns:

  • (Boolean) 


577
578
579
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 577

def justify?
  return @format_style == JUSTIFY
end

#left_align? ⇒ Boolean

Indicates that the format style is left alignment.

Default

true

Used in

#format, #paragraphs

Returns:

  • (Boolean) 


553
554
555
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 553

def left_align?
  return @format_style == LEFT_ALIGN
end

#paragraphs(to_wrap = nil) ⇒ Object

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.



902
903
904
905
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 902

def paragraphs(to_wrap = nil)
  to_wrap = @text if to_wrap.nil?
  __paragraphs([to_wrap].flatten)
end

#right_align? ⇒ Boolean

Indicates that the format style is right alignment.

Default

false

Used in

#format, #paragraphs

Returns:

  • (Boolean) 


561
562
563
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 561

def right_align?
  return @format_style == RIGHT_ALIGN
end

#right_fill? ⇒ Boolean

Indicates that the format style is right fill.

Default

false

Used in

#format, #paragraphs

Returns:

  • (Boolean) 


569
570
571
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 569

def right_fill?
  return @format_style == RIGHT_FILL
end

#unexpand(to_unexpand = nil) ⇒ Object

Replaces all occurrences of #tabstop consecutive spaces with a tab character.



925
926
927
928
929
930
931
932
 
# File 'lib/action_mailer/vendor/text-format-0.6.3/text/format.rb', line 925

def unexpand(to_unexpand = nil)
  to_unexpand = @text if to_unexpand.nil?
  if to_unexpand.class == Array
    to_unexpand.collect { |te| v << __unexpand(te) }
  else
    __unexpand(to_unexpand)
  end
end