greenmat 3.2.2.4 → 3.5.1.0

data/test/html_render_test.rb

@@ -3,79 +3,81 @@ require 'test_helper'
 
 class HTMLRenderTest < Greenmat::TestCase
   def setup
-    @markdown = Greenmat::Markdown.new(Greenmat::Render::HTML)
-    @rndr = {
-      :no_html => Greenmat::Render::HTML.new(:filter_html => true),
-      :no_images => Greenmat::Render::HTML.new(:no_images => true),
-      :no_links => Greenmat::Render::HTML.new(:no_links => true),
-      :safe_links => Greenmat::Render::HTML.new(:safe_links_only => true),
-      :escape_html => Greenmat::Render::HTML.new(:escape_html => true),
-      :hard_wrap => Greenmat::Render::HTML.new(:hard_wrap => true),
-      :toc_data => Greenmat::Render::HTML.new(:with_toc_data => true),
-      :prettify => Greenmat::Render::HTML.new(:prettify => true)
-    }
-  end
-
-  def render_with(rndr, text)
-    Greenmat::Markdown.new(rndr).render(text)
+    @renderer = Greenmat::Render::HTML
   end
 
   # Hint: overrides filter_html, no_images and no_links
   def test_that_escape_html_works
-    source = <<EOS
-Through <em>NO</em> <script>DOUBLE NO</script>
+    source = <<-HTML.strip_heredoc
+      Through <em>NO</em> <script>DOUBLE NO</script>
 
-<script>BAD</script>
+      <script>BAD</script>
 
-<img src="/favicon.ico" />
-EOS
-    expected = <<EOE
-<p>Through &lt;em&gt;NO&lt;/em&gt; &lt;script&gt;DOUBLE NO&lt;/script&gt;</p>
+      <img src="/favicon.ico" />
+    HTML
+    expected = <<-HTML.chomp.strip_heredoc
+      <p>Through &lt;em&gt;NO&lt;/em&gt; &lt;script&gt;DOUBLE NO&lt;/script&gt;</p>
 
-<p>&lt;script&gt;BAD&lt;/script&gt;</p>
+      <p>&lt;script&gt;BAD&lt;/script&gt;</p>
 
-<p>&lt;img src=&quot;/favicon.ico&quot; /&gt;</p>
-EOE
+      <p>&lt;img src=&quot;/favicon.ico&quot; /&gt;</p>
+    HTML
 
-    markdown = render_with(@rndr[:escape_html], source)
-    html_equal expected, markdown
+    assert_equal expected, render(source, with: [:escape_html])
   end
 
   def test_that_filter_html_works
-    markdown = render_with(@rndr[:no_html], 'Through <em>NO</em> <script>DOUBLE NO</script>')
-    html_equal "<p>Through NO DOUBLE NO</p>\n", markdown
+    markdown = 'Through <em>NO</em> <script>DOUBLE NO</script>'
+    output   = render(markdown, with: [:filter_html])
+
+    assert_equal "<p>Through NO DOUBLE NO</p>", output
   end
 
   def test_filter_html_doesnt_break_two_space_hard_break
-    markdown = render_with(@rndr[:no_html], "Lorem,  \nipsum\n")
-    html_equal "<p>Lorem,<br/>\nipsum</p>\n", markdown
+    markdown = "Lorem,  \nipsum\n"
+    output   = render(markdown, with: [:filter_html])
+
+    assert_equal "<p>Lorem,<br>\nipsum</p>", output
   end
 
   def test_that_no_image_flag_works
-    rd = render_with(@rndr[:no_images], %(![dust mite](http://dust.mite/image.png) <img src="image.png" />))
-    assert rd !~ /<img/
+    markdown = %(![dust mite](http://dust.mite/image.png) <img src="image.png" />)
+    output   = render(markdown, with: [:no_images])
+
+    assert_no_match %r{<img}, output
+  end
+
+  def test_that_links_with_ampersands_work
+    markdown = %([/?a=b&c=d](/?a=b&c=d))
+    output   = render(markdown)
+    assert_equal "<p><a href=\"/?a=b&c=d\">/?a=b&amp;c=d</a></p>", output
   end
 
   def test_that_no_links_flag_works
-    rd = render_with(@rndr[:no_links], %([This link](http://example.net/) <a href="links.html">links</a>))
-    assert rd !~ /<a /
+    markdown = %([This link](http://example.net/) <a href="links.html">links</a>)
+    output   = render(markdown, with: [:no_links])
+
+    assert_no_match %r{<a }, output
   end
 
   def test_that_safelink_flag_works
-    rd = render_with(@rndr[:safe_links], "[IRC](irc://chat.freenode.org/#freenode)")
-    html_equal "<p>[IRC](irc://chat.freenode.org/#freenode)</p>\n", rd
+    markdown = "[IRC](irc://chat.freenode.org/#freenode)"
+    output   = render(markdown, with: [:safe_links_only])
+
+    assert_equal "<p>[IRC](irc://chat.freenode.org/#freenode)</p>", output
   end
 
   def test_that_hard_wrap_works
-    rd = render_with(@rndr[:hard_wrap], <<EOE)
-Hello world,
-this is just a simple test
+    markdown = <<-Markdown.strip_heredoc
+      Hello world,
+      this is just a simple test
 
-With hard wraps
-and other *things*.
-EOE
+      With hard wraps
+      and other *things*.
+    Markdown
+    output   = render(markdown, with: [:hard_wrap])
 
-    assert rd =~ /<br>/
+    assert_match %r{<br>}, output
   end
 
   def test_that_link_attributes_work
@@ -85,48 +87,45 @@ EOE
   end
 
   def test_that_link_works_with_quotes
-    rd = render_with(Greenmat::Render::HTML.new, %([This'link"is](http://example.net/)))
-    assert_equal "<p><a href=\"http://example.net/\">This&#39;link&quot;is</a></p>\n", rd
+    markdown = %([This'link"is](http://example.net/))
+    expected = %(<p><a href="http://example.net/">This&#39;link&quot;is</a></p>)
 
-    rd = render_with(@rndr[:escape_html], %([This'link"is](http://example.net/)))
-    assert_equal "<p><a href=\"http://example.net/\">This&#39;link&quot;is</a></p>\n", rd
+    assert_equal expected, render(markdown)
+    assert_equal expected, render(markdown, with: [:escape_html])
   end
 
   def test_that_code_emphasis_work
-    markdown = <<-MD
-This should be **`a bold codespan`**
-However, this should be *`an emphasised codespan`*
+    markdown = <<-Markdown.strip_heredoc
+      This should be **`a bold codespan`**
+      However, this should be *`an emphasised codespan`*
 
-* **`ABC`** or **`DEF`**
-* Foo bar
-MD
+      * **`ABC`** or **`DEF`**
+      * Foo bar
+    Markdown
 
-    html = <<HTML
-<p>This should be <strong><code>a bold codespan</code></strong>
-However, this should be <em><code>an emphasised codespan</code></em></p>
+    html = <<-HTML.chomp.strip_heredoc
+      <p>This should be <strong><code>a bold codespan</code></strong>
+      However, this should be <em><code>an emphasised codespan</code></em></p>
 
-<ul>
-<li><strong><code>ABC</code></strong> or <strong><code>DEF</code></strong></li>
-<li>Foo bar</li>
-</ul>
-HTML
+      <ul>
+      <li><strong><code>ABC</code></strong> or <strong><code>DEF</code></strong></li>
+      <li>Foo bar</li>
+      </ul>
+    HTML
 
-    output = render_with(Greenmat::Render::HTML.new, markdown)
-    assert_equal html, output
+    assert_equal html, render(markdown)
   end
 
   def test_that_parenthesis_are_handled_into_links
-    markdown = "Hey have a look at the [bash man page](man:bash(1))!"
-    html = "<p>Hey have a look at the <a href=\"man:bash(1)\">bash man page</a>!</p>\n"
-    output = render_with(Greenmat::Render::HTML.new, markdown)
+    markdown = %(The [bash man page](man:bash(1))!)
+    expected = %(<p>The <a href="man:bash(1)">bash man page</a>!</p>)
 
-    assert_equal html, output
+    assert_equal expected, render(markdown)
   end
 
   def test_autolinking_works_as_expected
-    markdown = "Example of uri ftp://user:pass@example.com/. Email foo@bar.com and link http://bar.com"
-    renderer = Greenmat::Markdown.new(Greenmat::Render::HTML, :autolink => true)
-    output = renderer.render(markdown)
+    markdown = "Uri ftp://user:pass@example.com/. Email foo@bar.com and link http://bar.com"
+    output   = render(markdown, with: [:autolink])
 
     assert output.include? '<a href="ftp://user:pass@example.com/">ftp://user:pass@example.com/</a>'
     assert output.include? 'mailto:foo@bar.com'
@@ -134,107 +133,142 @@ HTML
   end
 
   def test_that_footnotes_work
-    markdown = <<-MD
-This is a footnote.[^1]
+    markdown = <<-Markdown.strip_heredoc
+      This is a footnote.[^1]
 
-[^1]: It provides additional information.
-MD
+      [^1]: It provides additional information.
+    Markdown
 
-    html = <<HTML
-<p>This is a footnote.<sup id="fnref1"><a href="#fn1" rel="footnote">1</a></sup></p>
+    html = <<-HTML.chomp.strip_heredoc
+      <p>This is a footnote.<sup id="fnref1"><a href="#fn1">1</a></sup></p>
 
-<div class="footnotes">
-<hr>
-<ol>
+      <div class="footnotes">
+      <hr>
+      <ol>
 
-<li id="fn1">
-<p>It provides additional information.&nbsp;<a href="#fnref1" rev="footnote">&#8617;</a></p>
-</li>
+      <li id="fn1">
+      <p>It provides additional information.&nbsp;<a href="#fnref1">&#8617;</a></p>
+      </li>
 
-</ol>
-</div>
-HTML
+      </ol>
+      </div>
+    HTML
 
-    renderer = Greenmat::Markdown.new(Greenmat::Render::HTML, :footnotes => true)
-    output = renderer.render(markdown)
+    output = render(markdown, with: [:footnotes])
     assert_equal html, output
   end
 
   def test_footnotes_enabled_but_missing_marker
-    markdown = <<MD
-Some text without a marker
+    markdown = <<-Markdown.strip_heredoc
+      Some text without a marker
 
-[^1] And a trailing definition
-MD
-    html = <<HTML
-<p>Some text without a marker</p>
+      [^1] And a trailing definition
+    Markdown
+    html = <<-HTML.chomp.strip_heredoc
+      <p>Some text without a marker</p>
 
-<p>[^1] And a trailing definition</p>
-HTML
+      <p>[^1] And a trailing definition</p>
+    HTML
 
-    renderer = Greenmat::Markdown.new(Greenmat::Render::HTML, :footnotes => true)
-    output = renderer.render(markdown)
+    output = render(markdown, with: [:footnotes])
     assert_equal html, output
   end
 
   def test_footnotes_enabled_but_missing_definition
     markdown = "Some text with a marker[^1] but no definition."
-    html = "<p>Some text with a marker[^1] but no definition.</p>\n"
+    expected = "<p>Some text with a marker[^1] but no definition.</p>"
 
-    renderer = Greenmat::Markdown.new(Greenmat::Render::HTML, :footnotes => true)
-    output = renderer.render(markdown)
-    assert_equal html, output
+    output = render(markdown, with: [:footnotes])
+    assert_equal expected, output
   end
 
   def test_autolink_short_domains
     markdown = "Example of uri ftp://auto/short/domains. Email auto@l.n and link http://a/u/t/o/s/h/o/r/t"
-    renderer = Greenmat::Markdown.new(Greenmat::Render::HTML, :autolink => true)
-    output = renderer.render(markdown)
+    output   = render(markdown, with: [:autolink])
 
     assert output.include? '<a href="ftp://auto/short/domains">ftp://auto/short/domains</a>'
     assert output.include? 'mailto:auto@l.n'
     assert output.include? '<a href="http://a/u/t/o/s/h/o/r/t">http://a/u/t/o/s/h/o/r/t</a>'
   end
 
-  def test_toc_heading_id
-    markdown = "# First level  heading\n## Second level heading"
-    output = render_with(@rndr[:toc_data], markdown)
-    assert_match /<h1 id="first-level-heading">/, output
-    assert_match /<h2 id="second-level-heading">/, output
-  end
-
   def test_that_prettify_works
-    text = <<-Markdown
-Foo
+    markdown = "\tclass Foo\nend"
+    output   = render(markdown, with: [:prettify])
+
+    assert output.include?("<pre><code class=\"prettyprint\">")
 
-~~~ruby
-some
-code
-~~~
+    markdown = "`class`"
+    output   = render(markdown, with: [:prettify])
 
-Bar
-Markdown
+    assert output.include?("<code class=\"prettyprint\">")
+  end
 
-    renderer = Greenmat::Markdown.new(@rndr[:prettify], fenced_code_blocks: true)
-    output = renderer.render(text)
+  def test_prettify_with_fenced_code_blocks
+    markdown = "~~~ruby\ncode\n~~~"
+    output   = render(markdown, with: [:fenced_code_blocks, :prettify])
 
     assert output.include?("<code class=\"prettyprint\" data-metadata=\"ruby\">")
   end
 
   def test_safe_links_only_with_anchors
     markdown = "An [anchor link](#anchor) on a page."
-
-    renderer = Greenmat::Markdown.new(@rndr[:safe_links])
-    output = renderer.render(markdown)
+    output   = render(markdown, with: [:safe_links_only])
 
     assert_match %r{<a href="#anchor">anchor link</a>}, output
   end
 
   def test_autolink_with_link_attributes
-    render = Greenmat::Render::HTML.new(link_attributes: {rel: "nofollow"})
-    parser = Greenmat::Markdown.new(render, autolink: true)
+    options = { autolink: true, link_attributes: {rel: "nofollow"} }
+    output  = render("https://github.com/", with: options)
 
-    output = parser.render("https://github.com/")
     assert_match %r{rel="nofollow"}, output
   end
+
+  def test_image_unsafe_src_with_safe_links_only
+    markdown = "![foo](javascript:while(1);)"
+    output   = render(markdown, with: [:safe_links_only])
+
+    assert_not_match %r{img src}, output
+  end
+
+  def test_no_styles_option_inside_a_paragraph
+    markdown = "Hello <style> foo { bar: baz; } </style> !"
+    output   = render(markdown, with: [:no_styles])
+
+    assert_no_match %r{<style>}, output
+  end
+
+  def test_no_styles_inside_html_block_rendering
+    markdown = "<style> foo { bar: baz; } </style>"
+    output   = render(markdown, with: [:no_styles])
+
+    assert_no_match %r{<style>}, output
+  end
+
+  def test_non_ascii_removal_in_header_anchors
+    markdown = "# Glühlampe"
+    html = "<h1 id=\"gl-hlampe\">Glühlampe</h1>"
+
+    assert_equal html, render(markdown, with: [:with_toc_data])
+  end
+
+  def test_utf8_only_header_anchors
+    markdown = "# 見出し"
+    if 1.size == 4 # 32-bit architecture
+      html = "<h1 id=\"part-a194139f\">見出し</h1>"
+    elsif 1.size == 8 # 64-bit architecture
+      html = "<h1 id=\"part-37870bfa194139f\">見出し</h1>"
+    else
+      raise "unknown integer size"
+    end
+
+    assert_equal html, render(markdown, with: [:with_toc_data])
+  end
+
+  def test_escape_entities_removal_from_anchor
+    output = render("# Foo's & Bar's", with: [:with_toc_data])
+    result = %(<h1 id="foos-bars">Foo&#39;s &amp; Bar&#39;s</h1>)
+
+    assert_equal result, output
+  end
 end

data/test/html_toc_render_test.rb

@@ -3,24 +3,28 @@ require 'test_helper'
 
 class HTMLTOCRenderTest < Greenmat::TestCase
   def setup
-    @render = Greenmat::Render::HTML_TOC
-    @markdown = "# A title \n## A __nice__ subtitle\n## Another one \n### A sub-sub-title"
+    @renderer = Greenmat::Render::HTML_TOC
+    @markdown = <<-Markdown.strip_heredoc
+      # A title
+      ## A __nice__ subtitle
+      ## Another one
+      ### A sub-sub-title
+      ### 見出し
+    Markdown
   end
 
   def test_simple_toc_render
-    renderer = Greenmat::Markdown.new(@render)
-    output = renderer.render(@markdown).strip
+    output = render(@markdown)
 
     assert output.start_with?("<ul>")
     assert output.end_with?("</ul>")
 
     assert_equal 3, output.scan("<ul>").length
-    assert_equal 4, output.scan("<li>").length
+    assert_equal 5, output.scan("<li>").length
   end
 
   def test_granular_toc_render
-    renderer = Greenmat::Markdown.new(@render.new(nesting_level: 2))
-    output = renderer.render(@markdown).strip
+    output = render(@markdown, with: { nesting_level: 2 })
 
     assert output.start_with?("<ul>")
     assert output.end_with?("</ul>")
@@ -29,21 +33,80 @@ class HTMLTOCRenderTest < Greenmat::TestCase
     assert !output.include?("A sub-sub title")
   end
 
+  def test_granular_toc_render_with_range
+    output = render(@markdown, with: { nesting_level: 2..5 }).strip
+
+    assert output.start_with?("<ul>")
+    assert output.end_with?("</ul>")
+
+    assert output.match("Another one")
+    assert output.match("A sub-sub-title")
+    assert output.match("見出し")
+
+    refute output.match("A title")
+    refute output.match("A really tiny title")
+  end
+
   def test_toc_heading_id
-    renderer = Greenmat::Markdown.new(@render)
-    output = renderer.render(@markdown)
+    output = render(@markdown)
 
     assert_match /a-title/, output
     assert_match /a-nice-subtitle/, output
     assert_match /another-one/, output
     assert_match /a-sub-sub-title/, output
+    # the part number length varies depending on architecture (32b or 64b)
+    assert_match /part-(37870bf)?a194139f/, output
   end
 
   def test_toc_heading_with_hyphen_and_equal
-    renderer = Greenmat::Markdown.new(@render)
-    output = renderer.render("# Hello World\n\n-\n\n=")
+    output = render("# Hello World\n\n-\n\n=")
 
     assert_equal 1, output.scan("<li>").length
     assert !output.include?('<a href=\"#\"></a>')
   end
+
+  def test_anchor_generation_with_edge_cases
+    # Imported from ActiveSupport::Inflector#parameterize's tests
+    titles = {
+      "Donald E. Knuth"                     => "donald-e-knuth",
+      "Random text with *(bad)* characters" => "random-text-with-bad-characters",
+      "!@#Surrounding bad characters!@#"    => "surrounding-bad-characters",
+      "Squeeze   separators"                => "squeeze-separators",
+      "Test with + sign"                    => "test-with-sign",
+      "Test with a Namespaced::Class"       => "test-with-a-namespaced-class"
+    }
+
+    titles.each do |title, anchor|
+      assert_match %("##{anchor}"), render("# #{title}")
+    end
+  end
+
+  def test_inline_markup_is_not_escaped
+    output = render(@markdown)
+
+    assert_match "A <strong>nice</strong> subtitle", output
+    assert_no_match %r{&lt;}, output
+  end
+
+  def test_inline_markup_escaping
+    output = render(@markdown, with: [:escape_html])
+
+    assert_match "&lt;strong&gt;", output
+    assert_no_match %r{<strong>}, output
+  end
+
+  def test_ignoring_fenced_code_blocks_comments
+    markdown = <<-Markdown.strip_heredoc
+    # Hello world !
+
+    ~~~ruby
+    # This is a comment
+    ~~~
+    Markdown
+
+    output = render(markdown)
+
+    assert output.match("Hello world")
+    refute output.match("This is a comment")
+  end
 end