Chris@1296: # Redmine - project management software
Chris@1296: # Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@1296: #
Chris@1296: # This program is free software; you can redistribute it and/or
Chris@1296: # modify it under the terms of the GNU General Public License
Chris@1296: # as published by the Free Software Foundation; either version 2
Chris@1296: # of the License, or (at your option) any later version.
Chris@1296: #
Chris@1296: # This program is distributed in the hope that it will be useful,
Chris@1296: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1296: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1296: # GNU General Public License for more details.
Chris@1296: #
Chris@1296: # You should have received a copy of the GNU General Public License
Chris@1296: # along with this program; if not, write to the Free Software
Chris@1296: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1296: 
Chris@1296: require File.expand_path('../../../../../test_helper', __FILE__)
Chris@1296: require 'digest/md5'
Chris@1296: 
Chris@1296: class Redmine::WikiFormatting::TextileFormatterTest < ActionView::TestCase
Chris@1296: 
Chris@1296:   def setup
Chris@1296:     @formatter = Redmine::WikiFormatting::Textile::Formatter
Chris@1296:   end
Chris@1296: 
Chris@1296:   MODIFIERS = {
Chris@1296:     "*" => 'strong', # bold
Chris@1296:     "_" => 'em',     # italic
Chris@1296:     "+" => 'ins',    # underline
Chris@1296:     "-" => 'del',    # deleted
Chris@1296:     "^" => 'sup',    # superscript
Chris@1296:     "~" => 'sub'     # subscript
Chris@1296:   }
Chris@1296: 
Chris@1296:   def test_modifiers
Chris@1296:     assert_html_output(
Chris@1296:       '*bold*'                => '<strong>bold</strong>',
Chris@1296:       'before *bold*'         => 'before <strong>bold</strong>',
Chris@1296:       '*bold* after'          => '<strong>bold</strong> after',
Chris@1296:       '*two words*'           => '<strong>two words</strong>',
Chris@1296:       '*two*words*'           => '<strong>two*words</strong>',
Chris@1296:       '*two * words*'         => '<strong>two * words</strong>',
Chris@1296:       '*two* *words*'         => '<strong>two</strong> <strong>words</strong>',
Chris@1296:       '*(two)* *(words)*'     => '<strong>(two)</strong> <strong>(words)</strong>',
Chris@1296:       # with class
Chris@1296:       '*(foo)two words*'      => '<strong class="foo">two words</strong>'
Chris@1296:     )
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_modifiers_combination
Chris@1296:     MODIFIERS.each do |m1, tag1|
Chris@1296:       MODIFIERS.each do |m2, tag2|
Chris@1296:         next if m1 == m2
Chris@1296:         text = "#{m2}#{m1}Phrase modifiers#{m1}#{m2}"
Chris@1296:         html = "<#{tag2}><#{tag1}>Phrase modifiers</#{tag1}></#{tag2}>"
Chris@1296:         assert_html_output text => html
Chris@1296:       end
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_styles
Chris@1296:     # single style
Chris@1296:     assert_html_output({
Chris@1296:       'p{color:red}. text'           => '<p style="color:red;">text</p>',
Chris@1296:       'p{color:red;}. text'          => '<p style="color:red;">text</p>',
Chris@1296:       'p{color: red}. text'          => '<p style="color: red;">text</p>',
Chris@1296:       'p{color:#f00}. text'          => '<p style="color:#f00;">text</p>',
Chris@1296:       'p{color:#ff0000}. text'       => '<p style="color:#ff0000;">text</p>',
Chris@1296:       'p{border:10px}. text'         => '<p style="border:10px;">text</p>',
Chris@1296:       'p{border:10}. text'           => '<p style="border:10;">text</p>',
Chris@1296:       'p{border:10%}. text'          => '<p style="border:10%;">text</p>',
Chris@1296:       'p{border:10em}. text'         => '<p style="border:10em;">text</p>',
Chris@1296:       'p{border:1.5em}. text'        => '<p style="border:1.5em;">text</p>',
Chris@1296:       'p{border-left:1px}. text'     => '<p style="border-left:1px;">text</p>',
Chris@1296:       'p{border-right:1px}. text'    => '<p style="border-right:1px;">text</p>',
Chris@1296:       'p{border-top:1px}. text'      => '<p style="border-top:1px;">text</p>',
Chris@1296:       'p{border-bottom:1px}. text'   => '<p style="border-bottom:1px;">text</p>',
Chris@1296:       }, false)
Chris@1296: 
Chris@1296:     # multiple styles
Chris@1296:     assert_html_output({
Chris@1296:       'p{color:red; border-top:1px}. text'   => '<p style="color:red;border-top:1px;">text</p>',
Chris@1296:       'p{color:red ; border-top:1px}. text'  => '<p style="color:red;border-top:1px;">text</p>',
Chris@1296:       'p{color:red;border-top:1px}. text'    => '<p style="color:red;border-top:1px;">text</p>',
Chris@1296:       }, false)
Chris@1296: 
Chris@1296:     # styles with multiple values
Chris@1296:     assert_html_output({
Chris@1296:       'p{border:1px solid red;}. text'             => '<p style="border:1px solid red;">text</p>',
Chris@1296:       'p{border-top-left-radius: 10px 5px;}. text' => '<p style="border-top-left-radius: 10px 5px;">text</p>',
Chris@1296:       }, false)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_invalid_styles_should_be_filtered
Chris@1296:     assert_html_output({
Chris@1296:       'p{invalid}. text'                     => '<p>text</p>',
Chris@1296:       'p{invalid:red}. text'                 => '<p>text</p>',
Chris@1296:       'p{color:(red)}. text'                 => '<p>text</p>',
Chris@1296:       'p{color:red;invalid:blue}. text'      => '<p style="color:red;">text</p>',
Chris@1296:       'p{invalid:blue;color:red}. text'      => '<p style="color:red;">text</p>',
Chris@1296:       'p{color:"}. text'                     => '<p>p{color:"}. text</p>',
Chris@1296:       }, false)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_inline_code
Chris@1296:     assert_html_output(
Chris@1296:       'this is @some code@'      => 'this is <code>some code</code>',
Chris@1296:       '@<Location /redmine>@'    => '<code>&lt;Location /redmine&gt;</code>'
Chris@1296:     )
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_nested_lists
Chris@1296:     raw = <<-RAW
Chris@1296: # Item 1
Chris@1296: # Item 2
Chris@1296: ** Item 2a
Chris@1296: ** Item 2b
Chris@1296: # Item 3
Chris@1296: ** Item 3a
Chris@1296: RAW
Chris@1296: 
Chris@1296:     expected = <<-EXPECTED
Chris@1296: <ol>
Chris@1296:   <li>Item 1</li>
Chris@1296:   <li>Item 2
Chris@1296:     <ul>
Chris@1296:       <li>Item 2a</li>
Chris@1296:       <li>Item 2b</li>
Chris@1296:     </ul>
Chris@1296:   </li>
Chris@1296:   <li>Item 3
Chris@1296:     <ul>
Chris@1296:       <li>Item 3a</li>
Chris@1296:     </ul>
Chris@1296:   </li>
Chris@1296: </ol>
Chris@1296: EXPECTED
Chris@1296: 
Chris@1296:     assert_equal expected.gsub(%r{\s+}, ''), to_html(raw).gsub(%r{\s+}, '')
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_escaping
Chris@1296:     assert_html_output(
Chris@1296:       'this is a <script>'      => 'this is a &lt;script&gt;'
Chris@1296:     )
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_use_of_backslashes_followed_by_numbers_in_headers
Chris@1296:     assert_html_output({
Chris@1296:       'h1. 2009\02\09'      => '<h1>2009\02\09</h1>'
Chris@1296:     }, false)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_double_dashes_should_not_strikethrough
Chris@1296:     assert_html_output(
Chris@1296:       'double -- dashes -- test'  => 'double -- dashes -- test',
Chris@1296:       'double -- *dashes* -- test'  => 'double -- <strong>dashes</strong> -- test'
Chris@1296:     )
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_acronyms
Chris@1296:     assert_html_output(
Chris@1296:       'this is an acronym: GPL(General Public License)' => 'this is an acronym: <acronym title="General Public License">GPL</acronym>',
Chris@1296:       '2 letters JP(Jean-Philippe) acronym' => '2 letters <acronym title="Jean-Philippe">JP</acronym> acronym',
Chris@1296:       'GPL(This is a double-quoted "title")' => '<acronym title="This is a double-quoted &quot;title&quot;">GPL</acronym>'
Chris@1296:     )
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_blockquote
Chris@1296:     # orig raw text
Chris@1296:     raw = <<-RAW
Chris@1296: John said:
Chris@1296: > Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.
Chris@1296: > Nullam commodo metus accumsan nulla. Curabitur lobortis dui id dolor.
Chris@1296: > * Donec odio lorem,
Chris@1296: > * sagittis ac,
Chris@1296: > * malesuada in,
Chris@1296: > * adipiscing eu, dolor.
Chris@1296: >
Chris@1296: > >Nulla varius pulvinar diam. Proin id arcu id lorem scelerisque condimentum. Proin vehicula turpis vitae lacus.
Chris@1296: > Proin a tellus. Nam vel neque.
Chris@1296: 
Chris@1296: He's right.
Chris@1296: RAW
Chris@1296: 
Chris@1296:     # expected html
Chris@1296:     expected = <<-EXPECTED
Chris@1296: <p>John said:</p>
Chris@1296: <blockquote>
Chris@1296: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.<br />
Chris@1296: Nullam commodo metus accumsan nulla. Curabitur lobortis dui id dolor.
Chris@1296: <ul>
Chris@1296:   <li>Donec odio lorem,</li>
Chris@1296:   <li>sagittis ac,</li>
Chris@1296:   <li>malesuada in,</li>
Chris@1296:   <li>adipiscing eu, dolor.</li>
Chris@1296: </ul>
Chris@1296: <blockquote>
Chris@1296: <p>Nulla varius pulvinar diam. Proin id arcu id lorem scelerisque condimentum. Proin vehicula turpis vitae lacus.</p>
Chris@1296: </blockquote>
Chris@1296: <p>Proin a tellus. Nam vel neque.</p>
Chris@1296: </blockquote>
Chris@1296: <p>He's right.</p>
Chris@1296: EXPECTED
Chris@1296: 
Chris@1296:     assert_equal expected.gsub(%r{\s+}, ''), to_html(raw).gsub(%r{\s+}, '')
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_table
Chris@1296:     raw = <<-RAW
Chris@1296: This is a table with empty cells:
Chris@1296: 
Chris@1296: |cell11|cell12||
Chris@1296: |cell21||cell23|
Chris@1296: |cell31|cell32|cell33|
Chris@1296: RAW
Chris@1296: 
Chris@1296:     expected = <<-EXPECTED
Chris@1296: <p>This is a table with empty cells:</p>
Chris@1296: 
Chris@1296: <table>
Chris@1296:   <tr><td>cell11</td><td>cell12</td><td></td></tr>
Chris@1296:   <tr><td>cell21</td><td></td><td>cell23</td></tr>
Chris@1296:   <tr><td>cell31</td><td>cell32</td><td>cell33</td></tr>
Chris@1296: </table>
Chris@1296: EXPECTED
Chris@1296: 
Chris@1296:     assert_equal expected.gsub(%r{\s+}, ''), to_html(raw).gsub(%r{\s+}, '')
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_table_with_line_breaks
Chris@1296:     raw = <<-RAW
Chris@1296: This is a table with line breaks:
Chris@1296: 
Chris@1296: |cell11
Chris@1296: continued|cell12||
Chris@1296: |-cell21-||cell23
Chris@1296: cell23 line2
Chris@1296: cell23 *line3*|
Chris@1296: |cell31|cell32
Chris@1296: cell32 line2|cell33|
Chris@1296: 
Chris@1296: RAW
Chris@1296: 
Chris@1296:     expected = <<-EXPECTED
Chris@1296: <p>This is a table with line breaks:</p>
Chris@1296: 
Chris@1296: <table>
Chris@1296:   <tr>
Chris@1296:     <td>cell11<br />continued</td>
Chris@1296:     <td>cell12</td>
Chris@1296:     <td></td>
Chris@1296:   </tr>
Chris@1296:   <tr>
Chris@1296:     <td><del>cell21</del></td>
Chris@1296:     <td></td>
Chris@1296:     <td>cell23<br/>cell23 line2<br/>cell23 <strong>line3</strong></td>
Chris@1296:   </tr>
Chris@1296:   <tr>
Chris@1296:     <td>cell31</td>
Chris@1296:     <td>cell32<br/>cell32 line2</td>
Chris@1296:     <td>cell33</td>
Chris@1296:   </tr>
Chris@1296: </table>
Chris@1296: EXPECTED
Chris@1296: 
Chris@1296:     assert_equal expected.gsub(%r{\s+}, ''), to_html(raw).gsub(%r{\s+}, '')
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_textile_should_not_mangle_brackets
Chris@1296:     assert_equal '<p>[msg1][msg2]</p>', to_html('[msg1][msg2]')
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_textile_should_escape_image_urls
Chris@1296:     # this is onclick="alert('XSS');" in encoded form
Chris@1296:     raw = '!/images/comment.png"onclick=&#x61;&#x6c;&#x65;&#x72;&#x74;&#x28;&#x27;&#x58;&#x53;&#x53;&#x27;&#x29;;&#x22;!'
Chris@1296:     expected = '<p><img src="/images/comment.png&quot;onclick=&amp;#x61;&amp;#x6c;&amp;#x65;&amp;#x72;&amp;#x74;&amp;#x28;&amp;#x27;&amp;#x58;&amp;#x53;&amp;#x53;&amp;#x27;&amp;#x29;;&amp;#x22;" alt="" /></p>'
Chris@1296:     assert_equal expected.gsub(%r{\s+}, ''), to_html(raw).gsub(%r{\s+}, '')
Chris@1296:   end
Chris@1296:   
Chris@1296:   
Chris@1296:   STR_WITHOUT_PRE = [
Chris@1296:   # 0
Chris@1296: "h1. Title
Chris@1296: 
Chris@1296: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.",
Chris@1296:   # 1
Chris@1296: "h2. Heading 2
Chris@1296: 
Chris@1296: Maecenas sed elit sit amet mi accumsan vestibulum non nec velit. Proin porta tincidunt lorem, consequat rhoncus dolor fermentum in.
Chris@1296: 
Chris@1296: Cras ipsum felis, ultrices at porttitor vel, faucibus eu nunc.",
Chris@1296:   # 2
Chris@1296: "h2. Heading 2
Chris@1296: 
Chris@1296: Morbi facilisis accumsan orci non pharetra.
Chris@1296: 
Chris@1296: h3. Heading 3
Chris@1296: 
Chris@1296: Nulla nunc nisi, egestas in ornare vel, posuere ac libero.",
Chris@1296:   # 3
Chris@1296: "h3. Heading 3
Chris@1296: 
Chris@1296: Praesent eget turpis nibh, a lacinia nulla.",
Chris@1296:   # 4
Chris@1296: "h2. Heading 2
Chris@1296: 
Chris@1296: Ut rhoncus elementum adipiscing."]
Chris@1296: 
Chris@1296:   TEXT_WITHOUT_PRE = STR_WITHOUT_PRE.join("\n\n").freeze
Chris@1296:   
Chris@1296:   def test_get_section_should_return_the_requested_section_and_its_hash
Chris@1296:     assert_section_with_hash STR_WITHOUT_PRE[1], TEXT_WITHOUT_PRE, 2
Chris@1296:     assert_section_with_hash STR_WITHOUT_PRE[2..3].join("\n\n"), TEXT_WITHOUT_PRE, 3
Chris@1296:     assert_section_with_hash STR_WITHOUT_PRE[3], TEXT_WITHOUT_PRE, 5
Chris@1296:     assert_section_with_hash STR_WITHOUT_PRE[4], TEXT_WITHOUT_PRE, 6
Chris@1296:     
Chris@1296:     assert_section_with_hash '', TEXT_WITHOUT_PRE, 0
Chris@1296:     assert_section_with_hash '', TEXT_WITHOUT_PRE, 10
Chris@1296:   end
Chris@1296:   
Chris@1296:   def test_update_section_should_update_the_requested_section
Chris@1296:     replacement = "New text"
Chris@1296:     
Chris@1296:     assert_equal [STR_WITHOUT_PRE[0], replacement, STR_WITHOUT_PRE[2..4]].flatten.join("\n\n"), @formatter.new(TEXT_WITHOUT_PRE).update_section(2, replacement)
Chris@1296:     assert_equal [STR_WITHOUT_PRE[0..1], replacement, STR_WITHOUT_PRE[4]].flatten.join("\n\n"), @formatter.new(TEXT_WITHOUT_PRE).update_section(3, replacement)
Chris@1296:     assert_equal [STR_WITHOUT_PRE[0..2], replacement, STR_WITHOUT_PRE[4]].flatten.join("\n\n"), @formatter.new(TEXT_WITHOUT_PRE).update_section(5, replacement)
Chris@1296:     assert_equal [STR_WITHOUT_PRE[0..3], replacement].flatten.join("\n\n"), @formatter.new(TEXT_WITHOUT_PRE).update_section(6, replacement)
Chris@1296:     
Chris@1296:     assert_equal TEXT_WITHOUT_PRE, @formatter.new(TEXT_WITHOUT_PRE).update_section(0, replacement)
Chris@1296:     assert_equal TEXT_WITHOUT_PRE, @formatter.new(TEXT_WITHOUT_PRE).update_section(10, replacement)
Chris@1296:   end
Chris@1296:   
Chris@1296:   def test_update_section_with_hash_should_update_the_requested_section
Chris@1296:     replacement = "New text"
Chris@1296:     
Chris@1296:     assert_equal [STR_WITHOUT_PRE[0], replacement, STR_WITHOUT_PRE[2..4]].flatten.join("\n\n"),
Chris@1296:       @formatter.new(TEXT_WITHOUT_PRE).update_section(2, replacement, Digest::MD5.hexdigest(STR_WITHOUT_PRE[1]))
Chris@1296:   end
Chris@1296:   
Chris@1296:   def test_update_section_with_wrong_hash_should_raise_an_error
Chris@1296:     assert_raise Redmine::WikiFormatting::StaleSectionError do
Chris@1296:       @formatter.new(TEXT_WITHOUT_PRE).update_section(2, "New text", Digest::MD5.hexdigest("Old text"))
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   STR_WITH_PRE = [
Chris@1296:   # 0
Chris@1296: "h1. Title
Chris@1296: 
Chris@1296: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.",
Chris@1296:   # 1
Chris@1296: "h2. Heading 2
Chris@1296: 
Chris@1296: <pre><code class=\"ruby\">
Chris@1296:   def foo
Chris@1296:   end
Chris@1296: </code></pre>
Chris@1296: 
Chris@1296: <pre><code><pre><code class=\"ruby\">
Chris@1296:   Place your code here.
Chris@1296: </code></pre>
Chris@1296: </code></pre>
Chris@1296: 
Chris@1296: Morbi facilisis accumsan orci non pharetra.
Chris@1296: 
Chris@1296: <pre>
Chris@1296: Pre Content:
Chris@1296: 
Chris@1296: h2. Inside pre
Chris@1296: 
Chris@1296: <tag> inside pre block
Chris@1296: 
Chris@1296: Morbi facilisis accumsan orci non pharetra.
Chris@1296: </pre>",
Chris@1296:   # 2
Chris@1296: "h3. Heading 3
Chris@1296: 
Chris@1296: Nulla nunc nisi, egestas in ornare vel, posuere ac libero."]
Chris@1296: 
Chris@1296:   def test_get_section_should_ignore_pre_content
Chris@1296:     text = STR_WITH_PRE.join("\n\n")
Chris@1296: 
Chris@1296:     assert_section_with_hash STR_WITH_PRE[1..2].join("\n\n"), text, 2
Chris@1296:     assert_section_with_hash STR_WITH_PRE[2], text, 3
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_update_section_should_not_escape_pre_content_outside_section
Chris@1296:     text = STR_WITH_PRE.join("\n\n")
Chris@1296:     replacement = "New text"
Chris@1296:     
Chris@1296:     assert_equal [STR_WITH_PRE[0..1], "New text"].flatten.join("\n\n"),
Chris@1296:       @formatter.new(text).update_section(3, replacement)
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_get_section_should_support_lines_with_spaces_before_heading
Chris@1296:     # the lines after Content 2 and Heading 4 contain a space
Chris@1296:     text = <<-STR
Chris@1296: h1. Heading 1
Chris@1296: 
Chris@1296: Content 1
Chris@1296: 
Chris@1296: h1. Heading 2
Chris@1296: 
Chris@1296: Content 2
Chris@1296:  
Chris@1296: h1. Heading 3
Chris@1296: 
Chris@1296: Content 3
Chris@1296: 
Chris@1296: h1. Heading 4
Chris@1296:  
Chris@1296: Content 4
Chris@1296: STR
Chris@1296: 
Chris@1296:     [1, 2, 3, 4].each do |index|
Chris@1296:       assert_match /\Ah1. Heading #{index}.+Content #{index}/m, @formatter.new(text).get_section(index).first
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def test_get_section_should_support_headings_starting_with_a_tab
Chris@1296:     text = <<-STR
Chris@1296: h1.\tHeading 1
Chris@1296: 
Chris@1296: Content 1
Chris@1296: 
Chris@1296: h1. Heading 2
Chris@1296: 
Chris@1296: Content 2
Chris@1296: STR
Chris@1296: 
Chris@1296:     assert_match /\Ah1.\tHeading 1\s+Content 1\z/, @formatter.new(text).get_section(1).first
Chris@1296:   end
Chris@1296: 
Chris@1296:   private
Chris@1296: 
Chris@1296:   def assert_html_output(to_test, expect_paragraph = true)
Chris@1296:     to_test.each do |text, expected|
Chris@1296:       assert_equal(( expect_paragraph ? "<p>#{expected}</p>" : expected ), @formatter.new(text).to_html, "Formatting the following text failed:\n===\n#{text}\n===\n")
Chris@1296:     end
Chris@1296:   end
Chris@1296: 
Chris@1296:   def to_html(text)
Chris@1296:     @formatter.new(text).to_html
Chris@1296:   end
Chris@1296:   
Chris@1296:   def assert_section_with_hash(expected, text, index)
Chris@1296:     result = @formatter.new(text).get_section(index)
Chris@1296:     
Chris@1296:     assert_kind_of Array, result
Chris@1296:     assert_equal 2, result.size
Chris@1296:     assert_equal expected, result.first, "section content did not match"
Chris@1296:     assert_equal Digest::MD5.hexdigest(expected), result.last, "section hash did not match"
Chris@1296:   end
Chris@1296: end