RubyGems - bluecloth - Versions diffs - 2.0.0 - Mend

bluecloth 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (103) hide show

data/ChangeLog +629 -0
data/LICENSE +27 -0
data/LICENSE.discount +47 -0
data/README +71 -0
data/Rakefile +319 -0
data/Rakefile.local +63 -0
data/bin/bluecloth +84 -0
data/ext/VERSION +1 -0
data/ext/amalloc.h +29 -0
data/ext/bluecloth.c +373 -0
data/ext/config.h +47 -0
data/ext/cstring.h +73 -0
data/ext/docheader.c +43 -0
data/ext/extconf.rb +45 -0
data/ext/generate.c +1387 -0
data/ext/markdown.c +939 -0
data/ext/markdown.h +135 -0
data/ext/mkdio.c +241 -0
data/ext/mkdio.h +66 -0
data/ext/resource.c +169 -0
data/ext/version.c +28 -0
data/lib/bluecloth.rb +148 -0
data/rake/191_compat.rb +26 -0
data/rake/dependencies.rb +76 -0
data/rake/helpers.rb +412 -0
data/rake/manual.rb +782 -0
data/rake/packaging.rb +116 -0
data/rake/publishing.rb +321 -0
data/rake/rdoc.rb +40 -0
data/rake/style.rb +62 -0
data/rake/svn.rb +639 -0
data/rake/testing.rb +204 -0
data/rake/verifytask.rb +64 -0
data/rake/win32.rb +186 -0
data/spec/bluecloth/101_changes_spec.rb +141 -0
data/spec/bluecloth/autolinks_spec.rb +49 -0
data/spec/bluecloth/blockquotes_spec.rb +143 -0
data/spec/bluecloth/code_spans_spec.rb +164 -0
data/spec/bluecloth/emphasis_spec.rb +164 -0
data/spec/bluecloth/entities_spec.rb +65 -0
data/spec/bluecloth/hrules_spec.rb +90 -0
data/spec/bluecloth/images_spec.rb +92 -0
data/spec/bluecloth/inline_html_spec.rb +238 -0
data/spec/bluecloth/links_spec.rb +171 -0
data/spec/bluecloth/lists_spec.rb +294 -0
data/spec/bluecloth/paragraphs_spec.rb +75 -0
data/spec/bluecloth/titles_spec.rb +305 -0
data/spec/bluecloth_spec.rb +209 -0
data/spec/bugfix_spec.rb +123 -0
data/spec/contributions_spec.rb +85 -0
data/spec/data/antsugar.txt +34 -0
data/spec/data/markdowntest/Amps and angle encoding.html +17 -0
data/spec/data/markdowntest/Amps and angle encoding.text +21 -0
data/spec/data/markdowntest/Auto links.html +18 -0
data/spec/data/markdowntest/Auto links.text +13 -0
data/spec/data/markdowntest/Backslash escapes.html +118 -0
data/spec/data/markdowntest/Backslash escapes.text +120 -0
data/spec/data/markdowntest/Blockquotes with code blocks.html +15 -0
data/spec/data/markdowntest/Blockquotes with code blocks.text +11 -0
data/spec/data/markdowntest/Code Blocks.html +18 -0
data/spec/data/markdowntest/Code Blocks.text +14 -0
data/spec/data/markdowntest/Code Spans.html +5 -0
data/spec/data/markdowntest/Code Spans.text +5 -0
data/spec/data/markdowntest/Hard-wrapped paragraphs with list-like lines.html +8 -0
data/spec/data/markdowntest/Hard-wrapped paragraphs with list-like lines.text +8 -0
data/spec/data/markdowntest/Horizontal rules.html +71 -0
data/spec/data/markdowntest/Horizontal rules.text +67 -0
data/spec/data/markdowntest/Inline HTML (Advanced).html +15 -0
data/spec/data/markdowntest/Inline HTML (Advanced).text +15 -0
data/spec/data/markdowntest/Inline HTML (Simple).html +72 -0
data/spec/data/markdowntest/Inline HTML (Simple).text +69 -0
data/spec/data/markdowntest/Inline HTML comments.html +13 -0
data/spec/data/markdowntest/Inline HTML comments.text +13 -0
data/spec/data/markdowntest/Links, inline style.html +11 -0
data/spec/data/markdowntest/Links, inline style.text +12 -0
data/spec/data/markdowntest/Links, reference style.html +52 -0
data/spec/data/markdowntest/Links, reference style.text +71 -0
data/spec/data/markdowntest/Links, shortcut references.html +9 -0
data/spec/data/markdowntest/Links, shortcut references.text +20 -0
data/spec/data/markdowntest/Literal quotes in titles.html +3 -0
data/spec/data/markdowntest/Literal quotes in titles.text +7 -0
data/spec/data/markdowntest/Markdown Documentation - Basics.html +314 -0
data/spec/data/markdowntest/Markdown Documentation - Basics.text +306 -0
data/spec/data/markdowntest/Markdown Documentation - Syntax.html +942 -0
data/spec/data/markdowntest/Markdown Documentation - Syntax.text +888 -0
data/spec/data/markdowntest/Nested blockquotes.html +9 -0
data/spec/data/markdowntest/Nested blockquotes.text +5 -0
data/spec/data/markdowntest/Ordered and unordered lists.html +148 -0
data/spec/data/markdowntest/Ordered and unordered lists.text +131 -0
data/spec/data/markdowntest/Strong and em together.html +7 -0
data/spec/data/markdowntest/Strong and em together.text +7 -0
data/spec/data/markdowntest/Tabs.html +25 -0
data/spec/data/markdowntest/Tabs.text +21 -0
data/spec/data/markdowntest/Tidyness.html +8 -0
data/spec/data/markdowntest/Tidyness.text +5 -0
data/spec/data/ml-announce.txt +17 -0
data/spec/data/re-overflow.txt +67 -0
data/spec/data/re-overflow2.txt +281 -0
data/spec/lib/constants.rb +5 -0
data/spec/lib/helpers.rb +137 -0
data/spec/lib/matchers.rb +235 -0
data/spec/markdowntest_spec.rb +76 -0
metadata +305 -0

data/Rakefile.local ADDED

@@ -0,0 +1,63 @@
+#!rake
+# C extension constants
+EXT_MAKEFILE       = EXTDIR + 'Makefile'
+EXT_SOURCES        = FileList[ EXTDIR + '*.c' ]
+EXT_SO             = EXTDIR + "bluecloth_ext.#{CONFIG['DLEXT']}"
+GEMSPEC.extra_rdoc_files << 'LICENSE.discount'
+DOCFILES << 'LICENSE.discount'
+#####################################################################
+###	T A S K S
+#####################################################################
+# Make both the default task and the spec task depend on building the extension
+task :local => :build
+task :spec => :build
+namespace :spec do
+	task :doc   => [ :build ]
+	task :quiet => [ :build ]
+	task :html  => [ :build ]
+	task :text  => [ :build ]
+end
+desc "Make the Makefile for the C extension"
+file EXT_MAKEFILE.to_s => EXT_SOURCES do
+	log "Configuring BlueCloth C extension"
+	in_subdirectory( EXTDIR ) do
+		ruby 'extconf.rb'
+	end
+end
+CLOBBER.include( EXTDIR + 'mkmf.log', EXTDIR + 'conftest.dSYM', EXT_SO )
+desc "Build the C extension"
+task :build => EXT_SO
+file EXT_SO => [ EXT_MAKEFILE.to_s, *EXT_SOURCES ] do
+	in_subdirectory( EXTDIR ) do
+		sh 'make'
+	end
+end
+desc "Rebuild the C extension"
+task :rebuild => [ :clobber, :build ]
+task :clean do
+	if EXT_MAKEFILE.exist?
+		in_subdirectory( EXTDIR ) do
+			sh 'make clean'
+		end
+	end
+end
+task :clobber do
+	if EXT_MAKEFILE.exist?
+		in_subdirectory( EXTDIR ) do
+			sh 'make distclean'
+		end
+	end
+end
+CLOBBER.include( EXT_MAKEFILE )

data/bin/bluecloth ADDED

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby
+#
+# = bluecloth
+#
+# Format one or more text files with the markdown formatter.
+#
+# = Synopsis
+#
+#   bluecloth [OPTIONS] [FILES]
+#
+#
+#
+BEGIN {
+	require 'bluecloth'
+	require 'optparse'
+}
+DocumentWrapper = %{
+<html>
+  <head><title>%s</title></head>
+  <body>
+%s
+  </body>
+</html>
+}
+def main
+	fragment = false
+	destination = '.'
+	ARGV.options do |oparser|
+		oparser.banner = "Usage: #$0 [OPTIONS] FILES"
+		# Debug mode
+		oparser.on( "--debug", "-d", TrueClass, "Turn debugging output on" ) {
+			$DEBUG = true
+		}
+		# 'Fragment' mode
+		oparser.on( "--fragment", "-f", TrueClass,
+			"Output HTML fragments instead of whole documents" ) {
+			fragment = true
+		}
+		# Output destination
+		#oparser.on( "--output=DESTINATION", "-o DESTINATION", String,
+		#	"Write output to DESTINATION instead of the current directory" ) {|arg|
+		#	destination = arg
+		#}
+		oparser.parse!
+	end
+	# Filter mode if no arguments
+	ARGV.push( "-" ) if ARGV.empty?
+	ARGV.each {|file|
+		if file == '-'
+			contents = $stdin.read
+		else
+			contents = File::read( file )
+		end
+		bc = BlueCloth::new( contents )
+		$stderr.puts "Using BlueCloth version #{BlueCloth::VERSION}"
+		if fragment
+			$stdout.puts bc.to_html
+		else
+			$stdout.puts DocumentWrapper % [ file, bc.to_html ]
+		end
+	}
+rescue => err
+	$stderr.puts "Aborting: Fatal error: %s" % err.message
+	exit 255
+end
+main

data/ext/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 1.3.4

data/ext/amalloc.h ADDED

@@ -0,0 +1,29 @@
+/*
+ * debugging malloc()/realloc()/calloc()/free() that attempts
+ * to keep track of just what's been allocated today.
+ */
+#ifndef AMALLOC_D
+#define AMALLOC_D
+#include "config.h"
+#ifdef USE_AMALLOC
+extern void *amalloc(int);
+extern void *acalloc(int,int);
+extern void *arealloc(void*,int);
+extern void afree(void*);
+extern void adump();
+#define malloc	amalloc
+#define	calloc	acalloc
+#define realloc	arealloc
+#define free	afree
+#else
+#define adump()	(void)1
+#endif
+#endif/*AMALLOC_D*/

data/ext/bluecloth.c ADDED

@@ -0,0 +1,373 @@
+/*
+ * BlueCloth -- a Ruby implementation of Markdown
+ * $Id: bluecloth.c 107 2009-03-13 22:56:29Z deveiant $
+ *
+ * = Authors
+ *
+ * - Michael Granger <ged@FaerieMUD.org>
+ *
+ * BlueCloth 2 is mostly just a wrapper around the Discount library
+ * written by David Loren Parsons <http://www.pell.portland.or.us/~orc>.
+ *
+ * = License
+ *
+ * Discount:
+ * Copyright (C) 2007 David Loren Parsons. All rights reserved.
+ *
+ * The Discount library is used under the licensing terms outlined in the
+ * COPYRIGHT.discount file included in the distribution.
+ *
+ * Ruby bits:
+ * See the LICENSE file included in the distribution.
+ *
+ */
+#include "mkdio.h"
+#include "ruby.h"
+VALUE bluecloth_cBlueCloth;
+VALUE bluecloth_default_opthash;
+/* Get a Discount document for the specified text */
+static MMIOT *
+bluecloth_alloc( VALUE text, int flags ) {
+	MMIOT *document;
+	document = mkd_string( RSTRING_PTR(text), RSTRING_LEN(text), flags );
+	if ( !document )
+		rb_raise( rb_eRuntimeError, "Failed to create a BlueCloth object for: %s", RSTRING_PTR(text) );
+	return document;
+}
+/*
+ * GC Free function
+ */
+static void
+bluecloth_gc_free( MMIOT *document ) {
+	if ( document ) {
+		mkd_cleanup( document );
+		document = NULL;
+	}
+}
+/* --------------------------------------------------------------
+ * Utility functions
+ * -------------------------------------------------------------- */
+#ifdef HAVE_STDARG_PROTOTYPES
+#include <stdarg.h>
+void
+bluecloth_debug(const char *fmt, ...)
+#else
+#include <varargs.h>
+void
+bluecloth_debug( fmt, va_alist )
+	 const char *fmt;
+	 va_dcl
+#endif
+{
+	char buf[BUFSIZ], buf2[BUFSIZ];
+	va_list	args;
+	if (!RTEST(ruby_debug)) return;
+	snprintf( buf, BUFSIZ, "Debug>>> %s", fmt );
+#ifdef HAVE_STDARG_PROTOTYPES
+	va_start( args, fmt );
+#else
+	va_start( args );
+#endif
+	vsnprintf( buf2, BUFSIZ, buf, args );
+	fputs( buf2, stderr );
+	fputs( "\n", stderr );
+	fflush( stderr );
+	va_end( args );
+}
+/*
+ * Object validity checker. Returns the data pointer.
+ */
+static MMIOT *
+bluecloth_check_ptr( VALUE self ) {
+	Check_Type( self, T_DATA );
+    if ( !rb_obj_is_kind_of(self, bluecloth_cBlueCloth) ) {
+		rb_raise( rb_eTypeError, "wrong argument type %s (expected BlueCloth object)",
+				  rb_class2name(CLASS_OF( self )) );
+    }
+	return DATA_PTR( self );
+}
+/*
+ * Fetch the data pointer and check it for sanity.
+ */
+static MMIOT *
+bluecloth_get_ptr( VALUE self ) {
+	MMIOT *ptr = bluecloth_check_ptr( self );
+	if ( !ptr )
+		rb_fatal( "Use of uninitialized BlueCloth object" );
+	return ptr;
+}
+/* --------------------------------------------------------------
+ * Class methods
+ * -------------------------------------------------------------- */
+/*
+ *  call-seq:
+ *     BlueCloth.allocate   -> object
+ *
+ *  Allocate a new BlueCloth object.
+ *
+ */
+static VALUE
+bluecloth_s_allocate( VALUE klass ) {
+	return Data_Wrap_Struct( klass, NULL, bluecloth_gc_free, 0 );
+}
+/*
+ *  call-seq:
+ *     BlueCloth.discount_version   -> string
+ *
+ *  Return the version string of the Discount library BlueCloth was built on.
+ *
+ */
+static VALUE
+bluecloth_s_discount_version( VALUE klass ) {
+	return rb_str_new2( markdown_version );
+}
+/* --------------------------------------------------------------
+ * Instance methods
+ * -------------------------------------------------------------- */
+/*
+ *  call-seq:
+ *     BlueCloth.new( string='', options=DEFAULT_OPTIONS )   -> object
+ *
+ * Create a new BlueCloth object that will process the given +string+. The +options+
+ * argument is a Hash that can be used to control the generated markup, and to
+ * enable/disable extensions. The supported options are:
+ *
+ * [:remove_links]
+ *   Ignore links in Markdown, and escape A tags in the output. Defaults to +false+.
+ * [:remove_images]
+ *   Ignore images in Markdown, and escape IMG tags in the output. Defaults to +false+.
+ * [:smartypants]
+ *   Do Smartypants-style mangling of quotes, dashes, or ellipses. Defaults to +true+.
+ * [:pseudoprotocols]
+ *   Support Discount's pseudo-protocol links. Defaults to +false+.
+ * [:pandoc_headers]
+ *   Support the extraction of
+ *   {Pandoc headers}[http://johnmacfarlane.net/pandoc/README.html#title-blocks], which
+ *   can be fetched as a Hash via the #header method. Defaults to +false+.
+ * [:header_labels]
+ *   Generate ID attributes for all headers. Defaults to +false+.
+ * [:escape_html]
+ *   Escape all HTML in the input string. Defaults to +false+.
+ * [:strict_mode]
+ *   Disables Discount's relaxed emphasis (ignores underscores in the middle of words) and
+ *   superscript notation. Defaults to +true+.
+ *
+ */
+static VALUE
+bluecloth_initialize( int argc, VALUE *argv, VALUE self ) {
+	if ( !bluecloth_check_ptr(self) ) {
+		MMIOT *document;
+		VALUE text, textcopy, optflags, fullhash, opthash = Qnil;
+		int flags = 0;
+		rb_scan_args( argc, argv, "02", &text, &opthash );
+		/* Default empty string and options */
+		if ( argc == 0 ) {
+			text = rb_str_new( "", 0 );
+		}
+		/* One arg could be either the text or the opthash, so shift the args if appropriate */
+		else if ( argc == 1 && (TYPE(text) == T_HASH || TYPE(text) == T_FIXNUM) ) {
+			opthash = text;
+			text = rb_str_new( "", 0 );
+		}
+		/* Merge the options hash with the defaults and turn it into a flags int */
+		if ( NIL_P(opthash) ) opthash = rb_hash_new();
+		optflags = rb_funcall( bluecloth_cBlueCloth, rb_intern("flags_from_opthash"), 1, opthash );
+		fullhash = rb_funcall( bluecloth_cBlueCloth, rb_intern("opthash_from_flags"), 1, optflags );
+		flags = NUM2INT( optflags );
+		DATA_PTR( self ) = document = bluecloth_alloc( text, flags );
+		if ( !mkd_compile(document, flags) )
+			rb_raise( rb_eRuntimeError, "Failed to compile markdown" );
+		textcopy = rb_str_dup( text );
+		OBJ_FREEZE( textcopy );
+		rb_iv_set( self, "@text", textcopy );
+		OBJ_FREEZE( fullhash );
+		rb_iv_set( self, "@options", fullhash );
+		OBJ_INFECT( self, text );
+	}
+	return self;
+}
+/*
+ *  call-seq:
+ *     bluecloth.to_html   -> string
+ *
+ *  Transform the document into HTML.
+ *
+ */
+static VALUE
+bluecloth_to_html( VALUE self ) {
+	MMIOT *document = bluecloth_get_ptr( self );
+	char *output;
+	int length;
+	VALUE result = Qnil;
+	bluecloth_debug( "Compiling document %p", document );
+	if ( (length = mkd_document( document, &output )) != EOF ) {
+		bluecloth_debug( "Pointer to results: %p, length = %d", output, length );
+		result = rb_str_new( output, length );
+		OBJ_INFECT( result, self );
+		return result;
+	} else {
+		return Qnil;
+	}
+}
+char * (*header_functions[3])(MMIOT *) = {
+	mkd_doc_title,
+	mkd_doc_author,
+	mkd_doc_date
+};
+/*
+ *  call-seq:
+ *     bluecloth.header   -> hash
+ *
+ *  Return the hash of
+ *  {Pandoc-style headers}[http://johnmacfarlane.net/pandoc/README.html#title-blocks]
+ *  from the parsed document. If there were no headers, or the BlueCloth object was not
+ *  constructed with the :pandoc_headers option enabled, an empty Hash is returned.
+ *
+ *     markdown = "%title My Essay\n%author Me\n%date Today\n\nSome stuff..."
+ *     bc = BlueCloth.new( markdown, :pandoc_headers => true )
+ *     # =>
+ *     bc.header
+ *     # =>
+ */
+static VALUE
+bluecloth_header( VALUE self ) {
+	MMIOT *document = bluecloth_get_ptr( self );
+	char *field;
+	VALUE fieldstring, headers = rb_hash_new();
+	bluecloth_debug( "Fetching pandoc headers for document %p", document );
+	if ( (field = mkd_doc_title(document)) ) {
+		fieldstring = rb_str_new2( field );
+		OBJ_INFECT( fieldstring, self );
+		rb_hash_aset( headers, ID2SYM(rb_intern("title")), fieldstring );
+	}
+	if ( (field = mkd_doc_author(document)) ) {
+		fieldstring = rb_str_new2( field );
+		OBJ_INFECT( fieldstring, self );
+		rb_hash_aset( headers, ID2SYM(rb_intern("author")), fieldstring );
+	}
+	if ( (field = mkd_doc_date(document)) ) {
+		fieldstring = rb_str_new2( field );
+		OBJ_INFECT( fieldstring, self );
+		rb_hash_aset( headers, ID2SYM(rb_intern("date")), fieldstring );
+	}
+	return headers;
+}
+/* --------------------------------------------------------------
+ * Initializer
+ * -------------------------------------------------------------- */
+void Init_bluecloth_ext( void ) {
+	bluecloth_cBlueCloth = rb_define_class( "BlueCloth", rb_cObject );
+	rb_define_alloc_func( bluecloth_cBlueCloth, bluecloth_s_allocate );
+	rb_define_singleton_method( bluecloth_cBlueCloth, "discount_version",
+		bluecloth_s_discount_version, 0 );
+	rb_define_method( bluecloth_cBlueCloth, "initialize", bluecloth_initialize, -1 );
+	rb_define_method( bluecloth_cBlueCloth, "to_html", bluecloth_to_html, 0 );
+	rb_define_method( bluecloth_cBlueCloth, "header", bluecloth_header, 0 );
+	rb_define_alias( bluecloth_cBlueCloth, "pandoc_header", "header" );
+	/* The original Markdown text the object was constructed with */
+	rb_define_attr( bluecloth_cBlueCloth, "text", 1, 0 );
+	/* The options hash that describes the options in effect when the object was created */
+	rb_define_attr( bluecloth_cBlueCloth, "options", 1, 0 );
+	/* --- Constants ----- */
+	/* special flags for markdown() and mkd_text() */
+	/* Do not process `[]' and remove A tags from the output. */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_NOLINKS",  INT2FIX(MKD_NOLINKS) );
+	/* Do not process `![]' and remove IMG tags from the output. */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_NOIMAGE",  INT2FIX(MKD_NOIMAGE) );
+	/* Do not do Smartypants-style mangling of quotes, dashes, or ellipses. */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_NOPANTS",  INT2FIX(MKD_NOPANTS) );
+	/* Escape all opening angle brackets in the input text instead of allowing block-level HTML */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_NOHTML",   INT2FIX(MKD_NOHTML) );
+	/* disable SUPERSCRIPT, RELAXED_EMPHASIS */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_STRICT",   INT2FIX(MKD_STRICT) );
+	/* don't expand `_` and `*` */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_TAGTEXT",  INT2FIX(MKD_TAGTEXT) );
+	/* don't allow pseudo-protocols */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_NO_EXT",   INT2FIX(MKD_NO_EXT) );
+	/* do table-of-contents processing */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_TOC",      INT2FIX(MKD_TOC) );
+	/* MarkdownTest 1.0 Compatibility Mode */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_1_COMPAT", INT2FIX(MKD_1_COMPAT) );
+	/* MKD_NOLINKS|MKD_NOIMAGE|MKD_TAGTEXT */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_EMBED",    INT2FIX(MKD_EMBED) );
+	/* -- special flags for mkd_in() and mkd_string() */
+	/* don't process header blocks */
+	rb_define_const( bluecloth_cBlueCloth, "MKD_NOHEADER", INT2FIX(MKD_NOHEADER) );
+	/* Make sure the Ruby side is loaded */
+	rb_require( "bluecloth" );
+	bluecloth_default_opthash = rb_const_get( bluecloth_cBlueCloth, rb_intern("DEFAULT_OPTIONS") );
+}