redcarpet 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43a33037d69f1dd517faf8a01c848668c225418d
-  data.tar.gz: 79ecfd87ac885f4c9a8af16dd9059927e8fe4c52
+  metadata.gz: f1ec4be4477178cfdbddb7bef23823f45b62fa49
+  data.tar.gz: 8d444aba2d98347c039435dadc795d642d92c7c1
 SHA512:
-  metadata.gz: 976b1611046fb3dc9423d4100d67ba4539e54484ea25073f8503a5d1c4ebc483bec3d9ee704890ab7f9ffaf9ac515f39fd682d81cee132c3c243463423714eba
-  data.tar.gz: 26a7e3d6bdaffc67c59f02b7935a2aea3a42d7cd1909854d16aa36a4135abcf882b13ed7d2e83321a4b8cd65c8aa83d0296c5b2aef221860ecf49fd406fa76d8
+  metadata.gz: 6f7de4add3ffb9325b0feb63d5353cc8d946704fbd9835a7e549d8adcab9509ac78c832089fce6fb869d40b836a6db79c7050a3f469946bb33d740104f4c3164
+  data.tar.gz: 8cf876f963adce44ba5513028e1a01b0a79beb649233f7e7f2355b26e4148d28991c9216d32c711caa96e344713ef51886a4e85e784ce8af95f1c34fc55b3bfc

data/README.markdown

@@ -332,6 +332,43 @@ SmartyPants works on top of already-rendered HTML, and will ignore replacements
 inside the content of HTML tags and inside specific HTML blocks such as
 `<code>` or `<pre>`.
 
+What? You really want to mix Markdown renderers?
+------------------------------------------------
+
+Redcarpet used to be a drop-in replacement for Redcloth. This is no longer the
+case since version 2 -- it now has its own API, but retains the old name. Yes,
+that does mean that Redcarpet is not backwards-compatible with the 1.X
+versions.
+
+Each renderer has its own API and its own set of extensions: you should choose one
+(it doesn't have to be Redcarpet, though that would be great!), write your
+software accordingly, and force your users to install it. That's the
+only way to have reliable and predictable Markdown output on your program.
+
+Markdown is already ill-specified enough; if you create software that is
+renderer-independent, the results will be completely unreliable!
+
+Still, if major forces (let's say, tornadoes or other natural disasters) force you
+to keep a Markdown-compatibility layer, Redcarpet also supports this:
+
+~~~~~ ruby
+require 'redcarpet/compat'
+~~~~~
+
+Requiring the compatibility library will declare a `Markdown` class with the
+classical RedCloth API, e.g.
+
+~~~~~ ruby
+Markdown.new('this is my text').to_html
+~~~~~
+
+This class renders 100% standards compliant Markdown with 0 extensions. Nada.
+Don't even try to enable extensions with a compatibility layer, because
+that's a maintenance nightmare and won't work.
+
+On a related topic: if your Markdown gem has a `lib/markdown.rb` file that
+monkeypatches the Markdown class, you're a terrible human being. Just saying.
+
 Boring legal stuff
 ------------------
 

data/bin/redcarpet

@@ -1,43 +1,7 @@
 #!/usr/bin/env ruby
-# Usage: redcarpet [--parse-<extension>...] [--render-<extension>...] [--smarty] [<file>...]
-# Convert one or more Markdown files to HTML and write to standard output. With
-# no <file> or when <file> is '-', read Markdown source text from standard input.
-# With <extension>s, perform additional Markdown processing before writing output.
-# With --smarty, use the SmartyHTML renderer
-if ARGV.include?('--help') or ARGV.include?('-h')
-  File.read(__FILE__).split("\n").grep(/^# /).each do |line|
-    puts line[2..-1]
-  end
-  exit 0
-end
+lib_path = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib_path)
 
-require 'redcarpet'
+require 'redcarpet/cli'
 
-if ARGV.include?('--version') or ARGV.include?('-v')
-  puts "Redcarpet #{Redcarpet::VERSION}"
-  exit 0
-end
-
-root = File.expand_path('../../', __FILE__)
-$:.unshift File.expand_path('lib', root)
-
-render_extensions = {}
-parse_extensions = {}
-renderer = Redcarpet::Render::HTML
-
-ARGV.delete_if do |arg|
-  if arg =~ /^--render-([\w-]+)$/
-    arg = $1.gsub('-', '_')
-    render_extensions[arg.to_sym] = true
-  elsif arg =~ /^--parse-([\w-]+)$/
-    arg = $1.gsub('-', '_')
-    parse_extensions[arg.to_sym] = true
-  elsif arg == '--smarty'
-    renderer = Redcarpet::Render::SmartyHTML
-  else
-    false
-  end
-end
-
-render = renderer.new(render_extensions)
-STDOUT.write(Redcarpet::Markdown.new(render, parse_extensions).render(ARGF.read))
+Redcarpet::CLI.process(ARGV)

data/ext/redcarpet/buffer.c

@@ -94,14 +94,14 @@ bufnew(size_t unit)
 
 /* bufnullterm: NULL-termination of the string array */
 const char *
-bufcstr(struct buf *buf)
+bufcstr(const struct buf *buf)
 {
 	assert(buf && buf->unit);
 
 	if (buf->size < buf->asize && buf->data[buf->size] == 0)
 		return (char *)buf->data;
 
-	if (buf->size + 1 <= buf->asize || bufgrow(buf, buf->size + 1) == 0) {
+	if (buf->size + 1 <= buf->asize || bufgrow(buf, buf->size + 1) == BUF_OK) {
 		buf->data[buf->size] = 0;
 		return (char *)buf->data;
 	}
@@ -118,7 +118,7 @@ bufprintf(struct buf *buf, const char *fmt, ...)
 
 	assert(buf && buf->unit);
 
-	if (buf->size >= buf->asize && bufgrow(buf, buf->size + 1) < 0)
+	if (buf->size >= buf->asize && bufgrow(buf, buf->size + 1) < BUF_OK)
 		return;
 
 	va_start(ap, fmt);
@@ -136,7 +136,7 @@ bufprintf(struct buf *buf, const char *fmt, ...)
 	}
 
 	if ((size_t)n >= buf->asize - buf->size) {
-		if (bufgrow(buf, buf->size + n + 1) < 0)
+		if (bufgrow(buf, buf->size + n + 1) < BUF_OK)
 			return;
 
 		va_start(ap, fmt);
@@ -156,7 +156,7 @@ bufput(struct buf *buf, const void *data, size_t len)
 {
 	assert(buf && buf->unit);
 
-	if (buf->size + len > buf->asize && bufgrow(buf, buf->size + len) < 0)
+	if (buf->size + len > buf->asize && bufgrow(buf, buf->size + len) < BUF_OK)
 		return;
 
 	memcpy(buf->data + buf->size, data, len);
@@ -177,7 +177,7 @@ bufputc(struct buf *buf, int c)
 {
 	assert(buf && buf->unit);
 
-	if (buf->size + 1 > buf->asize && bufgrow(buf, buf->size + 1) < 0)
+	if (buf->size + 1 > buf->asize && bufgrow(buf, buf->size + 1) < BUF_OK)
 		return;
 
 	buf->data[buf->size] = c;

data/ext/redcarpet/buffer.h

@@ -55,7 +55,7 @@ int bufgrow(struct buf *, size_t);
 struct buf *bufnew(size_t) __attribute__ ((malloc));
 
 /* bufnullterm: NUL-termination of the string array (making a C-string) */
-const char *bufcstr(struct buf *);
+const char *bufcstr(const struct buf *);
 
 /* bufprefix: compare the beginning of a buffer with a string */
 int bufprefix(const struct buf *buf, const char *prefix);

data/ext/redcarpet/html.c

@@ -17,7 +17,6 @@
 
 #include "markdown.h"
 #include "html.h"
-#include "ruby.h"
 #include <string.h>
 #include <stdlib.h>
 #include <stdio.h>
@@ -125,7 +124,7 @@ rndr_blockcode(struct buf *ob, const struct buf *text, const struct buf *lang, v
 	if (lang && lang->size) {
 		size_t i, cls;
 		if (options->flags & HTML_PRETTIFY) {
-			BUFPUTSL(ob, "<pre><code class=\"prettyprint ");
+			BUFPUTSL(ob, "<pre><code class=\"prettyprint lang-");
 			cls++;
 		} else {
 			BUFPUTSL(ob, "<pre><code class=\"");
@@ -265,17 +264,56 @@ rndr_linebreak(struct buf *ob, void *opaque)
 	return 1;
 }
 
-char *header_anchor(struct buf *text)
+char *header_anchor(const struct buf *buffer)
 {
-	VALUE str = rb_str_new2(bufcstr(text));
-	VALUE space_regex = rb_reg_new(" +", 2 /* length */, 0);
-	VALUE tags_regex = rb_reg_new("<\\/?[^>]*>", 10, 0);
+	size_t i = 0, j, k, size = buffer->size;
 
-	VALUE heading = rb_funcall(str, rb_intern("gsub"), 2, space_regex, rb_str_new2("-"));
-	heading = rb_funcall(heading, rb_intern("gsub"), 2, tags_regex, rb_str_new2(""));
-	heading = rb_funcall(heading, rb_intern("downcase"), 0);
+	char text[size];
+	strcpy(text, bufcstr(buffer));
 
-	return StringValueCStr(heading);
+	char raw_string[size];
+
+	/* Strip down the inline HTML markup if needed */
+	if (strchr(text, '<') < strchr(text, '>')) {
+		char* part = strtok(text, "<>");
+
+		/* Once every two times, the yielded token is the
+		   content of a HTML tag so we don't need to copy it */
+		for (k = 0; part != NULL; k++) {
+			if (k == 0)
+				strcpy(raw_string, part);
+			else if (k % 2 == 0)
+				strcat(raw_string, part);
+
+			part = strtok(NULL, "<>");
+		}
+
+		size = strlen(raw_string);
+	} else {
+		strcpy(raw_string, text);
+	}
+
+	char* heading = malloc(size * sizeof(char));
+
+	/* Remove leading stripped chars */
+	while (STRIPPED_CHAR(raw_string[i])) i++;
+
+	/* Dasherize the string removing extra white spaces
+	   and stripped chars */
+	for (j = 0; i < size; i++, j++) {
+		while ((i+1) < size && STRIPPED_CHAR(raw_string[i]) && STRIPPED_CHAR(raw_string[i+1]))
+			i++;
+
+		if (STRIPPED_CHAR(raw_string[i]) && i == size - 1)
+			break;
+		else if (STRIPPED_CHAR(raw_string[i]))
+			heading[j] = '-';
+		else
+			heading[j] = tolower(raw_string[i]);
+	}
+
+	heading[j++] = '\0';
+	return heading;
 }
 
 static void
@@ -395,15 +433,30 @@ rndr_paragraph(struct buf *ob, const struct buf *text, void *opaque)
 static void
 rndr_raw_block(struct buf *ob, const struct buf *text, void *opaque)
 {
-	size_t org, sz;
-	if (!text) return;
-	sz = text->size;
-	while (sz > 0 && text->data[sz - 1] == '\n') sz--;
-	org = 0;
-	while (org < sz && text->data[org] == '\n') org++;
-	if (org >= sz) return;
-	if (ob->size) bufputc(ob, '\n');
-	bufput(ob, text->data + org, sz - org);
+	size_t org, size;
+	struct html_renderopt *options = opaque;
+
+	if (!text)
+		return;
+
+	size = text->size;
+	while (size > 0 && text->data[size - 1] == '\n')
+		size--;
+
+	for (org = 0; org < size && text->data[org] == '\n'; ++org)
+
+	if (org >= size)
+		return;
+
+	/* Remove style tags if the `:no_styles` option is enabled */
+	if ((options->flags & HTML_SKIP_STYLE) != 0 &&
+		sdhtml_is_tag(text->data, size, "style"))
+		return;
+
+	if (ob->size)
+		bufputc(ob, '\n');
+
+	bufput(ob, text->data + org, size - org);
 	bufputc(ob, '\n');
 }
 
@@ -429,10 +482,15 @@ static int
 rndr_image(struct buf *ob, const struct buf *link, const struct buf *title, const struct buf *alt, void *opaque)
 {
 	struct html_renderopt *options = opaque;
-	if (!link || !link->size) return 0;
+
+	if (link != NULL && (options->flags & HTML_SAFELINK) != 0 && !sd_autolink_issafe(link->data, link->size))
+		return 0;
 
 	BUFPUTSL(ob, "<img src=\"");
-	escape_href(ob, link->data, link->size);
+
+	if (link && link->size)
+		escape_href(ob, link->data, link->size);
+
 	BUFPUTSL(ob, "\" alt=\"");
 
 	if (alt && alt->size)
@@ -440,7 +498,8 @@ rndr_image(struct buf *ob, const struct buf *link, const struct buf *title, cons
 
 	if (title && title->size) {
 		BUFPUTSL(ob, "\" title=\"");
-		escape_html(ob, title->data, title->size); }
+		escape_html(ob, title->data, title->size);
+	}
 
 	bufputs(ob, USE_XHTML(options) ? "\"/>" : "\">");
 	return 1;
@@ -452,7 +511,7 @@ rndr_raw_html(struct buf *ob, const struct buf *text, void *opaque)
 	struct html_renderopt *options = opaque;
 
 	/* HTML_ESCAPE overrides SKIP_HTML, SKIP_STYLE, SKIP_LINKS and SKIP_IMAGES
-	* It doens't see if there are any valid tags, just escape all of them. */
+	   It doesn't see if there are any valid tags, just escape all of them. */
 	if((options->flags & HTML_ESCAPE) != 0) {
 		escape_html(ob, text->data, text->size);
 		return 1;
@@ -636,7 +695,14 @@ toc_header(struct buf *ob, const struct buf *text, int level, void *opaque)
 		}
 
 		bufprintf(ob, "<a href=\"#%s\">", header_anchor(text));
-		if (text) escape_html(ob, text->data, text->size);
+
+		if (text) {
+			if (options->flags & HTML_ESCAPE)
+				escape_html(ob, text->data, text->size);
+			else
+				bufput(ob, text->data, text->size);
+		}
+
 		BUFPUTSL(ob, "</a>\n");
 	}
 }
@@ -661,7 +727,7 @@ toc_finalize(struct buf *ob, void *opaque)
 }
 
 void
-sdhtml_toc_renderer(struct sd_callbacks *callbacks, struct html_renderopt *options, int nesting_level)
+sdhtml_toc_renderer(struct sd_callbacks *callbacks, struct html_renderopt *options, unsigned int render_flags)
 {
 	static const struct sd_callbacks cb_default = {
 		NULL,
@@ -702,8 +768,7 @@ sdhtml_toc_renderer(struct sd_callbacks *callbacks, struct html_renderopt *optio
 	};
 
 	memset(options, 0x0, sizeof(struct html_renderopt));
-	options->flags = HTML_TOC;
-	options->toc_data.nesting_level = nesting_level;
+	options->flags = render_flags;
 
 	memcpy(callbacks, &cb_default, sizeof(struct sd_callbacks));
 }

data/ext/redcarpet/html.h

@@ -65,11 +65,17 @@ extern void
 sdhtml_renderer(struct sd_callbacks *callbacks, struct html_renderopt *options_ptr, unsigned int render_flags);
 
 extern void
-sdhtml_toc_renderer(struct sd_callbacks *callbacks, struct html_renderopt *options_ptr, int nesting_level);
+sdhtml_toc_renderer(struct sd_callbacks *callbacks, struct html_renderopt *options_ptr, unsigned int render_flags);
 
 extern void
 sdhtml_smartypants(struct buf *ob, const uint8_t *text, size_t size);
 
+/* header method used internally in Redcarpet */
+char *header_anchor(const struct buf *buffer);
+
+#define STRIPPED_CHARS " -&+$,/:;=?@\"#{}|^~[]`\\*()%.!'"
+#define STRIPPED_CHAR(x) (strchr(STRIPPED_CHARS, x) != NULL)
+
 #ifdef __cplusplus
 }
 #endif

data/ext/redcarpet/markdown.c

@@ -1119,7 +1119,7 @@ char_link(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t offset
 				title_e--;
 
 			/* checking for closing quote presence */
-			if (data[title_e] != '\'' &&  data[title_e] != '"') {
+			if (data[title_e] != '\'' && data[title_e] != '"') {
 				title_b = title_e = 0;
 				link_e = i;
 			}
@@ -1548,7 +1548,7 @@ prefix_oli(uint8_t *data, size_t size)
 	return i + 2;
 }
 
-/* prefix_uli • returns ordered list item prefix */
+/* prefix_uli • returns unordered list item prefix */
 static size_t
 prefix_uli(uint8_t *data, size_t size)
 {
@@ -1620,7 +1620,7 @@ parse_blockquote(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t
 static size_t
 parse_htmlblock(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t size, int do_render);
 
-/* parse_blockquote • handles parsing of a regular paragraph */
+/* parse_paragraph • handles parsing of a regular paragraph */
 static size_t
 parse_paragraph(struct buf *ob, struct sd_markdown *rndr, uint8_t *data, size_t size)
 {
@@ -2801,6 +2801,7 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 
 	struct buf *text;
 	size_t beg, end;
+	int in_fence = 0;
 
 	text = bufnew(64);
 	if (!text)
@@ -2812,7 +2813,8 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 	/* reset the references table */
 	memset(&md->refs, 0x0, REF_TABLE_SIZE * sizeof(void *));
 
-	int footnotes_enabled = md->ext_flags & MKDEXT_FOOTNOTES;
+	int footnotes_enabled  = md->ext_flags & MKDEXT_FOOTNOTES;
+	int codefences_enabled = md->ext_flags & MKDEXT_FENCED_CODE;
 
 	/* reset the footnotes lists */
 	if (footnotes_enabled) {
@@ -2828,10 +2830,13 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 	if (doc_size >= 3 && memcmp(document, UTF8_BOM, 3) == 0)
 		beg += 3;
 
-	while (beg < doc_size) /* iterating over lines */
-		if (footnotes_enabled && is_footnote(document, beg, doc_size, &end, &md->footnotes_found))
+	while (beg < doc_size) { /* iterating over lines */
+		if (codefences_enabled && (is_codefence(document + beg, doc_size - beg, NULL) != 0))
+			in_fence = !in_fence;
+
+		if (!in_fence && footnotes_enabled && is_footnote(document, beg, doc_size, &end, &md->footnotes_found))
 			beg = end;
-		else if (is_ref(document, beg, doc_size, &end, md->refs))
+		else if (!in_fence && is_ref(document, beg, doc_size, &end, md->refs))
 			beg = end;
 		else { /* skipping to the next line */
 			end = beg;
@@ -2851,6 +2856,7 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 
 			beg = end;
 		}
+	}
 
 	/* pre-grow the output buffer to minimize allocations */
 	bufgrow(ob, MARKDOWN_GROW(text->size));
@@ -2861,7 +2867,7 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 
 	if (text->size) {
 		/* adding a final newline if not already present */
-		if (text->data[text->size - 1] != '\n' &&  text->data[text->size - 1] != '\r')
+		if (text->data[text->size - 1] != '\n' && text->data[text->size - 1] != '\r')
 			bufputc(text, '\n');
 
 		parse_block(ob, md, text->data, text->size);
@@ -2874,6 +2880,9 @@ sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, str
 	if (md->cb.doc_footer)
 		md->cb.doc_footer(ob, md->opaque);
 
+	/* Null-terminate the buffer */
+	bufcstr(ob);
+
 	/* clean-up */
 	bufrelease(text);
 	free_link_refs(md->refs);