actionmailer_csi 2.3.5.p6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. data/CHANGELOG +370 -0
  2. data/MIT-LICENSE +21 -0
  3. data/README +149 -0
  4. data/Rakefile +99 -0
  5. data/install.rb +30 -0
  6. data/lib/action_mailer/adv_attr_accessor.rb +30 -0
  7. data/lib/action_mailer/base.rb +706 -0
  8. data/lib/action_mailer/helpers.rb +113 -0
  9. data/lib/action_mailer/mail_helper.rb +17 -0
  10. data/lib/action_mailer/part.rb +107 -0
  11. data/lib/action_mailer/part_container.rb +55 -0
  12. data/lib/action_mailer/quoting.rb +61 -0
  13. data/lib/action_mailer/test_case.rb +64 -0
  14. data/lib/action_mailer/test_helper.rb +68 -0
  15. data/lib/action_mailer/utils.rb +7 -0
  16. data/lib/action_mailer/vendor/text-format-0.6.3/text/format.rb +1466 -0
  17. data/lib/action_mailer/vendor/text_format.rb +10 -0
  18. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/address.rb +426 -0
  19. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/attachments.rb +46 -0
  20. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/base64.rb +46 -0
  21. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/compat.rb +41 -0
  22. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/config.rb +67 -0
  23. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/core_extensions.rb +63 -0
  24. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/encode.rb +581 -0
  25. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/header.rb +960 -0
  26. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/index.rb +9 -0
  27. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/interface.rb +1130 -0
  28. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/loader.rb +3 -0
  29. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/mail.rb +578 -0
  30. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/mailbox.rb +495 -0
  31. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/main.rb +6 -0
  32. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/mbox.rb +3 -0
  33. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/net.rb +248 -0
  34. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/obsolete.rb +132 -0
  35. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/parser.rb +1478 -0
  36. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/port.rb +379 -0
  37. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/quoting.rb +118 -0
  38. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/require_arch.rb +58 -0
  39. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/scanner.rb +49 -0
  40. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/scanner_r.rb +261 -0
  41. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/stringio.rb +280 -0
  42. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/utils.rb +337 -0
  43. data/lib/action_mailer/vendor/tmail-1.2.3/tmail/version.rb +39 -0
  44. data/lib/action_mailer/vendor/tmail-1.2.3/tmail.rb +5 -0
  45. data/lib/action_mailer/vendor/tmail.rb +17 -0
  46. data/lib/action_mailer/version.rb +9 -0
  47. data/lib/action_mailer.rb +62 -0
  48. data/lib/actionmailer.rb +2 -0
  49. data/test/abstract_unit.rb +62 -0
  50. data/test/asset_host_test.rb +54 -0
  51. data/test/delivery_method_test.rb +51 -0
  52. data/test/fixtures/asset_host_mailer/email_with_asset.html.erb +1 -0
  53. data/test/fixtures/auto_layout_mailer/hello.html.erb +1 -0
  54. data/test/fixtures/auto_layout_mailer/multipart.text.html.erb +1 -0
  55. data/test/fixtures/auto_layout_mailer/multipart.text.plain.erb +1 -0
  56. data/test/fixtures/explicit_layout_mailer/logout.html.erb +1 -0
  57. data/test/fixtures/explicit_layout_mailer/signup.html.erb +1 -0
  58. data/test/fixtures/first_mailer/share.erb +1 -0
  59. data/test/fixtures/helper_mailer/use_example_helper.erb +1 -0
  60. data/test/fixtures/helper_mailer/use_helper.erb +1 -0
  61. data/test/fixtures/helper_mailer/use_helper_method.erb +1 -0
  62. data/test/fixtures/helper_mailer/use_mail_helper.erb +5 -0
  63. data/test/fixtures/helpers/example_helper.rb +5 -0
  64. data/test/fixtures/layouts/auto_layout_mailer.html.erb +1 -0
  65. data/test/fixtures/layouts/auto_layout_mailer.text.erb +1 -0
  66. data/test/fixtures/layouts/spam.html.erb +1 -0
  67. data/test/fixtures/path.with.dots/funky_path_mailer/multipart_with_template_path_with_dots.erb +1 -0
  68. data/test/fixtures/raw_email +14 -0
  69. data/test/fixtures/raw_email10 +20 -0
  70. data/test/fixtures/raw_email12 +32 -0
  71. data/test/fixtures/raw_email13 +29 -0
  72. data/test/fixtures/raw_email2 +114 -0
  73. data/test/fixtures/raw_email3 +70 -0
  74. data/test/fixtures/raw_email4 +59 -0
  75. data/test/fixtures/raw_email5 +19 -0
  76. data/test/fixtures/raw_email6 +20 -0
  77. data/test/fixtures/raw_email7 +66 -0
  78. data/test/fixtures/raw_email8 +47 -0
  79. data/test/fixtures/raw_email9 +28 -0
  80. data/test/fixtures/raw_email_quoted_with_0d0a +14 -0
  81. data/test/fixtures/raw_email_with_invalid_characters_in_content_type +104 -0
  82. data/test/fixtures/raw_email_with_nested_attachment +100 -0
  83. data/test/fixtures/raw_email_with_partially_quoted_subject +14 -0
  84. data/test/fixtures/second_mailer/share.erb +1 -0
  85. data/test/fixtures/templates/signed_up.erb +3 -0
  86. data/test/fixtures/test_mailer/_subtemplate.text.plain.erb +1 -0
  87. data/test/fixtures/test_mailer/body_ivar.erb +2 -0
  88. data/test/fixtures/test_mailer/custom_templating_extension.text.html.haml +6 -0
  89. data/test/fixtures/test_mailer/custom_templating_extension.text.plain.haml +6 -0
  90. data/test/fixtures/test_mailer/implicitly_multipart_example.ignored.erb +1 -0
  91. data/test/fixtures/test_mailer/implicitly_multipart_example.rhtml.bak +1 -0
  92. data/test/fixtures/test_mailer/implicitly_multipart_example.text.html.erb +10 -0
  93. data/test/fixtures/test_mailer/implicitly_multipart_example.text.html.erb~ +10 -0
  94. data/test/fixtures/test_mailer/implicitly_multipart_example.text.plain.erb +2 -0
  95. data/test/fixtures/test_mailer/implicitly_multipart_example.text.yaml.erb +1 -0
  96. data/test/fixtures/test_mailer/included_subtemplate.text.plain.erb +1 -0
  97. data/test/fixtures/test_mailer/rxml_template.builder +2 -0
  98. data/test/fixtures/test_mailer/rxml_template.rxml +2 -0
  99. data/test/fixtures/test_mailer/signed_up.html.erb +3 -0
  100. data/test/fixtures/test_mailer/signed_up_with_url.erb +5 -0
  101. data/test/mail_helper_test.rb +95 -0
  102. data/test/mail_layout_test.rb +123 -0
  103. data/test/mail_render_test.rb +116 -0
  104. data/test/mail_service_test.rb +1081 -0
  105. data/test/quoting_test.rb +99 -0
  106. data/test/test_helper_test.rb +129 -0
  107. data/test/tmail_test.rb +22 -0
  108. data/test/url_test.rb +76 -0
  109. metadata +195 -0
@@ -0,0 +1,1466 @@
1
+ #--
2
+ # Text::Format for Ruby
3
+ # Version 0.63
4
+ #
5
+ # Copyright (c) 2002 - 2003 Austin Ziegler
6
+ #
7
+ # $Id: format.rb,v 1.1.1.1 2004/10/14 11:59:57 webster132 Exp $
8
+ #
9
+ # ==========================================================================
10
+ # Revision History ::
11
+ # YYYY.MM.DD Change ID Developer
12
+ # Description
13
+ # --------------------------------------------------------------------------
14
+ # 2002.10.18 Austin Ziegler
15
+ # Fixed a minor problem with tabs not being counted. Changed
16
+ # abbreviations from Hash to Array to better suit Ruby's
17
+ # capabilities. Fixed problems with the way that Array arguments
18
+ # are handled in calls to the major object types, excepting in
19
+ # Text::Format#expand and Text::Format#unexpand (these will
20
+ # probably need to be fixed).
21
+ # 2002.10.30 Austin Ziegler
22
+ # Fixed the ordering of the <=> for binary tests. Fixed
23
+ # Text::Format#expand and Text::Format#unexpand to handle array
24
+ # arguments better.
25
+ # 2003.01.24 Austin Ziegler
26
+ # Fixed a problem with Text::Format::RIGHT_FILL handling where a
27
+ # single word is larger than #columns. Removed Comparable
28
+ # capabilities (<=> doesn't make sense; == does). Added Symbol
29
+ # equivalents for the Hash initialization. Hash initialization has
30
+ # been modified so that values are set as follows (Symbols are
31
+ # highest priority; strings are middle; defaults are lowest):
32
+ # @columns = arg[:columns] || arg['columns'] || @columns
33
+ # Added #hard_margins, #split_rules, #hyphenator, and #split_words.
34
+ # 2003.02.07 Austin Ziegler
35
+ # Fixed the installer for proper case-sensitive handling.
36
+ # 2003.03.28 Austin Ziegler
37
+ # Added the ability for a hyphenator to receive the formatter
38
+ # object. Fixed a bug for strings matching /\A\s*\Z/ failing
39
+ # entirely. Fixed a test case failing under 1.6.8.
40
+ # 2003.04.04 Austin Ziegler
41
+ # Handle the case of hyphenators returning nil for first/rest.
42
+ # 2003.09.17 Austin Ziegler
43
+ # Fixed a problem where #paragraphs(" ") was raising
44
+ # NoMethodError.
45
+ #
46
+ # ==========================================================================
47
+ #++
48
+
49
+ module Text #:nodoc:
50
+ # Text::Format for Ruby is copyright 2002 - 2005 by Austin Ziegler. It
51
+ # is available under Ruby's licence, the Perl Artistic licence, or the
52
+ # GNU GPL version 2 (or at your option, any later version). As a
53
+ # special exception, for use with official Rails (provided by the
54
+ # rubyonrails.org development team) and any project created with
55
+ # official Rails, the following alternative MIT-style licence may be
56
+ # used:
57
+ #
58
+ # == Text::Format Licence for Rails and Rails Applications
59
+ # Permission is hereby granted, free of charge, to any person
60
+ # obtaining a copy of this software and associated documentation files
61
+ # (the "Software"), to deal in the Software without restriction,
62
+ # including without limitation the rights to use, copy, modify, merge,
63
+ # publish, distribute, sublicense, and/or sell copies of the Software,
64
+ # and to permit persons to whom the Software is furnished to do so,
65
+ # subject to the following conditions:
66
+ #
67
+ # * The names of its contributors may not be used to endorse or
68
+ # promote products derived from this software without specific prior
69
+ # written permission.
70
+ #
71
+ # The above copyright notice and this permission notice shall be
72
+ # included in all copies or substantial portions of the Software.
73
+ #
74
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
75
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
76
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
77
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
78
+ # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
79
+ # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
80
+ # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
81
+ # SOFTWARE.
82
+ class Format
83
+ VERSION = '0.63'
84
+
85
+ # Local abbreviations. More can be added with Text::Format.abbreviations
86
+ ABBREV = [ 'Mr', 'Mrs', 'Ms', 'Jr', 'Sr' ]
87
+
88
+ # Formatting values
89
+ LEFT_ALIGN = 0
90
+ RIGHT_ALIGN = 1
91
+ RIGHT_FILL = 2
92
+ JUSTIFY = 3
93
+
94
+ # Word split modes (only applies when #hard_margins is true).
95
+ SPLIT_FIXED = 1
96
+ SPLIT_CONTINUATION = 2
97
+ SPLIT_HYPHENATION = 4
98
+ SPLIT_CONTINUATION_FIXED = SPLIT_CONTINUATION | SPLIT_FIXED
99
+ SPLIT_HYPHENATION_FIXED = SPLIT_HYPHENATION | SPLIT_FIXED
100
+ SPLIT_HYPHENATION_CONTINUATION = SPLIT_HYPHENATION | SPLIT_CONTINUATION
101
+ SPLIT_ALL = SPLIT_HYPHENATION | SPLIT_CONTINUATION | SPLIT_FIXED
102
+
103
+ # Words forcibly split by Text::Format will be stored as split words.
104
+ # This class represents a word forcibly split.
105
+ class SplitWord
106
+ # The word that was split.
107
+ attr_reader :word
108
+ # The first part of the word that was split.
109
+ attr_reader :first
110
+ # The remainder of the word that was split.
111
+ attr_reader :rest
112
+
113
+ def initialize(word, first, rest) #:nodoc:
114
+ @word = word
115
+ @first = first
116
+ @rest = rest
117
+ end
118
+ end
119
+
120
+ private
121
+ LEQ_RE = /[.?!]['"]?$/
122
+
123
+ def brk_re(i) #:nodoc:
124
+ %r/((?:\S+\s+){#{i}})(.+)/
125
+ end
126
+
127
+ def posint(p) #:nodoc:
128
+ p.to_i.abs
129
+ end
130
+
131
+ public
132
+ # Compares two Text::Format objects. All settings of the objects are
133
+ # compared *except* #hyphenator. Generated results (e.g., #split_words)
134
+ # are not compared, either.
135
+ def ==(o)
136
+ (@text == o.text) &&
137
+ (@columns == o.columns) &&
138
+ (@left_margin == o.left_margin) &&
139
+ (@right_margin == o.right_margin) &&
140
+ (@hard_margins == o.hard_margins) &&
141
+ (@split_rules == o.split_rules) &&
142
+ (@first_indent == o.first_indent) &&
143
+ (@body_indent == o.body_indent) &&
144
+ (@tag_text == o.tag_text) &&
145
+ (@tabstop == o.tabstop) &&
146
+ (@format_style == o.format_style) &&
147
+ (@extra_space == o.extra_space) &&
148
+ (@tag_paragraph == o.tag_paragraph) &&
149
+ (@nobreak == o.nobreak) &&
150
+ (@abbreviations == o.abbreviations) &&
151
+ (@nobreak_regex == o.nobreak_regex)
152
+ end
153
+
154
+ # The text to be manipulated. Note that value is optional, but if the
155
+ # formatting functions are called without values, this text is what will
156
+ # be formatted.
157
+ #
158
+ # *Default*:: <tt>[]</tt>
159
+ # <b>Used in</b>:: All methods
160
+ attr_accessor :text
161
+
162
+ # The total width of the format area. The margins, indentation, and text
163
+ # are formatted into this space.
164
+ #
165
+ # COLUMNS
166
+ # <-------------------------------------------------------------->
167
+ # <-----------><------><---------------------------><------------>
168
+ # left margin indent text is formatted into here right margin
169
+ #
170
+ # *Default*:: <tt>72</tt>
171
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>,
172
+ # <tt>#center</tt>
173
+ attr_reader :columns
174
+
175
+ # The total width of the format area. The margins, indentation, and text
176
+ # are formatted into this space. The value provided is silently
177
+ # converted to a positive integer.
178
+ #
179
+ # COLUMNS
180
+ # <-------------------------------------------------------------->
181
+ # <-----------><------><---------------------------><------------>
182
+ # left margin indent text is formatted into here right margin
183
+ #
184
+ # *Default*:: <tt>72</tt>
185
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>,
186
+ # <tt>#center</tt>
187
+ def columns=(c)
188
+ @columns = posint(c)
189
+ end
190
+
191
+ # The number of spaces used for the left margin.
192
+ #
193
+ # columns
194
+ # <-------------------------------------------------------------->
195
+ # <-----------><------><---------------------------><------------>
196
+ # LEFT MARGIN indent text is formatted into here right margin
197
+ #
198
+ # *Default*:: <tt>0</tt>
199
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>,
200
+ # <tt>#center</tt>
201
+ attr_reader :left_margin
202
+
203
+ # The number of spaces used for the left margin. The value provided is
204
+ # silently converted to a positive integer value.
205
+ #
206
+ # columns
207
+ # <-------------------------------------------------------------->
208
+ # <-----------><------><---------------------------><------------>
209
+ # LEFT MARGIN indent text is formatted into here right margin
210
+ #
211
+ # *Default*:: <tt>0</tt>
212
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>,
213
+ # <tt>#center</tt>
214
+ def left_margin=(left)
215
+ @left_margin = posint(left)
216
+ end
217
+
218
+ # The number of spaces used for the right margin.
219
+ #
220
+ # columns
221
+ # <-------------------------------------------------------------->
222
+ # <-----------><------><---------------------------><------------>
223
+ # left margin indent text is formatted into here RIGHT MARGIN
224
+ #
225
+ # *Default*:: <tt>0</tt>
226
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>,
227
+ # <tt>#center</tt>
228
+ attr_reader :right_margin
229
+
230
+ # The number of spaces used for the right margin. The value provided is
231
+ # silently converted to a positive integer value.
232
+ #
233
+ # columns
234
+ # <-------------------------------------------------------------->
235
+ # <-----------><------><---------------------------><------------>
236
+ # left margin indent text is formatted into here RIGHT MARGIN
237
+ #
238
+ # *Default*:: <tt>0</tt>
239
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>,
240
+ # <tt>#center</tt>
241
+ def right_margin=(r)
242
+ @right_margin = posint(r)
243
+ end
244
+
245
+ # The number of spaces to indent the first line of a paragraph.
246
+ #
247
+ # columns
248
+ # <-------------------------------------------------------------->
249
+ # <-----------><------><---------------------------><------------>
250
+ # left margin INDENT text is formatted into here right margin
251
+ #
252
+ # *Default*:: <tt>4</tt>
253
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
254
+ attr_reader :first_indent
255
+
256
+ # The number of spaces to indent the first line of a paragraph. The
257
+ # value provided is silently converted to a positive integer value.
258
+ #
259
+ # columns
260
+ # <-------------------------------------------------------------->
261
+ # <-----------><------><---------------------------><------------>
262
+ # left margin INDENT text is formatted into here right margin
263
+ #
264
+ # *Default*:: <tt>4</tt>
265
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
266
+ def first_indent=(f)
267
+ @first_indent = posint(f)
268
+ end
269
+
270
+ # The number of spaces to indent all lines after the first line of a
271
+ # paragraph.
272
+ #
273
+ # columns
274
+ # <-------------------------------------------------------------->
275
+ # <-----------><------><---------------------------><------------>
276
+ # left margin INDENT text is formatted into here right margin
277
+ #
278
+ # *Default*:: <tt>0</tt>
279
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
280
+ attr_reader :body_indent
281
+
282
+ # The number of spaces to indent all lines after the first line of
283
+ # a paragraph. The value provided is silently converted to a
284
+ # positive integer value.
285
+ #
286
+ # columns
287
+ # <-------------------------------------------------------------->
288
+ # <-----------><------><---------------------------><------------>
289
+ # left margin INDENT text is formatted into here right margin
290
+ #
291
+ # *Default*:: <tt>0</tt>
292
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
293
+ def body_indent=(b)
294
+ @body_indent = posint(b)
295
+ end
296
+
297
+ # Normally, words larger than the format area will be placed on a line
298
+ # by themselves. Setting this to +true+ will force words larger than the
299
+ # format area to be split into one or more "words" each at most the size
300
+ # of the format area. The first line and the original word will be
301
+ # placed into <tt>#split_words</tt>. Note that this will cause the
302
+ # output to look *similar* to a #format_style of JUSTIFY. (Lines will be
303
+ # filled as much as possible.)
304
+ #
305
+ # *Default*:: +false+
306
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
307
+ attr_accessor :hard_margins
308
+
309
+ # An array of words split during formatting if #hard_margins is set to
310
+ # +true+.
311
+ # #split_words << Text::Format::SplitWord.new(word, first, rest)
312
+ attr_reader :split_words
313
+
314
+ # The object responsible for hyphenating. It must respond to
315
+ # #hyphenate_to(word, size) or #hyphenate_to(word, size, formatter) and
316
+ # return an array of the word split into two parts; if there is a
317
+ # hyphenation mark to be applied, responsibility belongs to the
318
+ # hyphenator object. The size is the MAXIMUM size permitted, including
319
+ # any hyphenation marks. If the #hyphenate_to method has an arity of 3,
320
+ # the formatter will be provided to the method. This allows the
321
+ # hyphenator to make decisions about the hyphenation based on the
322
+ # formatting rules.
323
+ #
324
+ # *Default*:: +nil+
325
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
326
+ attr_reader :hyphenator
327
+
328
+ # The object responsible for hyphenating. It must respond to
329
+ # #hyphenate_to(word, size) and return an array of the word hyphenated
330
+ # into two parts. The size is the MAXIMUM size permitted, including any
331
+ # hyphenation marks.
332
+ #
333
+ # *Default*:: +nil+
334
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
335
+ def hyphenator=(h)
336
+ raise ArgumentError, "#{h.inspect} is not a valid hyphenator." unless h.respond_to?(:hyphenate_to)
337
+ arity = h.method(:hyphenate_to).arity
338
+ raise ArgumentError, "#{h.inspect} must have exactly two or three arguments." unless [2, 3].include?(arity)
339
+ @hyphenator = h
340
+ @hyphenator_arity = arity
341
+ end
342
+
343
+ # Specifies the split mode; used only when #hard_margins is set to
344
+ # +true+. Allowable values are:
345
+ # [+SPLIT_FIXED+] The word will be split at the number of
346
+ # characters needed, with no marking at all.
347
+ # repre
348
+ # senta
349
+ # ion
350
+ # [+SPLIT_CONTINUATION+] The word will be split at the number of
351
+ # characters needed, with a C-style continuation
352
+ # character. If a word is the only item on a
353
+ # line and it cannot be split into an
354
+ # appropriate size, SPLIT_FIXED will be used.
355
+ # repr\
356
+ # esen\
357
+ # tati\
358
+ # on
359
+ # [+SPLIT_HYPHENATION+] The word will be split according to the
360
+ # hyphenator specified in #hyphenator. If there
361
+ # is no #hyphenator specified, works like
362
+ # SPLIT_CONTINUATION. The example is using
363
+ # TeX::Hyphen. If a word is the only item on a
364
+ # line and it cannot be split into an
365
+ # appropriate size, SPLIT_CONTINUATION mode will
366
+ # be used.
367
+ # rep-
368
+ # re-
369
+ # sen-
370
+ # ta-
371
+ # tion
372
+ #
373
+ # *Default*:: <tt>Text::Format::SPLIT_FIXED</tt>
374
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
375
+ attr_reader :split_rules
376
+
377
+ # Specifies the split mode; used only when #hard_margins is set to
378
+ # +true+. Allowable values are:
379
+ # [+SPLIT_FIXED+] The word will be split at the number of
380
+ # characters needed, with no marking at all.
381
+ # repre
382
+ # senta
383
+ # ion
384
+ # [+SPLIT_CONTINUATION+] The word will be split at the number of
385
+ # characters needed, with a C-style continuation
386
+ # character.
387
+ # repr\
388
+ # esen\
389
+ # tati\
390
+ # on
391
+ # [+SPLIT_HYPHENATION+] The word will be split according to the
392
+ # hyphenator specified in #hyphenator. If there
393
+ # is no #hyphenator specified, works like
394
+ # SPLIT_CONTINUATION. The example is using
395
+ # TeX::Hyphen as the #hyphenator.
396
+ # rep-
397
+ # re-
398
+ # sen-
399
+ # ta-
400
+ # tion
401
+ #
402
+ # These values can be bitwise ORed together (e.g., <tt>SPLIT_FIXED |
403
+ # SPLIT_CONTINUATION</tt>) to provide fallback split methods. In the
404
+ # example given, an attempt will be made to split the word using the
405
+ # rules of SPLIT_CONTINUATION; if there is not enough room, the word
406
+ # will be split with the rules of SPLIT_FIXED. These combinations are
407
+ # also available as the following values:
408
+ # * +SPLIT_CONTINUATION_FIXED+
409
+ # * +SPLIT_HYPHENATION_FIXED+
410
+ # * +SPLIT_HYPHENATION_CONTINUATION+
411
+ # * +SPLIT_ALL+
412
+ #
413
+ # *Default*:: <tt>Text::Format::SPLIT_FIXED</tt>
414
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
415
+ def split_rules=(s)
416
+ raise ArgumentError, "Invalid value provided for split_rules." if ((s < SPLIT_FIXED) || (s > SPLIT_ALL))
417
+ @split_rules = s
418
+ end
419
+
420
+ # Indicates whether sentence terminators should be followed by a single
421
+ # space (+false+), or two spaces (+true+).
422
+ #
423
+ # *Default*:: +false+
424
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
425
+ attr_accessor :extra_space
426
+
427
+ # Defines the current abbreviations as an array. This is only used if
428
+ # extra_space is turned on.
429
+ #
430
+ # If one is abbreviating "President" as "Pres." (abbreviations =
431
+ # ["Pres"]), then the results of formatting will be as illustrated in
432
+ # the table below:
433
+ #
434
+ # extra_space | include? | !include?
435
+ # true | Pres. Lincoln | Pres. Lincoln
436
+ # false | Pres. Lincoln | Pres. Lincoln
437
+ #
438
+ # *Default*:: <tt>{}</tt>
439
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
440
+ attr_accessor :abbreviations
441
+
442
+ # Indicates whether the formatting of paragraphs should be done with
443
+ # tagged paragraphs. Useful only with <tt>#tag_text</tt>.
444
+ #
445
+ # *Default*:: +false+
446
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
447
+ attr_accessor :tag_paragraph
448
+
449
+ # The array of text to be placed before each paragraph when
450
+ # <tt>#tag_paragraph</tt> is +true+. When <tt>#format()</tt> is called,
451
+ # only the first element of the array is used. When <tt>#paragraphs</tt>
452
+ # is called, then each entry in the array will be used once, with
453
+ # corresponding paragraphs. If the tag elements are exhausted before the
454
+ # text is exhausted, then the remaining paragraphs will not be tagged.
455
+ # Regardless of indentation settings, a blank line will be inserted
456
+ # between all paragraphs when <tt>#tag_paragraph</tt> is +true+.
457
+ #
458
+ # *Default*:: <tt>[]</tt>
459
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
460
+ attr_accessor :tag_text
461
+
462
+ # Indicates whether or not the non-breaking space feature should be
463
+ # used.
464
+ #
465
+ # *Default*:: +false+
466
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
467
+ attr_accessor :nobreak
468
+
469
+ # A hash which holds the regular expressions on which spaces should not
470
+ # be broken. The hash is set up such that the key is the first word and
471
+ # the value is the second word.
472
+ #
473
+ # For example, if +nobreak_regex+ contains the following hash:
474
+ #
475
+ # { '^Mrs?\.$' => '\S+$', '^\S+$' => '^(?:S|J)r\.$'}
476
+ #
477
+ # Then "Mr. Jones", "Mrs. Jones", and "Jones Jr." would not be broken.
478
+ # If this simple matching algorithm indicates that there should not be a
479
+ # break at the current end of line, then a backtrack is done until there
480
+ # are two words on which line breaking is permitted. If two such words
481
+ # are not found, then the end of the line will be broken *regardless*.
482
+ # If there is a single word on the current line, then no backtrack is
483
+ # done and the word is stuck on the end.
484
+ #
485
+ # *Default*:: <tt>{}</tt>
486
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
487
+ attr_accessor :nobreak_regex
488
+
489
+ # Indicates the number of spaces that a single tab represents.
490
+ #
491
+ # *Default*:: <tt>8</tt>
492
+ # <b>Used in</b>:: <tt>#expand</tt>, <tt>#unexpand</tt>,
493
+ # <tt>#paragraphs</tt>
494
+ attr_reader :tabstop
495
+
496
+ # Indicates the number of spaces that a single tab represents.
497
+ #
498
+ # *Default*:: <tt>8</tt>
499
+ # <b>Used in</b>:: <tt>#expand</tt>, <tt>#unexpand</tt>,
500
+ # <tt>#paragraphs</tt>
501
+ def tabstop=(t)
502
+ @tabstop = posint(t)
503
+ end
504
+
505
+ # Specifies the format style. Allowable values are:
506
+ # [+LEFT_ALIGN+] Left justified, ragged right.
507
+ # |A paragraph that is|
508
+ # |left aligned.|
509
+ # [+RIGHT_ALIGN+] Right justified, ragged left.
510
+ # |A paragraph that is|
511
+ # | right aligned.|
512
+ # [+RIGHT_FILL+] Left justified, right ragged, filled to width by
513
+ # spaces. (Essentially the same as +LEFT_ALIGN+ except
514
+ # that lines are padded on the right.)
515
+ # |A paragraph that is|
516
+ # |left aligned. |
517
+ # [+JUSTIFY+] Fully justified, words filled to width by spaces,
518
+ # except the last line.
519
+ # |A paragraph that|
520
+ # |is justified.|
521
+ #
522
+ # *Default*:: <tt>Text::Format::LEFT_ALIGN</tt>
523
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
524
+ attr_reader :format_style
525
+
526
+ # Specifies the format style. Allowable values are:
527
+ # [+LEFT_ALIGN+] Left justified, ragged right.
528
+ # |A paragraph that is|
529
+ # |left aligned.|
530
+ # [+RIGHT_ALIGN+] Right justified, ragged left.
531
+ # |A paragraph that is|
532
+ # | right aligned.|
533
+ # [+RIGHT_FILL+] Left justified, right ragged, filled to width by
534
+ # spaces. (Essentially the same as +LEFT_ALIGN+ except
535
+ # that lines are padded on the right.)
536
+ # |A paragraph that is|
537
+ # |left aligned. |
538
+ # [+JUSTIFY+] Fully justified, words filled to width by spaces.
539
+ # |A paragraph that|
540
+ # |is justified.|
541
+ #
542
+ # *Default*:: <tt>Text::Format::LEFT_ALIGN</tt>
543
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
544
+ def format_style=(fs)
545
+ raise ArgumentError, "Invalid value provided for format_style." if ((fs < LEFT_ALIGN) || (fs > JUSTIFY))
546
+ @format_style = fs
547
+ end
548
+
549
+ # Indicates that the format style is left alignment.
550
+ #
551
+ # *Default*:: +true+
552
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
553
+ def left_align?
554
+ return @format_style == LEFT_ALIGN
555
+ end
556
+
557
+ # Indicates that the format style is right alignment.
558
+ #
559
+ # *Default*:: +false+
560
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
561
+ def right_align?
562
+ return @format_style == RIGHT_ALIGN
563
+ end
564
+
565
+ # Indicates that the format style is right fill.
566
+ #
567
+ # *Default*:: +false+
568
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
569
+ def right_fill?
570
+ return @format_style == RIGHT_FILL
571
+ end
572
+
573
+ # Indicates that the format style is full justification.
574
+ #
575
+ # *Default*:: +false+
576
+ # <b>Used in</b>:: <tt>#format</tt>, <tt>#paragraphs</tt>
577
+ def justify?
578
+ return @format_style == JUSTIFY
579
+ end
580
+
581
+ # The default implementation of #hyphenate_to implements
582
+ # SPLIT_CONTINUATION.
583
+ def hyphenate_to(word, size)
584
+ [word[0 .. (size - 2)] + "\\", word[(size - 1) .. -1]]
585
+ end
586
+
587
+ private
588
+ def __do_split_word(word, size) #:nodoc:
589
+ [word[0 .. (size - 1)], word[size .. -1]]
590
+ end
591
+
592
+ def __format(to_wrap) #:nodoc:
593
+ words = to_wrap.split(/\s+/).compact
594
+ words.shift if words[0].nil? or words[0].empty?
595
+ to_wrap = []
596
+
597
+ abbrev = false
598
+ width = @columns - @first_indent - @left_margin - @right_margin
599
+ indent_str = ' ' * @first_indent
600
+ first_line = true
601
+ line = words.shift
602
+ abbrev = __is_abbrev(line) unless line.nil? || line.empty?
603
+
604
+ while w = words.shift
605
+ if (w.size + line.size < (width - 1)) ||
606
+ ((line !~ LEQ_RE || abbrev) && (w.size + line.size < width))
607
+ line << " " if (line =~ LEQ_RE) && (not abbrev)
608
+ line << " #{w}"
609
+ else
610
+ line, w = __do_break(line, w) if @nobreak
611
+ line, w = __do_hyphenate(line, w, width) if @hard_margins
612
+ if w.index(/\s+/)
613
+ w, *w2 = w.split(/\s+/)
614
+ words.unshift(w2)
615
+ words.flatten!
616
+ end
617
+ to_wrap << __make_line(line, indent_str, width, w.nil?) unless line.nil?
618
+ if first_line
619
+ first_line = false
620
+ width = @columns - @body_indent - @left_margin - @right_margin
621
+ indent_str = ' ' * @body_indent
622
+ end
623
+ line = w
624
+ end
625
+
626
+ abbrev = __is_abbrev(w) unless w.nil?
627
+ end
628
+
629
+ loop do
630
+ break if line.nil? or line.empty?
631
+ line, w = __do_hyphenate(line, w, width) if @hard_margins
632
+ to_wrap << __make_line(line, indent_str, width, w.nil?)
633
+ line = w
634
+ end
635
+
636
+ if (@tag_paragraph && (to_wrap.size > 0)) then
637
+ clr = %r{`(\w+)'}.match([caller(1)].flatten[0])[1]
638
+ clr = "" if clr.nil?
639
+
640
+ if ((not @tag_text[0].nil?) && (@tag_cur.size < 1) &&
641
+ (clr != "__paragraphs")) then
642
+ @tag_cur = @tag_text[0]
643
+ end
644
+
645
+ fchar = /(\S)/.match(to_wrap[0])[1]
646
+ white = to_wrap[0].index(fchar)
647
+ if ((white - @left_margin - 1) > @tag_cur.size) then
648
+ white = @tag_cur.size + @left_margin
649
+ to_wrap[0].gsub!(/^ {#{white}}/, "#{' ' * @left_margin}#{@tag_cur}")
650
+ else
651
+ to_wrap.unshift("#{' ' * @left_margin}#{@tag_cur}\n")
652
+ end
653
+ end
654
+ to_wrap.join('')
655
+ end
656
+
657
+ # format lines in text into paragraphs with each element of @wrap a
658
+ # paragraph; uses Text::Format.format for the formatting
659
+ def __paragraphs(to_wrap) #:nodoc:
660
+ if ((@first_indent == @body_indent) || @tag_paragraph) then
661
+ p_end = "\n"
662
+ else
663
+ p_end = ''
664
+ end
665
+
666
+ cnt = 0
667
+ ret = []
668
+ to_wrap.each do |tw|
669
+ @tag_cur = @tag_text[cnt] if @tag_paragraph
670
+ @tag_cur = '' if @tag_cur.nil?
671
+ line = __format(tw)
672
+ ret << "#{line}#{p_end}" if (not line.nil?) && (line.size > 0)
673
+ cnt += 1
674
+ end
675
+
676
+ ret[-1].chomp! unless ret.empty?
677
+ ret.join('')
678
+ end
679
+
680
+ # center text using spaces on left side to pad it out empty lines
681
+ # are preserved
682
+ def __center(to_center) #:nodoc:
683
+ tabs = 0
684
+ width = @columns - @left_margin - @right_margin
685
+ centered = []
686
+ to_center.each do |tc|
687
+ s = tc.strip
688
+ tabs = s.count("\t")
689
+ tabs = 0 if tabs.nil?
690
+ ct = ((width - s.size - (tabs * @tabstop) + tabs) / 2)
691
+ ct = (width - @left_margin - @right_margin) - ct
692
+ centered << "#{s.rjust(ct)}\n"
693
+ end
694
+ centered.join('')
695
+ end
696
+
697
+ # expand tabs to spaces should be similar to Text::Tabs::expand
698
+ def __expand(to_expand) #:nodoc:
699
+ expanded = []
700
+ to_expand.split("\n").each { |te| expanded << te.gsub(/\t/, ' ' * @tabstop) }
701
+ expanded.join('')
702
+ end
703
+
704
+ def __unexpand(to_unexpand) #:nodoc:
705
+ unexpanded = []
706
+ to_unexpand.split("\n").each { |tu| unexpanded << tu.gsub(/ {#{@tabstop}}/, "\t") }
707
+ unexpanded.join('')
708
+ end
709
+
710
+ def __is_abbrev(word) #:nodoc:
711
+ # remove period if there is one.
712
+ w = word.gsub(/\.$/, '') unless word.nil?
713
+ return true if (!@extra_space || ABBREV.include?(w) || @abbreviations.include?(w))
714
+ false
715
+ end
716
+
717
+ def __make_line(line, indent, width, last = false) #:nodoc:
718
+ lmargin = " " * @left_margin
719
+ fill = " " * (width - line.size) if right_fill? && (line.size <= width)
720
+
721
+ if (justify? && ((not line.nil?) && (not line.empty?)) && line =~ /\S+\s+\S+/ && !last)
722
+ spaces = width - line.size
723
+ words = line.split(/(\s+)/)
724
+ ws = spaces / (words.size / 2)
725
+ spaces = spaces % (words.size / 2) if ws > 0
726
+ words.reverse.each do |rw|
727
+ next if (rw =~ /^\S/)
728
+ rw.sub!(/^/, " " * ws)
729
+ next unless (spaces > 0)
730
+ rw.sub!(/^/, " ")
731
+ spaces -= 1
732
+ end
733
+ line = words.join('')
734
+ end
735
+ line = "#{lmargin}#{indent}#{line}#{fill}\n" unless line.nil?
736
+ if right_align? && (not line.nil?)
737
+ line.sub(/^/, " " * (@columns - @right_margin - (line.size - 1)))
738
+ else
739
+ line
740
+ end
741
+ end
742
+
743
+ def __do_hyphenate(line, next_line, width) #:nodoc:
744
+ rline = line.dup rescue line
745
+ rnext = next_line.dup rescue next_line
746
+ loop do
747
+ if rline.size == width
748
+ break
749
+ elsif rline.size > width
750
+ words = rline.strip.split(/\s+/)
751
+ word = words[-1].dup
752
+ size = width - rline.size + word.size
753
+ if (size <= 0)
754
+ words[-1] = nil
755
+ rline = words.join(' ').strip
756
+ rnext = "#{word} #{rnext}".strip
757
+ next
758
+ end
759
+
760
+ first = rest = nil
761
+
762
+ if ((@split_rules & SPLIT_HYPHENATION) != 0)
763
+ if @hyphenator_arity == 2
764
+ first, rest = @hyphenator.hyphenate_to(word, size)
765
+ else
766
+ first, rest = @hyphenator.hyphenate_to(word, size, self)
767
+ end
768
+ end
769
+
770
+ if ((@split_rules & SPLIT_CONTINUATION) != 0) and first.nil?
771
+ first, rest = self.hyphenate_to(word, size)
772
+ end
773
+
774
+ if ((@split_rules & SPLIT_FIXED) != 0) and first.nil?
775
+ first.nil? or @split_rules == SPLIT_FIXED
776
+ first, rest = __do_split_word(word, size)
777
+ end
778
+
779
+ if first.nil?
780
+ words[-1] = nil
781
+ rest = word
782
+ else
783
+ words[-1] = first
784
+ @split_words << SplitWord.new(word, first, rest)
785
+ end
786
+ rline = words.join(' ').strip
787
+ rnext = "#{rest} #{rnext}".strip
788
+ break
789
+ else
790
+ break if rnext.nil? or rnext.empty? or rline.nil? or rline.empty?
791
+ words = rnext.split(/\s+/)
792
+ word = words.shift
793
+ size = width - rline.size - 1
794
+
795
+ if (size <= 0)
796
+ rnext = "#{word} #{words.join(' ')}".strip
797
+ break
798
+ end
799
+
800
+ first = rest = nil
801
+
802
+ if ((@split_rules & SPLIT_HYPHENATION) != 0)
803
+ if @hyphenator_arity == 2
804
+ first, rest = @hyphenator.hyphenate_to(word, size)
805
+ else
806
+ first, rest = @hyphenator.hyphenate_to(word, size, self)
807
+ end
808
+ end
809
+
810
+ first, rest = self.hyphenate_to(word, size) if ((@split_rules & SPLIT_CONTINUATION) != 0) and first.nil?
811
+
812
+ first, rest = __do_split_word(word, size) if ((@split_rules & SPLIT_FIXED) != 0) and first.nil?
813
+
814
+ if (rline.size + (first ? first.size : 0)) < width
815
+ @split_words << SplitWord.new(word, first, rest)
816
+ rline = "#{rline} #{first}".strip
817
+ rnext = "#{rest} #{words.join(' ')}".strip
818
+ end
819
+ break
820
+ end
821
+ end
822
+ [rline, rnext]
823
+ end
824
+
825
+ def __do_break(line, next_line) #:nodoc:
826
+ no_brk = false
827
+ words = []
828
+ words = line.split(/\s+/) unless line.nil?
829
+ last_word = words[-1]
830
+
831
+ @nobreak_regex.each { |k, v| no_brk = ((last_word =~ /#{k}/) and (next_line =~ /#{v}/)) }
832
+
833
+ if no_brk && words.size > 1
834
+ i = words.size
835
+ while i > 0
836
+ no_brk = false
837
+ @nobreak_regex.each { |k, v| no_brk = ((words[i + 1] =~ /#{k}/) && (words[i] =~ /#{v}/)) }
838
+ i -= 1
839
+ break if not no_brk
840
+ end
841
+ if i > 0
842
+ l = brk_re(i).match(line)
843
+ line.sub!(brk_re(i), l[1])
844
+ next_line = "#{l[2]} #{next_line}"
845
+ line.sub!(/\s+$/, '')
846
+ end
847
+ end
848
+ [line, next_line]
849
+ end
850
+
851
+ def __create(arg = nil, &block) #:nodoc:
852
+ # Format::Text.new(text-to-wrap)
853
+ @text = arg unless arg.nil?
854
+ # Defaults
855
+ @columns = 72
856
+ @tabstop = 8
857
+ @first_indent = 4
858
+ @body_indent = 0
859
+ @format_style = LEFT_ALIGN
860
+ @left_margin = 0
861
+ @right_margin = 0
862
+ @extra_space = false
863
+ @text = Array.new if @text.nil?
864
+ @tag_paragraph = false
865
+ @tag_text = Array.new
866
+ @tag_cur = ""
867
+ @abbreviations = Array.new
868
+ @nobreak = false
869
+ @nobreak_regex = Hash.new
870
+ @split_words = Array.new
871
+ @hard_margins = false
872
+ @split_rules = SPLIT_FIXED
873
+ @hyphenator = self
874
+ @hyphenator_arity = self.method(:hyphenate_to).arity
875
+
876
+ instance_eval(&block) unless block.nil?
877
+ end
878
+
879
+ public
880
+ # Formats text into a nice paragraph format. The text is separated
881
+ # into words and then reassembled a word at a time using the settings
882
+ # of this Format object. If a word is larger than the number of
883
+ # columns available for formatting, then that word will appear on the
884
+ # line by itself.
885
+ #
886
+ # If +to_wrap+ is +nil+, then the value of <tt>#text</tt> will be
887
+ # worked on.
888
+ def format(to_wrap = nil)
889
+ to_wrap = @text if to_wrap.nil?
890
+ if to_wrap.class == Array
891
+ __format(to_wrap[0])
892
+ else
893
+ __format(to_wrap)
894
+ end
895
+ end
896
+
897
+ # Considers each element of text (provided or internal) as a paragraph.
898
+ # If <tt>#first_indent</tt> is the same as <tt>#body_indent</tt>, then
899
+ # paragraphs will be separated by a single empty line in the result;
900
+ # otherwise, the paragraphs will follow immediately after each other.
901
+ # Uses <tt>#format</tt> to do the heavy lifting.
902
+ def paragraphs(to_wrap = nil)
903
+ to_wrap = @text if to_wrap.nil?
904
+ __paragraphs([to_wrap].flatten)
905
+ end
906
+
907
+ # Centers the text, preserving empty lines and tabs.
908
+ def center(to_center = nil)
909
+ to_center = @text if to_center.nil?
910
+ __center([to_center].flatten)
911
+ end
912
+
913
+ # Replaces all tab characters in the text with <tt>#tabstop</tt> spaces.
914
+ def expand(to_expand = nil)
915
+ to_expand = @text if to_expand.nil?
916
+ if to_expand.class == Array
917
+ to_expand.collect { |te| __expand(te) }
918
+ else
919
+ __expand(to_expand)
920
+ end
921
+ end
922
+
923
+ # Replaces all occurrences of <tt>#tabstop</tt> consecutive spaces
924
+ # with a tab character.
925
+ def unexpand(to_unexpand = nil)
926
+ to_unexpand = @text if to_unexpand.nil?
927
+ if to_unexpand.class == Array
928
+ to_unexpand.collect { |te| v << __unexpand(te) }
929
+ else
930
+ __unexpand(to_unexpand)
931
+ end
932
+ end
933
+
934
+ # This constructor takes advantage of a technique for Ruby object
935
+ # construction introduced by Andy Hunt and Dave Thomas (see reference),
936
+ # where optional values are set using commands in a block.
937
+ #
938
+ # Text::Format.new {
939
+ # columns = 72
940
+ # left_margin = 0
941
+ # right_margin = 0
942
+ # first_indent = 4
943
+ # body_indent = 0
944
+ # format_style = Text::Format::LEFT_ALIGN
945
+ # extra_space = false
946
+ # abbreviations = {}
947
+ # tag_paragraph = false
948
+ # tag_text = []
949
+ # nobreak = false
950
+ # nobreak_regex = {}
951
+ # tabstop = 8
952
+ # text = nil
953
+ # }
954
+ #
955
+ # As shown above, +arg+ is optional. If +arg+ is specified and is a
956
+ # +String+, then arg is used as the default value of <tt>#text</tt>.
957
+ # Alternately, an existing Text::Format object can be used or a Hash can
958
+ # be used. With all forms, a block can be specified.
959
+ #
960
+ # *Reference*:: "Object Construction and Blocks"
961
+ # <http://www.pragmaticprogrammer.com/ruby/articles/insteval.html>
962
+ #
963
+ def initialize(arg = nil, &block)
964
+ case arg
965
+ when Text::Format
966
+ __create(arg.text) do
967
+ @columns = arg.columns
968
+ @tabstop = arg.tabstop
969
+ @first_indent = arg.first_indent
970
+ @body_indent = arg.body_indent
971
+ @format_style = arg.format_style
972
+ @left_margin = arg.left_margin
973
+ @right_margin = arg.right_margin
974
+ @extra_space = arg.extra_space
975
+ @tag_paragraph = arg.tag_paragraph
976
+ @tag_text = arg.tag_text
977
+ @abbreviations = arg.abbreviations
978
+ @nobreak = arg.nobreak
979
+ @nobreak_regex = arg.nobreak_regex
980
+ @text = arg.text
981
+ @hard_margins = arg.hard_margins
982
+ @split_words = arg.split_words
983
+ @split_rules = arg.split_rules
984
+ @hyphenator = arg.hyphenator
985
+ end
986
+ instance_eval(&block) unless block.nil?
987
+ when Hash
988
+ __create do
989
+ @columns = arg[:columns] || arg['columns'] || @columns
990
+ @tabstop = arg[:tabstop] || arg['tabstop'] || @tabstop
991
+ @first_indent = arg[:first_indent] || arg['first_indent'] || @first_indent
992
+ @body_indent = arg[:body_indent] || arg['body_indent'] || @body_indent
993
+ @format_style = arg[:format_style] || arg['format_style'] || @format_style
994
+ @left_margin = arg[:left_margin] || arg['left_margin'] || @left_margin
995
+ @right_margin = arg[:right_margin] || arg['right_margin'] || @right_margin
996
+ @extra_space = arg[:extra_space] || arg['extra_space'] || @extra_space
997
+ @text = arg[:text] || arg['text'] || @text
998
+ @tag_paragraph = arg[:tag_paragraph] || arg['tag_paragraph'] || @tag_paragraph
999
+ @tag_text = arg[:tag_text] || arg['tag_text'] || @tag_text
1000
+ @abbreviations = arg[:abbreviations] || arg['abbreviations'] || @abbreviations
1001
+ @nobreak = arg[:nobreak] || arg['nobreak'] || @nobreak
1002
+ @nobreak_regex = arg[:nobreak_regex] || arg['nobreak_regex'] || @nobreak_regex
1003
+ @hard_margins = arg[:hard_margins] || arg['hard_margins'] || @hard_margins
1004
+ @split_rules = arg[:split_rules] || arg['split_rules'] || @split_rules
1005
+ @hyphenator = arg[:hyphenator] || arg['hyphenator'] || @hyphenator
1006
+ end
1007
+ instance_eval(&block) unless block.nil?
1008
+ when String
1009
+ __create(arg, &block)
1010
+ when NilClass
1011
+ __create(&block)
1012
+ else
1013
+ raise TypeError
1014
+ end
1015
+ end
1016
+ end
1017
+ end
1018
+
1019
+ if __FILE__ == $0
1020
+ require 'test/unit'
1021
+
1022
+ class TestText__Format < Test::Unit::TestCase #:nodoc:
1023
+ attr_accessor :format_o
1024
+
1025
+ GETTYSBURG = <<-'EOS'
1026
+ Four score and seven years ago our fathers brought forth on this
1027
+ continent a new nation, conceived in liberty and dedicated to the
1028
+ proposition that all men are created equal. Now we are engaged in
1029
+ a great civil war, testing whether that nation or any nation so
1030
+ conceived and so dedicated can long endure. We are met on a great
1031
+ battlefield of that war. We have come to dedicate a portion of
1032
+ that field as a final resting-place for those who here gave their
1033
+ lives that that nation might live. It is altogether fitting and
1034
+ proper that we should do this. But in a larger sense, we cannot
1035
+ dedicate, we cannot consecrate, we cannot hallow this ground.
1036
+ The brave men, living and dead who struggled here have consecrated
1037
+ it far above our poor power to add or detract. The world will
1038
+ little note nor long remember what we say here, but it can never
1039
+ forget what they did here. It is for us the living rather to be
1040
+ dedicated here to the unfinished work which they who fought here
1041
+ have thus far so nobly advanced. It is rather for us to be here
1042
+ dedicated to the great task remaining before us--that from these
1043
+ honored dead we take increased devotion to that cause for which
1044
+ they gave the last full measure of devotion--that we here highly
1045
+ resolve that these dead shall not have died in vain, that this
1046
+ nation under God shall have a new birth of freedom, and that
1047
+ government of the people, by the people, for the people shall
1048
+ not perish from the earth.
1049
+
1050
+ -- Pres. Abraham Lincoln, 19 November 1863
1051
+ EOS
1052
+
1053
+ FIVE_COL = "Four \nscore\nand s\neven \nyears\nago o\nur fa\nthers\nbroug\nht fo\nrth o\nn thi\ns con\ntinen\nt a n\new na\ntion,\nconce\nived \nin li\nberty\nand d\nedica\nted t\no the\npropo\nsitio\nn tha\nt all\nmen a\nre cr\neated\nequal\n. Now\nwe ar\ne eng\naged \nin a \ngreat\ncivil\nwar, \ntesti\nng wh\nether\nthat \nnatio\nn or \nany n\nation\nso co\nnceiv\ned an\nd so \ndedic\nated \ncan l\nong e\nndure\n. We \nare m\net on\na gre\nat ba\nttlef\nield \nof th\nat wa\nr. We\nhave \ncome \nto de\ndicat\ne a p\nortio\nn of \nthat \nfield\nas a \nfinal\nresti\nng-pl\nace f\nor th\nose w\nho he\nre ga\nve th\neir l\nives \nthat \nthat \nnatio\nn mig\nht li\nve. I\nt is \naltog\nether\nfitti\nng an\nd pro\nper t\nhat w\ne sho\nuld d\no thi\ns. Bu\nt in \na lar\nger s\nense,\nwe ca\nnnot \ndedic\nate, \nwe ca\nnnot \nconse\ncrate\n, we \ncanno\nt hal\nlow t\nhis g\nround\n. The\nbrave\nmen, \nlivin\ng and\ndead \nwho s\ntrugg\nled h\nere h\nave c\nonsec\nrated\nit fa\nr abo\nve ou\nr poo\nr pow\ner to\nadd o\nr det\nract.\nThe w\norld \nwill \nlittl\ne not\ne nor\nlong \nremem\nber w\nhat w\ne say\nhere,\nbut i\nt can\nnever\nforge\nt wha\nt the\ny did\nhere.\nIt is\nfor u\ns the\nlivin\ng rat\nher t\no be \ndedic\nated \nhere \nto th\ne unf\ninish\ned wo\nrk wh\nich t\nhey w\nho fo\nught \nhere \nhave \nthus \nfar s\no nob\nly ad\nvance\nd. It\nis ra\nther \nfor u\ns to \nbe he\nre de\ndicat\ned to\nthe g\nreat \ntask \nremai\nning \nbefor\ne us-\n-that\nfrom \nthese\nhonor\ned de\nad we\ntake \nincre\nased \ndevot\nion t\no tha\nt cau\nse fo\nr whi\nch th\ney ga\nve th\ne las\nt ful\nl mea\nsure \nof de\nvotio\nn--th\nat we\nhere \nhighl\ny res\nolve \nthat \nthese\ndead \nshall\nnot h\nave d\nied i\nn vai\nn, th\nat th\nis na\ntion \nunder\nGod s\nhall \nhave \na new\nbirth\nof fr\needom\n, and\nthat \ngover\nnment\nof th\ne peo\nple, \nby th\ne peo\nple, \nfor t\nhe pe\nople \nshall\nnot p\nerish\nfrom \nthe e\narth.\n-- Pr\nes. A\nbraha\nm Lin\ncoln,\n19 No\nvembe\nr 186\n3 \n"
1054
+
1055
+ FIVE_CNT = "Four \nscore\nand \nseven\nyears\nago \nour \nfath\\\ners \nbrou\\\nght \nforth\non t\\\nhis \ncont\\\ninent\na new\nnati\\\non, \nconc\\\neived\nin l\\\niber\\\nty a\\\nnd d\\\nedic\\\nated \nto t\\\nhe p\\\nropo\\\nsiti\\\non t\\\nhat \nall \nmen \nare \ncrea\\\nted \nequa\\\nl. N\\\now we\nare \nenga\\\nged \nin a \ngreat\ncivil\nwar, \ntest\\\ning \nwhet\\\nher \nthat \nnati\\\non or\nany \nnati\\\non so\nconc\\\neived\nand \nso d\\\nedic\\\nated \ncan \nlong \nendu\\\nre. \nWe a\\\nre m\\\net on\na gr\\\neat \nbatt\\\nlefi\\\neld \nof t\\\nhat \nwar. \nWe h\\\nave \ncome \nto d\\\nedic\\\nate a\nport\\\nion \nof t\\\nhat \nfield\nas a \nfinal\nrest\\\ning-\\\nplace\nfor \nthose\nwho \nhere \ngave \ntheir\nlives\nthat \nthat \nnati\\\non m\\\night \nlive.\nIt is\nalto\\\ngeth\\\ner f\\\nitti\\\nng a\\\nnd p\\\nroper\nthat \nwe s\\\nhould\ndo t\\\nhis. \nBut \nin a \nlarg\\\ner s\\\nense,\nwe c\\\nannot\ndedi\\\ncate,\nwe c\\\nannot\ncons\\\necra\\\nte, \nwe c\\\nannot\nhall\\\now t\\\nhis \ngrou\\\nnd. \nThe \nbrave\nmen, \nlivi\\\nng a\\\nnd d\\\nead \nwho \nstru\\\nggled\nhere \nhave \ncons\\\necra\\\nted \nit f\\\nar a\\\nbove \nour \npoor \npower\nto a\\\ndd or\ndetr\\\nact. \nThe \nworld\nwill \nlitt\\\nle n\\\note \nnor \nlong \nreme\\\nmber \nwhat \nwe s\\\nay h\\\nere, \nbut \nit c\\\nan n\\\never \nforg\\\net w\\\nhat \nthey \ndid \nhere.\nIt is\nfor \nus t\\\nhe l\\\niving\nrath\\\ner to\nbe d\\\nedic\\\nated \nhere \nto t\\\nhe u\\\nnfin\\\nished\nwork \nwhich\nthey \nwho \nfoug\\\nht h\\\nere \nhave \nthus \nfar \nso n\\\nobly \nadva\\\nnced.\nIt is\nrath\\\ner f\\\nor us\nto be\nhere \ndedi\\\ncated\nto t\\\nhe g\\\nreat \ntask \nrema\\\nining\nbefo\\\nre u\\\ns--t\\\nhat \nfrom \nthese\nhono\\\nred \ndead \nwe t\\\nake \nincr\\\neased\ndevo\\\ntion \nto t\\\nhat \ncause\nfor \nwhich\nthey \ngave \nthe \nlast \nfull \nmeas\\\nure \nof d\\\nevot\\\nion-\\\n-that\nwe h\\\nere \nhigh\\\nly r\\\nesol\\\nve t\\\nhat \nthese\ndead \nshall\nnot \nhave \ndied \nin v\\\nain, \nthat \nthis \nnati\\\non u\\\nnder \nGod \nshall\nhave \na new\nbirth\nof f\\\nreed\\\nom, \nand \nthat \ngove\\\nrnme\\\nnt of\nthe \npeop\\\nle, \nby t\\\nhe p\\\neopl\\\ne, f\\\nor t\\\nhe p\\\neople\nshall\nnot \nperi\\\nsh f\\\nrom \nthe \neart\\\nh. --\nPres.\nAbra\\\nham \nLinc\\\noln, \n19 N\\\novem\\\nber \n1863 \n"
1056
+
1057
+ # Tests both abbreviations and abbreviations=
1058
+ def test_abbreviations
1059
+ abbr = [" Pres. Abraham Lincoln\n", " Pres. Abraham Lincoln\n"]
1060
+ assert_nothing_raised { @format_o = Text::Format.new }
1061
+ assert_equal([], @format_o.abbreviations)
1062
+ assert_nothing_raised { @format_o.abbreviations = [ 'foo', 'bar' ] }
1063
+ assert_equal([ 'foo', 'bar' ], @format_o.abbreviations)
1064
+ assert_equal(abbr[0], @format_o.format(abbr[0]))
1065
+ assert_nothing_raised { @format_o.extra_space = true }
1066
+ assert_equal(abbr[1], @format_o.format(abbr[0]))
1067
+ assert_nothing_raised { @format_o.abbreviations = [ "Pres" ] }
1068
+ assert_equal([ "Pres" ], @format_o.abbreviations)
1069
+ assert_equal(abbr[0], @format_o.format(abbr[0]))
1070
+ assert_nothing_raised { @format_o.extra_space = false }
1071
+ assert_equal(abbr[0], @format_o.format(abbr[0]))
1072
+ end
1073
+
1074
+ # Tests both body_indent and body_indent=
1075
+ def test_body_indent
1076
+ assert_nothing_raised { @format_o = Text::Format.new }
1077
+ assert_equal(0, @format_o.body_indent)
1078
+ assert_nothing_raised { @format_o.body_indent = 7 }
1079
+ assert_equal(7, @format_o.body_indent)
1080
+ assert_nothing_raised { @format_o.body_indent = -3 }
1081
+ assert_equal(3, @format_o.body_indent)
1082
+ assert_nothing_raised { @format_o.body_indent = "9" }
1083
+ assert_equal(9, @format_o.body_indent)
1084
+ assert_nothing_raised { @format_o.body_indent = "-2" }
1085
+ assert_equal(2, @format_o.body_indent)
1086
+ assert_match(/^ [^ ]/, @format_o.format(GETTYSBURG).split("\n")[1])
1087
+ end
1088
+
1089
+ # Tests both columns and columns=
1090
+ def test_columns
1091
+ assert_nothing_raised { @format_o = Text::Format.new }
1092
+ assert_equal(72, @format_o.columns)
1093
+ assert_nothing_raised { @format_o.columns = 7 }
1094
+ assert_equal(7, @format_o.columns)
1095
+ assert_nothing_raised { @format_o.columns = -3 }
1096
+ assert_equal(3, @format_o.columns)
1097
+ assert_nothing_raised { @format_o.columns = "9" }
1098
+ assert_equal(9, @format_o.columns)
1099
+ assert_nothing_raised { @format_o.columns = "-2" }
1100
+ assert_equal(2, @format_o.columns)
1101
+ assert_nothing_raised { @format_o.columns = 40 }
1102
+ assert_equal(40, @format_o.columns)
1103
+ assert_match(/this continent$/,
1104
+ @format_o.format(GETTYSBURG).split("\n")[1])
1105
+ end
1106
+
1107
+ # Tests both extra_space and extra_space=
1108
+ def test_extra_space
1109
+ assert_nothing_raised { @format_o = Text::Format.new }
1110
+ assert(!@format_o.extra_space)
1111
+ assert_nothing_raised { @format_o.extra_space = true }
1112
+ assert(@format_o.extra_space)
1113
+ # The behaviour of extra_space is tested in test_abbreviations. There
1114
+ # is no need to reproduce it here.
1115
+ end
1116
+
1117
+ # Tests both first_indent and first_indent=
1118
+ def test_first_indent
1119
+ assert_nothing_raised { @format_o = Text::Format.new }
1120
+ assert_equal(4, @format_o.first_indent)
1121
+ assert_nothing_raised { @format_o.first_indent = 7 }
1122
+ assert_equal(7, @format_o.first_indent)
1123
+ assert_nothing_raised { @format_o.first_indent = -3 }
1124
+ assert_equal(3, @format_o.first_indent)
1125
+ assert_nothing_raised { @format_o.first_indent = "9" }
1126
+ assert_equal(9, @format_o.first_indent)
1127
+ assert_nothing_raised { @format_o.first_indent = "-2" }
1128
+ assert_equal(2, @format_o.first_indent)
1129
+ assert_match(/^ [^ ]/, @format_o.format(GETTYSBURG).split("\n")[0])
1130
+ end
1131
+
1132
+ def test_format_style
1133
+ assert_nothing_raised { @format_o = Text::Format.new }
1134
+ assert_equal(Text::Format::LEFT_ALIGN, @format_o.format_style)
1135
+ assert_match(/^November 1863$/,
1136
+ @format_o.format(GETTYSBURG).split("\n")[-1])
1137
+ assert_nothing_raised {
1138
+ @format_o.format_style = Text::Format::RIGHT_ALIGN
1139
+ }
1140
+ assert_equal(Text::Format::RIGHT_ALIGN, @format_o.format_style)
1141
+ assert_match(/^ +November 1863$/,
1142
+ @format_o.format(GETTYSBURG).split("\n")[-1])
1143
+ assert_nothing_raised {
1144
+ @format_o.format_style = Text::Format::RIGHT_FILL
1145
+ }
1146
+ assert_equal(Text::Format::RIGHT_FILL, @format_o.format_style)
1147
+ assert_match(/^November 1863 +$/,
1148
+ @format_o.format(GETTYSBURG).split("\n")[-1])
1149
+ assert_nothing_raised { @format_o.format_style = Text::Format::JUSTIFY }
1150
+ assert_equal(Text::Format::JUSTIFY, @format_o.format_style)
1151
+ assert_match(/^of freedom, and that government of the people, by the people, for the$/,
1152
+ @format_o.format(GETTYSBURG).split("\n")[-3])
1153
+ assert_raise(ArgumentError) { @format_o.format_style = 33 }
1154
+ end
1155
+
1156
+ def test_tag_paragraph
1157
+ assert_nothing_raised { @format_o = Text::Format.new }
1158
+ assert(!@format_o.tag_paragraph)
1159
+ assert_nothing_raised { @format_o.tag_paragraph = true }
1160
+ assert(@format_o.tag_paragraph)
1161
+ assert_not_equal(@format_o.paragraphs([GETTYSBURG, GETTYSBURG]),
1162
+ Text::Format.new.paragraphs([GETTYSBURG, GETTYSBURG]))
1163
+ end
1164
+
1165
+ def test_tag_text
1166
+ assert_nothing_raised { @format_o = Text::Format.new }
1167
+ assert_equal([], @format_o.tag_text)
1168
+ assert_equal(@format_o.format(GETTYSBURG),
1169
+ Text::Format.new.format(GETTYSBURG))
1170
+ assert_nothing_raised {
1171
+ @format_o.tag_paragraph = true
1172
+ @format_o.tag_text = ["Gettysburg Address", "---"]
1173
+ }
1174
+ assert_not_equal(@format_o.format(GETTYSBURG),
1175
+ Text::Format.new.format(GETTYSBURG))
1176
+ assert_not_equal(@format_o.paragraphs([GETTYSBURG, GETTYSBURG]),
1177
+ Text::Format.new.paragraphs([GETTYSBURG, GETTYSBURG]))
1178
+ assert_not_equal(@format_o.paragraphs([GETTYSBURG, GETTYSBURG,
1179
+ GETTYSBURG]),
1180
+ Text::Format.new.paragraphs([GETTYSBURG, GETTYSBURG,
1181
+ GETTYSBURG]))
1182
+ end
1183
+
1184
+ def test_justify?
1185
+ assert_nothing_raised { @format_o = Text::Format.new }
1186
+ assert(!@format_o.justify?)
1187
+ assert_nothing_raised {
1188
+ @format_o.format_style = Text::Format::RIGHT_ALIGN
1189
+ }
1190
+ assert(!@format_o.justify?)
1191
+ assert_nothing_raised {
1192
+ @format_o.format_style = Text::Format::RIGHT_FILL
1193
+ }
1194
+ assert(!@format_o.justify?)
1195
+ assert_nothing_raised {
1196
+ @format_o.format_style = Text::Format::JUSTIFY
1197
+ }
1198
+ assert(@format_o.justify?)
1199
+ # The format testing is done in test_format_style
1200
+ end
1201
+
1202
+ def test_left_align?
1203
+ assert_nothing_raised { @format_o = Text::Format.new }
1204
+ assert(@format_o.left_align?)
1205
+ assert_nothing_raised {
1206
+ @format_o.format_style = Text::Format::RIGHT_ALIGN
1207
+ }
1208
+ assert(!@format_o.left_align?)
1209
+ assert_nothing_raised {
1210
+ @format_o.format_style = Text::Format::RIGHT_FILL
1211
+ }
1212
+ assert(!@format_o.left_align?)
1213
+ assert_nothing_raised { @format_o.format_style = Text::Format::JUSTIFY }
1214
+ assert(!@format_o.left_align?)
1215
+ # The format testing is done in test_format_style
1216
+ end
1217
+
1218
+ def test_left_margin
1219
+ assert_nothing_raised { @format_o = Text::Format.new }
1220
+ assert_equal(0, @format_o.left_margin)
1221
+ assert_nothing_raised { @format_o.left_margin = -3 }
1222
+ assert_equal(3, @format_o.left_margin)
1223
+ assert_nothing_raised { @format_o.left_margin = "9" }
1224
+ assert_equal(9, @format_o.left_margin)
1225
+ assert_nothing_raised { @format_o.left_margin = "-2" }
1226
+ assert_equal(2, @format_o.left_margin)
1227
+ assert_nothing_raised { @format_o.left_margin = 7 }
1228
+ assert_equal(7, @format_o.left_margin)
1229
+ assert_nothing_raised {
1230
+ ft = @format_o.format(GETTYSBURG).split("\n")
1231
+ assert_match(/^ {11}Four score/, ft[0])
1232
+ assert_match(/^ {7}November/, ft[-1])
1233
+ }
1234
+ end
1235
+
1236
+ def test_hard_margins
1237
+ assert_nothing_raised { @format_o = Text::Format.new }
1238
+ assert(!@format_o.hard_margins)
1239
+ assert_nothing_raised {
1240
+ @format_o.hard_margins = true
1241
+ @format_o.columns = 5
1242
+ @format_o.first_indent = 0
1243
+ @format_o.format_style = Text::Format::RIGHT_FILL
1244
+ }
1245
+ assert(@format_o.hard_margins)
1246
+ assert_equal(FIVE_COL, @format_o.format(GETTYSBURG))
1247
+ assert_nothing_raised {
1248
+ @format_o.split_rules |= Text::Format::SPLIT_CONTINUATION
1249
+ assert_equal(Text::Format::SPLIT_CONTINUATION_FIXED,
1250
+ @format_o.split_rules)
1251
+ }
1252
+ assert_equal(FIVE_CNT, @format_o.format(GETTYSBURG))
1253
+ end
1254
+
1255
+ # Tests both nobreak and nobreak_regex, since one is only useful
1256
+ # with the other.
1257
+ def test_nobreak
1258
+ assert_nothing_raised { @format_o = Text::Format.new }
1259
+ assert(!@format_o.nobreak)
1260
+ assert(@format_o.nobreak_regex.empty?)
1261
+ assert_nothing_raised {
1262
+ @format_o.nobreak = true
1263
+ @format_o.nobreak_regex = { '^this$' => '^continent$' }
1264
+ @format_o.columns = 77
1265
+ }
1266
+ assert(@format_o.nobreak)
1267
+ assert_equal({ '^this$' => '^continent$' }, @format_o.nobreak_regex)
1268
+ assert_match(/^this continent/,
1269
+ @format_o.format(GETTYSBURG).split("\n")[1])
1270
+ end
1271
+
1272
+ def test_right_align?
1273
+ assert_nothing_raised { @format_o = Text::Format.new }
1274
+ assert(!@format_o.right_align?)
1275
+ assert_nothing_raised {
1276
+ @format_o.format_style = Text::Format::RIGHT_ALIGN
1277
+ }
1278
+ assert(@format_o.right_align?)
1279
+ assert_nothing_raised {
1280
+ @format_o.format_style = Text::Format::RIGHT_FILL
1281
+ }
1282
+ assert(!@format_o.right_align?)
1283
+ assert_nothing_raised { @format_o.format_style = Text::Format::JUSTIFY }
1284
+ assert(!@format_o.right_align?)
1285
+ # The format testing is done in test_format_style
1286
+ end
1287
+
1288
+ def test_right_fill?
1289
+ assert_nothing_raised { @format_o = Text::Format.new }
1290
+ assert(!@format_o.right_fill?)
1291
+ assert_nothing_raised {
1292
+ @format_o.format_style = Text::Format::RIGHT_ALIGN
1293
+ }
1294
+ assert(!@format_o.right_fill?)
1295
+ assert_nothing_raised {
1296
+ @format_o.format_style = Text::Format::RIGHT_FILL
1297
+ }
1298
+ assert(@format_o.right_fill?)
1299
+ assert_nothing_raised {
1300
+ @format_o.format_style = Text::Format::JUSTIFY
1301
+ }
1302
+ assert(!@format_o.right_fill?)
1303
+ # The format testing is done in test_format_style
1304
+ end
1305
+
1306
+ def test_right_margin
1307
+ assert_nothing_raised { @format_o = Text::Format.new }
1308
+ assert_equal(0, @format_o.right_margin)
1309
+ assert_nothing_raised { @format_o.right_margin = -3 }
1310
+ assert_equal(3, @format_o.right_margin)
1311
+ assert_nothing_raised { @format_o.right_margin = "9" }
1312
+ assert_equal(9, @format_o.right_margin)
1313
+ assert_nothing_raised { @format_o.right_margin = "-2" }
1314
+ assert_equal(2, @format_o.right_margin)
1315
+ assert_nothing_raised { @format_o.right_margin = 7 }
1316
+ assert_equal(7, @format_o.right_margin)
1317
+ assert_nothing_raised {
1318
+ ft = @format_o.format(GETTYSBURG).split("\n")
1319
+ assert_match(/^ {4}Four score.*forth on$/, ft[0])
1320
+ assert_match(/^November/, ft[-1])
1321
+ }
1322
+ end
1323
+
1324
+ def test_tabstop
1325
+ assert_nothing_raised { @format_o = Text::Format.new }
1326
+ assert_equal(8, @format_o.tabstop)
1327
+ assert_nothing_raised { @format_o.tabstop = 7 }
1328
+ assert_equal(7, @format_o.tabstop)
1329
+ assert_nothing_raised { @format_o.tabstop = -3 }
1330
+ assert_equal(3, @format_o.tabstop)
1331
+ assert_nothing_raised { @format_o.tabstop = "9" }
1332
+ assert_equal(9, @format_o.tabstop)
1333
+ assert_nothing_raised { @format_o.tabstop = "-2" }
1334
+ assert_equal(2, @format_o.tabstop)
1335
+ end
1336
+
1337
+ def test_text
1338
+ assert_nothing_raised { @format_o = Text::Format.new }
1339
+ assert_equal([], @format_o.text)
1340
+ assert_nothing_raised { @format_o.text = "Test Text" }
1341
+ assert_equal("Test Text", @format_o.text)
1342
+ assert_nothing_raised { @format_o.text = ["Line 1", "Line 2"] }
1343
+ assert_equal(["Line 1", "Line 2"], @format_o.text)
1344
+ end
1345
+
1346
+ def test_s_new
1347
+ # new(NilClass) { block }
1348
+ assert_nothing_raised do
1349
+ @format_o = Text::Format.new {
1350
+ self.text = "Test 1, 2, 3"
1351
+ }
1352
+ end
1353
+ assert_equal("Test 1, 2, 3", @format_o.text)
1354
+
1355
+ # new(Hash Symbols)
1356
+ assert_nothing_raised { @format_o = Text::Format.new(:columns => 72) }
1357
+ assert_equal(72, @format_o.columns)
1358
+
1359
+ # new(Hash String)
1360
+ assert_nothing_raised { @format_o = Text::Format.new('columns' => 72) }
1361
+ assert_equal(72, @format_o.columns)
1362
+
1363
+ # new(Hash) { block }
1364
+ assert_nothing_raised do
1365
+ @format_o = Text::Format.new('columns' => 80) {
1366
+ self.text = "Test 4, 5, 6"
1367
+ }
1368
+ end
1369
+ assert_equal("Test 4, 5, 6", @format_o.text)
1370
+ assert_equal(80, @format_o.columns)
1371
+
1372
+ # new(Text::Format)
1373
+ assert_nothing_raised do
1374
+ fo = Text::Format.new(@format_o)
1375
+ assert(fo == @format_o)
1376
+ end
1377
+
1378
+ # new(Text::Format) { block }
1379
+ assert_nothing_raised do
1380
+ fo = Text::Format.new(@format_o) { self.columns = 79 }
1381
+ assert(fo != @format_o)
1382
+ end
1383
+
1384
+ # new(String)
1385
+ assert_nothing_raised { @format_o = Text::Format.new("Test A, B, C") }
1386
+ assert_equal("Test A, B, C", @format_o.text)
1387
+
1388
+ # new(String) { block }
1389
+ assert_nothing_raised do
1390
+ @format_o = Text::Format.new("Test X, Y, Z") { self.columns = -5 }
1391
+ end
1392
+ assert_equal("Test X, Y, Z", @format_o.text)
1393
+ assert_equal(5, @format_o.columns)
1394
+ end
1395
+
1396
+ def test_center
1397
+ assert_nothing_raised { @format_o = Text::Format.new }
1398
+ assert_nothing_raised do
1399
+ ct = @format_o.center(GETTYSBURG.split("\n")).split("\n")
1400
+ assert_match(/^ Four score and seven years ago our fathers brought forth on this/, ct[0])
1401
+ assert_match(/^ not perish from the earth./, ct[-3])
1402
+ end
1403
+ end
1404
+
1405
+ def test_expand
1406
+ assert_nothing_raised { @format_o = Text::Format.new }
1407
+ assert_equal(" ", @format_o.expand("\t "))
1408
+ assert_nothing_raised { @format_o.tabstop = 4 }
1409
+ assert_equal(" ", @format_o.expand("\t "))
1410
+ end
1411
+
1412
+ def test_unexpand
1413
+ assert_nothing_raised { @format_o = Text::Format.new }
1414
+ assert_equal("\t ", @format_o.unexpand(" "))
1415
+ assert_nothing_raised { @format_o.tabstop = 4 }
1416
+ assert_equal("\t ", @format_o.unexpand(" "))
1417
+ end
1418
+
1419
+ def test_space_only
1420
+ assert_equal("", Text::Format.new.format(" "))
1421
+ assert_equal("", Text::Format.new.format("\n"))
1422
+ assert_equal("", Text::Format.new.format(" "))
1423
+ assert_equal("", Text::Format.new.format(" \n"))
1424
+ assert_equal("", Text::Format.new.paragraphs("\n"))
1425
+ assert_equal("", Text::Format.new.paragraphs(" "))
1426
+ assert_equal("", Text::Format.new.paragraphs(" "))
1427
+ assert_equal("", Text::Format.new.paragraphs(" \n"))
1428
+ assert_equal("", Text::Format.new.paragraphs(["\n"]))
1429
+ assert_equal("", Text::Format.new.paragraphs([" "]))
1430
+ assert_equal("", Text::Format.new.paragraphs([" "]))
1431
+ assert_equal("", Text::Format.new.paragraphs([" \n"]))
1432
+ end
1433
+
1434
+ def test_splendiferous
1435
+ h = nil
1436
+ test = "This is a splendiferous test"
1437
+ assert_nothing_raised { @format_o = Text::Format.new(:columns => 6, :left_margin => 0, :indent => 0, :first_indent => 0) }
1438
+ assert_match(/^splendiferous$/, @format_o.format(test))
1439
+ assert_nothing_raised { @format_o.hard_margins = true }
1440
+ assert_match(/^lendif$/, @format_o.format(test))
1441
+ assert_nothing_raised { h = Object.new }
1442
+ assert_nothing_raised do
1443
+ @format_o.split_rules = Text::Format::SPLIT_HYPHENATION
1444
+ class << h #:nodoc:
1445
+ def hyphenate_to(word, size)
1446
+ return ["", word] if size < 2
1447
+ [word[0 ... size], word[size .. -1]]
1448
+ end
1449
+ end
1450
+ @format_o.hyphenator = h
1451
+ end
1452
+ assert_match(/^iferou$/, @format_o.format(test))
1453
+ assert_nothing_raised { h = Object.new }
1454
+ assert_nothing_raised do
1455
+ class << h #:nodoc:
1456
+ def hyphenate_to(word, size, formatter)
1457
+ return ["", word] if word.size < formatter.columns
1458
+ [word[0 ... size], word[size .. -1]]
1459
+ end
1460
+ end
1461
+ @format_o.hyphenator = h
1462
+ end
1463
+ assert_match(/^ferous$/, @format_o.format(test))
1464
+ end
1465
+ end
1466
+ end