redcarpet 3.2.3 → 3.3.0

data/test/html_toc_render_test.rb

@@ -3,13 +3,12 @@ require 'test_helper'
 
 class HTMLTOCRenderTest < Redcarpet::TestCase
   def setup
-    @render = Redcarpet::Render::HTML_TOC
+    @renderer = Redcarpet::Render::HTML_TOC
     @markdown = "# A title \n## A __nice__ subtitle\n## Another one \n### A sub-sub-title"
   end
 
   def test_simple_toc_render
-    renderer = Redcarpet::Markdown.new(@render)
-    output = renderer.render(@markdown).strip
+    output = render(@markdown).strip
 
     assert output.start_with?("<ul>")
     assert output.end_with?("</ul>")
@@ -19,8 +18,7 @@ class HTMLTOCRenderTest < Redcarpet::TestCase
   end
 
   def test_granular_toc_render
-    renderer = Redcarpet::Markdown.new(@render.new(nesting_level: 2))
-    output = renderer.render(@markdown).strip
+    output = render(@markdown, with: { nesting_level: 2 }).strip
 
     assert output.start_with?("<ul>")
     assert output.end_with?("</ul>")
@@ -30,8 +28,7 @@ class HTMLTOCRenderTest < Redcarpet::TestCase
   end
 
   def test_toc_heading_id
-    renderer = Redcarpet::Markdown.new(@render)
-    output = renderer.render(@markdown)
+    output = render(@markdown)
 
     assert_match /a-title/, output
     assert_match /a-nice-subtitle/, output
@@ -40,10 +37,39 @@ class HTMLTOCRenderTest < Redcarpet::TestCase
   end
 
   def test_toc_heading_with_hyphen_and_equal
-    renderer = Redcarpet::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
 end

data/test/markdown_test.rb

@@ -13,37 +13,37 @@ class MarkdownTest < Redcarpet::TestCase
 
   def test_that_simple_one_liner_goes_to_html
     assert_respond_to @markdown, :render
-    html_equal "<p>Hello World.</p>\n", @markdown.render("Hello World.")
+    assert_equal "<p>Hello World.</p>\n", @markdown.render("Hello World.")
   end
 
   def test_that_inline_markdown_goes_to_html
     markdown = @markdown.render('_Hello World_!')
-    html_equal "<p><em>Hello World</em>!</p>\n", markdown
+    assert_equal "<p><em>Hello World</em>!</p>\n", markdown
   end
 
   def test_that_inline_markdown_starts_and_ends_correctly
     markdown = render_with({:no_intra_emphasis => true}, '_start _ foo_bar bar_baz _ end_ *italic* **bold** <a>_blah_</a>')
 
-    html_equal "<p><em>start _ foo_bar bar_baz _ end</em> <em>italic</em> <strong>bold</strong> <a><em>blah</em></a></p>\n", markdown
+    assert_equal "<p><em>start _ foo_bar bar_baz _ end</em> <em>italic</em> <strong>bold</strong> <a><em>blah</em></a></p>\n", markdown
 
     markdown = @markdown.render("Run 'rake radiant:extensions:rbac_base:migrate'")
-    html_equal "<p>Run 'rake radiant:extensions:rbac_base:migrate'</p>\n", markdown
+    assert_equal "<p>Run &#39;rake radiant:extensions:rbac_base:migrate&#39;</p>\n", markdown
   end
 
   def test_that_urls_are_not_doubly_escaped
     markdown = @markdown.render('[Page 2](/search?query=Markdown+Test&page=2)')
-    html_equal "<p><a href=\"/search?query=Markdown+Test&amp;page=2\">Page 2</a></p>\n", markdown
+    assert_equal "<p><a href=\"/search?query=Markdown+Test&amp;page=2\">Page 2</a></p>\n", markdown
   end
 
   def test_simple_inline_html
     #markdown = Markdown.new("before\n\n<div>\n  foo\n</div>\nafter")
     markdown = @markdown.render("before\n\n<div>\n  foo\n</div>\n\nafter")
-    html_equal "<p>before</p>\n\n<div>\n  foo\n</div>\n\n<p>after</p>\n", markdown
+    assert_equal "<p>before</p>\n\n<div>\n  foo\n</div>\n\n<p>after</p>\n", markdown
   end
 
   def test_that_html_blocks_do_not_require_their_own_end_tag_line
     markdown = @markdown.render("Para 1\n\n<div><pre>HTML block\n</pre></div>\n\nPara 2 [Link](#anchor)")
-    html_equal "<p>Para 1</p>\n\n<div><pre>HTML block\n</pre></div>\n\n<p>Para 2 <a href=\"#anchor\">Link</a></p>\n",
+    assert_equal "<p>Para 1</p>\n\n<div><pre>HTML block\n</pre></div>\n\n<p>Para 2 <a href=\"#anchor\">Link</a></p>\n",
       markdown
   end
 
@@ -53,8 +53,8 @@ class MarkdownTest < Redcarpet::TestCase
       "A wise man once said:\n\n" +
       " > Isn't it wonderful just to be alive.\n"
     )
-    html_equal "<p>A wise man once said:</p>\n\n" +
-      "<blockquote><p>Isn't it wonderful just to be alive.</p>\n</blockquote>\n",
+    assert_equal "<p>A wise man once said:</p>\n\n" +
+      "<blockquote>\n<p>Isn&#39;t it wonderful just to be alive.</p>\n</blockquote>\n",
       markdown
   end
 
@@ -63,7 +63,7 @@ class MarkdownTest < Redcarpet::TestCase
       "Things to watch out for\n" +
       "<ul>\n<li>Blah</li>\n</ul>\n")
 
-    html_equal "<p>Things to watch out for</p>\n\n" +
+    assert_equal "<p>Things to watch out for</p>\n\n" +
       "<ul>\n<li>Blah</li>\n</ul>\n", markdown
   end
 
@@ -85,7 +85,7 @@ MARKDOWN
 
 <p>This paragraph is not part of the list.</p>
 HTML
-    html_equal expected, @markdown.render(text)
+    assert_equal expected, @markdown.render(text)
   end
 
   # http://github.com/rtomayko/rdiscount/issues/#issue/13
@@ -93,37 +93,37 @@ HTML
     text = "The Ant-Sugar Tales \n"         +
            "=================== \n\n"        +
            "By Candice Yellowflower   \n"
-    html_equal "<h1>The Ant-Sugar Tales </h1>\n\n<p>By Candice Yellowflower   </p>\n", @markdown.render(text)
+    assert_equal "<h1>The Ant-Sugar Tales </h1>\n\n<p>By Candice Yellowflower   </p>\n", @markdown.render(text)
   end
 
   def test_that_intra_emphasis_works
     rd = render_with({}, "foo_bar_baz")
-    html_equal "<p>foo<em>bar</em>baz</p>\n", rd
+    assert_equal "<p>foo<em>bar</em>baz</p>\n", rd
 
     rd = render_with({:no_intra_emphasis => true},"foo_bar_baz")
-    html_equal "<p>foo_bar_baz</p>\n", rd
+    assert_equal "<p>foo_bar_baz</p>\n", rd
   end
 
   def test_that_autolink_flag_works
     rd = render_with({:autolink => true}, "http://github.com/rtomayko/rdiscount")
-    html_equal "<p><a href=\"http://github.com/rtomayko/rdiscount\">http://github.com/rtomayko/rdiscount</a></p>\n", rd
+    assert_equal "<p><a href=\"http://github.com/rtomayko/rdiscount\">http://github.com/rtomayko/rdiscount</a></p>\n", rd
   end
 
   def test_that_tags_can_have_dashes_and_underscores
     rd = @markdown.render("foo <asdf-qwerty>bar</asdf-qwerty> and <a_b>baz</a_b>")
-    html_equal "<p>foo <asdf-qwerty>bar</asdf-qwerty> and <a_b>baz</a_b></p>\n", rd
+    assert_equal "<p>foo <asdf-qwerty>bar</asdf-qwerty> and <a_b>baz</a_b></p>\n", rd
   end
 
   def test_link_syntax_is_not_processed_within_code_blocks
     markdown = @markdown.render("    This is a code block\n    This is a link [[1]] inside\n")
-    html_equal "<pre><code>This is a code block\nThis is a link [[1]] inside\n</code></pre>\n",
+    assert_equal "<pre><code>This is a code block\nThis is a link [[1]] inside\n</code></pre>\n",
       markdown
   end
 
   def test_whitespace_after_urls
     rd = render_with({:autolink => true}, "Japan: http://www.abc.net.au/news/events/japan-quake-2011/beforeafter.htm (yes, japan)")
     exp = %{<p>Japan: <a href="http://www.abc.net.au/news/events/japan-quake-2011/beforeafter.htm">http://www.abc.net.au/news/events/japan-quake-2011/beforeafter.htm</a> (yes, japan)</p>\n}
-    html_equal exp, rd
+    assert_equal exp, rd
   end
 
   def test_memory_leak_when_parsing_char_links
@@ -142,7 +142,7 @@ HTML
   end
 
   def test_infinite_loop_in_header
-    html_equal "<h1>Body</h1>\n", @markdown.render(<<-header)
+    assert_equal "<h1>Body</h1>\n", @markdown.render(<<-header)
 ######
 #Body#
 ######
@@ -150,8 +150,8 @@ HTML
   end
 
   def test_a_hyphen_and_a_equal_should_not_be_converted_to_heading
-    html_equal "<p>-</p>\n", @markdown.render("-")
-    html_equal "<p>=</p>\n", @markdown.render("=")
+    assert_equal "<p>-</p>\n", @markdown.render("-")
+    assert_equal "<p>=</p>\n", @markdown.render("=")
   end
 
   def test_that_tables_flag_works
@@ -238,6 +238,32 @@ fenced
     assert !out.include?("<pre><code>")
   end
 
+  def test_that_indented_code_preserves_references
+    text = <<indented
+This is normal text
+
+    Link to [Google][1]
+
+    [1]: http://google.com
+indented
+    out = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :fenced_code_blocks => true).render(text)
+    assert out.include?("[1]: http://google.com")
+  end
+
+  def test_that_fenced_flag_preserves_references
+    text = <<fenced
+This is normal text
+
+```
+Link to [Google][1]
+
+[1]: http://google.com
+```
+fenced
+    out = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :fenced_code_blocks => true).render(text)
+    assert out.include?("[1]: http://google.com")
+  end
+
   def test_that_indented_flag_works
     text = <<indented
 This is a simple text
@@ -254,14 +280,14 @@ indented
 
   def test_that_headers_are_linkable
     markdown = @markdown.render('### Hello [GitHub](http://github.com)')
-    html_equal "<h3>Hello <a href=\"http://github.com\">GitHub</a></h3>\n", markdown
+    assert_equal "<h3>Hello <a href=\"http://github.com\">GitHub</a></h3>\n", markdown
   end
 
   def test_autolinking_with_ent_chars
     markdown = render_with({:autolink => true}, <<text)
 This a stupid link: https://github.com/rtomayko/tilt/issues?milestone=1&state=open
 text
-    html_equal "<p>This a stupid link: <a href=\"https://github.com/rtomayko/tilt/issues?milestone=1&state=open\">https://github.com/rtomayko/tilt/issues?milestone=1&amp;state=open</a></p>\n", markdown
+    assert_equal "<p>This a stupid link: <a href=\"https://github.com/rtomayko/tilt/issues?milestone=1&amp;state=open\">https://github.com/rtomayko/tilt/issues?milestone=1&amp;state=open</a></p>\n", markdown
   end
 
   def test_spaced_headers
@@ -287,13 +313,13 @@ text
 
   def test_emphasis_escaping
     markdown = @markdown.render("**foo\\*** _dd\\_dd_")
-    html_equal "<p><strong>foo*</strong> <em>dd_dd</em></p>\n", markdown
+    assert_equal "<p><strong>foo*</strong> <em>dd_dd</em></p>\n", markdown
   end
 
   def test_char_escaping_when_highlighting
     markdown = "==attribute\\==="
     output = render_with({highlight: true}, markdown)
-    html_equal "<p><mark>attribute=</mark></p>\n", output
+    assert_equal "<p><mark>attribute=</mark></p>\n", output
   end
 
   def test_ordered_lists_with_lax_spacing
@@ -306,7 +332,17 @@ text
 
   def test_references_with_tabs_after_colon
     markdown = @markdown.render("[Link][id]\n[id]:\t\t\thttp://google.es")
-    html_equal "<p><a href=\"http://google.es\">Link</a></p>\n", markdown
+    assert_equal "<p><a href=\"http://google.es\">Link</a></p>\n", markdown
+  end
+
+  def test_superscript
+    markdown = render_with({:superscript => true}, "this is the 2^nd time")
+    assert_equal "<p>this is the 2<sup>nd</sup> time</p>\n", markdown
+  end
+
+  def test_superscript_enclosed_in_parenthesis
+    markdown = render_with({:superscript => true}, "this is the 2^(nd) time")
+    assert_equal "<p>this is the 2<sup>nd</sup> time</p>\n", markdown
   end
 
   def test_no_rewind_into_previous_inline

data/test/redcarpet_bin_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+require 'tempfile'
+
+class RedcarpetBinTest < Redcarpet::TestCase
+  def setup
+    @fixture_file = Tempfile.new('bin')
+    @fixture_path = @fixture_file.path
+
+    @fixture_file.write "A ==simple== fixture file -- with " \
+                        "a [link](https://github.com)."
+    @fixture_file.rewind
+  end
+
+  def teardown
+    @fixture_file.unlink
+  end
+
+  def test_vanilla_bin
+    run_bin(@fixture_path)
+
+    expected = "<p>A ==simple== fixture file -- with " \
+               "a <a href=\"https://github.com\">link</a>.</p>\n"
+
+    assert_equal expected, @output
+  end
+
+  def test_enabling_a_parse_option
+    run_bin("--parse", "highlight", @fixture_path)
+
+    assert_output "<mark>"
+    refute_output "=="
+  end
+
+  def test_enabling_a_render_option
+    run_bin("--render", "no-links", @fixture_path)
+
+    assert_output "[link]"
+    refute_output "</a>"
+  end
+
+  def test_enabling_smarty_pants
+    run_bin("--smarty", @fixture_path)
+
+    assert_output "&ndash"
+    refute_output "--"
+  end
+
+  def test_version_option
+    run_bin("--version")
+    assert_output "Redcarpet #{Redcarpet::VERSION}"
+  end
+
+  def test_legacy_option_parsing
+    run_bin("--parse-highlight", "--render-no-links", @fixture_path)
+
+    assert_output "<mark>"
+    refute_output "=="
+
+    assert_output "[link]"
+    refute_output "</a>"
+  end
+
+  private
+
+  def run_bin(*args)
+    bin_path = File.expand_path('../../bin/redcarpet', __FILE__)
+
+    IO.popen("#{bin_path} #{args.join(" ")}") do |stream|
+      @output = stream.read
+    end
+  end
+
+  def assert_output(pattern)
+    assert_match pattern, @output
+  end
+
+  def refute_output(pattern)
+    refute_match Regexp.new(pattern), @output
+  end
+end

data/test/redcarpet_compat_test.rb

@@ -4,35 +4,35 @@ require 'test_helper'
 class RedcarpetCompatTest < Redcarpet::TestCase
   def test_simple_compat_api
     html = RedcarpetCompat.new("This is_just_a test").to_html
-    html_equal "<p>This is<em>just</em>a test</p>\n", html
+    assert_equal "<p>This is<em>just</em>a test</p>\n", html
   end
 
   def test_compat_api_enables_extensions
     html = RedcarpetCompat.new("This is_just_a test", :no_intra_emphasis).to_html
-    html_equal "<p>This is_just_a test</p>\n", html
+    assert_equal "<p>This is_just_a test</p>\n", html
   end
 
   def test_compat_api_knows_fenced_code_extension
     text = "```ruby\nx = 'foo'\n```"
     html = RedcarpetCompat.new(text, :fenced_code).to_html
-    html_equal "<pre><code class=\"ruby\">x = 'foo'\n</code></pre>\n", html
+    assert_equal "<pre><code class=\"ruby\">x = &#39;foo&#39;\n</code></pre>\n", html
   end
 
   def test_compat_api_ignores_gh_blockcode_extension
     text = "```ruby\nx = 'foo'\n```"
     html = RedcarpetCompat.new(text, :fenced_code, :gh_blockcode).to_html
-    html_equal "<pre><code class=\"ruby\">x = 'foo'\n</code></pre>\n", html
+    assert_equal "<pre><code class=\"ruby\">x = &#39;foo&#39;\n</code></pre>\n", html
   end
 
   def test_compat_api_knows_no_intraemphasis_extension
     html = RedcarpetCompat.new("This is_just_a test", :no_intraemphasis).to_html
-    html_equal "<p>This is_just_a test</p>\n", html
+    assert_equal "<p>This is_just_a test</p>\n", html
   end
 
   def test_translate_outdated_extensions
     # these extensions are no longer used
     exts = [:gh_blockcode, :no_tables, :smart, :strict]
     html = RedcarpetCompat.new('"TEST"', *exts).to_html
-    html_equal "<p>&quot;TEST&quot;</p>\n", html
+    assert_equal "<p>&quot;TEST&quot;</p>\n", html
   end
 end

data/test/test_helper.rb

@@ -1,29 +1,33 @@
 # coding: UTF-8
 Encoding.default_internal = 'UTF-8' if defined? Encoding
 
-gem 'test-unit', '>= 2' # necessary when not using bundle exec
-
 require 'test/unit'
-require 'nokogiri'
 
 require 'redcarpet'
 require 'redcarpet/render_strip'
 require 'redcarpet/render_man'
-require 'redcarpet/compat'
 
 class Redcarpet::TestCase < Test::Unit::TestCase
-  def html_equal(html_a, html_b)
-    assert_equal Nokogiri::HTML::DocumentFragment.parse(html_a).to_html,
-      Nokogiri::HTML::DocumentFragment.parse(html_b).to_html
+  def assert_renders(html, markdown)
+    assert_equal html, render(markdown)
   end
 
-  def assert_renders(html, markdown)
-    html_equal html, parser.render(markdown)
+  def render(markdown, options = {})
+    options = options.fetch(:with, {})
+
+    if options.kind_of?(Array)
+      options = Hash[options.map {|o| [o, true]}]
+    end
+
+    render = renderer.new(options)
+    parser = Redcarpet::Markdown.new(render, options)
+
+    parser.render(markdown)
   end
 
   private
 
-  def parser
-    @parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+  def renderer
+    @renderer ||= Redcarpet::Render::HTML
   end
 end