redcarpet 1.6.0 → 1.7.0

data/README.markdown

@@ -1,26 +1,54 @@
-Markdown + Ruby + libupskirt
-============================
+Ruby + Upskirt = Markdown that doesn't suck
+===========================================
 
-> Inspired by Rick Astley wearing a kilt
+Redcarpet is a Ruby wrapper for Upskirt. It is mostly based on Ryan
+Tomayko's RDiscount wrapper, and inspired by Rick Astley wearing a kilt.
 
-Upskirt is an implementation of John Gruber's Markdown markup
-language. Upskirt is safe, fast and production ready. Check out
-the original version at <http://git.instinctive.eu/cgit/libupskirt/>
+Redcarpet is powered by the Upskirt library, which can be found at
 
-Redcarpet is Upskirt with a touch of Ruby. It is mostly based on Ryan
-Tomayko's RDiscount wrapper, and inspired by Rick Astley wearing a kilt.
+	https://www.github.com/tanoku/upskirt
+
+You might want to find out more about Upskirt to see what makes these Ruby
+bindings so awesome.
+
+Credits
+-------
+
+* Natacha Porté, lady of Markdown
+* Vicent Martí, wannabe
+* With special thanks to Ryan Tomayko
+
+Install
+-------
+
+Redcarpet is readily available as a Ruby gem:
 
-Redcarpet is powered by a modified version of Upskirt, which has been
-updated to pass the official Markdown test suite and now has support
-for many additional features: autolinks, smartypants, safe filters,
-and a long etcetera.
+    $ [sudo] gem install redcarpet
 
-Redcarpet is a drop-in replacement for BlueCloth, RedCloth and RDiscount.
+The Redcarpet source (including Upskirt as a submodule) is available at GitHub:
 
-* Upskirt is (C)2009 Natacha Porté
-* Upskirt has been brought back to life and made standards-compilant in 2011 by Vicent Marti
-* Redcarpet is (C)2011 Vicent Marti
- 
+    $ git clone git://github.com/tanoku/redcarpet.git
+
+Usage
+-----
+
+Redcarpet implements the basic protocol popularized by RedCloth:
+
+    require 'redcarpet'
+    markdown = Redcarpet.new("Hello World!")
+    puts markdown.to_html
+
+Additional processing options can be turned on when creating the
+Redcarpet object:
+
+    markdown = Redcarpet.new("Hello World!", :smart, :filter_html)
+
+Note that by default, Redcarpet parses standard Markdown (with no extensions)
+and offers a sane subset of parse options which allow you to modify the rendering
+output and to enable MD extensions on a per-case basis.
+
+Redcarpet also offers a wrapper class, `RedcarpetCompat` with the same flags
+and behavior as the RDiscount library, which acts as a drop-in replacement.
 
 License
 -------
@@ -36,3 +64,4 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/Rakefile

@@ -133,3 +133,23 @@ file 'redcarpet.gemspec' => FileList['Rakefile','lib/redcarpet.rb'] do |f|
   File.open(f.name, 'w') { |io| io.write(spec) }
   puts "updated #{f.name}"
 end
+
+desc 'Gather required Upskirt sources into extension directory'
+task :gather => 'upskirt/src/markdown.h' do |t|
+  files =
+    FileList[
+      'upskirt/src/{markdown,buffer,array}.h',
+      'upskirt/src/{markdown,buffer,array}.c',
+      'upskirt/render/xhtml.c',
+      'upskirt/render/xhtml.h',
+    ]
+  cp files, 'ext/',
+    :preserve => true,
+    :verbose => true
+end
+
+file 'upskirt/src/markdown.h' do |t|
+  abort "The Upskirt submodule is required."
+end
+
+

data/ext/markdown.c

@@ -18,12 +18,12 @@
  */
 
 #include "markdown.h"
-
 #include "array.h"
 
 #include <assert.h>
 #include <string.h>
 #include <strings.h> /* for strncasecmp */
+#include <ctype.h>
 
 #define TEXT_UNIT 64	/* unit for the copy of the input buffer */
 #define WORK_UNIT 64	/* block-level working buffer */
@@ -948,7 +948,6 @@ static size_t
 is_codefence(char *data, size_t size)
 {
 	size_t i = 0, n = 0;
-	char c;
 
 	/* skipping initial spaces */
 	if (size < 3) return 0;
@@ -1113,8 +1112,6 @@ parse_paragraph(struct buf *ob, struct render *rndr, char *data, size_t size)
 	struct buf work = { data, 0, 0, 0, 0 }; /* volatile working buffer */
 
 	while (i < size) {
-		size_t html_size;
-
 		for (end = i + 1; end < size && data[end - 1] != '\n'; end++) /* empty */;
 
 		if (is_empty(data + i, size - i) || (level = is_headerline(data + i, size - i)) != 0)
@@ -1747,8 +1744,6 @@ parse_table_header(struct buf *ob, struct render *rndr, char *data, size_t size,
 		under_end++;
 
 	for (col = 0; col < *columns && i < under_end; ++col) {
-		size_t cell_start, cell_end;
-
 		if (data[i] == ':') {
 			i++; (*column_data)[col] |= MKD_TABLE_ALIGN_L;
 		}
@@ -1804,7 +1799,6 @@ parse_table(struct buf *ob, struct render *rndr, char *data, size_t size)
 	if (i > 0) {
 
 		while (i < size) {
-			size_t row_len;
 			size_t row_start;
 			int pipes = 0;
 
@@ -2032,7 +2026,7 @@ static void expand_tabs(struct buf *ob, const char *line, size_t size)
 
 /* markdown • parses the input buffer and renders it into the output buffer */
 void
-markdown(struct buf *ob, struct buf *ib, const struct mkd_renderer *rndrer, unsigned int extensions) {
+ups_markdown(struct buf *ob, struct buf *ib, const struct mkd_renderer *rndrer, unsigned int extensions) {
 	struct link_ref *lr;
 	struct buf *text = bufnew(TEXT_UNIT);
 	size_t i, beg, end;
@@ -2049,10 +2043,11 @@ markdown(struct buf *ob, struct buf *ib, const struct mkd_renderer *rndrer, unsi
 	for (i = 0; i < 256; i += 1)
 		rndr.active_char[i] = 0;
 
-	if ((rndr.make.emphasis || rndr.make.double_emphasis || rndr.make.triple_emphasis) &&
-		rndr.make.emph_chars) {
-		for (i = 0; rndr.make.emph_chars[i]; i += 1)
-			rndr.active_char[(unsigned char)rndr.make.emph_chars[i]] = char_emphasis;
+	if (rndr.make.emphasis || rndr.make.double_emphasis || rndr.make.triple_emphasis) {
+		rndr.active_char['*'] = char_emphasis;
+		rndr.active_char['_'] = char_emphasis;
+		if (extensions & MKDEXT_STRIKETHROUGH)
+			rndr.active_char['~'] = char_emphasis;
 	}
 
 	if (rndr.make.codespan)

data/ext/markdown.h

@@ -41,6 +41,7 @@ enum mkd_extensions {
 	MKDEXT_TABLES = (1 << 1),
 	MKDEXT_FENCED_CODE = (1 << 2),
 	MKDEXT_AUTOLINK = (1 << 3),
+	MKDEXT_STRIKETHROUGH = (1 << 4),
 };
 
 /* mkd_renderer • functions for rendering parsed data */
@@ -78,8 +79,7 @@ struct mkd_renderer {
 	void (*doc_header)(struct buf *ob, void *opaque);
 	void (*doc_footer)(struct buf *ob, void *opaque);
 
-	/* renderer data */
-	const char *emph_chars; /* chars that trigger emphasis rendering */
+	/* user data */
 	void *opaque;
 };
 
@@ -106,8 +106,8 @@ is_safe_link(const char *link, size_t link_len);
  **********************/
 
 /* markdown • parses the input buffer and renders it into the output buffer */
-void
-markdown(struct buf *ob, struct buf *ib, const struct mkd_renderer *rndr, unsigned int extensions);
+extern void
+ups_markdown(struct buf *ob, struct buf *ib, const struct mkd_renderer *rndr, unsigned int extensions);
 
 #endif
 

data/ext/redcarpet.c

@@ -62,7 +62,7 @@ static void rb_redcarpet__get_flags(VALUE ruby_obj,
 		extensions |= MKDEXT_AUTOLINK;
 
 	if (rb_funcall(ruby_obj, rb_intern("strikethrough"), 0) == Qtrue)
-		render_flags |= XHTML_STRIKETHROUGH;
+		extensions |= MKDEXT_STRIKETHROUGH;
 
 	*enabled_extensions_p = extensions;
 	*render_flags_p = render_flags;
@@ -90,22 +90,22 @@ static VALUE rb_redcarpet__render(VALUE self, RendererType render_type)
 
 	switch (render_type) {
 	case REDCARPET_RENDER_XHTML:
-		init_xhtml_renderer(&renderer, render_flags);
+		ups_xhtml_renderer(&renderer, render_flags);
 		break;
 
 	case REDCARPET_RENDER_TOC:
-		init_toc_renderer(&renderer);
+		ups_toc_renderer(&renderer);
 		break;
 
 	default:
 		return Qnil;
 	}
 
-	markdown(output_buf, &input_buf, &renderer, enabled_extensions);
+	ups_markdown(output_buf, &input_buf, &renderer, enabled_extensions);
 
 	result = rb_str_new(output_buf->data, output_buf->size);
 	bufrelease(output_buf);
-	free_renderer(&renderer);
+	ups_free_renderer(&renderer);
 
 	/* force the input encoding */
 	if (rb_respond_to(text, rb_intern("encoding"))) {

data/ext/xhtml.c

@@ -21,6 +21,7 @@
 #include <strings.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <ctype.h>
 
 struct xhtml_renderopt {
 	struct {
@@ -139,15 +140,10 @@ rndr_codespan(struct buf *ob, struct buf *text, void *opaque)
 static int
 rndr_double_emphasis(struct buf *ob, struct buf *text, char c, void *opaque)
 {
-	struct xhtml_renderopt *options = opaque;
-
 	if (!text || !text->size)
 		return 0;
 
 	if (c == '~') {
-		if ((options->flags & XHTML_STRIKETHROUGH) == 0)
-			return 0;
-		
 		BUFPUTSL(ob, "<span style=\"text-decoration:line-through;\">");
 		bufput(ob, text->data, text->size);
 		BUFPUTSL(ob, "</span>");
@@ -412,7 +408,7 @@ static struct {
 
 #define SUBS_COUNT (sizeof(smartypants_subs) / sizeof(smartypants_subs[0]))
 
-static inline
+static inline int
 word_boundary(char c)
 {
 	return isspace(c) || ispunct(c);
@@ -628,7 +624,7 @@ toc_finalize(struct buf *ob, void *opaque)
 }
 
 void
-init_toc_renderer(struct mkd_renderer *renderer)
+ups_toc_renderer(struct mkd_renderer *renderer)
 {
 	static const struct mkd_renderer toc_render = {
 		NULL,
@@ -659,7 +655,6 @@ init_toc_renderer(struct mkd_renderer *renderer)
 		NULL,
 		toc_finalize,
 
-		"*-~",
 		NULL
 	};
 
@@ -672,7 +667,7 @@ init_toc_renderer(struct mkd_renderer *renderer)
 }
 
 void
-init_xhtml_renderer(struct mkd_renderer *renderer, unsigned int render_flags)
+ups_xhtml_renderer(struct mkd_renderer *renderer, unsigned int render_flags)
 {
 	static const struct mkd_renderer renderer_default = {
 		rndr_blockcode,
@@ -703,7 +698,6 @@ init_xhtml_renderer(struct mkd_renderer *renderer, unsigned int render_flags)
 		NULL,
 		NULL,
 
-		"*_~",
 		NULL
 	};
 
@@ -727,7 +721,7 @@ init_xhtml_renderer(struct mkd_renderer *renderer, unsigned int render_flags)
 }
 
 void
-free_renderer(struct mkd_renderer *renderer)
+ups_free_renderer(struct mkd_renderer *renderer)
 {
 	free(renderer->opaque);
 }

data/ext/xhtml.h

@@ -26,17 +26,16 @@ typedef enum {
 	XHTML_EXPAND_TABS = (1 << 5),
 	XHTML_SAFELINK = (1 << 7),
 	XHTML_TOC = (1 << 8),
-	XHTML_STRIKETHROUGH = (1 << 10),
 } render_mode;
 
-void
-init_xhtml_renderer(struct mkd_renderer *renderer, unsigned int render_flags);
+extern void
+ups_xhtml_renderer(struct mkd_renderer *renderer, unsigned int render_flags);
 
-void
-init_toc_renderer(struct mkd_renderer *renderer);
+extern void
+ups_toc_renderer(struct mkd_renderer *renderer);
 
-void
-free_renderer(struct mkd_renderer *renderer);
+extern void
+ups_free_renderer(struct mkd_renderer *renderer);
 
 #endif
 

data/lib/redcarpet.rb

@@ -26,7 +26,7 @@
 #   end
 #
 class Redcarpet
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 
   # Original Markdown formatted text.
   attr_reader :text
@@ -67,9 +67,6 @@ class Redcarpet
   # Enable PHP-Markdown fenced code extension
   attr_accessor :fenced_code
 
-  # Backwards compatibility
-  attr_accessor :fold_lines
-
   def initialize(text, *extensions)
     @text  = text
     extensions.each { |e| send("#{e}=", true) }
@@ -82,10 +79,15 @@ Markdown = Redcarpet unless defined? Markdown
 # Creates a instance of Redcarpet with all markdown
 # extensions enabled, same behavior as in RDiscount
 class RedcarpetCompat < Redcarpet
+  # Backwards compatibility
+  attr_accessor :fold_lines
+  attr_accessor :no_tables
+  attr_accessor :fold_lines
+
   def initialize(text, *extensions)
     super(text, *extensions)
-    tables = true
-    strikethrough = true
+    self.tables = !self.no_tables
+    self.strikethrough = true
   end
 end
 

data/redcarpet.gemspec

@@ -1,8 +1,9 @@
 Gem::Specification.new do |s|
   s.name = 'redcarpet'
-  s.version = '1.6.0'
+  s.version = '1.7.0'
   s.summary = "Ruby bindings for libupskirt"
-  s.date = '2011-04-12'
+  s.description = 'A fast and safe Markdown to (X)HTML parser'
+  s.date = '2011-04-15'
   s.email = 'vicent@github.com'
   s.homepage = 'http://github.com/tanoku/redcarpet'
   s.has_rdoc = true
@@ -30,6 +31,7 @@ Gem::Specification.new do |s|
     test/benchmark.txt
     test/markdown_test.rb
     test/redcarpet_test.rb
+    upskirt
   ]
   # = MANIFEST =
   s.test_files = ["test/markdown_test.rb", "test/redcarpet_test.rb"]

data/test/markdown_test.rb

@@ -60,12 +60,12 @@ class MarkdownTest < Test::Unit::TestCase
   end
 
   def test_that_redcloth_attributes_are_supported
-    markdown = Markdown.new('Hello World.')
+    markdown = RedcarpetCompat.new('Hello World.')
     assert_respond_to markdown, :fold_lines
     assert_respond_to markdown, :fold_lines=
     assert_not_equal true, markdown.fold_lines
 
-    markdown = Markdown.new('Hello World.', :fold_lines)
+    markdown = RedcarpetCompat.new('Hello World.', :fold_lines)
     assert_equal true, markdown.fold_lines
   end
 

data/test/redcarpet_test.rb

@@ -163,13 +163,13 @@ hello|sailor
 EOS
 
     assert Redcarpet.new(text).to_html !~ /<table/
-    assert Redcarpet.new(text, :tables).to_html ~ /<table/
+    assert Redcarpet.new(text, :tables).to_html =~ /<table/
   end
 
   def test_strikethrough_flag_works
     text = "this is ~some~ striked ~~text~~"
     assert Redcarpet.new(text).to_html !~ /text-decoration:line-through;/
-    assert Redcarpet.new(text, :strikethrough).to_html ~ /text-decoration:line-through;/
+    assert Redcarpet.new(text, :strikethrough).to_html =~ /text-decoration:line-through;/
   end
 
   def test_that_fenced_flag_works
@@ -183,7 +183,7 @@ This is some awesome code
 fenced
 
     assert Redcarpet.new(text).to_html !~ /<code/
-    assert Redcarpet.new(text, :fenced_code).to_html ~ /<code/
+    assert Redcarpet.new(text, :fenced_code).to_html =~ /<code/
   end
 
   def test_that_compat_is_working
@@ -194,8 +194,9 @@ hello|sailor
 
 This is ~~striked through~~ test
 EOS
-    assert rd.to_html ~ /<table/
-    assert rd.to_html ~ /text-decoration:line-through;/
+    assert rd.tables
+    assert rd.to_html =~ /<table/
+    assert rd.to_html =~ /text-decoration:line-through;/
   end
 
   def test_that_headers_are_linkable

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redcarpet
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 6
+  - 7
   - 0
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors: 
 - "Natacha Port\xC3\xA9"
@@ -16,11 +16,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 -07:00
+date: 2011-04-15 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
-description: 
+description: A fast and safe Markdown to (X)HTML parser
 email: vicent@github.com
 executables: 
 - redcarpet