rdiscountwl 1.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cf4a08fc2c37e30426673510f7b439d449c0259aa7f1e44d29d9bb0ccdb8982
+  data.tar.gz: 72f862b4b48d71ce5f5928c5cd26d002b77fb9d48fd1ab30922a807ac79b9481
+SHA512:
+  metadata.gz: ee42bb1796afd8e69375f57848787e739ccb8cc1d94d0d7ff859e39c605e1e8765301c42a53080f4f3bd2c5f769475fb543c26c13326baaaf6d9e2fa2c4bf844
+  data.tar.gz: 42e679b35f2398656d9521ea69a9d3d84fcccb8db56a8c35d0a94db9287b0446283a57308b01b7fc26d0c42776a8d34eb4704944dcc82ba8542f2034c0260e7f

data/BUILDING

@@ -0,0 +1,151 @@
+BUILDING rdiscount
+==================
+
+You'll be needing Ruby, rake, and a basic build environment.
+
+Build the rdiscount extension for tests and local development:
+
+    $ rake build
+
+Use your rdiscount working copy when running ruby programs:
+
+    $ export RUBYLIB=~/rdiscount/lib:$RUBYLIB
+    $ ruby some-program.rb
+
+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:
+
+    $ git submodule update --init
+    Submodule 'discount' (git://github.com/davidfstr/discount.git) registered for path 'discount'
+    Cloning into discount...
+    $ cd discount
+    $ ./configure.sh
+    $ make  # ensure it compiles
+    $ cd ..
+    $ rake gather
+    $ rake build
+
+
+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 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/blocktags ext/VERSION | tr ' ' "\n" | sort
+
+(There is an old Rakefile target called "rdiscount.gemspec" that looks like it
+ is designed to perform an update of these files, however I haven't tested it.)
+
+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 or configure flags.
+If so, update the Ruby interface.
+
+If the ./configure.sh line needs to be changed to support new features,
+you will need to port some #defines from discount/config.h to ext/config.h
+manually to get RDiscount's embedded Discount to use the same configure flags.
+
+For new Discount extensions via new MKD_* flags, 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 also add new tests!
+And don't forget to rerun the preexisting tests.
+
+Update the CHANGELOG.
+
+Update rdiscount.gemspec with the new RDiscount version number and date.
+Also update the VERSION constant in lib/rdiscount.rb.
+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/COPYING

@@ -0,0 +1,33 @@
+The core Discount C sources are
+Copyright (C) 2007 David Loren Parsons.
+
+The Discount Ruby extension sources are
+Copyright (C) 2008 Ryan Tomayko.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1.  Redistributions of works must retain the original copyright notice,
+    this list of conditions and the following disclaimer.
+2.  Redistributions in binary form must reproduce the original copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+3.  Neither my name (David L Parsons) nor the names of contributors to
+    this code may be used to endorse or promote products derived
+    from this work without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.markdown

@@ -0,0 +1,73 @@
+Discount Markdown Processor for Ruby
+====================================
+[![Build Status](https://travis-ci.org/davidfstr/rdiscount.svg?branch=master)](https://travis-ci.org/davidfstr/rdiscount)
+[![Build status](https://ci.appveyor.com/api/projects/status/47i0qxrnvjbg724f/branch/master?svg=true)](https://ci.appveyor.com/project/DavidFoster/rdiscount/branch/master)
+
+Discount is an implementation of John Gruber's Markdown markup language in C. It
+implements all of the language described in [the markdown syntax document][1] and
+passes the [Markdown 1.0 test suite][2].
+
+CODE: `git clone git://github.com/davidfstr/rdiscount.git`  
+HOME: <http://dafoster.net/projects/rdiscount/>  
+DOCS: <http://rdoc.info/github/davidfstr/rdiscount/master/RDiscount>  
+BUGS: <http://github.com/davidfstr/rdiscount/issues>  
+
+Discount was developed by [David Loren Parsons][3]. The Ruby extension
+is maintained by [David Foster][4].
+
+[1]: http://daringfireball.net/projects/markdown/syntax
+[2]: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip
+[3]: http://www.pell.portland.or.us/~orc
+[4]: https://github.com/davidfstr
+
+INSTALL, HACKING
+----------------
+
+New releases of RDiscount are published to [RubyGems][]:
+
+    $ [sudo] gem install rdiscount
+
+The RDiscount sources are available via Git:
+
+    $ git clone git://github.com/davidfstr/rdiscount.git
+    $ cd rdiscount
+    $ rake --tasks
+
+See the file [BUILDING][] for hacking instructions.
+
+[RubyGems]: https://rubygems.org/gems/rdiscount
+[BUILDING]: https://github.com/davidfstr/rdiscount/blob/master/BUILDING
+
+USAGE
+-----
+
+RDiscount implements the basic protocol popularized by RedCloth and adopted
+by BlueCloth:
+
+    require 'rdiscount'
+    markdown = RDiscount.new("Hello World!")
+    puts markdown.to_html
+
+Additional processing options can be turned on when creating the
+RDiscount object:
+
+    markdown = RDiscount.new("Hello World!", :smart, :filter_html)
+
+Inject RDiscount into your BlueCloth-using code by replacing your bluecloth
+require statements with the following:
+
+    begin
+      require 'rdiscount'
+      BlueCloth = RDiscount
+    rescue LoadError
+      require 'bluecloth'
+    end
+
+COPYING
+-------
+
+Discount is free software;  it is released under a BSD-style license
+that allows you to do as you wish with it as long as you don't attempt
+to claim it as your own work. RDiscount adopts Discount's license
+verbatim. See the file `COPYING` for more information.
+

data/Rakefile

@@ -0,0 +1,224 @@
+require 'date'
+require 'rake/clean'
+require 'digest/md5'
+
+task :default => :test
+
+# ==========================================================
+# Ruby Extension
+# ==========================================================
+
+DLEXT = RbConfig::MAKEFILE_CONFIG['DLEXT']
+RUBYDIGEST = Digest::MD5.hexdigest(`ruby --version`)
+
+file "ext/ruby-#{RUBYDIGEST}" do |f|
+  rm_f FileList["ext/ruby-*"]
+  touch f.name
+end
+CLEAN.include "ext/ruby-*"
+
+file 'ext/Makefile' => FileList['ext/*.{c,h,rb}', "ext/ruby-#{RUBYDIGEST}"] do
+  chdir('ext') { ruby 'extconf.rb' }
+end
+CLEAN.include 'ext/Makefile', 'ext/mkmf.log'
+
+file "ext/rdiscount.#{DLEXT}" => FileList["ext/Makefile"] do |f|
+  sh 'cd ext && make clean && make && rm -rf conftest.dSYM'
+end
+CLEAN.include 'ext/*.{o,bundle,so,dll}'
+
+file "lib/rdiscount.#{DLEXT}" => "ext/rdiscount.#{DLEXT}" do |f|
+  cp f.prerequisites, "lib/", :preserve => true
+end
+
+desc 'Build the rdiscount extension'
+task :build => "lib/rdiscount.#{DLEXT}"
+
+# ==========================================================
+# Manual
+# ==========================================================
+
+file 'man/rdiscount.1' => 'man/rdiscount.1.ronn' do
+  sh "ronn --manual=RUBY -b man/rdiscount.1.ronn"
+end
+CLOBBER.include 'man/rdiscount.1'
+
+desc 'Build manpages'
+task :man => 'man/rdiscount.1'
+
+# ==========================================================
+# Testing
+# ==========================================================
+
+require 'rake/testtask'
+Rake::TestTask.new('test:unit') do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts += ['-rubygems'] if defined? Gem
+end
+task 'test:unit' => [:build]
+
+desc 'Run conformance tests (MARKDOWN_TEST_VER=1.0)'
+task 'test:conformance' => [:build] do |t|
+  script = "#{pwd}/bin/rdiscount"
+  test_version = ENV['MARKDOWN_TEST_VER'] || '1.0.3'
+  lib_dir = "#{pwd}/lib"
+  chdir("test/MarkdownTest_#{test_version}") do
+    result = `RUBYLIB=#{lib_dir} ./MarkdownTest.pl --script='#{script}' --tidy`
+    print result
+    fail unless result.include? "; 0 failed."
+  end
+end
+
+desc 'Run version 1.0 conformance suite'
+task 'test:conformance:1.0' => [:build] do |t|
+  ENV['MARKDOWN_TEST_VER'] = '1.0'
+  Rake::Task['test:conformance'].invoke
+end
+
+desc 'Run 1.0.3 conformance suite'
+task 'test:conformance:1.0.3' => [:build] do |t|
+  ENV['MARKDOWN_TEST_VER'] = '1.0.3'
+  Rake::Task['test:conformance'].invoke
+end
+
+desc 'Run unit and conformance tests'
+task :test => %w[test:unit test:conformance]
+
+desc 'Run benchmarks'
+task :benchmark => :build do |t|
+  $:.unshift 'lib'
+  load 'test/benchmark.rb'
+end
+
+# ==========================================================
+# Documentation
+# ==========================================================
+
+desc 'Generate API documentation'
+task :doc => 'doc/index.html'
+
+file 'doc/index.html' => FileList['lib/*.rb'] do |f|
+  sh((<<-end).gsub(/\s+/, ' '))
+    hanna --charset utf8 --fmt html --inline-source --line-numbers \
+          --main RDiscount --op doc --title 'RDiscount API Documentation' \
+          #{f.prerequisites.join(' ')}
+  end
+end
+
+CLEAN.include 'doc'
+
+# ==========================================================
+# Update package's Discount sources
+# ==========================================================
+
+desc 'Gather required discount sources into extension directory'
+task :gather => 'discount/markdown.h' do |t|
+  # Files unique to /ext that should not be overridden
+  rdiscount_ext_files = [
+    "config.h",
+    "extconf.rb",
+    "rdiscount.c",
+  ]
+  
+  # Files in /discount that have a main function and should not be copied to /ext
+  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
+  
+  # Copy special files from discount -> ext
+  cp 'discount/blocktags', 'ext/'
+  cp 'discount/VERSION', 'ext/'
+  
+  # Copy man page
+  cp 'discount/markdown.7', 'man/'
+end
+
+file 'discount/markdown.h' do |t|
+  abort "The discount submodule is required. See the file BUILDING for getting set up."
+end
+
+# PACKAGING =================================================================
+
+require 'rubygems'
+$spec = eval(File.read('rdiscount.gemspec'))
+
+def package(ext='')
+  "pkg/rdiscount-#{$spec.version}" + ext
+end
+
+desc 'Build packages'
+task :package => %w[.gem .tar.gz].map {|e| package(e)}
+
+desc 'Build and install as local gem'
+task :install => package('.gem') do
+  sh "gem install #{package('.gem')}"
+end
+
+directory 'pkg/'
+
+file package('.gem') => %w[pkg/ rdiscount.gemspec] + $spec.files do |f|
+  sh "gem build rdiscount.gemspec"
+  mv File.basename(f.name), f.name
+end
+
+file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
+  sh "git archive --format=tar HEAD | gzip > #{f.name}"
+end
+
+# GEMSPEC HELPERS ==========================================================
+
+def source_version
+  line = File.read('lib/rdiscount.rb')[/^\s*VERSION = .*/]
+  line.match(/.*VERSION = '(.*)'/)[1]
+end
+
+file 'rdiscount.gemspec' => FileList['Rakefile','lib/rdiscount.rb'] do |f|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  head.sub!(/\.version = '.*'/, ".version = '#{source_version}'")
+  head.sub!(/\.date = '.*'/, ".date = '#{Date.today.to_s}'")
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject{ |file| file =~ /^\./ || file =~ /^test\/MarkdownTest/ }.
+    map{ |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write...
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head,manifest,tail].join("  # = MANIFEST =\n")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "updated #{f.name}"
+end

data/bin/rdiscount

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# Usage: rdiscount [<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.
+if ARGV.include?('--help')
+  File.read(__FILE__).split("\n").grep(/^# /).each do |line|
+    puts line[2..-1]
+  end
+  exit 0
+end
+
+require 'rdiscount'
+STDOUT.write(RDiscount.new(ARGF.read).to_html)

data/ext/Csio.c

@@ -0,0 +1,61 @@
+#include <stdio.h>
+#include <string.h>
+#include <stdarg.h>
+#include "cstring.h"
+#include "markdown.h"
+#include "amalloc.h"
+
+
+/* putc() into a cstring
+ */
+void
+Csputc(int c, Cstring *iot)
+{
+    EXPAND(*iot) = c;
+}
+
+
+/* printf() into a cstring
+ */
+int
+Csprintf(Cstring *iot, char *fmt, ...)
+{
+    va_list ptr;
+    int siz=100;
+
+    do {
+	RESERVE(*iot, siz);
+	va_start(ptr, fmt);
+	siz = vsnprintf(T(*iot)+S(*iot), ALLOCATED(*iot)-S(*iot), fmt, ptr);
+	va_end(ptr);
+    } while ( siz > (ALLOCATED(*iot)-S(*iot)) );
+
+    S(*iot) += siz;
+    return siz;
+}
+
+
+/* write() into a cstring
+ */
+int
+Cswrite(Cstring *iot, char *bfr, int size)
+{
+    RESERVE(*iot, size);
+    memcpy(T(*iot)+S(*iot), bfr, size);
+    S(*iot) += size;
+    return size;
+}
+
+
+/* reparse() into a cstring
+ */
+void
+Csreparse(Cstring *iot, char *buf, int size, int flags)
+{
+    MMIOT f;
+    ___mkd_initmmiot(&f, 0);
+    ___mkd_reparse(buf, size, 0, &f, 0);
+    ___mkd_emblock(&f);
+    SUFFIX(*iot, T(f.out), S(f.out));
+    ___mkd_freemmiot(&f, 0);
+}

data/ext/VERSION

@@ -0,0 +1 @@
+2.2.0

data/ext/amalloc.c

@@ -0,0 +1,135 @@
+/*
+ * 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, index; int *end; struct alist *next, *last; };
+
+static struct alist list =  { 0, 0, 0, 0 };
+
+static int mallocs=0;
+static int reallocs=0;
+static int frees=0;
+
+static int index = 0;
+
+static void
+die(char *msg, int index)
+{
+    fprintf(stderr, msg, index);
+    abort();
+}
+
+
+void *
+acalloc(int count, int size)
+{
+    struct alist *ret;
+
+    if ( size > 1 ) {
+	count *= size;
+	size = 1;
+    }
+
+    if ( ret = calloc(count + sizeof(struct alist) + sizeof(int), size) ) {
+	ret->magic = MAGIC;
+	ret->size = size * count;
+	ret->index = index ++;
+	ret->end = (int*)(count + (char*) (ret + 1));
+	*(ret->end) = ~MAGIC;
+	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 ) {
+	if ( ! (p2->end && *(p2->end) == ~MAGIC) )
+	    die("goddam: corrupted memory block %d in free()!\n", p2->index);
+	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 ) {
+	if ( ! (p2->end && *(p2->end) == ~MAGIC) )
+	    die("goddam: corrupted memory block %d in realloc()!\n", p2->index);
+	save.next = p2->next;
+	save.last = p2->last;
+	p2 = realloc(p2, sizeof(int) + sizeof(*p2) + size);
+
+	if ( p2 ) {
+	    p2->size = size;
+	    p2->end = (int*)(size + (char*) (p2 + 1));
+	    *(p2->end) = ~MAGIC;
+	    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");
+    }
+}