rdiscount 2.0.7 → 2.0.7.1

data/BUILDING

@@ -12,7 +12,7 @@ Use your rdiscount working copy when running ruby programs:
     $ export RUBYLIB=~/rdiscount/lib:$RUBYLIB
     $ ruby some-program.rb
 
-Gathering changes from an upstream Orc/discount.git clone requires first
+Gathering changes from an upstream discount clone requires first
 grabbing the discount submodule into the root of the project and then running
 the rake gather task to copy discount source files into the ext/ directory:
 
@@ -25,14 +25,118 @@ the rake gather task to copy discount source files into the ext/ directory:
     $ rake gather
     $ rake build
 
-The rtomayko/discount.git repository's master branch is the default submodule
-head. It exists to merge branches for rdiscount specific patches to the upstream
-discount codebase.
 
-Do work in the submodule and then add a remote for your clone THAT YOU FORKED ON
-GITHUB BECAUSE YOU'RE GOING TO SEND ME A PULL REQUEST. After you've committed
-your great changes somewhere, push them up with:
+UPGRADING Discount
+==================
+
+The most common maintenance task is upgrading the version of Discount that
+RDiscount is using.
+
+Before doing anything, make sure you can build the current (unmodified) version
+of RDiscount. See the section above for details.
+
+Update the Discount submodule to the desired version:
 
     $ cd discount
-    $ git remote add you git@github.com:you/discount.git
-    $ git push you HEAD:topic-branch-name
+    $ git fetch
+    $ git checkout v2.0.7.x  # insert desired version
+    $ cd ..
+
+Copy the new Discount sources to the appropriate directories for RDiscount:
+
+    $ rake gather
+
+Update rdiscount.gemspec to include all *.c, *.h, and *.rb files in
+ext. This must be done manually. Here's a quick way to get the full list:
+
+    $ echo ext/*.c ext/*.h ext/*.rb ext/VERSION | tr ' ' "\n" | sort
+
+Build the RDiscount gem. If you get errors related to missing files
+in ext, make sure you updated the gemspec correctly in the previous step.
+
+    $ gem build rdiscount.gemspec
+
+Install this new gem locally. It is recommended that you use RVM to
+create an isolated installation environment. If you get an error after the line
+"Building native extensions", see the troubleshooting section below.
+
+    $ rvm ruby@rdiscount --create  # recommended; requires RVM
+    $ gem install rdiscount-*.gem
+
+Make sure the gem can be imported:
+
+    $ ruby -e 'require "rdiscount"'
+
+Make sure the tests (still) pass:
+
+    $ rake test
+
+Worked? Swell! The hard part is past.
+
+Check the Discount release notes to determine whether it has gained any new
+features that should be exposed through the RDiscount Ruby interface
+(lib/rdiscount.rb), such as new MKD_* flags. If so, update the
+Ruby interface.
+
+For new Discount extensions, you will need to update:
+
+* lib/rdiscount.rb with new accessors and
+* the rb_rdiscount__get_flags function in ext/rdiscount.c with new
+  accessor-to-flag mappings for each new extension.
+
+You should also look for RDiscount-specific bugs & feature requests in the
+GitHub tracker and fix a few.
+
+If any bugs were fixed or features added, be sure to rerun the
+release tests mentioned above.
+
+Update the CHANGELOG.
+
+Update rdiscount.gemspec with the new version number and date.
+Push that change as the final commit with a message in the format
+"2.0.7 release".
+
+Tag the release commit:
+
+    $ git tag 2.0.7     # insert desired version
+
+Rebuild the gem file and push it to RubyGems.
+
+    $ gem build rdiscount.gemspec
+    $ gem push rdiscount-NEW_VERSION.gem
+
+Announce the new release! For releases with new features it is recommended to
+write a full blog post.
+
+
+Troubleshooting Native Extension Issues
+---------------------------------------
+
+The most likely place where errors will crop up is when you attempt to build
+the C extension. If this happens, you will have to debug manually. Below are
+a few recommended sanity checks:
+
+Ensure the Makefile is generated correctly:
+
+    $ cd ext
+    $ ruby extconf.rb
+
+Ensure make succeeds:
+
+    $ make
+
+If you get linker errors related to there being duplicate symbols for _main,
+you probably need to update the deploy target of the Rakefile to exclude
+new *.c files from Discount that have a main function.
+
+For issues related to config.h or extconf.rb, there was probably some
+change to Discount's configure.sh that broke them. You will probably need
+to update these files in ext/ manually.
+
+For other errors, you'll have to investigate yourself. Common error classes:
+    * 'ext/configure.sh' fails:
+        - Create a patch to the upstream Discount.
+    * Some files missing from ext/ that are present in discount/:
+        - Update 'rake deploy' target to copy more files.
+    * Some files missing when `gem build` is run:
+        - Update gemspec to enumerate the correct files in ext/.

data/Rakefile

@@ -111,14 +111,50 @@ CLEAN.include 'doc'
 
 desc 'Gather required discount sources into extension directory'
 task :gather => 'discount/markdown.h' do |t|
-  files =
-    FileList[
-      'discount/{markdown,mkdio,amalloc,cstring,tags}.h',
-      'discount/{markdown,docheader,dumptree,generate,mkdio,resource,toc,Csio,xml,css,basename,emmatch,tags,html5}.c'
-    ]
-  cp files, 'ext/',
-    :preserve => true,
-    :verbose => true
+  rdiscount_ext_files = [
+    "config.h",
+    "extconf.rb",
+    "rdiscount.c",
+  ]
+  
+  discount_c_files_with_main_function = [
+    "main.c",
+    "makepage.c",
+    "mkd2html.c",
+    "theme.c",
+  ]
+  
+  # Ensure configure.sh was run
+  if not File.exists? 'discount/mkdio.h'
+    abort "discount/mkdio.h not found. Did you run ./configure.sh in the discount directory?"
+  end
+  
+  # Delete all *.c and *.h files from ext that are not specific to RDiscount.
+  Dir.chdir("ext") do
+    c_files_to_delete = Dir["*.c"].select { |e| !rdiscount_ext_files.include? e }
+    h_files_to_delete = Dir["*.h"].select { |e| !rdiscount_ext_files.include? e }
+    
+    rm (c_files_to_delete + h_files_to_delete),
+      :verbose => true
+  end
+  
+  # Copy all *.c and *.h files from discount -> ext except those that
+  # RDiscount overrides. Also exclude Discount files with main functions.
+  Dir.chdir("discount") do
+    c_files_to_copy = Dir["*.c"].select { |e|
+      (!rdiscount_ext_files.include? e) &&
+      (!discount_c_files_with_main_function.include? e)
+    }
+    h_files_to_copy = Dir["*.h"].select { |e| !rdiscount_ext_files.include? e }
+  
+    cp (c_files_to_copy + h_files_to_copy), '../ext/',
+      :preserve => true,
+      :verbose => true
+  end
+  
+  cp 'discount/VERSION', 'ext/'
+  
+  # Copy man page
   cp 'discount/markdown.7', 'man/'
 end
 

data/ext/VERSION

@@ -0,0 +1 @@
+2.0.7

data/ext/amalloc.c

@@ -0,0 +1,111 @@
+/*
+ * debugging malloc()/realloc()/calloc()/free() that attempts
+ * to keep track of just what's been allocated today.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#define MAGIC 0x1f2e3d4c
+
+struct alist { int magic, size; struct alist *next, *last; };
+
+static struct alist list =  { 0, 0, 0, 0 };
+
+static int mallocs=0;
+static int reallocs=0;
+static int frees=0;
+
+void *
+acalloc(int size, int count)
+{
+    struct alist *ret = calloc(size + sizeof(struct alist), count);
+
+    if ( ret ) {
+	ret->magic = MAGIC;
+	ret->size = size * count;
+	if ( list.next ) {
+	    ret->next = list.next;
+	    ret->last = &list;
+	    ret->next->last = ret;
+	    list.next = ret;
+	}
+	else {
+	    ret->last = ret->next = &list;
+	    list.next = list.last = ret;
+	}
+	++mallocs;
+	return ret+1;
+    }
+    return 0;
+}
+
+
+void*
+amalloc(int size)
+{
+    return acalloc(size,1);
+}
+
+
+void
+afree(void *ptr)
+{
+    struct alist *p2 = ((struct alist*)ptr)-1;
+
+    if ( p2->magic == MAGIC ) {
+	p2->last->next = p2->next;
+	p2->next->last = p2->last;
+	++frees;
+	free(p2);
+    }
+    else
+	free(ptr);
+}
+
+
+void *
+arealloc(void *ptr, int size)
+{
+    struct alist *p2 = ((struct alist*)ptr)-1;
+    struct alist save;
+
+    if ( p2->magic == MAGIC ) {
+	save.next = p2->next;
+	save.last = p2->last;
+	p2 = realloc(p2, sizeof(*p2) + size);
+
+	if ( p2 ) {
+	    p2->size = size;
+	    p2->next->last = p2;
+	    p2->last->next = p2;
+	    ++reallocs;
+	    return p2+1;
+	}
+	else {
+	    save.next->last = save.last;
+	    save.last->next = save.next;
+	    return 0;
+	}
+    }
+    return realloc(ptr, size);
+}
+
+
+void
+adump()
+{
+    struct alist *p;
+
+
+    for ( p = list.next; p && (p != &list); p = p->next ) {
+	fprintf(stderr, "allocated: %d byte%s\n", p->size, (p->size==1) ? "" : "s");
+	fprintf(stderr, "           [%.*s]\n", p->size, (char*)(p+1));
+    }
+
+    if ( getenv("AMALLOC_STATISTICS") ) {
+	fprintf(stderr, "%d malloc%s\n", mallocs, (mallocs==1)?"":"s");
+	fprintf(stderr, "%d realloc%s\n", reallocs, (reallocs==1)?"":"s");
+	fprintf(stderr, "%d free%s\n", frees, (frees==1)?"":"s");
+    }
+}

data/ext/extconf.rb

@@ -15,9 +15,11 @@ end
 DWORD = sized_int(4, ["unsigned long", "unsigned int"])
 WORD =  sized_int(2, ["unsigned int", "unsigned short"])
 BYTE = "unsigned char"
+VERSION = IO.read('VERSION').strip
 
 $defs.push("-DDWORD='#{DWORD}'")
 $defs.push("-DWORD='#{WORD}'")
 $defs.push("-DBYTE='#{BYTE}'")
+$defs.push("-DVERSION=\\\"#{VERSION}\\\"")
 
 create_makefile('rdiscount')

data/ext/flags.c

@@ -0,0 +1,84 @@
+#include <stdio.h>
+#include "markdown.h"
+
+struct flagnames {
+    DWORD flag;
+    char *name;
+};
+
+static struct flagnames flagnames[] = {
+    { MKD_NOLINKS,        "!LINKS" },
+    { MKD_NOIMAGE,        "!IMAGE" },
+    { MKD_NOPANTS,        "!PANTS" },
+    { MKD_NOHTML,         "!HTML" },
+    { MKD_STRICT,         "STRICT" },
+    { MKD_TAGTEXT,        "TAGTEXT" },
+    { MKD_NO_EXT,         "!EXT" },
+    { MKD_CDATA,          "CDATA" },
+    { MKD_NOSUPERSCRIPT,  "!SUPERSCRIPT" },
+    { MKD_NORELAXED,      "!RELAXED" },
+    { MKD_NOTABLES,       "!TABLES" },
+    { MKD_NOSTRIKETHROUGH,"!STRIKETHROUGH" },
+    { MKD_TOC,            "TOC" },
+    { MKD_1_COMPAT,       "MKD_1_COMPAT" },
+    { MKD_AUTOLINK,       "AUTOLINK" },
+    { MKD_SAFELINK,       "SAFELINK" },
+    { MKD_NOHEADER,       "!HEADER" },
+    { MKD_TABSTOP,        "TABSTOP" },
+    { MKD_NODIVQUOTE,     "!DIVQUOTE" },
+    { MKD_NOALPHALIST,    "!ALPHALIST" },
+    { MKD_NODLIST,        "!DLIST" },
+    { MKD_EXTRA_FOOTNOTE, "FOOTNOTE" },
+};
+#define NR(x)	(sizeof x/sizeof x[0])
+
+
+void
+mkd_flags_are(FILE *f, DWORD flags, int htmlplease)
+{
+    int i;
+    int not, set, even=1;
+    char *name;
+
+    if ( htmlplease )
+	fprintf(f, "<table class=\"mkd_flags_are\">\n");
+    for (i=0; i < NR(flagnames); i++) {
+	set = flags & flagnames[i].flag;
+	name = flagnames[i].name;
+	if ( not = (*name == '!') ) {
+	    ++name;
+	    set = !set;
+	}
+
+	if ( htmlplease ) {
+	    if ( even ) fprintf(f, " <tr>");
+	    fprintf(f, "<td>");
+	}
+	else
+	    fputc(' ', f);
+
+	if ( !set )
+	    fprintf(f, htmlplease ? "<s>" : "!");
+
+	fprintf(f, "%s", name);
+
+	if ( htmlplease ) {
+	    if ( !set )
+		fprintf(f, "</s>");
+	    fprintf(f, "</td>");
+	    if ( !even ) fprintf(f, "</tr>\n");
+	}
+	even = !even;
+    }
+    if ( htmlplease ) {
+	if ( even ) fprintf(f, "</tr>\n");
+	fprintf(f, "</table>\n");
+    }
+}
+
+void
+mkd_mmiot_flags(FILE *f, MMIOT *m, int htmlplease)
+{
+    if ( m )
+	mkd_flags_are(f, m->flags, htmlplease);
+}

data/ext/generate.c

@@ -963,7 +963,7 @@ maybe_tag_or_link(MMIOT *f)
 	}
 	else if ( isspace(c) )
 	    break;
-	else if ( ! (c == '/' || c == '-' || c == '_' || isalnum(c) ) )
+	else if ( ! (c == '/' || isalnum(c) ) )
 	    maybetag=0;
     }
 

data/ext/rdiscount.c

@@ -1,4 +1,5 @@
 #include <stdio.h>
+#include <locale.h>
 #include "ruby.h"
 #include "mkdio.h"
 
@@ -16,6 +17,17 @@ rb_rdiscount_to_html(int argc, VALUE *argv, VALUE self)
     Check_Type(text, T_STRING);
 
     int flags = rb_rdiscount__get_flags(self);
+    
+    /* 
+     * Force Discount to use ASCII character encoding for isalnum(), isalpha(),
+     * and similar functions.
+     * 
+     * Ruby tends to use UTF-8 encoding, which is ill-defined for these
+     * functions since they expect 8-bit codepoints (and UTF-8 has codepoints
+     * of at least 21 bits).
+     */
+    char *old_locale = setlocale(LC_CTYPE, NULL);
+    setlocale(LC_CTYPE, "C");   // ASCII (and passthru characters > 127)
 
     MMIOT *doc = mkd_string(RSTRING_PTR(text), RSTRING_LEN(text), flags);
 
@@ -29,6 +41,7 @@ rb_rdiscount_to_html(int argc, VALUE *argv, VALUE self)
     }
     mkd_cleanup(doc);
 
+    setlocale(LC_CTYPE, old_locale);
 
     /* force the input encoding */
     if ( rb_respond_to(text, rb_intern("encoding")) ) {

data/ext/version.c

@@ -0,0 +1,22 @@
+#include "config.h"
+
+char markdown_version[] = VERSION
+#if 4 != 4
+		" TAB=4"
+#endif
+#if USE_AMALLOC
+		" DEBUG"
+#endif
+#if USE_DISCOUNT_DL
+# if USE_EXTRA_DL
+		" DL=BOTH"
+# else
+		" DL=DISCOUNT"
+# endif
+#elif USE_EXTRA_DL
+		" DL=EXTRA"
+#else
+		" DL=NONE"
+#endif
+
+		;

data/ext/xmlpage.c

@@ -0,0 +1,48 @@
+/*
+ * xmlpage -- write a skeletal xhtml page
+ *
+ * Copyright (C) 2007 David L Parsons.
+ * The redistribution terms are provided in the COPYRIGHT file that must
+ * be distributed with this source code.
+ */
+#include "config.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <ctype.h>
+
+#include "cstring.h"
+#include "markdown.h"
+#include "amalloc.h"
+
+
+int
+mkd_xhtmlpage(Document *p, int flags, FILE *out)
+{
+    char *title;
+    extern char *mkd_doc_title(Document *);
+    
+    if ( mkd_compile(p, flags) ) {
+	fprintf(out, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
+	fprintf(out, "<!DOCTYPE html "
+		     " PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\""
+		     " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n");
+
+	fprintf(out, "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n");
+
+	fprintf(out, "<head>\n");
+	if ( title = mkd_doc_title(p) )
+	    fprintf(out, "<title>%s</title>\n", title);
+	mkd_generatecss(p, out);
+	fprintf(out, "</head>\n");
+	
+	fprintf(out, "<body>\n");
+	mkd_generatehtml(p, out);
+	fprintf(out, "</body>\n");
+	fprintf(out, "</html>\n");
+	
+	mkd_cleanup(p);
+
+	return 0;
+    }
+    return -1;
+}

data/rdiscount.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'rdiscount'
-  s.version = '2.0.7'
+  s.version = '2.0.7.1'
   s.summary = "Fast Implementation of Gruber's Markdown in C"
-  s.date = '2013-01-29'
+  s.date = '2013-02-26'
   s.email = 'rtomayko@gmail.com'
   s.homepage = 'http://github.com/rtomayko/rdiscount'
   s.authors = ["Ryan Tomayko", "David Loren Parsons", "Andrew White", "David Foster"]
@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
     bin/rdiscount
     discount
     ext/Csio.c
+    ext/VERSION
+    ext/amalloc.c
     ext/amalloc.h
     ext/basename.c
     ext/config.h
@@ -24,6 +26,7 @@ Gem::Specification.new do |s|
     ext/dumptree.c
     ext/emmatch.c
     ext/extconf.rb
+    ext/flags.c
     ext/generate.c
     ext/html5.c
     ext/markdown.c
@@ -36,7 +39,9 @@ Gem::Specification.new do |s|
     ext/tags.c
     ext/tags.h
     ext/toc.c
+    ext/version.c
     ext/xml.c
+    ext/xmlpage.c
     lib/markdown.rb
     lib/rdiscount.rb
     man/markdown.7

data/test/rdiscount_test.rb

@@ -117,5 +117,10 @@ Obtuse text.[^1]
 EOS
     assert rd.to_html.include?('<a href="#fn:1" rel="footnote">1</a>')
   end
+  
+  def test_that_unicode_urls_encoded_correctly
+    rd = RDiscount.new("[Test](http://example.com/ß)")
+    assert_equal "<p><a href=\"http://example.com/%C3%9F\">Test</a></p>\n", rd.to_html
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdiscount
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: rtomayko@gmail.com
@@ -29,6 +29,8 @@ files:
 - Rakefile
 - bin/rdiscount
 - ext/Csio.c
+- ext/VERSION
+- ext/amalloc.c
 - ext/amalloc.h
 - ext/basename.c
 - ext/config.h
@@ -38,6 +40,7 @@ files:
 - ext/dumptree.c
 - ext/emmatch.c
 - ext/extconf.rb
+- ext/flags.c
 - ext/generate.c
 - ext/html5.c
 - ext/markdown.c
@@ -50,7 +53,9 @@ files:
 - ext/tags.c
 - ext/tags.h
 - ext/toc.c
+- ext/version.c
 - ext/xml.c
+- ext/xmlpage.c
 - lib/markdown.rb
 - lib/rdiscount.rb
 - man/markdown.7