redcarpet 3.0.0 → 3.1.0

data/ext/redcarpet/markdown.h

@@ -16,8 +16,8 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-#ifndef UPSKIRT_MARKDOWN_H
-#define UPSKIRT_MARKDOWN_H
+#ifndef MARKDOWN_H__
+#define MARKDOWN_H__
 
 #include "buffer.h"
 #include "autolink.h"
@@ -26,11 +26,6 @@
 extern "C" {
 #endif
 
-#define SUNDOWN_VERSION "1.16.0"
-#define SUNDOWN_VER_MAJOR 1
-#define SUNDOWN_VER_MINOR 16
-#define SUNDOWN_VER_REVISION 0
-
 /********************
  * TYPE DEFINITIONS *
  ********************/
@@ -61,7 +56,9 @@ enum mkd_extensions {
 	MKDEXT_SUPERSCRIPT = (1 << 7),
 	MKDEXT_LAX_SPACING = (1 << 8),
 	MKDEXT_DISABLE_INDENTED_CODE = (1 << 9),
-	MKDEXT_HIGHLIGHT = (1 << 10)
+	MKDEXT_HIGHLIGHT = (1 << 10),
+	MKDEXT_FOOTNOTES = (1 << 11),
+	MKDEXT_QUOTE = (1 << 12)
 };
 
 /* sd_callbacks - functions for rendering parsed data */
@@ -70,7 +67,7 @@ struct sd_callbacks {
 	void (*blockcode)(struct buf *ob, const struct buf *text, const struct buf *lang, void *opaque);
 	void (*blockquote)(struct buf *ob, const struct buf *text, void *opaque);
 	void (*blockhtml)(struct buf *ob,const  struct buf *text, void *opaque);
-	void (*header)(struct buf *ob, const struct buf *text, int level, void *opaque);
+	void (*header)(struct buf *ob, const struct buf *text, int level, char *anchor, void *opaque);
 	void (*hrule)(struct buf *ob, void *opaque);
 	void (*list)(struct buf *ob, const struct buf *text, int flags, void *opaque);
 	void (*listitem)(struct buf *ob, const struct buf *text, int flags, void *opaque);
@@ -78,7 +75,8 @@ struct sd_callbacks {
 	void (*table)(struct buf *ob, const struct buf *header, const struct buf *body, void *opaque);
 	void (*table_row)(struct buf *ob, const struct buf *text, void *opaque);
 	void (*table_cell)(struct buf *ob, const struct buf *text, int flags, void *opaque);
-
+	void (*footnotes)(struct buf *ob, const struct buf *text, void *opaque);
+	void (*footnote_def)(struct buf *ob, const struct buf *text, unsigned int num, void *opaque);
 
 	/* span level callbacks - NULL or return 0 prints the span verbatim */
 	int (*autolink)(struct buf *ob, const struct buf *link, enum mkd_autolink type, void *opaque);
@@ -87,6 +85,7 @@ struct sd_callbacks {
 	int (*emphasis)(struct buf *ob, const struct buf *text, void *opaque);
 	int (*underline)(struct buf *ob, const struct buf *text, void *opaque);
 	int (*highlight)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*quote)(struct buf *ob, const struct buf *text, void *opaque);
 	int (*image)(struct buf *ob, const struct buf *link, const struct buf *title, const struct buf *alt, void *opaque);
 	int (*linebreak)(struct buf *ob, void *opaque);
 	int (*link)(struct buf *ob, const struct buf *link, const struct buf *title, const struct buf *content, void *opaque);
@@ -94,6 +93,7 @@ struct sd_callbacks {
 	int (*triple_emphasis)(struct buf *ob, const struct buf *text, void *opaque);
 	int (*strikethrough)(struct buf *ob, const struct buf *text, void *opaque);
 	int (*superscript)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*footnote_ref)(struct buf *ob, unsigned int num, void *opaque);
 
 	/* low level callbacks - NULL copies input directly into the output */
 	void (*entity)(struct buf *ob, const struct buf *entity, void *opaque);
@@ -131,9 +131,6 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 extern void
 sd_markdown_free(struct sd_markdown *md);
 
-extern void
-sd_version(int *major, int *minor, int *revision);
-
 #ifdef __cplusplus
 }
 #endif

data/ext/redcarpet/rc_markdown.c

@@ -53,6 +53,9 @@ static void rb_redcarpet_md_flags(VALUE hash, unsigned int *enabled_extensions_p
 	if (rb_hash_lookup(hash, CSTR2SYM("highlight")) == Qtrue)
 		extensions |= MKDEXT_HIGHLIGHT;
 
+	if (rb_hash_lookup(hash, CSTR2SYM("quote")) == Qtrue)
+		extensions |= MKDEXT_QUOTE;
+
 	if (rb_hash_lookup(hash, CSTR2SYM("lax_spacing")) == Qtrue)
 		extensions |= MKDEXT_LAX_SPACING;
 
@@ -62,6 +65,9 @@ static void rb_redcarpet_md_flags(VALUE hash, unsigned int *enabled_extensions_p
 	if (rb_hash_lookup(hash, CSTR2SYM("superscript")) == Qtrue)
 		extensions |= MKDEXT_SUPERSCRIPT;
 
+	if (rb_hash_lookup(hash, CSTR2SYM("footnotes")) == Qtrue)
+		extensions |= MKDEXT_FOOTNOTES;
+
 	*enabled_extensions_p = extensions;
 }
 

data/ext/redcarpet/rc_render.c

@@ -61,9 +61,9 @@ rndr_raw_block(struct buf *ob, const struct buf *text, void *opaque)
 }
 
 static void
-rndr_header(struct buf *ob, const struct buf *text, int level, void *opaque)
+rndr_header(struct buf *ob, const struct buf *text, int level, char *anchor, void *opaque)
 {
-	BLOCK_CALLBACK("header", 2, buf2str(text), INT2FIX(level));
+	BLOCK_CALLBACK("header", 3, buf2str(text), INT2FIX(level), rb_str_new2(anchor));
 }
 
 static void
@@ -130,7 +130,17 @@ rndr_tablecell(struct buf *ob, const struct buf *text, int align, void *opaque)
 	BLOCK_CALLBACK("table_cell", 2, buf2str(text), rb_align);
 }
 
+static void
+rndr_footnotes(struct buf *ob, const struct buf *text, void *opaque)
+{
+	BLOCK_CALLBACK("footnotes", 1, buf2str(text));
+}
 
+static void
+rndr_footnote_def(struct buf *ob, const struct buf *text, unsigned int num, void *opaque)
+{
+	BLOCK_CALLBACK("footnote_def", 2, buf2str(text), INT2FIX(num));
+}
 
 
 /***
@@ -173,6 +183,12 @@ rndr_highlight(struct buf *ob, const struct buf *text, void *opaque)
 	SPAN_CALLBACK("highlight", 1, buf2str(text));
 }
 
+static int
+rndr_quote(struct buf *ob, const struct buf *text, void *opaque)
+{
+	SPAN_CALLBACK("quote", 1, buf2str(text));
+}
+
 static int
 rndr_image(struct buf *ob, const struct buf *link, const struct buf *title, const struct buf *alt, void *opaque)
 {
@@ -215,6 +231,12 @@ rndr_superscript(struct buf *ob, const struct buf *text, void *opaque)
 	SPAN_CALLBACK("superscript", 1, buf2str(text));
 }
 
+static int
+rndr_footnote_ref(struct buf *ob, unsigned int num, void *opaque)
+{
+	SPAN_CALLBACK("footnote_ref", 1, INT2FIX(num));
+}
+
 /**
  * direct writes
  */
@@ -275,6 +297,8 @@ static struct sd_callbacks rb_redcarpet_callbacks = {
 	rndr_table,
 	rndr_tablerow,
 	rndr_tablecell,
+	rndr_footnotes,
+	rndr_footnote_def,
 
 	rndr_autolink,
 	rndr_codespan,
@@ -282,6 +306,7 @@ static struct sd_callbacks rb_redcarpet_callbacks = {
 	rndr_emphasis,
 	rndr_underline,
 	rndr_highlight,
+	rndr_quote,
 	rndr_image,
 	rndr_linebreak,
 	rndr_link,
@@ -289,6 +314,7 @@ static struct sd_callbacks rb_redcarpet_callbacks = {
 	rndr_triple_emphasis,
 	rndr_strikethrough,
 	rndr_superscript,
+	rndr_footnote_ref,
 
 	rndr_entity,
 	rndr_normal_text,
@@ -309,6 +335,8 @@ static const char *rb_redcarpet_method_names[] = {
 	"table",
 	"table_row",
 	"table_cell",
+	"footnotes",
+	"footnote_def",
 
 	"autolink",
 	"codespan",
@@ -316,6 +344,7 @@ static const char *rb_redcarpet_method_names[] = {
 	"emphasis",
 	"underline",
 	"highlight",
+	"quote",
 	"image",
 	"linebreak",
 	"link",
@@ -323,6 +352,7 @@ static const char *rb_redcarpet_method_names[] = {
 	"triple_emphasis",
 	"strikethrough",
 	"superscript",
+	"footnote_ref",
 
 	"entity",
 	"normal_text",
@@ -439,12 +469,26 @@ static VALUE rb_redcarpet_html_init(int argc, VALUE *argv, VALUE self)
 	return Qnil;
 }
 
-static VALUE rb_redcarpet_htmltoc_init(VALUE self)
+static VALUE rb_redcarpet_htmltoc_init(int argc, VALUE *argv, VALUE self)
 {
 	struct rb_redcarpet_rndr *rndr;
+	int nesting_level = 6;
+	VALUE hash, key = Qnil;
+
 	Data_Get_Struct(self, struct rb_redcarpet_rndr, rndr);
 
-	sdhtml_toc_renderer(&rndr->callbacks, (struct html_renderopt *)&rndr->options.html);
+	if (rb_scan_args(argc, argv, "01", &hash) == 1) {
+		Check_Type(hash, T_HASH);
+
+		key = CSTR2SYM("nesting_level");
+
+		if (RTEST(rb_hash_aref(hash, key))) {
+			Check_Type(rb_hash_aref(hash, key), T_FIXNUM);
+			nesting_level = NUM2INT(rb_hash_aref(hash, key));
+		}
+	}
+
+	sdhtml_toc_renderer(&rndr->callbacks, (struct html_renderopt *)&rndr->options.html, nesting_level);
 	rb_redcarpet__overload(self, rb_cRenderHTML_TOC);
 
 	return Qnil;
@@ -478,7 +522,7 @@ void Init_redcarpet_rndr()
 	rb_define_method(rb_cRenderHTML, "initialize", rb_redcarpet_html_init, -1);
 
 	rb_cRenderHTML_TOC = rb_define_class_under(rb_mRender, "HTML_TOC", rb_cRenderBase);
-	rb_define_method(rb_cRenderHTML_TOC, "initialize", rb_redcarpet_htmltoc_init, 0);
+	rb_define_method(rb_cRenderHTML_TOC, "initialize", rb_redcarpet_htmltoc_init, -1);
 
 	rb_mSmartyPants = rb_define_module_under(rb_mRender, "SmartyPants");
 	rb_define_method(rb_mSmartyPants, "postprocess", rb_redcarpet_smartypants_render, 1);

data/ext/redcarpet/stack.c

@@ -51,15 +51,6 @@ redcarpet_stack_init(struct stack *st, size_t initial_size)
 	return redcarpet_stack_grow(st, initial_size);
 }
 
-void *
-redcarpet_stack_pop(struct stack *st)
-{
-	if (!st->size)
-		return NULL;
-
-	return st->item[--st->size];
-}
-
 int
 redcarpet_stack_push(struct stack *st, void *item)
 {
@@ -69,13 +60,3 @@ redcarpet_stack_push(struct stack *st, void *item)
 	st->item[st->size++] = item;
 	return 0;
 }
-
-void *
-redcarpet_stack_top(struct stack *st)
-{
-	if (!st->size)
-		return NULL;
-
-	return st->item[st->size - 1];
-}
-

data/ext/redcarpet/stack.h

@@ -19,9 +19,6 @@ int redcarpet_stack_init(struct stack *, size_t);
 
 int redcarpet_stack_push(struct stack *, void *);
 
-void *redcarpet_stack_pop(struct stack *);
-void *redcarpet_stack_top(struct stack *);
-
 #ifdef __cplusplus
 }
 #endif

data/lib/redcarpet.rb

@@ -1,7 +1,7 @@
 require 'redcarpet.so'
 
 module Redcarpet
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 
   class Markdown
     attr_reader :renderer
@@ -68,9 +68,9 @@ class RedcarpetCompat
   def to_html(*_dummy)
     @markdown.render(@text)
   end
-  
+
   private
-  
+
   EXTENSION_MAP = {
     # old name => new name
     :autolink => :autolink,
@@ -95,10 +95,10 @@ class RedcarpetCompat
     :smart => nil,
     :strict => nil
   }
-  
-  RENDERER_OPTIONS = [:filter_html, :no_images, :no_links, :no_styles, 
+
+  RENDERER_OPTIONS = [:filter_html, :no_images, :no_links, :no_styles,
     :safe_links_only, :with_toc_data, :hard_wrap, :prettify, :xhtml]
-  
+
   def rename_extensions(exts)
     exts.map do |old_name|
       if new_name = EXTENSION_MAP[old_name]
@@ -108,7 +108,7 @@ class RedcarpetCompat
       end
     end.compact
   end
-  
+
   # Returns two hashes, the extensions and renderer options
   # given the extension list
   def parse_extensions_and_renderer_options(exts)
@@ -116,7 +116,7 @@ class RedcarpetCompat
     exts.partition {|ext| !RENDERER_OPTIONS.include?(ext) }.
       map {|list| list_to_truthy_hash(list) }
   end
-  
+
   # Turns a list of symbols into a hash of <tt>symbol => true</tt>.
   def list_to_truthy_hash(list)
     list.inject({}) {|h, k| h[k] = true; h }

data/lib/redcarpet/render_strip.rb

@@ -1,4 +1,3 @@
-
 module Redcarpet
   module Render
     # Markdown-stripping renderer. Turns Markdown into plaintext
@@ -16,6 +15,9 @@ module Redcarpet
         :triple_emphasis, :strikethrough,
         :superscript,
 
+        # footnotes
+        :footnotes, :footnote_def, :footnote_ref,
+
         # low level rendering
         :entity, :normal_text
       ].each do |method|
@@ -33,7 +35,7 @@ module Redcarpet
         text + "\n"
       end
 
-      def header(text, header_level)
+      def header(text, header_level, anchor)
         text + "\n"
       end
     end

data/redcarpet.gemspec

@@ -1,14 +1,15 @@
 # encoding: utf-8
 Gem::Specification.new do |s|
   s.name = 'redcarpet'
-  s.version = '3.0.0'
+  s.version = '3.1.0'
   s.summary = "Markdown that smells nice"
   s.description = 'A fast, safe and extensible Markdown to (X)HTML parser'
-  s.date = '2013-07-09'
+  s.date = '2014-02-08'
   s.email = 'vicent@github.com'
   s.homepage = 'http://github.com/vmg/redcarpet'
   s.authors = ["Natacha Porté", "Vicent Martí"]
   s.license = 'MIT'
+  s.required_ruby_version = '>= 1.9.2'
   # = MANIFEST =
   s.files = %w[
     COPYING
@@ -43,6 +44,7 @@ Gem::Specification.new do |s|
     test/test_helper.rb
     test/custom_render_test.rb
     test/html_render_test.rb
+    test/html_toc_render_test.rb
     test/markdown_test.rb
     test/pathological_inputs_test.rb
     test/redcarpet_compat_test.rb
@@ -60,6 +62,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "nokogiri", "~> 1.6.0"
   s.add_development_dependency "rake-compiler", "~> 0.8.3"
   s.add_development_dependency "test-unit", "~> 2.5.4"
-  s.add_development_dependency "bluecloth", "~> 2.2.0"
-  s.add_development_dependency "kramdown", "~> 1.0.2"
 end

data/test/html_render_test.rb

@@ -11,6 +11,8 @@ class HTMLRenderTest < Test::Unit::TestCase
       :safe_links => Redcarpet::Render::HTML.new(:safe_links_only => true),
       :escape_html => Redcarpet::Render::HTML.new(:escape_html => true),
       :hard_wrap => Redcarpet::Render::HTML.new(:hard_wrap => true),
+      :toc_data => Redcarpet::Render::HTML.new(:with_toc_data => true),
+      :prettify => Redcarpet::Render::HTML.new(:prettify => true)
     }
   end
 
@@ -131,9 +133,91 @@ HTML
     assert output.include? '<a href="http://bar.com">'
   end
 
-  def test_that_comments_arent_escaped
-    input = "<!-- This is a nice comment! -->"
-    output = render_with(@rndr[:escape_html], input)
-    assert output.include? input
+  def test_that_footnotes_work
+    markdown = <<-MD
+This is a footnote.[^1]
+
+[^1]: It provides additional information.
+MD
+
+    html = <<HTML
+<p>This is a footnote.<sup id="fnref1"><a href="#fn1" rel="footnote">1</a></sup></p>
+
+<div class="footnotes">
+<hr>
+<ol>
+
+<li id="fn1">
+<p>It provides additional information.&nbsp;<a href="#fnref1" rev="footnote">&#8617;</a></p>
+</li>
+
+</ol>
+</div>
+HTML
+
+    renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :footnotes => true)
+    output = renderer.render(markdown)
+    assert_equal html, output
+  end
+
+  def test_footnotes_enabled_but_missing_marker
+    markdown = <<MD
+Some text without a marker
+
+[^1] And a trailing definition
+MD
+    html = <<HTML
+<p>Some text without a marker</p>
+
+<p>[^1] And a trailing definition</p>
+HTML
+
+    renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :footnotes => true)
+    output = renderer.render(markdown)
+    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"
+
+    renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :footnotes => true)
+    output = renderer.render(markdown)
+    assert_equal html, 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 = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :autolink => true)
+    output = renderer.render(markdown)
+
+    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
+
+~~~ruby
+some
+code
+~~~
+
+Bar
+Markdown
+
+    renderer = Redcarpet::Markdown.new(@rndr[:prettify], fenced_code_blocks: true)
+    output = renderer.render(text)
+
+    assert output.include?("<code class=\"prettyprint ruby\">")
   end
 end