redcarpet 3.3.4 → 3.4.0

data/ext/redcarpet/rc_markdown.c

@@ -86,7 +86,7 @@ rb_redcarpet_md__free(void *markdown)
 
 static VALUE rb_redcarpet_md__new(int argc, VALUE *argv, VALUE klass)
 {
-	VALUE rb_markdown, rb_rndr, hash;
+	VALUE rb_markdown, rb_rndr, hash, rndr_options;
 	unsigned int extensions = 0;
 
 	struct rb_redcarpet_rndr *rndr;
@@ -103,6 +103,12 @@ static VALUE rb_redcarpet_md__new(int argc, VALUE *argv, VALUE klass)
 
 	Data_Get_Struct(rb_rndr, struct rb_redcarpet_rndr, rndr);
 
+	/* Merge the current options in the @options hash */
+	if (hash != Qnil) {
+		rndr_options = rb_iv_get(rb_rndr, "@options");
+		rb_funcall(rndr_options, rb_intern("merge!"), 1, hash);
+	}
+
 	markdown = sd_markdown_new(extensions, 16, &rndr->callbacks, &rndr->options);
 	if (!markdown)
 		rb_raise(rb_eRuntimeError, "Failed to create new Renderer class");

data/ext/redcarpet/rc_render.c

@@ -410,6 +410,9 @@ static void rb_redcarpet__overload(VALUE self, VALUE base_class)
 				dest[i] = source[i];
 		}
 	}
+
+	if (rb_iv_get(self, "@options") == Qnil)
+		rb_iv_set(self, "@options", rb_hash_new());
 }
 
 static VALUE rb_redcarpet_rbase_init(VALUE self)
@@ -429,6 +432,9 @@ static VALUE rb_redcarpet_html_init(int argc, VALUE *argv, VALUE self)
 	if (rb_scan_args(argc, argv, "01", &hash) == 1) {
 		Check_Type(hash, T_HASH);
 
+		/* Give access to the passed options through `@options` */
+		rb_iv_set(self, "@options", hash);
+
 		/* escape_html */
 		if (rb_hash_aref(hash, CSTR2SYM("escape_html")) == Qtrue)
 			render_flags |= HTML_ESCAPE;
@@ -491,6 +497,9 @@ static VALUE rb_redcarpet_htmltoc_init(int argc, VALUE *argv, VALUE self)
 	if (rb_scan_args(argc, argv, "01", &hash) == 1) {
 		Check_Type(hash, T_HASH);
 
+		/* Give access to the passed options through `@options` */
+		rb_iv_set(self, "@options", hash);
+
 		/* escape_html */
 		if (rb_hash_aref(hash, CSTR2SYM("escape_html")) == Qtrue)
 			render_flags |= HTML_ESCAPE;

data/lib/redcarpet.rb

@@ -2,7 +2,7 @@ require 'redcarpet.so'
 require 'redcarpet/compat'
 
 module Redcarpet
-  VERSION = '3.3.4'
+  VERSION = '3.4.0'
 
   class Markdown
     attr_reader :renderer

data/lib/redcarpet/cli.rb

@@ -47,7 +47,7 @@ module Redcarpet
         end
 
         opts.on_tail("-v", "--version", "Display the current version") do
-          STDOUT.write "Redcarpet #{Redcarpet::VERSION}"
+          STDOUT.puts "Redcarpet #{Redcarpet::VERSION}"
           exit
         end
 

data/redcarpet.gemspec

@@ -1,10 +1,10 @@
 # encoding: utf-8
 Gem::Specification.new do |s|
   s.name = 'redcarpet'
-  s.version = '3.3.4'
+  s.version = '3.4.0'
   s.summary = "Markdown that smells nice"
   s.description = 'A fast, safe and extensible Markdown to (X)HTML parser'
-  s.date = '2015-12-25'
+  s.date = '2016-12-25'
   s.email = 'vicent@github.com'
   s.homepage = 'http://github.com/vmg/redcarpet'
   s.authors = ["Natacha Porté", "Vicent Martí"]
@@ -65,6 +65,7 @@ Gem::Specification.new do |s|
   s.executables = ["redcarpet"]
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "rake", "~> 10.5"
   s.add_development_dependency "rake-compiler", "~> 0.9.5"
   s.add_development_dependency "test-unit", "~> 3.1.3"
 end

data/test/custom_render_test.rb

@@ -4,7 +4,15 @@ require 'test_helper'
 class CustomRenderTest < Redcarpet::TestCase
   class SimpleRender < Redcarpet::Render::HTML
     def emphasis(text)
-      "<em class=\"cool\">#{text}</em>"
+      if @options[:no_intra_emphasis]
+        return %(<em class="no_intra_emphasis">#{text}</em>)
+      end
+
+      %(<em class="cool">#{text}</em>)
+    end
+
+    def header(text, level)
+      "My little poney" if @options[:with_toc_data]
     end
   end
 
@@ -14,6 +22,20 @@ class CustomRenderTest < Redcarpet::TestCase
       md.render("This is *just* a test")
   end
 
+  def test_renderer_options
+    parser = Redcarpet::Markdown.new(SimpleRender.new(with_toc_data: true))
+    output = parser.render("# A title")
+
+    assert_match "My little poney", output
+  end
+
+  def test_markdown_options
+    parser = Redcarpet::Markdown.new(SimpleRender, no_intra_emphasis: true)
+    output = parser.render("*foo*")
+
+    assert_match "no_intra_emphasis", output
+  end
+
   class NilPreprocessRenderer < Redcarpet::Render::HTML
     def preprocess(fulldoc)
       nil
@@ -25,4 +47,11 @@ class CustomRenderTest < Redcarpet::TestCase
     assert_equal(nil,md.render("Anything"))
   end
 
+  def test_base_render_without_quote_callback
+    # Regression test for https://github.com/vmg/redcarpet/issues/569
+    render = Class.new(Redcarpet::Render::Base)
+    parser = Redcarpet::Markdown.new render.new, quote: true
+
+    assert_equal "", parser.render(%(a "quote"))
+  end
 end

data/test/html5_test.rb

@@ -2,68 +2,81 @@ require 'test_helper'
 
 class HTML5Test < Redcarpet::TestCase
   def test_that_html5_works
-    section = <<EOS
-<section>
-  <p>The quick brown fox jumps over the lazy dog.</p>
-</section>
-EOS
+    section = <<-HTML.chomp.strip_heredoc
+      <section>
+        <p>The quick brown fox jumps over the lazy dog.</p>
+      </section>
+    HTML
 
-    figure = <<EOS
-<figure>
-  <img src="http://example.org/image.jpg" alt="">
-  <figcaption>
-    <p>Hello world!</p>
-  </figcaption>
-</figure>
-EOS
+    figure = <<-HTML.chomp.strip_heredoc
+      <figure>
+        <img src="http://example.org/image.jpg" alt="">
+        <figcaption>
+          <p>Hello world!</p>
+        </figcaption>
+      </figure>
+    HTML
 
     assert_renders section, section
     assert_renders figure, figure
   end
 
   def test_that_html5_works_with_code_blocks
-    section = <<EOS
+    section = <<-HTML
 \t<section>
 \t\t<p>The quick brown fox jumps over the lazy dog.</p>
 \t</section>
-EOS
+    HTML
 
-    section_expected = <<EOE
-<pre><code>&lt;section&gt;
-    &lt;p&gt;The quick brown fox jumps over the lazy dog.&lt;/p&gt;
-&lt;/section&gt;
-</code></pre>
-EOE
+    section_expected = <<-HTML.chomp.strip_heredoc
+      <pre><code>&lt;section&gt;
+          &lt;p&gt;The quick brown fox jumps over the lazy dog.&lt;/p&gt;
+      &lt;/section&gt;
+      </code></pre>
+    HTML
 
-    header = <<EOS
+    header = <<-HTML
     <header>
         <hgroup>
             <h1>Section heading</h1>
             <h2>Subhead</h2>
         </hgroup>
     </header>
-EOS
+    HTML
 
-    header_expected = <<EOE
-<pre><code>&lt;header&gt;
-    &lt;hgroup&gt;
-        &lt;h1&gt;Section heading&lt;/h1&gt;
-        &lt;h2&gt;Subhead&lt;/h2&gt;
-    &lt;/hgroup&gt;
-&lt;/header&gt;
-</code></pre>
-EOE
+    header_expected = <<-HTML.chomp.strip_heredoc
+      <pre><code>&lt;header&gt;
+          &lt;hgroup&gt;
+              &lt;h1&gt;Section heading&lt;/h1&gt;
+              &lt;h2&gt;Subhead&lt;/h2&gt;
+          &lt;/hgroup&gt;
+      &lt;/header&gt;
+      </code></pre>
+    HTML
 
     assert_renders section_expected, section
     assert_renders header_expected, header
   end
 
   def test_script_tag_recognition
-    markdown = <<-Md
-<script type="text/javascript">
-  alert('Foo!');
-</script>
-Md
-    assert_renders markdown, markdown
+    html = <<-HTML.chomp.strip_heredoc
+      <script type="text/javascript">
+        alert('Foo!');
+      </script>
+    HTML
+
+    assert_renders html, html
+  end
+
+  def test_new_html5_tags_not_escaped
+    details = <<-HTML.chomp.strip_heredoc
+      <details>
+        log:
+
+      </details>
+    HTML
+
+    assert_renders details, details
   end
+
 end

data/test/html_render_test.rb

@@ -8,20 +8,20 @@ class HTMLRenderTest < Redcarpet::TestCase
 
   # 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
 
     assert_equal expected, render(source, with: [:escape_html])
   end
@@ -30,14 +30,14 @@ EOE
     markdown = 'Through <em>NO</em> <script>DOUBLE NO</script>'
     output   = render(markdown, with: [:filter_html])
 
-    assert_equal "<p>Through NO DOUBLE NO</p>\n", output
+    assert_equal "<p>Through NO DOUBLE NO</p>", output
   end
 
   def test_filter_html_doesnt_break_two_space_hard_break
     markdown = "Lorem,  \nipsum\n"
     output   = render(markdown, with: [:filter_html])
 
-    assert_equal "<p>Lorem,<br>\nipsum</p>\n", output
+    assert_equal "<p>Lorem,<br>\nipsum</p>", output
   end
 
   def test_that_no_image_flag_works
@@ -47,6 +47,12 @@ EOE
     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
     markdown = %([This link](http://example.net/) <a href="links.html">links</a>)
     output   = render(markdown, with: [:no_links])
@@ -58,17 +64,17 @@ EOE
     markdown = "[IRC](irc://chat.freenode.org/#freenode)"
     output   = render(markdown, with: [:safe_links_only])
 
-    assert_equal "<p>[IRC](irc://chat.freenode.org/#freenode)</p>\n", output
+    assert_equal "<p>[IRC](irc://chat.freenode.org/#freenode)</p>", output
   end
 
   def test_that_hard_wrap_works
-    markdown = <<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_match %r{<br>}, output
@@ -82,37 +88,37 @@ EOE
 
   def test_that_link_works_with_quotes
     markdown = %([This'link"is](http://example.net/))
-    expected = %(<p><a href="http://example.net/">This&#39;link&quot;is</a></p>\n)
+    expected = %(<p><a href="http://example.net/">This&#39;link&quot;is</a></p>)
 
     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
 
     assert_equal html, render(markdown)
   end
 
   def test_that_parenthesis_are_handled_into_links
     markdown = %(The [bash man page](man:bash(1))!)
-    expected = %(<p>The <a href="man:bash(1)">bash man page</a>!</p>\n)
+    expected = %(<p>The <a href="man:bash(1)">bash man page</a>!</p>)
 
     assert_equal expected, render(markdown)
   end
@@ -127,42 +133,42 @@ 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" rel="footnote">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" rev="footnote">&#8617;</a></p>
+      </li>
 
-</ol>
-</div>
-HTML
+      </ol>
+      </div>
+    HTML
 
     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
 
     output = render(markdown, with: [:footnotes])
     assert_equal html, output
@@ -170,7 +176,7 @@ HTML
 
   def test_footnotes_enabled_but_missing_definition
     markdown = "Some text with a marker[^1] but no definition."
-    expected = "<p>Some text with a marker[^1] but no definition.</p>\n"
+    expected = "<p>Some text with a marker[^1] but no definition.</p>"
 
     output = render(markdown, with: [:footnotes])
     assert_equal expected, output
@@ -241,8 +247,22 @@ HTML
 
   def test_non_ascii_removal_in_header_anchors
     markdown = "# Glühlampe"
-    html = "<h1 id=\"gl-hlampe\">Glühlampe</h1>\n"
+    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 = "# 見出し"
+    html = "<h1 id=\"part-37870bfa194139f\">見出し</h1>"
+
+    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