##// END OF EJS Templates
Makes textile formatter accept 2 letters acronym (#6591)....
Jean-Philippe Lang -
r4260:f79a6f701a6b
parent child
Show More
@@ -1,1193 +1,1193
1 1 # vim:ts=4:sw=4:
2 2 # = RedCloth - Textile and Markdown Hybrid for Ruby
3 3 #
4 4 # Homepage:: http://whytheluckystiff.net/ruby/redcloth/
5 5 # Author:: why the lucky stiff (http://whytheluckystiff.net/)
6 6 # Copyright:: (cc) 2004 why the lucky stiff (and his puppet organizations.)
7 7 # License:: BSD
8 8 #
9 9 # (see http://hobix.com/textile/ for a Textile Reference.)
10 10 #
11 11 # Based on (and also inspired by) both:
12 12 #
13 13 # PyTextile: http://diveintomark.org/projects/textile/textile.py.txt
14 14 # Textism for PHP: http://www.textism.com/tools/textile/
15 15 #
16 16 #
17 17
18 18 # = RedCloth
19 19 #
20 20 # RedCloth is a Ruby library for converting Textile and/or Markdown
21 21 # into HTML. You can use either format, intermingled or separately.
22 22 # You can also extend RedCloth to honor your own custom text stylings.
23 23 #
24 24 # RedCloth users are encouraged to use Textile if they are generating
25 25 # HTML and to use Markdown if others will be viewing the plain text.
26 26 #
27 27 # == What is Textile?
28 28 #
29 29 # Textile is a simple formatting style for text
30 30 # documents, loosely based on some HTML conventions.
31 31 #
32 32 # == Sample Textile Text
33 33 #
34 34 # h2. This is a title
35 35 #
36 36 # h3. This is a subhead
37 37 #
38 38 # This is a bit of paragraph.
39 39 #
40 40 # bq. This is a blockquote.
41 41 #
42 42 # = Writing Textile
43 43 #
44 44 # A Textile document consists of paragraphs. Paragraphs
45 45 # can be specially formatted by adding a small instruction
46 46 # to the beginning of the paragraph.
47 47 #
48 48 # h[n]. Header of size [n].
49 49 # bq. Blockquote.
50 50 # # Numeric list.
51 51 # * Bulleted list.
52 52 #
53 53 # == Quick Phrase Modifiers
54 54 #
55 55 # Quick phrase modifiers are also included, to allow formatting
56 56 # of small portions of text within a paragraph.
57 57 #
58 58 # \_emphasis\_
59 59 # \_\_italicized\_\_
60 60 # \*strong\*
61 61 # \*\*bold\*\*
62 62 # ??citation??
63 63 # -deleted text-
64 64 # +inserted text+
65 65 # ^superscript^
66 66 # ~subscript~
67 67 # @code@
68 68 # %(classname)span%
69 69 #
70 70 # ==notextile== (leave text alone)
71 71 #
72 72 # == Links
73 73 #
74 74 # To make a hypertext link, put the link text in "quotation
75 75 # marks" followed immediately by a colon and the URL of the link.
76 76 #
77 77 # Optional: text in (parentheses) following the link text,
78 78 # but before the closing quotation mark, will become a Title
79 79 # attribute for the link, visible as a tool tip when a cursor is above it.
80 80 #
81 81 # Example:
82 82 #
83 83 # "This is a link (This is a title) ":http://www.textism.com
84 84 #
85 85 # Will become:
86 86 #
87 87 # <a href="http://www.textism.com" title="This is a title">This is a link</a>
88 88 #
89 89 # == Images
90 90 #
91 91 # To insert an image, put the URL for the image inside exclamation marks.
92 92 #
93 93 # Optional: text that immediately follows the URL in (parentheses) will
94 94 # be used as the Alt text for the image. Images on the web should always
95 95 # have descriptive Alt text for the benefit of readers using non-graphical
96 96 # browsers.
97 97 #
98 98 # Optional: place a colon followed by a URL immediately after the
99 99 # closing ! to make the image into a link.
100 100 #
101 101 # Example:
102 102 #
103 103 # !http://www.textism.com/common/textist.gif(Textist)!
104 104 #
105 105 # Will become:
106 106 #
107 107 # <img src="http://www.textism.com/common/textist.gif" alt="Textist" />
108 108 #
109 109 # With a link:
110 110 #
111 111 # !/common/textist.gif(Textist)!:http://textism.com
112 112 #
113 113 # Will become:
114 114 #
115 115 # <a href="http://textism.com"><img src="/common/textist.gif" alt="Textist" /></a>
116 116 #
117 117 # == Defining Acronyms
118 118 #
119 119 # HTML allows authors to define acronyms via the tag. The definition appears as a
120 120 # tool tip when a cursor hovers over the acronym. A crucial aid to clear writing,
121 121 # this should be used at least once for each acronym in documents where they appear.
122 122 #
123 123 # To quickly define an acronym in Textile, place the full text in (parentheses)
124 124 # immediately following the acronym.
125 125 #
126 126 # Example:
127 127 #
128 128 # ACLU(American Civil Liberties Union)
129 129 #
130 130 # Will become:
131 131 #
132 132 # <acronym title="American Civil Liberties Union">ACLU</acronym>
133 133 #
134 134 # == Adding Tables
135 135 #
136 136 # In Textile, simple tables can be added by seperating each column by
137 137 # a pipe.
138 138 #
139 139 # |a|simple|table|row|
140 140 # |And|Another|table|row|
141 141 #
142 142 # Attributes are defined by style definitions in parentheses.
143 143 #
144 144 # table(border:1px solid black).
145 145 # (background:#ddd;color:red). |{}| | | |
146 146 #
147 147 # == Using RedCloth
148 148 #
149 149 # RedCloth is simply an extension of the String class, which can handle
150 150 # Textile formatting. Use it like a String and output HTML with its
151 151 # RedCloth#to_html method.
152 152 #
153 153 # doc = RedCloth.new "
154 154 #
155 155 # h2. Test document
156 156 #
157 157 # Just a simple test."
158 158 #
159 159 # puts doc.to_html
160 160 #
161 161 # By default, RedCloth uses both Textile and Markdown formatting, with
162 162 # Textile formatting taking precedence. If you want to turn off Markdown
163 163 # formatting, to boost speed and limit the processor:
164 164 #
165 165 # class RedCloth::Textile.new( str )
166 166
167 167 class RedCloth3 < String
168 168
169 169 VERSION = '3.0.4'
170 170 DEFAULT_RULES = [:textile, :markdown]
171 171
172 172 #
173 173 # Two accessor for setting security restrictions.
174 174 #
175 175 # This is a nice thing if you're using RedCloth for
176 176 # formatting in public places (e.g. Wikis) where you
177 177 # don't want users to abuse HTML for bad things.
178 178 #
179 179 # If +:filter_html+ is set, HTML which wasn't
180 180 # created by the Textile processor will be escaped.
181 181 #
182 182 # If +:filter_styles+ is set, it will also disable
183 183 # the style markup specifier. ('{color: red}')
184 184 #
185 185 attr_accessor :filter_html, :filter_styles
186 186
187 187 #
188 188 # Accessor for toggling hard breaks.
189 189 #
190 190 # If +:hard_breaks+ is set, single newlines will
191 191 # be converted to HTML break tags. This is the
192 192 # default behavior for traditional RedCloth.
193 193 #
194 194 attr_accessor :hard_breaks
195 195
196 196 # Accessor for toggling lite mode.
197 197 #
198 198 # In lite mode, block-level rules are ignored. This means
199 199 # that tables, paragraphs, lists, and such aren't available.
200 200 # Only the inline markup for bold, italics, entities and so on.
201 201 #
202 202 # r = RedCloth.new( "And then? She *fell*!", [:lite_mode] )
203 203 # r.to_html
204 204 # #=> "And then? She <strong>fell</strong>!"
205 205 #
206 206 attr_accessor :lite_mode
207 207
208 208 #
209 209 # Accessor for toggling span caps.
210 210 #
211 211 # Textile places `span' tags around capitalized
212 212 # words by default, but this wreaks havoc on Wikis.
213 213 # If +:no_span_caps+ is set, this will be
214 214 # suppressed.
215 215 #
216 216 attr_accessor :no_span_caps
217 217
218 218 #
219 219 # Establishes the markup predence. Available rules include:
220 220 #
221 221 # == Textile Rules
222 222 #
223 223 # The following textile rules can be set individually. Or add the complete
224 224 # set of rules with the single :textile rule, which supplies the rule set in
225 225 # the following precedence:
226 226 #
227 227 # refs_textile:: Textile references (i.e. [hobix]http://hobix.com/)
228 228 # block_textile_table:: Textile table block structures
229 229 # block_textile_lists:: Textile list structures
230 230 # block_textile_prefix:: Textile blocks with prefixes (i.e. bq., h2., etc.)
231 231 # inline_textile_image:: Textile inline images
232 232 # inline_textile_link:: Textile inline links
233 233 # inline_textile_span:: Textile inline spans
234 234 # glyphs_textile:: Textile entities (such as em-dashes and smart quotes)
235 235 #
236 236 # == Markdown
237 237 #
238 238 # refs_markdown:: Markdown references (for example: [hobix]: http://hobix.com/)
239 239 # block_markdown_setext:: Markdown setext headers
240 240 # block_markdown_atx:: Markdown atx headers
241 241 # block_markdown_rule:: Markdown horizontal rules
242 242 # block_markdown_bq:: Markdown blockquotes
243 243 # block_markdown_lists:: Markdown lists
244 244 # inline_markdown_link:: Markdown links
245 245 attr_accessor :rules
246 246
247 247 # Returns a new RedCloth object, based on _string_ and
248 248 # enforcing all the included _restrictions_.
249 249 #
250 250 # r = RedCloth.new( "h1. A <b>bold</b> man", [:filter_html] )
251 251 # r.to_html
252 252 # #=>"<h1>A &lt;b&gt;bold&lt;/b&gt; man</h1>"
253 253 #
254 254 def initialize( string, restrictions = [] )
255 255 restrictions.each { |r| method( "#{ r }=" ).call( true ) }
256 256 super( string )
257 257 end
258 258
259 259 #
260 260 # Generates HTML from the Textile contents.
261 261 #
262 262 # r = RedCloth.new( "And then? She *fell*!" )
263 263 # r.to_html( true )
264 264 # #=>"And then? She <strong>fell</strong>!"
265 265 #
266 266 def to_html( *rules )
267 267 rules = DEFAULT_RULES if rules.empty?
268 268 # make our working copy
269 269 text = self.dup
270 270
271 271 @urlrefs = {}
272 272 @shelf = []
273 273 textile_rules = [:block_textile_table, :block_textile_lists,
274 274 :block_textile_prefix, :inline_textile_image, :inline_textile_link,
275 275 :inline_textile_code, :inline_textile_span, :glyphs_textile]
276 276 markdown_rules = [:refs_markdown, :block_markdown_setext, :block_markdown_atx, :block_markdown_rule,
277 277 :block_markdown_bq, :block_markdown_lists,
278 278 :inline_markdown_reflink, :inline_markdown_link]
279 279 @rules = rules.collect do |rule|
280 280 case rule
281 281 when :markdown
282 282 markdown_rules
283 283 when :textile
284 284 textile_rules
285 285 else
286 286 rule
287 287 end
288 288 end.flatten
289 289
290 290 # standard clean up
291 291 incoming_entities text
292 292 clean_white_space text
293 293
294 294 # start processor
295 295 @pre_list = []
296 296 rip_offtags text
297 297 no_textile text
298 298 escape_html_tags text
299 299 hard_break text
300 300 unless @lite_mode
301 301 refs text
302 302 # need to do this before text is split by #blocks
303 303 block_textile_quotes text
304 304 blocks text
305 305 end
306 306 inline text
307 307 smooth_offtags text
308 308
309 309 retrieve text
310 310
311 311 text.gsub!( /<\/?notextile>/, '' )
312 312 text.gsub!( /x%x%/, '&#38;' )
313 313 clean_html text if filter_html
314 314 text.strip!
315 315 text
316 316
317 317 end
318 318
319 319 #######
320 320 private
321 321 #######
322 322 #
323 323 # Mapping of 8-bit ASCII codes to HTML numerical entity equivalents.
324 324 # (from PyTextile)
325 325 #
326 326 TEXTILE_TAGS =
327 327
328 328 [[128, 8364], [129, 0], [130, 8218], [131, 402], [132, 8222], [133, 8230],
329 329 [134, 8224], [135, 8225], [136, 710], [137, 8240], [138, 352], [139, 8249],
330 330 [140, 338], [141, 0], [142, 0], [143, 0], [144, 0], [145, 8216], [146, 8217],
331 331 [147, 8220], [148, 8221], [149, 8226], [150, 8211], [151, 8212], [152, 732],
332 332 [153, 8482], [154, 353], [155, 8250], [156, 339], [157, 0], [158, 0], [159, 376]].
333 333
334 334 collect! do |a, b|
335 335 [a.chr, ( b.zero? and "" or "&#{ b };" )]
336 336 end
337 337
338 338 #
339 339 # Regular expressions to convert to HTML.
340 340 #
341 341 A_HLGN = /(?:(?:<>|<|>|\=|[()]+)+)/
342 342 A_VLGN = /[\-^~]/
343 343 C_CLAS = '(?:\([^)]+\))'
344 344 C_LNGE = '(?:\[[^\[\]]+\])'
345 345 C_STYL = '(?:\{[^}]+\})'
346 346 S_CSPN = '(?:\\\\\d+)'
347 347 S_RSPN = '(?:/\d+)'
348 348 A = "(?:#{A_HLGN}?#{A_VLGN}?|#{A_VLGN}?#{A_HLGN}?)"
349 349 S = "(?:#{S_CSPN}?#{S_RSPN}|#{S_RSPN}?#{S_CSPN}?)"
350 350 C = "(?:#{C_CLAS}?#{C_STYL}?#{C_LNGE}?|#{C_STYL}?#{C_LNGE}?#{C_CLAS}?|#{C_LNGE}?#{C_STYL}?#{C_CLAS}?)"
351 351 # PUNCT = Regexp::quote( '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~' )
352 352 PUNCT = Regexp::quote( '!"#$%&\'*+,-./:;=?@\\^_`|~' )
353 353 PUNCT_NOQ = Regexp::quote( '!"#$&\',./:;=?@\\`|' )
354 354 PUNCT_Q = Regexp::quote( '*-_+^~%' )
355 355 HYPERLINK = '(\S+?)([^\w\s/;=\?]*?)(?=\s|<|$)'
356 356
357 357 # Text markup tags, don't conflict with block tags
358 358 SIMPLE_HTML_TAGS = [
359 359 'tt', 'b', 'i', 'big', 'small', 'em', 'strong', 'dfn', 'code',
360 360 'samp', 'kbd', 'var', 'cite', 'abbr', 'acronym', 'a', 'img', 'br',
361 361 'br', 'map', 'q', 'sub', 'sup', 'span', 'bdo'
362 362 ]
363 363
364 364 QTAGS = [
365 365 ['**', 'b', :limit],
366 366 ['*', 'strong', :limit],
367 367 ['??', 'cite', :limit],
368 368 ['-', 'del', :limit],
369 369 ['__', 'i', :limit],
370 370 ['_', 'em', :limit],
371 371 ['%', 'span', :limit],
372 372 ['+', 'ins', :limit],
373 373 ['^', 'sup', :limit],
374 374 ['~', 'sub', :limit]
375 375 ]
376 376 QTAGS_JOIN = QTAGS.map {|rc, ht, rtype| Regexp::quote rc}.join('|')
377 377
378 378 QTAGS.collect! do |rc, ht, rtype|
379 379 rcq = Regexp::quote rc
380 380 re =
381 381 case rtype
382 382 when :limit
383 383 /(^|[>\s\(]) # sta
384 384 (?!\-\-)
385 385 (#{QTAGS_JOIN}|) # oqs
386 386 (#{rcq}) # qtag
387 387 (\w|[^\s].*?[^\s]) # content
388 388 (?!\-\-)
389 389 #{rcq}
390 390 (#{QTAGS_JOIN}|) # oqa
391 391 (?=[[:punct:]]|<|\s|\)|$)/x
392 392 else
393 393 /(#{rcq})
394 394 (#{C})
395 395 (?::(\S+))?
396 396 (\w|[^\s\-].*?[^\s\-])
397 397 #{rcq}/xm
398 398 end
399 399 [rc, ht, re, rtype]
400 400 end
401 401
402 402 # Elements to handle
403 403 GLYPHS = [
404 404 # [ /([^\s\[{(>])?\'([dmst]\b|ll\b|ve\b|\s|:|$)/, '\1&#8217;\2' ], # single closing
405 405 # [ /([^\s\[{(>#{PUNCT_Q}][#{PUNCT_Q}]*)\'/, '\1&#8217;' ], # single closing
406 406 # [ /\'(?=[#{PUNCT_Q}]*(s\b|[\s#{PUNCT_NOQ}]))/, '&#8217;' ], # single closing
407 407 # [ /\'/, '&#8216;' ], # single opening
408 408 # [ /</, '&lt;' ], # less-than
409 409 # [ />/, '&gt;' ], # greater-than
410 410 # [ /([^\s\[{(])?"(\s|:|$)/, '\1&#8221;\2' ], # double closing
411 411 # [ /([^\s\[{(>#{PUNCT_Q}][#{PUNCT_Q}]*)"/, '\1&#8221;' ], # double closing
412 412 # [ /"(?=[#{PUNCT_Q}]*[\s#{PUNCT_NOQ}])/, '&#8221;' ], # double closing
413 413 # [ /"/, '&#8220;' ], # double opening
414 414 # [ /\b( )?\.{3}/, '\1&#8230;' ], # ellipsis
415 415 # [ /\b([A-Z][A-Z0-9]{2,})\b(?:[(]([^)]*)[)])/, '<acronym title="\2">\1</acronym>' ], # 3+ uppercase acronym
416 416 # [ /(^|[^"][>\s])([A-Z][A-Z0-9 ]+[A-Z0-9])([^<A-Za-z0-9]|$)/, '\1<span class="caps">\2</span>\3', :no_span_caps ], # 3+ uppercase caps
417 417 # [ /(\.\s)?\s?--\s?/, '\1&#8212;' ], # em dash
418 418 # [ /\s->\s/, ' &rarr; ' ], # right arrow
419 419 # [ /\s-\s/, ' &#8211; ' ], # en dash
420 420 # [ /(\d+) ?x ?(\d+)/, '\1&#215;\2' ], # dimension sign
421 421 # [ /\b ?[(\[]TM[\])]/i, '&#8482;' ], # trademark
422 422 # [ /\b ?[(\[]R[\])]/i, '&#174;' ], # registered
423 423 # [ /\b ?[(\[]C[\])]/i, '&#169;' ] # copyright
424 424 ]
425 425
426 426 H_ALGN_VALS = {
427 427 '<' => 'left',
428 428 '=' => 'center',
429 429 '>' => 'right',
430 430 '<>' => 'justify'
431 431 }
432 432
433 433 V_ALGN_VALS = {
434 434 '^' => 'top',
435 435 '-' => 'middle',
436 436 '~' => 'bottom'
437 437 }
438 438
439 439 #
440 440 # Flexible HTML escaping
441 441 #
442 442 def htmlesc( str, mode=:Quotes )
443 443 if str
444 444 str.gsub!( '&', '&amp;' )
445 445 str.gsub!( '"', '&quot;' ) if mode != :NoQuotes
446 446 str.gsub!( "'", '&#039;' ) if mode == :Quotes
447 447 str.gsub!( '<', '&lt;')
448 448 str.gsub!( '>', '&gt;')
449 449 end
450 450 str
451 451 end
452 452
453 453 # Search and replace for Textile glyphs (quotes, dashes, other symbols)
454 454 def pgl( text )
455 455 #GLYPHS.each do |re, resub, tog|
456 456 # next if tog and method( tog ).call
457 457 # text.gsub! re, resub
458 458 #end
459 text.gsub!(/\b([A-Z][A-Z0-9]{2,})\b(?:[(]([^)]*)[)])/) do |m|
459 text.gsub!(/\b([A-Z][A-Z0-9]{1,})\b(?:[(]([^)]*)[)])/) do |m|
460 460 "<acronym title=\"#{htmlesc $2}\">#{$1}</acronym>"
461 461 end
462 462 end
463 463
464 464 # Parses Textile attribute lists and builds an HTML attribute string
465 465 def pba( text_in, element = "" )
466 466
467 467 return '' unless text_in
468 468
469 469 style = []
470 470 text = text_in.dup
471 471 if element == 'td'
472 472 colspan = $1 if text =~ /\\(\d+)/
473 473 rowspan = $1 if text =~ /\/(\d+)/
474 474 style << "vertical-align:#{ v_align( $& ) };" if text =~ A_VLGN
475 475 end
476 476
477 477 style << "#{ htmlesc $1 };" if text.sub!( /\{([^}]*)\}/, '' ) && !filter_styles
478 478
479 479 lang = $1 if
480 480 text.sub!( /\[([^)]+?)\]/, '' )
481 481
482 482 cls = $1 if
483 483 text.sub!( /\(([^()]+?)\)/, '' )
484 484
485 485 style << "padding-left:#{ $1.length }em;" if
486 486 text.sub!( /([(]+)/, '' )
487 487
488 488 style << "padding-right:#{ $1.length }em;" if text.sub!( /([)]+)/, '' )
489 489
490 490 style << "text-align:#{ h_align( $& ) };" if text =~ A_HLGN
491 491
492 492 cls, id = $1, $2 if cls =~ /^(.*?)#(.*)$/
493 493
494 494 atts = ''
495 495 atts << " style=\"#{ style.join }\"" unless style.empty?
496 496 atts << " class=\"#{ cls }\"" unless cls.to_s.empty?
497 497 atts << " lang=\"#{ lang }\"" if lang
498 498 atts << " id=\"#{ id }\"" if id
499 499 atts << " colspan=\"#{ colspan }\"" if colspan
500 500 atts << " rowspan=\"#{ rowspan }\"" if rowspan
501 501
502 502 atts
503 503 end
504 504
505 505 TABLE_RE = /^(?:table(_?#{S}#{A}#{C})\. ?\n)?^(#{A}#{C}\.? ?\|.*?\|)(\n\n|\Z)/m
506 506
507 507 # Parses a Textile table block, building HTML from the result.
508 508 def block_textile_table( text )
509 509 text.gsub!( TABLE_RE ) do |matches|
510 510
511 511 tatts, fullrow = $~[1..2]
512 512 tatts = pba( tatts, 'table' )
513 513 tatts = shelve( tatts ) if tatts
514 514 rows = []
515 515
516 516 fullrow.each_line do |row|
517 517 ratts, row = pba( $1, 'tr' ), $2 if row =~ /^(#{A}#{C}\. )(.*)/m
518 518 cells = []
519 519 row.split( /(\|)(?![^\[\|]*\]\])/ )[1..-2].each do |cell|
520 520 next if cell == '|'
521 521 ctyp = 'd'
522 522 ctyp = 'h' if cell =~ /^_/
523 523
524 524 catts = ''
525 525 catts, cell = pba( $1, 'td' ), $2 if cell =~ /^(_?#{S}#{A}#{C}\. ?)(.*)/
526 526
527 527 catts = shelve( catts ) if catts
528 528 cells << "\t\t\t<t#{ ctyp }#{ catts }>#{ cell }</t#{ ctyp }>"
529 529 end
530 530 ratts = shelve( ratts ) if ratts
531 531 rows << "\t\t<tr#{ ratts }>\n#{ cells.join( "\n" ) }\n\t\t</tr>"
532 532 end
533 533 "\t<table#{ tatts }>\n#{ rows.join( "\n" ) }\n\t</table>\n\n"
534 534 end
535 535 end
536 536
537 537 LISTS_RE = /^([#*]+?#{C} .*?)$(?![^#*])/m
538 538 LISTS_CONTENT_RE = /^([#*]+)(#{A}#{C}) (.*)$/m
539 539
540 540 # Parses Textile lists and generates HTML
541 541 def block_textile_lists( text )
542 542 text.gsub!( LISTS_RE ) do |match|
543 543 lines = match.split( /\n/ )
544 544 last_line = -1
545 545 depth = []
546 546 lines.each_with_index do |line, line_id|
547 547 if line =~ LISTS_CONTENT_RE
548 548 tl,atts,content = $~[1..3]
549 549 if depth.last
550 550 if depth.last.length > tl.length
551 551 (depth.length - 1).downto(0) do |i|
552 552 break if depth[i].length == tl.length
553 553 lines[line_id - 1] << "</li>\n\t</#{ lT( depth[i] ) }l>\n\t"
554 554 depth.pop
555 555 end
556 556 end
557 557 if depth.last and depth.last.length == tl.length
558 558 lines[line_id - 1] << '</li>'
559 559 end
560 560 end
561 561 unless depth.last == tl
562 562 depth << tl
563 563 atts = pba( atts )
564 564 atts = shelve( atts ) if atts
565 565 lines[line_id] = "\t<#{ lT(tl) }l#{ atts }>\n\t<li>#{ content }"
566 566 else
567 567 lines[line_id] = "\t\t<li>#{ content }"
568 568 end
569 569 last_line = line_id
570 570
571 571 else
572 572 last_line = line_id
573 573 end
574 574 if line_id - last_line > 1 or line_id == lines.length - 1
575 575 depth.delete_if do |v|
576 576 lines[last_line] << "</li>\n\t</#{ lT( v ) }l>"
577 577 end
578 578 end
579 579 end
580 580 lines.join( "\n" )
581 581 end
582 582 end
583 583
584 584 QUOTES_RE = /(^>+([^\n]*?)(\n|$))+/m
585 585 QUOTES_CONTENT_RE = /^([> ]+)(.*)$/m
586 586
587 587 def block_textile_quotes( text )
588 588 text.gsub!( QUOTES_RE ) do |match|
589 589 lines = match.split( /\n/ )
590 590 quotes = ''
591 591 indent = 0
592 592 lines.each do |line|
593 593 line =~ QUOTES_CONTENT_RE
594 594 bq,content = $1, $2
595 595 l = bq.count('>')
596 596 if l != indent
597 597 quotes << ("\n\n" + (l>indent ? '<blockquote>' * (l-indent) : '</blockquote>' * (indent-l)) + "\n\n")
598 598 indent = l
599 599 end
600 600 quotes << (content + "\n")
601 601 end
602 602 quotes << ("\n" + '</blockquote>' * indent + "\n\n")
603 603 quotes
604 604 end
605 605 end
606 606
607 607 CODE_RE = /(\W)
608 608 @
609 609 (?:\|(\w+?)\|)?
610 610 (.+?)
611 611 @
612 612 (?=\W)/x
613 613
614 614 def inline_textile_code( text )
615 615 text.gsub!( CODE_RE ) do |m|
616 616 before,lang,code,after = $~[1..4]
617 617 lang = " lang=\"#{ lang }\"" if lang
618 618 rip_offtags( "#{ before }<code#{ lang }>#{ code }</code>#{ after }", false )
619 619 end
620 620 end
621 621
622 622 def lT( text )
623 623 text =~ /\#$/ ? 'o' : 'u'
624 624 end
625 625
626 626 def hard_break( text )
627 627 text.gsub!( /(.)\n(?!\Z| *([#*=]+(\s|$)|[{|]))/, "\\1<br />" ) if hard_breaks
628 628 end
629 629
630 630 BLOCKS_GROUP_RE = /\n{2,}(?! )/m
631 631
632 632 def blocks( text, deep_code = false )
633 633 text.replace( text.split( BLOCKS_GROUP_RE ).collect do |blk|
634 634 plain = blk !~ /\A[#*> ]/
635 635
636 636 # skip blocks that are complex HTML
637 637 if blk =~ /^<\/?(\w+).*>/ and not SIMPLE_HTML_TAGS.include? $1
638 638 blk
639 639 else
640 640 # search for indentation levels
641 641 blk.strip!
642 642 if blk.empty?
643 643 blk
644 644 else
645 645 code_blk = nil
646 646 blk.gsub!( /((?:\n(?:\n^ +[^\n]*)+)+)/m ) do |iblk|
647 647 flush_left iblk
648 648 blocks iblk, plain
649 649 iblk.gsub( /^(\S)/, "\t\\1" )
650 650 if plain
651 651 code_blk = iblk; ""
652 652 else
653 653 iblk
654 654 end
655 655 end
656 656
657 657 block_applied = 0
658 658 @rules.each do |rule_name|
659 659 block_applied += 1 if ( rule_name.to_s.match /^block_/ and method( rule_name ).call( blk ) )
660 660 end
661 661 if block_applied.zero?
662 662 if deep_code
663 663 blk = "\t<pre><code>#{ blk }</code></pre>"
664 664 else
665 665 blk = "\t<p>#{ blk }</p>"
666 666 end
667 667 end
668 668 # hard_break blk
669 669 blk + "\n#{ code_blk }"
670 670 end
671 671 end
672 672
673 673 end.join( "\n\n" ) )
674 674 end
675 675
676 676 def textile_bq( tag, atts, cite, content )
677 677 cite, cite_title = check_refs( cite )
678 678 cite = " cite=\"#{ cite }\"" if cite
679 679 atts = shelve( atts ) if atts
680 680 "\t<blockquote#{ cite }>\n\t\t<p#{ atts }>#{ content }</p>\n\t</blockquote>"
681 681 end
682 682
683 683 def textile_p( tag, atts, cite, content )
684 684 atts = shelve( atts ) if atts
685 685 "\t<#{ tag }#{ atts }>#{ content }</#{ tag }>"
686 686 end
687 687
688 688 alias textile_h1 textile_p
689 689 alias textile_h2 textile_p
690 690 alias textile_h3 textile_p
691 691 alias textile_h4 textile_p
692 692 alias textile_h5 textile_p
693 693 alias textile_h6 textile_p
694 694
695 695 def textile_fn_( tag, num, atts, cite, content )
696 696 atts << " id=\"fn#{ num }\" class=\"footnote\""
697 697 content = "<sup>#{ num }</sup> #{ content }"
698 698 atts = shelve( atts ) if atts
699 699 "\t<p#{ atts }>#{ content }</p>"
700 700 end
701 701
702 702 BLOCK_RE = /^(([a-z]+)(\d*))(#{A}#{C})\.(?::(\S+))? (.*)$/m
703 703
704 704 def block_textile_prefix( text )
705 705 if text =~ BLOCK_RE
706 706 tag,tagpre,num,atts,cite,content = $~[1..6]
707 707 atts = pba( atts )
708 708
709 709 # pass to prefix handler
710 710 if respond_to? "textile_#{ tag }", true
711 711 text.gsub!( $&, method( "textile_#{ tag }" ).call( tag, atts, cite, content ) )
712 712 elsif respond_to? "textile_#{ tagpre }_", true
713 713 text.gsub!( $&, method( "textile_#{ tagpre }_" ).call( tagpre, num, atts, cite, content ) )
714 714 end
715 715 end
716 716 end
717 717
718 718 SETEXT_RE = /\A(.+?)\n([=-])[=-]* *$/m
719 719 def block_markdown_setext( text )
720 720 if text =~ SETEXT_RE
721 721 tag = if $2 == "="; "h1"; else; "h2"; end
722 722 blk, cont = "<#{ tag }>#{ $1 }</#{ tag }>", $'
723 723 blocks cont
724 724 text.replace( blk + cont )
725 725 end
726 726 end
727 727
728 728 ATX_RE = /\A(\#{1,6}) # $1 = string of #'s
729 729 [ ]*
730 730 (.+?) # $2 = Header text
731 731 [ ]*
732 732 \#* # optional closing #'s (not counted)
733 733 $/x
734 734 def block_markdown_atx( text )
735 735 if text =~ ATX_RE
736 736 tag = "h#{ $1.length }"
737 737 blk, cont = "<#{ tag }>#{ $2 }</#{ tag }>\n\n", $'
738 738 blocks cont
739 739 text.replace( blk + cont )
740 740 end
741 741 end
742 742
743 743 MARKDOWN_BQ_RE = /\A(^ *> ?.+$(.+\n)*\n*)+/m
744 744
745 745 def block_markdown_bq( text )
746 746 text.gsub!( MARKDOWN_BQ_RE ) do |blk|
747 747 blk.gsub!( /^ *> ?/, '' )
748 748 flush_left blk
749 749 blocks blk
750 750 blk.gsub!( /^(\S)/, "\t\\1" )
751 751 "<blockquote>\n#{ blk }\n</blockquote>\n\n"
752 752 end
753 753 end
754 754
755 755 MARKDOWN_RULE_RE = /^(#{
756 756 ['*', '-', '_'].collect { |ch| ' ?(' + Regexp::quote( ch ) + ' ?){3,}' }.join( '|' )
757 757 })$/
758 758
759 759 def block_markdown_rule( text )
760 760 text.gsub!( MARKDOWN_RULE_RE ) do |blk|
761 761 "<hr />"
762 762 end
763 763 end
764 764
765 765 # XXX TODO XXX
766 766 def block_markdown_lists( text )
767 767 end
768 768
769 769 def inline_textile_span( text )
770 770 QTAGS.each do |qtag_rc, ht, qtag_re, rtype|
771 771 text.gsub!( qtag_re ) do |m|
772 772
773 773 case rtype
774 774 when :limit
775 775 sta,oqs,qtag,content,oqa = $~[1..6]
776 776 atts = nil
777 777 if content =~ /^(#{C})(.+)$/
778 778 atts, content = $~[1..2]
779 779 end
780 780 else
781 781 qtag,atts,cite,content = $~[1..4]
782 782 sta = ''
783 783 end
784 784 atts = pba( atts )
785 785 atts = shelve( atts ) if atts
786 786
787 787 "#{ sta }#{ oqs }<#{ ht }#{ atts }>#{ content }</#{ ht }>#{ oqa }"
788 788
789 789 end
790 790 end
791 791 end
792 792
793 793 LINK_RE = /
794 794 (
795 795 ([\s\[{(]|[#{PUNCT}])? # $pre
796 796 " # start
797 797 (#{C}) # $atts
798 798 ([^"\n]+?) # $text
799 799 \s?
800 800 (?:\(([^)]+?)\)(?="))? # $title
801 801 ":
802 802 ( # $url
803 803 (\/|[a-zA-Z]+:\/\/|www\.|mailto:) # $proto
804 804 [\w\/]\S+?
805 805 )
806 806 (\/)? # $slash
807 807 ([^\w\=\/;\(\)]*?) # $post
808 808 )
809 809 (?=<|\s|$)
810 810 /x
811 811 #"
812 812 def inline_textile_link( text )
813 813 text.gsub!( LINK_RE ) do |m|
814 814 all,pre,atts,text,title,url,proto,slash,post = $~[1..9]
815 815 if text.include?('<br />')
816 816 all
817 817 else
818 818 url, url_title = check_refs( url )
819 819 title ||= url_title
820 820
821 821 # Idea below : an URL with unbalanced parethesis and
822 822 # ending by ')' is put into external parenthesis
823 823 if ( url[-1]==?) and ((url.count("(") - url.count(")")) < 0 ) )
824 824 url=url[0..-2] # discard closing parenth from url
825 825 post = ")"+post # add closing parenth to post
826 826 end
827 827 atts = pba( atts )
828 828 atts = " href=\"#{ htmlesc url }#{ slash }\"#{ atts }"
829 829 atts << " title=\"#{ htmlesc title }\"" if title
830 830 atts = shelve( atts ) if atts
831 831
832 832 external = (url =~ /^https?:\/\//) ? ' class="external"' : ''
833 833
834 834 "#{ pre }<a#{ atts }#{ external }>#{ text }</a>#{ post }"
835 835 end
836 836 end
837 837 end
838 838
839 839 MARKDOWN_REFLINK_RE = /
840 840 \[([^\[\]]+)\] # $text
841 841 [ ]? # opt. space
842 842 (?:\n[ ]*)? # one optional newline followed by spaces
843 843 \[(.*?)\] # $id
844 844 /x
845 845
846 846 def inline_markdown_reflink( text )
847 847 text.gsub!( MARKDOWN_REFLINK_RE ) do |m|
848 848 text, id = $~[1..2]
849 849
850 850 if id.empty?
851 851 url, title = check_refs( text )
852 852 else
853 853 url, title = check_refs( id )
854 854 end
855 855
856 856 atts = " href=\"#{ url }\""
857 857 atts << " title=\"#{ title }\"" if title
858 858 atts = shelve( atts )
859 859
860 860 "<a#{ atts }>#{ text }</a>"
861 861 end
862 862 end
863 863
864 864 MARKDOWN_LINK_RE = /
865 865 \[([^\[\]]+)\] # $text
866 866 \( # open paren
867 867 [ \t]* # opt space
868 868 <?(.+?)>? # $href
869 869 [ \t]* # opt space
870 870 (?: # whole title
871 871 (['"]) # $quote
872 872 (.*?) # $title
873 873 \3 # matching quote
874 874 )? # title is optional
875 875 \)
876 876 /x
877 877
878 878 def inline_markdown_link( text )
879 879 text.gsub!( MARKDOWN_LINK_RE ) do |m|
880 880 text, url, quote, title = $~[1..4]
881 881
882 882 atts = " href=\"#{ url }\""
883 883 atts << " title=\"#{ title }\"" if title
884 884 atts = shelve( atts )
885 885
886 886 "<a#{ atts }>#{ text }</a>"
887 887 end
888 888 end
889 889
890 890 TEXTILE_REFS_RE = /(^ *)\[([^\[\n]+?)\](#{HYPERLINK})(?=\s|$)/
891 891 MARKDOWN_REFS_RE = /(^ *)\[([^\n]+?)\]:\s+<?(#{HYPERLINK})>?(?:\s+"((?:[^"]|\\")+)")?(?=\s|$)/m
892 892
893 893 def refs( text )
894 894 @rules.each do |rule_name|
895 895 method( rule_name ).call( text ) if rule_name.to_s.match /^refs_/
896 896 end
897 897 end
898 898
899 899 def refs_textile( text )
900 900 text.gsub!( TEXTILE_REFS_RE ) do |m|
901 901 flag, url = $~[2..3]
902 902 @urlrefs[flag.downcase] = [url, nil]
903 903 nil
904 904 end
905 905 end
906 906
907 907 def refs_markdown( text )
908 908 text.gsub!( MARKDOWN_REFS_RE ) do |m|
909 909 flag, url = $~[2..3]
910 910 title = $~[6]
911 911 @urlrefs[flag.downcase] = [url, title]
912 912 nil
913 913 end
914 914 end
915 915
916 916 def check_refs( text )
917 917 ret = @urlrefs[text.downcase] if text
918 918 ret || [text, nil]
919 919 end
920 920
921 921 IMAGE_RE = /
922 922 (>|\s|^) # start of line?
923 923 \! # opening
924 924 (\<|\=|\>)? # optional alignment atts
925 925 (#{C}) # optional style,class atts
926 926 (?:\. )? # optional dot-space
927 927 ([^\s(!]+?) # presume this is the src
928 928 \s? # optional space
929 929 (?:\(((?:[^\(\)]|\([^\)]+\))+?)\))? # optional title
930 930 \! # closing
931 931 (?::#{ HYPERLINK })? # optional href
932 932 /x
933 933
934 934 def inline_textile_image( text )
935 935 text.gsub!( IMAGE_RE ) do |m|
936 936 stln,algn,atts,url,title,href,href_a1,href_a2 = $~[1..8]
937 937 htmlesc title
938 938 atts = pba( atts )
939 939 atts = " src=\"#{ url }\"#{ atts }"
940 940 atts << " title=\"#{ title }\"" if title
941 941 atts << " alt=\"#{ title }\""
942 942 # size = @getimagesize($url);
943 943 # if($size) $atts.= " $size[3]";
944 944
945 945 href, alt_title = check_refs( href ) if href
946 946 url, url_title = check_refs( url )
947 947
948 948 out = ''
949 949 out << "<a#{ shelve( " href=\"#{ href }\"" ) }>" if href
950 950 out << "<img#{ shelve( atts ) } />"
951 951 out << "</a>#{ href_a1 }#{ href_a2 }" if href
952 952
953 953 if algn
954 954 algn = h_align( algn )
955 955 if stln == "<p>"
956 956 out = "<p style=\"float:#{ algn }\">#{ out }"
957 957 else
958 958 out = "#{ stln }<div style=\"float:#{ algn }\">#{ out }</div>"
959 959 end
960 960 else
961 961 out = stln + out
962 962 end
963 963
964 964 out
965 965 end
966 966 end
967 967
968 968 def shelve( val )
969 969 @shelf << val
970 970 " :redsh##{ @shelf.length }:"
971 971 end
972 972
973 973 def retrieve( text )
974 974 @shelf.each_with_index do |r, i|
975 975 text.gsub!( " :redsh##{ i + 1 }:", r )
976 976 end
977 977 end
978 978
979 979 def incoming_entities( text )
980 980 ## turn any incoming ampersands into a dummy character for now.
981 981 ## This uses a negative lookahead for alphanumerics followed by a semicolon,
982 982 ## implying an incoming html entity, to be skipped
983 983
984 984 text.gsub!( /&(?![#a-z0-9]+;)/i, "x%x%" )
985 985 end
986 986
987 987 def no_textile( text )
988 988 text.gsub!( /(^|\s)==([^=]+.*?)==(\s|$)?/,
989 989 '\1<notextile>\2</notextile>\3' )
990 990 text.gsub!( /^ *==([^=]+.*?)==/m,
991 991 '\1<notextile>\2</notextile>\3' )
992 992 end
993 993
994 994 def clean_white_space( text )
995 995 # normalize line breaks
996 996 text.gsub!( /\r\n/, "\n" )
997 997 text.gsub!( /\r/, "\n" )
998 998 text.gsub!( /\t/, ' ' )
999 999 text.gsub!( /^ +$/, '' )
1000 1000 text.gsub!( /\n{3,}/, "\n\n" )
1001 1001 text.gsub!( /"$/, "\" " )
1002 1002
1003 1003 # if entire document is indented, flush
1004 1004 # to the left side
1005 1005 flush_left text
1006 1006 end
1007 1007
1008 1008 def flush_left( text )
1009 1009 indt = 0
1010 1010 if text =~ /^ /
1011 1011 while text !~ /^ {#{indt}}\S/
1012 1012 indt += 1
1013 1013 end unless text.empty?
1014 1014 if indt.nonzero?
1015 1015 text.gsub!( /^ {#{indt}}/, '' )
1016 1016 end
1017 1017 end
1018 1018 end
1019 1019
1020 1020 def footnote_ref( text )
1021 1021 text.gsub!( /\b\[([0-9]+?)\](\s)?/,
1022 1022 '<sup><a href="#fn\1">\1</a></sup>\2' )
1023 1023 end
1024 1024
1025 1025 OFFTAGS = /(code|pre|kbd|notextile)/
1026 1026 OFFTAG_MATCH = /(?:(<\/#{ OFFTAGS }>)|(<#{ OFFTAGS }[^>]*>))(.*?)(?=<\/?#{ OFFTAGS }\W|\Z)/mi
1027 1027 OFFTAG_OPEN = /<#{ OFFTAGS }/
1028 1028 OFFTAG_CLOSE = /<\/?#{ OFFTAGS }/
1029 1029 HASTAG_MATCH = /(<\/?\w[^\n]*?>)/m
1030 1030 ALLTAG_MATCH = /(<\/?\w[^\n]*?>)|.*?(?=<\/?\w[^\n]*?>|$)/m
1031 1031
1032 1032 def glyphs_textile( text, level = 0 )
1033 1033 if text !~ HASTAG_MATCH
1034 1034 pgl text
1035 1035 footnote_ref text
1036 1036 else
1037 1037 codepre = 0
1038 1038 text.gsub!( ALLTAG_MATCH ) do |line|
1039 1039 ## matches are off if we're between <code>, <pre> etc.
1040 1040 if $1
1041 1041 if line =~ OFFTAG_OPEN
1042 1042 codepre += 1
1043 1043 elsif line =~ OFFTAG_CLOSE
1044 1044 codepre -= 1
1045 1045 codepre = 0 if codepre < 0
1046 1046 end
1047 1047 elsif codepre.zero?
1048 1048 glyphs_textile( line, level + 1 )
1049 1049 else
1050 1050 htmlesc( line, :NoQuotes )
1051 1051 end
1052 1052 # p [level, codepre, line]
1053 1053
1054 1054 line
1055 1055 end
1056 1056 end
1057 1057 end
1058 1058
1059 1059 def rip_offtags( text, escape_aftertag=true )
1060 1060 if text =~ /<.*>/
1061 1061 ## strip and encode <pre> content
1062 1062 codepre, used_offtags = 0, {}
1063 1063 text.gsub!( OFFTAG_MATCH ) do |line|
1064 1064 if $3
1065 1065 first, offtag, aftertag = $3, $4, $5
1066 1066 codepre += 1
1067 1067 used_offtags[offtag] = true
1068 1068 if codepre - used_offtags.length > 0
1069 1069 htmlesc( line, :NoQuotes )
1070 1070 @pre_list.last << line
1071 1071 line = ""
1072 1072 else
1073 1073 ### htmlesc is disabled between CODE tags which will be parsed with highlighter
1074 1074 ### Regexp in formatter.rb is : /<code\s+class="(\w+)">\s?(.+)/m
1075 1075 ### NB: some changes were made not to use $N variables, because we use "match"
1076 1076 ### and it breaks following lines
1077 1077 htmlesc( aftertag, :NoQuotes ) if aftertag && escape_aftertag && !first.match(/<code\s+class="(\w+)">/)
1078 1078 line = "<redpre##{ @pre_list.length }>"
1079 1079 first.match(/<#{ OFFTAGS }([^>]*)>/)
1080 1080 tag = $1
1081 1081 $2.to_s.match(/(class\=\S+)/i)
1082 1082 tag << " #{$1}" if $1
1083 1083 @pre_list << "<#{ tag }>#{ aftertag }"
1084 1084 end
1085 1085 elsif $1 and codepre > 0
1086 1086 if codepre - used_offtags.length > 0
1087 1087 htmlesc( line, :NoQuotes )
1088 1088 @pre_list.last << line
1089 1089 line = ""
1090 1090 end
1091 1091 codepre -= 1 unless codepre.zero?
1092 1092 used_offtags = {} if codepre.zero?
1093 1093 end
1094 1094 line
1095 1095 end
1096 1096 end
1097 1097 text
1098 1098 end
1099 1099
1100 1100 def smooth_offtags( text )
1101 1101 unless @pre_list.empty?
1102 1102 ## replace <pre> content
1103 1103 text.gsub!( /<redpre#(\d+)>/ ) { @pre_list[$1.to_i] }
1104 1104 end
1105 1105 end
1106 1106
1107 1107 def inline( text )
1108 1108 [/^inline_/, /^glyphs_/].each do |meth_re|
1109 1109 @rules.each do |rule_name|
1110 1110 method( rule_name ).call( text ) if rule_name.to_s.match( meth_re )
1111 1111 end
1112 1112 end
1113 1113 end
1114 1114
1115 1115 def h_align( text )
1116 1116 H_ALGN_VALS[text]
1117 1117 end
1118 1118
1119 1119 def v_align( text )
1120 1120 V_ALGN_VALS[text]
1121 1121 end
1122 1122
1123 1123 def textile_popup_help( name, windowW, windowH )
1124 1124 ' <a target="_blank" href="http://hobix.com/textile/#' + helpvar + '" onclick="window.open(this.href, \'popupwindow\', \'width=' + windowW + ',height=' + windowH + ',scrollbars,resizable\'); return false;">' + name + '</a><br />'
1125 1125 end
1126 1126
1127 1127 # HTML cleansing stuff
1128 1128 BASIC_TAGS = {
1129 1129 'a' => ['href', 'title'],
1130 1130 'img' => ['src', 'alt', 'title'],
1131 1131 'br' => [],
1132 1132 'i' => nil,
1133 1133 'u' => nil,
1134 1134 'b' => nil,
1135 1135 'pre' => nil,
1136 1136 'kbd' => nil,
1137 1137 'code' => ['lang'],
1138 1138 'cite' => nil,
1139 1139 'strong' => nil,
1140 1140 'em' => nil,
1141 1141 'ins' => nil,
1142 1142 'sup' => nil,
1143 1143 'sub' => nil,
1144 1144 'del' => nil,
1145 1145 'table' => nil,
1146 1146 'tr' => nil,
1147 1147 'td' => ['colspan', 'rowspan'],
1148 1148 'th' => nil,
1149 1149 'ol' => nil,
1150 1150 'ul' => nil,
1151 1151 'li' => nil,
1152 1152 'p' => nil,
1153 1153 'h1' => nil,
1154 1154 'h2' => nil,
1155 1155 'h3' => nil,
1156 1156 'h4' => nil,
1157 1157 'h5' => nil,
1158 1158 'h6' => nil,
1159 1159 'blockquote' => ['cite']
1160 1160 }
1161 1161
1162 1162 def clean_html( text, tags = BASIC_TAGS )
1163 1163 text.gsub!( /<!\[CDATA\[/, '' )
1164 1164 text.gsub!( /<(\/*)(\w+)([^>]*)>/ ) do
1165 1165 raw = $~
1166 1166 tag = raw[2].downcase
1167 1167 if tags.has_key? tag
1168 1168 pcs = [tag]
1169 1169 tags[tag].each do |prop|
1170 1170 ['"', "'", ''].each do |q|
1171 1171 q2 = ( q != '' ? q : '\s' )
1172 1172 if raw[3] =~ /#{prop}\s*=\s*#{q}([^#{q2}]+)#{q}/i
1173 1173 attrv = $1
1174 1174 next if prop == 'src' and attrv =~ %r{^(?!http)\w+:}
1175 1175 pcs << "#{prop}=\"#{$1.gsub('"', '\\"')}\""
1176 1176 break
1177 1177 end
1178 1178 end
1179 1179 end if tags[tag]
1180 1180 "<#{raw[1]}#{pcs.join " "}>"
1181 1181 else
1182 1182 " "
1183 1183 end
1184 1184 end
1185 1185 end
1186 1186
1187 1187 ALLOWED_TAGS = %w(redpre pre code notextile)
1188 1188
1189 1189 def escape_html_tags(text)
1190 1190 text.gsub!(%r{<(\/?([!\w]+)[^<>\n]*)(>?)}) {|m| ALLOWED_TAGS.include?($2) ? "<#{$1}#{$3}" : "&lt;#{$1}#{'&gt;' unless $3.blank?}" }
1191 1191 end
1192 1192 end
1193 1193
@@ -1,631 +1,617
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2009 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require File.dirname(__FILE__) + '/../../test_helper'
19 19
20 20 class ApplicationHelperTest < ActionView::TestCase
21 21
22 22 fixtures :projects, :roles, :enabled_modules, :users,
23 23 :repositories, :changesets,
24 24 :trackers, :issue_statuses, :issues, :versions, :documents,
25 25 :wikis, :wiki_pages, :wiki_contents,
26 26 :boards, :messages,
27 27 :attachments,
28 28 :enumerations
29 29
30 30 def setup
31 31 super
32 32 end
33 33
34 34 context "#link_to_if_authorized" do
35 35 context "authorized user" do
36 36 should "be tested"
37 37 end
38 38
39 39 context "unauthorized user" do
40 40 should "be tested"
41 41 end
42 42
43 43 should "allow using the :controller and :action for the target link" do
44 44 User.current = User.find_by_login('admin')
45 45
46 46 @project = Issue.first.project # Used by helper
47 47 response = link_to_if_authorized("By controller/action",
48 48 {:controller => 'issues', :action => 'edit', :id => Issue.first.id})
49 49 assert_match /href/, response
50 50 end
51 51
52 52 end
53 53
54 54 def test_auto_links
55 55 to_test = {
56 56 'http://foo.bar' => '<a class="external" href="http://foo.bar">http://foo.bar</a>',
57 57 'http://foo.bar/~user' => '<a class="external" href="http://foo.bar/~user">http://foo.bar/~user</a>',
58 58 'http://foo.bar.' => '<a class="external" href="http://foo.bar">http://foo.bar</a>.',
59 59 'https://foo.bar.' => '<a class="external" href="https://foo.bar">https://foo.bar</a>.',
60 60 'This is a link: http://foo.bar.' => 'This is a link: <a class="external" href="http://foo.bar">http://foo.bar</a>.',
61 61 'A link (eg. http://foo.bar).' => 'A link (eg. <a class="external" href="http://foo.bar">http://foo.bar</a>).',
62 62 'http://foo.bar/foo.bar#foo.bar.' => '<a class="external" href="http://foo.bar/foo.bar#foo.bar">http://foo.bar/foo.bar#foo.bar</a>.',
63 63 'http://www.foo.bar/Test_(foobar)' => '<a class="external" href="http://www.foo.bar/Test_(foobar)">http://www.foo.bar/Test_(foobar)</a>',
64 64 '(see inline link : http://www.foo.bar/Test_(foobar))' => '(see inline link : <a class="external" href="http://www.foo.bar/Test_(foobar)">http://www.foo.bar/Test_(foobar)</a>)',
65 65 '(see inline link : http://www.foo.bar/Test)' => '(see inline link : <a class="external" href="http://www.foo.bar/Test">http://www.foo.bar/Test</a>)',
66 66 '(see inline link : http://www.foo.bar/Test).' => '(see inline link : <a class="external" href="http://www.foo.bar/Test">http://www.foo.bar/Test</a>).',
67 67 '(see "inline link":http://www.foo.bar/Test_(foobar))' => '(see <a href="http://www.foo.bar/Test_(foobar)" class="external">inline link</a>)',
68 68 '(see "inline link":http://www.foo.bar/Test)' => '(see <a href="http://www.foo.bar/Test" class="external">inline link</a>)',
69 69 '(see "inline link":http://www.foo.bar/Test).' => '(see <a href="http://www.foo.bar/Test" class="external">inline link</a>).',
70 70 'www.foo.bar' => '<a class="external" href="http://www.foo.bar">www.foo.bar</a>',
71 71 'http://foo.bar/page?p=1&t=z&s=' => '<a class="external" href="http://foo.bar/page?p=1&#38;t=z&#38;s=">http://foo.bar/page?p=1&#38;t=z&#38;s=</a>',
72 72 'http://foo.bar/page#125' => '<a class="external" href="http://foo.bar/page#125">http://foo.bar/page#125</a>',
73 73 'http://foo@www.bar.com' => '<a class="external" href="http://foo@www.bar.com">http://foo@www.bar.com</a>',
74 74 'http://foo:bar@www.bar.com' => '<a class="external" href="http://foo:bar@www.bar.com">http://foo:bar@www.bar.com</a>',
75 75 'ftp://foo.bar' => '<a class="external" href="ftp://foo.bar">ftp://foo.bar</a>',
76 76 'ftps://foo.bar' => '<a class="external" href="ftps://foo.bar">ftps://foo.bar</a>',
77 77 'sftp://foo.bar' => '<a class="external" href="sftp://foo.bar">sftp://foo.bar</a>',
78 78 # two exclamation marks
79 79 'http://example.net/path!602815048C7B5C20!302.html' => '<a class="external" href="http://example.net/path!602815048C7B5C20!302.html">http://example.net/path!602815048C7B5C20!302.html</a>',
80 80 # escaping
81 81 'http://foo"bar' => '<a class="external" href="http://foo&quot;bar">http://foo"bar</a>',
82 82 # wrap in angle brackets
83 83 '<http://foo.bar>' => '&lt;<a class="external" href="http://foo.bar">http://foo.bar</a>&gt;'
84 84 }
85 85 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
86 86 end
87 87
88 88 def test_auto_mailto
89 89 assert_equal '<p><a class="email" href="mailto:test@foo.bar">test@foo.bar</a></p>',
90 90 textilizable('test@foo.bar')
91 91 end
92 92
93 93 def test_inline_images
94 94 to_test = {
95 95 '!http://foo.bar/image.jpg!' => '<img src="http://foo.bar/image.jpg" alt="" />',
96 96 'floating !>http://foo.bar/image.jpg!' => 'floating <div style="float:right"><img src="http://foo.bar/image.jpg" alt="" /></div>',
97 97 'with class !(some-class)http://foo.bar/image.jpg!' => 'with class <img src="http://foo.bar/image.jpg" class="some-class" alt="" />',
98 98 # inline styles should be stripped
99 99 'with style !{width:100px;height100px}http://foo.bar/image.jpg!' => 'with style <img src="http://foo.bar/image.jpg" alt="" />',
100 100 'with title !http://foo.bar/image.jpg(This is a title)!' => 'with title <img src="http://foo.bar/image.jpg" title="This is a title" alt="This is a title" />',
101 101 'with title !http://foo.bar/image.jpg(This is a double-quoted "title")!' => 'with title <img src="http://foo.bar/image.jpg" title="This is a double-quoted &quot;title&quot;" alt="This is a double-quoted &quot;title&quot;" />',
102 102 }
103 103 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
104 104 end
105 105
106 106 def test_inline_images_inside_tags
107 107 raw = <<-RAW
108 108 h1. !foo.png! Heading
109 109
110 110 Centered image:
111 111
112 112 p=. !bar.gif!
113 113 RAW
114 114
115 115 assert textilizable(raw).include?('<img src="foo.png" alt="" />')
116 116 assert textilizable(raw).include?('<img src="bar.gif" alt="" />')
117 117 end
118 118
119 def test_acronyms
120 to_test = {
121 'this is an acronym: GPL(General Public License)' => 'this is an acronym: <acronym title="General Public License">GPL</acronym>',
122 'GPL(This is a double-quoted "title")' => '<acronym title="This is a double-quoted &quot;title&quot;">GPL</acronym>',
123 }
124 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
125
126 end
127
128 119 def test_attached_images
129 120 to_test = {
130 121 'Inline image: !logo.gif!' => 'Inline image: <img src="/attachments/download/3" title="This is a logo" alt="This is a logo" />',
131 122 'Inline image: !logo.GIF!' => 'Inline image: <img src="/attachments/download/3" title="This is a logo" alt="This is a logo" />',
132 123 'No match: !ogo.gif!' => 'No match: <img src="ogo.gif" alt="" />',
133 124 'No match: !ogo.GIF!' => 'No match: <img src="ogo.GIF" alt="" />',
134 125 # link image
135 126 '!logo.gif!:http://foo.bar/' => '<a href="http://foo.bar/"><img src="/attachments/download/3" title="This is a logo" alt="This is a logo" /></a>',
136 127 }
137 128 attachments = Attachment.find(:all)
138 129 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text, :attachments => attachments) }
139 130 end
140 131
141 132 def test_textile_external_links
142 133 to_test = {
143 134 'This is a "link":http://foo.bar' => 'This is a <a href="http://foo.bar" class="external">link</a>',
144 135 'This is an intern "link":/foo/bar' => 'This is an intern <a href="/foo/bar">link</a>',
145 136 '"link (Link title)":http://foo.bar' => '<a href="http://foo.bar" title="Link title" class="external">link</a>',
146 137 '"link (Link title with "double-quotes")":http://foo.bar' => '<a href="http://foo.bar" title="Link title with &quot;double-quotes&quot;" class="external">link</a>',
147 138 "This is not a \"Link\":\n\nAnother paragraph" => "This is not a \"Link\":</p>\n\n\n\t<p>Another paragraph",
148 139 # no multiline link text
149 140 "This is a double quote \"on the first line\nand another on a second line\":test" => "This is a double quote \"on the first line<br />and another on a second line\":test",
150 141 # mailto link
151 142 "\"system administrator\":mailto:sysadmin@example.com?subject=redmine%20permissions" => "<a href=\"mailto:sysadmin@example.com?subject=redmine%20permissions\">system administrator</a>",
152 143 # two exclamation marks
153 144 '"a link":http://example.net/path!602815048C7B5C20!302.html' => '<a href="http://example.net/path!602815048C7B5C20!302.html" class="external">a link</a>',
154 145 # escaping
155 146 '"test":http://foo"bar' => '<a href="http://foo&quot;bar" class="external">test</a>',
156 147 }
157 148 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
158 149 end
159 150
160 151 def test_redmine_links
161 152 issue_link = link_to('#3', {:controller => 'issues', :action => 'show', :id => 3},
162 153 :class => 'issue status-1 priority-1 overdue', :title => 'Error 281 when updating a recipe (New)')
163 154
164 155 changeset_link = link_to('r1', {:controller => 'repositories', :action => 'revision', :id => 'ecookbook', :rev => 1},
165 156 :class => 'changeset', :title => 'My very first commit')
166 157 changeset_link2 = link_to('r2', {:controller => 'repositories', :action => 'revision', :id => 'ecookbook', :rev => 2},
167 158 :class => 'changeset', :title => 'This commit fixes #1, #2 and references #1 & #3')
168 159
169 160 document_link = link_to('Test document', {:controller => 'documents', :action => 'show', :id => 1},
170 161 :class => 'document')
171 162
172 163 version_link = link_to('1.0', {:controller => 'versions', :action => 'show', :id => 2},
173 164 :class => 'version')
174 165
175 166 message_url = {:controller => 'messages', :action => 'show', :board_id => 1, :id => 4}
176 167
177 168 project_url = {:controller => 'projects', :action => 'show', :id => 'subproject1'}
178 169
179 170 source_url = {:controller => 'repositories', :action => 'entry', :id => 'ecookbook', :path => ['some', 'file']}
180 171 source_url_with_ext = {:controller => 'repositories', :action => 'entry', :id => 'ecookbook', :path => ['some', 'file.ext']}
181 172
182 173 to_test = {
183 174 # tickets
184 175 '#3, [#3], (#3) and #3.' => "#{issue_link}, [#{issue_link}], (#{issue_link}) and #{issue_link}.",
185 176 # changesets
186 177 'r1' => changeset_link,
187 178 'r1.' => "#{changeset_link}.",
188 179 'r1, r2' => "#{changeset_link}, #{changeset_link2}",
189 180 'r1,r2' => "#{changeset_link},#{changeset_link2}",
190 181 # documents
191 182 'document#1' => document_link,
192 183 'document:"Test document"' => document_link,
193 184 # versions
194 185 'version#2' => version_link,
195 186 'version:1.0' => version_link,
196 187 'version:"1.0"' => version_link,
197 188 # source
198 189 'source:/some/file' => link_to('source:/some/file', source_url, :class => 'source'),
199 190 'source:/some/file.' => link_to('source:/some/file', source_url, :class => 'source') + ".",
200 191 'source:/some/file.ext.' => link_to('source:/some/file.ext', source_url_with_ext, :class => 'source') + ".",
201 192 'source:/some/file. ' => link_to('source:/some/file', source_url, :class => 'source') + ".",
202 193 'source:/some/file.ext. ' => link_to('source:/some/file.ext', source_url_with_ext, :class => 'source') + ".",
203 194 'source:/some/file, ' => link_to('source:/some/file', source_url, :class => 'source') + ",",
204 195 'source:/some/file@52' => link_to('source:/some/file@52', source_url.merge(:rev => 52), :class => 'source'),
205 196 'source:/some/file.ext@52' => link_to('source:/some/file.ext@52', source_url_with_ext.merge(:rev => 52), :class => 'source'),
206 197 'source:/some/file#L110' => link_to('source:/some/file#L110', source_url.merge(:anchor => 'L110'), :class => 'source'),
207 198 'source:/some/file.ext#L110' => link_to('source:/some/file.ext#L110', source_url_with_ext.merge(:anchor => 'L110'), :class => 'source'),
208 199 'source:/some/file@52#L110' => link_to('source:/some/file@52#L110', source_url.merge(:rev => 52, :anchor => 'L110'), :class => 'source'),
209 200 'export:/some/file' => link_to('export:/some/file', source_url.merge(:format => 'raw'), :class => 'source download'),
210 201 # message
211 202 'message#4' => link_to('Post 2', message_url, :class => 'message'),
212 203 'message#5' => link_to('RE: post 2', message_url.merge(:anchor => 'message-5'), :class => 'message'),
213 204 # project
214 205 'project#3' => link_to('eCookbook Subproject 1', project_url, :class => 'project'),
215 206 'project:subproject1' => link_to('eCookbook Subproject 1', project_url, :class => 'project'),
216 207 'project:"eCookbook subProject 1"' => link_to('eCookbook Subproject 1', project_url, :class => 'project'),
217 208 # escaping
218 209 '!#3.' => '#3.',
219 210 '!r1' => 'r1',
220 211 '!document#1' => 'document#1',
221 212 '!document:"Test document"' => 'document:"Test document"',
222 213 '!version#2' => 'version#2',
223 214 '!version:1.0' => 'version:1.0',
224 215 '!version:"1.0"' => 'version:"1.0"',
225 216 '!source:/some/file' => 'source:/some/file',
226 217 # not found
227 218 '#0123456789' => '#0123456789',
228 219 # invalid expressions
229 220 'source:' => 'source:',
230 221 # url hash
231 222 "http://foo.bar/FAQ#3" => '<a class="external" href="http://foo.bar/FAQ#3">http://foo.bar/FAQ#3</a>',
232 223 }
233 224 @project = Project.find(1)
234 225 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text), "#{text} failed" }
235 226 end
236 227
237 228 def test_attachment_links
238 229 attachment_link = link_to('error281.txt', {:controller => 'attachments', :action => 'download', :id => '1'}, :class => 'attachment')
239 230 to_test = {
240 231 'attachment:error281.txt' => attachment_link
241 232 }
242 233 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text, :attachments => Issue.find(3).attachments), "#{text} failed" }
243 234 end
244 235
245 236 def test_wiki_links
246 237 to_test = {
247 238 '[[CookBook documentation]]' => '<a href="/projects/ecookbook/wiki/CookBook_documentation" class="wiki-page">CookBook documentation</a>',
248 239 '[[Another page|Page]]' => '<a href="/projects/ecookbook/wiki/Another_page" class="wiki-page">Page</a>',
249 240 # link with anchor
250 241 '[[CookBook documentation#One-section]]' => '<a href="/projects/ecookbook/wiki/CookBook_documentation#One-section" class="wiki-page">CookBook documentation</a>',
251 242 '[[Another page#anchor|Page]]' => '<a href="/projects/ecookbook/wiki/Another_page#anchor" class="wiki-page">Page</a>',
252 243 # page that doesn't exist
253 244 '[[Unknown page]]' => '<a href="/projects/ecookbook/wiki/Unknown_page" class="wiki-page new">Unknown page</a>',
254 245 '[[Unknown page|404]]' => '<a href="/projects/ecookbook/wiki/Unknown_page" class="wiki-page new">404</a>',
255 246 # link to another project wiki
256 247 '[[onlinestore:]]' => '<a href="/projects/onlinestore/wiki" class="wiki-page">onlinestore</a>',
257 248 '[[onlinestore:|Wiki]]' => '<a href="/projects/onlinestore/wiki" class="wiki-page">Wiki</a>',
258 249 '[[onlinestore:Start page]]' => '<a href="/projects/onlinestore/wiki/Start_page" class="wiki-page">Start page</a>',
259 250 '[[onlinestore:Start page|Text]]' => '<a href="/projects/onlinestore/wiki/Start_page" class="wiki-page">Text</a>',
260 251 '[[onlinestore:Unknown page]]' => '<a href="/projects/onlinestore/wiki/Unknown_page" class="wiki-page new">Unknown page</a>',
261 252 # striked through link
262 253 '-[[Another page|Page]]-' => '<del><a href="/projects/ecookbook/wiki/Another_page" class="wiki-page">Page</a></del>',
263 254 '-[[Another page|Page]] link-' => '<del><a href="/projects/ecookbook/wiki/Another_page" class="wiki-page">Page</a> link</del>',
264 255 # escaping
265 256 '![[Another page|Page]]' => '[[Another page|Page]]',
266 257 # project does not exist
267 258 '[[unknowproject:Start]]' => '[[unknowproject:Start]]',
268 259 '[[unknowproject:Start|Page title]]' => '[[unknowproject:Start|Page title]]',
269 260 }
270 261 @project = Project.find(1)
271 262 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
272 263 end
273 264
274 265 def test_html_tags
275 266 to_test = {
276 267 "<div>content</div>" => "<p>&lt;div&gt;content&lt;/div&gt;</p>",
277 268 "<div class=\"bold\">content</div>" => "<p>&lt;div class=\"bold\"&gt;content&lt;/div&gt;</p>",
278 269 "<script>some script;</script>" => "<p>&lt;script&gt;some script;&lt;/script&gt;</p>",
279 270 # do not escape pre/code tags
280 271 "<pre>\nline 1\nline2</pre>" => "<pre>\nline 1\nline2</pre>",
281 272 "<pre><code>\nline 1\nline2</code></pre>" => "<pre><code>\nline 1\nline2</code></pre>",
282 273 "<pre><div>content</div></pre>" => "<pre>&lt;div&gt;content&lt;/div&gt;</pre>",
283 274 "HTML comment: <!-- no comments -->" => "<p>HTML comment: &lt;!-- no comments --&gt;</p>",
284 275 "<!-- opening comment" => "<p>&lt;!-- opening comment</p>",
285 276 # remove attributes except class
286 277 "<pre class='foo'>some text</pre>" => "<pre class='foo'>some text</pre>",
287 278 "<pre onmouseover='alert(1)'>some text</pre>" => "<pre>some text</pre>",
288 279 }
289 280 to_test.each { |text, result| assert_equal result, textilizable(text) }
290 281 end
291 282
292 283 def test_allowed_html_tags
293 284 to_test = {
294 285 "<pre>preformatted text</pre>" => "<pre>preformatted text</pre>",
295 286 "<notextile>no *textile* formatting</notextile>" => "no *textile* formatting",
296 287 "<notextile>this is <tag>a tag</tag></notextile>" => "this is &lt;tag&gt;a tag&lt;/tag&gt;"
297 288 }
298 289 to_test.each { |text, result| assert_equal result, textilizable(text) }
299 290 end
300 291
301 292 def test_pre_tags
302 293 raw = <<-RAW
303 294 Before
304 295
305 296 <pre>
306 297 <prepared-statement-cache-size>32</prepared-statement-cache-size>
307 298 </pre>
308 299
309 300 After
310 301 RAW
311 302
312 303 expected = <<-EXPECTED
313 304 <p>Before</p>
314 305 <pre>
315 306 &lt;prepared-statement-cache-size&gt;32&lt;/prepared-statement-cache-size&gt;
316 307 </pre>
317 308 <p>After</p>
318 309 EXPECTED
319 310
320 311 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(raw).gsub(%r{[\r\n\t]}, '')
321 312 end
322 313
323 314 def test_pre_content_should_not_parse_wiki_and_redmine_links
324 315 raw = <<-RAW
325 316 [[CookBook documentation]]
326 317
327 318 #1
328 319
329 320 <pre>
330 321 [[CookBook documentation]]
331 322
332 323 #1
333 324 </pre>
334 325 RAW
335 326
336 327 expected = <<-EXPECTED
337 328 <p><a href="/projects/ecookbook/wiki/CookBook_documentation" class="wiki-page">CookBook documentation</a></p>
338 329 <p><a href="/issues/1" class="issue status-1 priority-1" title="Can't print recipes (New)">#1</a></p>
339 330 <pre>
340 331 [[CookBook documentation]]
341 332
342 333 #1
343 334 </pre>
344 335 EXPECTED
345 336
346 337 @project = Project.find(1)
347 338 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(raw).gsub(%r{[\r\n\t]}, '')
348 339 end
349 340
350 341 def test_non_closing_pre_blocks_should_be_closed
351 342 raw = <<-RAW
352 343 <pre><code>
353 344 RAW
354 345
355 346 expected = <<-EXPECTED
356 347 <pre><code>
357 348 </code></pre>
358 349 EXPECTED
359 350
360 351 @project = Project.find(1)
361 352 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(raw).gsub(%r{[\r\n\t]}, '')
362 353 end
363 354
364 355 def test_syntax_highlight
365 356 raw = <<-RAW
366 357 <pre><code class="ruby">
367 358 # Some ruby code here
368 359 </code></pre>
369 360 RAW
370 361
371 362 expected = <<-EXPECTED
372 363 <pre><code class="ruby syntaxhl"><span class=\"CodeRay\"><span class="no">1</span> <span class="c"># Some ruby code here</span></span>
373 364 </code></pre>
374 365 EXPECTED
375 366
376 367 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(raw).gsub(%r{[\r\n\t]}, '')
377 368 end
378 369
379 370 def test_wiki_links_in_tables
380 371 to_test = {"|[[Page|Link title]]|[[Other Page|Other title]]|\n|Cell 21|[[Last page]]|" =>
381 372 '<tr><td><a href="/projects/ecookbook/wiki/Page" class="wiki-page new">Link title</a></td>' +
382 373 '<td><a href="/projects/ecookbook/wiki/Other_Page" class="wiki-page new">Other title</a></td>' +
383 374 '</tr><tr><td>Cell 21</td><td><a href="/projects/ecookbook/wiki/Last_page" class="wiki-page new">Last page</a></td></tr>'
384 375 }
385 376 @project = Project.find(1)
386 377 to_test.each { |text, result| assert_equal "<table>#{result}</table>", textilizable(text).gsub(/[\t\n]/, '') }
387 378 end
388 379
389 380 def test_text_formatting
390 381 to_test = {'*_+bold, italic and underline+_*' => '<strong><em><ins>bold, italic and underline</ins></em></strong>',
391 382 '(_text within parentheses_)' => '(<em>text within parentheses</em>)',
392 383 'a *Humane Web* Text Generator' => 'a <strong>Humane Web</strong> Text Generator',
393 384 'a H *umane* W *eb* T *ext* G *enerator*' => 'a H <strong>umane</strong> W <strong>eb</strong> T <strong>ext</strong> G <strong>enerator</strong>',
394 385 'a *H* umane *W* eb *T* ext *G* enerator' => 'a <strong>H</strong> umane <strong>W</strong> eb <strong>T</strong> ext <strong>G</strong> enerator',
395 386 }
396 387 to_test.each { |text, result| assert_equal "<p>#{result}</p>", textilizable(text) }
397 388 end
398 389
399 390 def test_wiki_horizontal_rule
400 391 assert_equal '<hr />', textilizable('---')
401 392 assert_equal '<p>Dashes: ---</p>', textilizable('Dashes: ---')
402 393 end
403 394
404 def test_acronym
405 assert_equal '<p>This is an acronym: <acronym title="American Civil Liberties Union">ACLU</acronym>.</p>',
406 textilizable('This is an acronym: ACLU(American Civil Liberties Union).')
407 end
408
409 395 def test_footnotes
410 396 raw = <<-RAW
411 397 This is some text[1].
412 398
413 399 fn1. This is the foot note
414 400 RAW
415 401
416 402 expected = <<-EXPECTED
417 403 <p>This is some text<sup><a href=\"#fn1\">1</a></sup>.</p>
418 404 <p id="fn1" class="footnote"><sup>1</sup> This is the foot note</p>
419 405 EXPECTED
420 406
421 407 assert_equal expected.gsub(%r{[\r\n\t]}, ''), textilizable(raw).gsub(%r{[\r\n\t]}, '')
422 408 end
423 409
424 410 def test_table_of_content
425 411 raw = <<-RAW
426 412 {{toc}}
427 413
428 414 h1. Title
429 415
430 416 Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.
431 417
432 418 h2. Subtitle with a [[Wiki]] link
433 419
434 420 Nullam commodo metus accumsan nulla. Curabitur lobortis dui id dolor.
435 421
436 422 h2. Subtitle with [[Wiki|another Wiki]] link
437 423
438 424 h2. Subtitle with %{color:red}red text%
439 425
440 426 h1. Another title
441 427
442 428 h2. An "Internet link":http://www.redmine.org/ inside subtitle
443 429
444 430 h2. "Project Name !/attachments/1234/logo_small.gif! !/attachments/5678/logo_2.png!":/projects/projectname/issues
445 431
446 432 RAW
447 433
448 434 expected = '<ul class="toc">' +
449 435 '<li class="heading1"><a href="#Title">Title</a></li>' +
450 436 '<li class="heading2"><a href="#Subtitle-with-a-Wiki-link">Subtitle with a Wiki link</a></li>' +
451 437 '<li class="heading2"><a href="#Subtitle-with-another-Wiki-link">Subtitle with another Wiki link</a></li>' +
452 438 '<li class="heading2"><a href="#Subtitle-with-red-text">Subtitle with red text</a></li>' +
453 439 '<li class="heading1"><a href="#Another-title">Another title</a></li>' +
454 440 '<li class="heading2"><a href="#An-Internet-link-inside-subtitle">An Internet link inside subtitle</a></li>' +
455 441 '<li class="heading2"><a href="#Project-Name">Project Name</a></li>' +
456 442 '</ul>'
457 443
458 444 assert textilizable(raw).gsub("\n", "").include?(expected)
459 445 end
460 446
461 447 def test_blockquote
462 448 # orig raw text
463 449 raw = <<-RAW
464 450 John said:
465 451 > Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.
466 452 > Nullam commodo metus accumsan nulla. Curabitur lobortis dui id dolor.
467 453 > * Donec odio lorem,
468 454 > * sagittis ac,
469 455 > * malesuada in,
470 456 > * adipiscing eu, dolor.
471 457 >
472 458 > >Nulla varius pulvinar diam. Proin id arcu id lorem scelerisque condimentum. Proin vehicula turpis vitae lacus.
473 459 > Proin a tellus. Nam vel neque.
474 460
475 461 He's right.
476 462 RAW
477 463
478 464 # expected html
479 465 expected = <<-EXPECTED
480 466 <p>John said:</p>
481 467 <blockquote>
482 468 Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.
483 469 Nullam commodo metus accumsan nulla. Curabitur lobortis dui id dolor.
484 470 <ul>
485 471 <li>Donec odio lorem,</li>
486 472 <li>sagittis ac,</li>
487 473 <li>malesuada in,</li>
488 474 <li>adipiscing eu, dolor.</li>
489 475 </ul>
490 476 <blockquote>
491 477 <p>Nulla varius pulvinar diam. Proin id arcu id lorem scelerisque condimentum. Proin vehicula turpis vitae lacus.</p>
492 478 </blockquote>
493 479 <p>Proin a tellus. Nam vel neque.</p>
494 480 </blockquote>
495 481 <p>He's right.</p>
496 482 EXPECTED
497 483
498 484 assert_equal expected.gsub(%r{\s+}, ''), textilizable(raw).gsub(%r{\s+}, '')
499 485 end
500 486
501 487 def test_table
502 488 raw = <<-RAW
503 489 This is a table with empty cells:
504 490
505 491 |cell11|cell12||
506 492 |cell21||cell23|
507 493 |cell31|cell32|cell33|
508 494 RAW
509 495
510 496 expected = <<-EXPECTED
511 497 <p>This is a table with empty cells:</p>
512 498
513 499 <table>
514 500 <tr><td>cell11</td><td>cell12</td><td></td></tr>
515 501 <tr><td>cell21</td><td></td><td>cell23</td></tr>
516 502 <tr><td>cell31</td><td>cell32</td><td>cell33</td></tr>
517 503 </table>
518 504 EXPECTED
519 505
520 506 assert_equal expected.gsub(%r{\s+}, ''), textilizable(raw).gsub(%r{\s+}, '')
521 507 end
522 508
523 509 def test_table_with_line_breaks
524 510 raw = <<-RAW
525 511 This is a table with line breaks:
526 512
527 513 |cell11
528 514 continued|cell12||
529 515 |-cell21-||cell23
530 516 cell23 line2
531 517 cell23 *line3*|
532 518 |cell31|cell32
533 519 cell32 line2|cell33|
534 520
535 521 RAW
536 522
537 523 expected = <<-EXPECTED
538 524 <p>This is a table with line breaks:</p>
539 525
540 526 <table>
541 527 <tr>
542 528 <td>cell11<br />continued</td>
543 529 <td>cell12</td>
544 530 <td></td>
545 531 </tr>
546 532 <tr>
547 533 <td><del>cell21</del></td>
548 534 <td></td>
549 535 <td>cell23<br/>cell23 line2<br/>cell23 <strong>line3</strong></td>
550 536 </tr>
551 537 <tr>
552 538 <td>cell31</td>
553 539 <td>cell32<br/>cell32 line2</td>
554 540 <td>cell33</td>
555 541 </tr>
556 542 </table>
557 543 EXPECTED
558 544
559 545 assert_equal expected.gsub(%r{\s+}, ''), textilizable(raw).gsub(%r{\s+}, '')
560 546 end
561 547
562 548 def test_textile_should_not_mangle_brackets
563 549 assert_equal '<p>[msg1][msg2]</p>', textilizable('[msg1][msg2]')
564 550 end
565 551
566 552 def test_default_formatter
567 553 Setting.text_formatting = 'unknown'
568 554 text = 'a *link*: http://www.example.net/'
569 555 assert_equal '<p>a *link*: <a href="http://www.example.net/">http://www.example.net/</a></p>', textilizable(text)
570 556 Setting.text_formatting = 'textile'
571 557 end
572 558
573 559 def test_due_date_distance_in_words
574 560 to_test = { Date.today => 'Due in 0 days',
575 561 Date.today + 1 => 'Due in 1 day',
576 562 Date.today + 100 => 'Due in about 3 months',
577 563 Date.today + 20000 => 'Due in over 54 years',
578 564 Date.today - 1 => '1 day late',
579 565 Date.today - 100 => 'about 3 months late',
580 566 Date.today - 20000 => 'over 54 years late',
581 567 }
582 568 to_test.each do |date, expected|
583 569 assert_equal expected, due_date_distance_in_words(date)
584 570 end
585 571 end
586 572
587 573 def test_avatar
588 574 # turn on avatars
589 575 Setting.gravatar_enabled = '1'
590 576 assert avatar(User.find_by_mail('jsmith@somenet.foo')).include?(Digest::MD5.hexdigest('jsmith@somenet.foo'))
591 577 assert avatar('jsmith <jsmith@somenet.foo>').include?(Digest::MD5.hexdigest('jsmith@somenet.foo'))
592 578 assert_nil avatar('jsmith')
593 579 assert_nil avatar(nil)
594 580
595 581 # turn off avatars
596 582 Setting.gravatar_enabled = '0'
597 583 assert_equal '', avatar(User.find_by_mail('jsmith@somenet.foo'))
598 584 end
599 585
600 586 def test_link_to_user
601 587 user = User.find(2)
602 588 t = link_to_user(user)
603 589 assert_equal "<a href=\"/users/2\">#{ user.name }</a>", t
604 590 end
605 591
606 592 def test_link_to_user_should_not_link_to_locked_user
607 593 user = User.find(5)
608 594 assert user.locked?
609 595 t = link_to_user(user)
610 596 assert_equal user.name, t
611 597 end
612 598
613 599 def test_link_to_user_should_not_link_to_anonymous
614 600 user = User.anonymous
615 601 assert user.anonymous?
616 602 t = link_to_user(user)
617 603 assert_equal ::I18n.t(:label_user_anonymous), t
618 604 end
619 605
620 606 def test_link_to_project
621 607 project = Project.find(1)
622 608 assert_equal %(<a href="/projects/ecookbook">eCookbook</a>),
623 609 link_to_project(project)
624 610 assert_equal %(<a href="/projects/ecookbook/settings">eCookbook</a>),
625 611 link_to_project(project, :action => 'settings')
626 612 assert_equal %(<a href="http://test.host/projects/ecookbook?jump=blah">eCookbook</a>),
627 613 link_to_project(project, {:only_path => false, :jump => 'blah'})
628 614 assert_equal %(<a href="/projects/ecookbook/settings" class="project">eCookbook</a>),
629 615 link_to_project(project, {:action => 'settings'}, :class => "project")
630 616 end
631 617 end
@@ -1,88 +1,96
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2010 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require File.dirname(__FILE__) + '/../../../../test_helper'
19 19
20 20 class Redmine::WikiFormatting::TextileFormatterTest < HelperTestCase
21 21
22 22 def setup
23 23 @formatter = Redmine::WikiFormatting::Textile::Formatter
24 24 end
25 25
26 26 MODIFIERS = {
27 27 "*" => 'strong', # bold
28 28 "_" => 'em', # italic
29 29 "+" => 'ins', # underline
30 30 "-" => 'del', # deleted
31 31 "^" => 'sup', # superscript
32 32 "~" => 'sub' # subscript
33 33 }
34 34
35 35 def test_modifiers
36 36 assert_html_output(
37 37 '*bold*' => '<strong>bold</strong>',
38 38 'before *bold*' => 'before <strong>bold</strong>',
39 39 '*bold* after' => '<strong>bold</strong> after',
40 40 '*two words*' => '<strong>two words</strong>',
41 41 '*two*words*' => '<strong>two*words</strong>',
42 42 '*two * words*' => '<strong>two * words</strong>',
43 43 '*two* *words*' => '<strong>two</strong> <strong>words</strong>',
44 44 '*(two)* *(words)*' => '<strong>(two)</strong> <strong>(words)</strong>',
45 45 # with class
46 46 '*(foo)two words*' => '<strong class="foo">two words</strong>'
47 47 )
48 48 end
49 49
50 50 def test_modifiers_combination
51 51 MODIFIERS.each do |m1, tag1|
52 52 MODIFIERS.each do |m2, tag2|
53 53 next if m1 == m2
54 54 text = "#{m2}#{m1}Phrase modifiers#{m1}#{m2}"
55 55 html = "<#{tag2}><#{tag1}>Phrase modifiers</#{tag1}></#{tag2}>"
56 56 assert_html_output text => html
57 57 end
58 58 end
59 59 end
60 60
61 61 def test_inline_code
62 62 assert_html_output(
63 63 'this is @some code@' => 'this is <code>some code</code>',
64 64 '@<Location /redmine>@' => '<code>&lt;Location /redmine&gt;</code>'
65 65 )
66 66 end
67 67
68 68 def test_escaping
69 69 assert_html_output(
70 70 'this is a <script>' => 'this is a &lt;script&gt;'
71 71 )
72 72 end
73 73
74 74 def test_double_dashes_should_not_strikethrough
75 75 assert_html_output(
76 76 'double -- dashes -- test' => 'double -- dashes -- test',
77 77 'double -- *dashes* -- test' => 'double -- <strong>dashes</strong> -- test'
78 78 )
79 79 end
80 80
81 def test_acronyms
82 assert_html_output(
83 'this is an acronym: GPL(General Public License)' => 'this is an acronym: <acronym title="General Public License">GPL</acronym>',
84 '2 letters JP(Jean-Philippe) acronym' => '2 letters <acronym title="Jean-Philippe">JP</acronym> acronym',
85 'GPL(This is a double-quoted "title")' => '<acronym title="This is a double-quoted &quot;title&quot;">GPL</acronym>'
86 )
87 end
88
81 89 private
82 90
83 91 def assert_html_output(to_test)
84 92 to_test.each do |text, expected|
85 93 assert_equal "<p>#{expected}</p>", @formatter.new(text).to_html, "Formatting the following text failed:\n===\n#{text}\n===\n"
86 94 end
87 95 end
88 96 end
General Comments 0
You need to be logged in to leave comments. Login now