rpeg-multimarkdown2 2.0.1

data/LICENSE

@@ -0,0 +1,96 @@
+Ruby PEG MultiMarkdown 2, implemented using peg-multimarkdown
+Copyright (c) 2012 Andor Chen
+Ruby Markdown Extension, implemented using peg-markdown
+Copyright (c) 2008 Ryan Tomayko
+markdown in c, implemented using PEG grammar
+Copyright (c) 2008 John MacFarlane
+Additional MultiMarkdown files
+Copyright (c) 2005-2011 Fletcher T. Penney
+Micro-optparse (included in bin/rpeg-multimarkdown)
+Copyright (c) 2011 Florian Pilz
+
+Both peg-markdown and the rpeg-markdown license are released under both the GPL
+and MIT licenses. You may pick the license that best fits your needs.
+
+Micro-optparse is released under the MIT license.
+
+The GPL
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+
+peg-0.1.4 (included for convenience - http://piumarta.com/software/peg/)
+
+Copyright (c) 2007 by Ian Piumarta
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the 'Software'),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, provided that the above copyright notice(s) and this
+permission notice appear in all copies of the Software.  Acknowledgement
+of the use of this Software in supporting documentation would be
+appreciated but is not required.
+
+THE SOFTWARE IS PROVIDED 'AS IS'.  USE ENTIRELY AT YOUR OWN RISK.
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+
+my_getopt (included for convenience - http://www.geocities.com/bsittler/)
+
+Copyright 1997, 2000, 2001, 2002, 2006, Benjamin Sittler
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,52 @@
+# Ruby PEG MultiMarkdown 2
+
+An extension library around [Fletcher Penney's implementation][1]
+of MultiMarkdown in C. This library is based (almost entirely) on
+[rpeg-multimarkdown][2].
+
+[1]: http://github.com/fletcher/peg-multimarkdown/
+[2]: https://github.com/djungelvral/rpeg-multimarkdown
+
+## Synopsis
+
+    >> require 'multimarkdown2'
+
+    >> puts MultiMarkdown.new('Hello, world.').to_html
+    # <p>Hello, world.</p>
+
+    >> puts MultiMarkdown.new('_Hello World!_', :smart, :filter_html).to_html
+    # <p><em>Hello World!</em></p>
+
+    >> puts MultiMarkdown.new('_Hello World!_').to_latex
+    # \emph{Hello World!}
+
+    >> puts MultiMarkdown.new("Title: Some document\n\nSome text in the document").extract_metadata("title")
+    # Some document
+
+    >> PEGMultiMarkdown.new('Hello! World!')
+
+## Installation / Hacking
+
+This library requires a recent version of glib2. All modern GNU userland
+systems should be fine.
+
+Install from GEM:
+
+    $ sudo gem install rpeg-multimarkdown2
+
+Hacking:
+
+    $ git clone git://github.com/AndorChen/rpeg-multimarkdown2.git
+    $ cd rpeg-multimarkdown2
+    $ rake test
+
+## Changes
+
+  * [Version 0.1.1](http://github.com/djungelvral/rpeg-multimarkdown/tree/v0.1.1)
+
+## COPYING
+
+The peg-markdown, peg-multimarkdown, and Ruby PEG Markdown extension sources
+are licensed under the GPL and the Ruby PEG MultiMarkdown extension sources
+adopts this license. See the file LICENSE included with this distribution for
+more information.

data/Rakefile

@@ -0,0 +1,167 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+
+task :default => :test
+
+DLEXT = RbConfig::CONFIG['DLEXT']
+VERS = '2.0.1'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "rpeg-multimarkdown2"
+  s.version           = VERS
+  s.summary           = "Fast MultiMarkdown implementation"
+  s.description       =<<-EOF
+                        A Ruby extension to process MultiMarkdown-formatted
+                        text, using Fletcher Penney's C peg-multimarkdown
+                        implementation.
+                        EOF
+  s.files             = FileList[
+                          'README.markdown','LICENSE','Rakefile',
+                          '{lib,ext,test}/**.rb','ext/*.{c,h}',
+                          'test/MultiMarkdownTest/**/*',
+                          'bin/rpeg-multimarkdown2'
+                        ]
+  s.bindir            = 'bin'
+  s.executables       << 'rpeg-multimarkdown2'
+  s.require_path      = 'lib'
+  s.extra_rdoc_files  = ['LICENSE']
+  s.test_files        = FileList['test/multimarkdown_test.rb']
+  s.extensions        = ['ext/extconf.rb']
+
+  s.authors           = ['Andor Chen']
+  s.email             = ['andor.chen.27@gmail.com']
+  s.homepage          = 'http://github.com/AndorChen/rpeg-multimarkdown2'
+end
+
+# For Mac OS X -- prevents prevent additional ._* files being added to tarball
+ENV['COPYFILE_DISABLE'] = 'true'
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar_gz = true
+  pkg.need_tar = false
+  pkg.need_zip = false
+end
+
+namespace :submodule do
+  desc 'Init the peg-multimarkdown submodule'
+  task :init do |t|
+    unless File.exist? 'peg-multimarkdown/markdown.c'
+      rm_rf 'peg-multimarkdown'
+      sh 'git submodule init peg-multimarkdown'
+      sh 'git submodule update peg-multimarkdown'
+    end
+  end
+
+  desc 'Update the peg-multimarkdown submodule'
+  task :update => :init do
+    sh 'git submodule update peg-multimarkdown' unless File.symlink?('peg-multimarkdown')
+  end
+
+  file 'peg-multimarkdown/markdown.c' do
+    Rake::Task['submodule:init'].invoke
+  end
+  task :exist => 'peg-multimarkdown/markdown.c'
+end
+
+desc 'Gather required peg-multimarkdown sources into extension directory'
+task :gather => 'submodule:exist' do |t|
+  sh 'cd peg-multimarkdown && make markdown_parser.c'
+  files =
+    FileList[
+      'peg-multimarkdown/markdown_{peg.h,parser.c,output.c,lib.c,lib.h}',
+      'peg-multimarkdown/{utility,parsing}_functions.c',
+      'peg-multimarkdown/odf.{c,h}'
+    ]
+  cp files, 'ext/',
+    :preserve => true,
+    :verbose => true
+end
+
+file 'ext/Makefile' => FileList['ext/{extconf.rb,*.c,*.h,*.rb}'] do
+  chdir('ext') { ruby 'extconf.rb' }
+end
+CLEAN.include 'ext/Makefile'
+
+file "ext/peg_multimarkdown.#{DLEXT}" => FileList['ext/Makefile', 'ext/*.{c,h,rb}'] do |f|
+  sh 'cd ext && make'
+end
+CLEAN.include 'ext/*.{o,bundle,so}'
+
+file "lib/peg_multimarkdown.#{DLEXT}" => "ext/peg_multimarkdown.#{DLEXT}" do |f|
+  cp f.prerequisites, "lib/", :preserve => true
+end
+CLEAN.include "lib/*.{so,bundle}"
+
+desc 'Build the peg_multimarkdown extension'
+task :build => "lib/peg_multimarkdown.#{DLEXT}"
+
+desc 'Run unit and conformance tests'
+task :test => [ 'test:unit', 'test:conformance' ]
+
+desc 'Run unit tests'
+task 'test:unit' => [:build] do |t|
+  ruby 'test/multimarkdown_test.rb'
+end
+
+desc "Run conformance tests"
+task 'test:conformance' => [:build] do |t|
+  script = "#{pwd}/bin/rpeg-multimarkdown2"
+  chdir("test/MultiMarkdownTest") do
+    sh "./MarkdownTest.pl --script='#{script}' --flags='-c' --tidy"
+    sh "./MarkdownTest.pl --script='#{script}' --testdir='MultiMarkdownTests'"
+  	sh "./MarkdownTest.pl --script='#{script}' --testdir='MultiMarkdownTests' --flags='-t latex' --ext='.tex'"
+  	sh "./MarkdownTest.pl --script='#{script}' --testdir='BeamerTests' --flags='-t latex' --ext='.tex'"
+  	sh "./MarkdownTest.pl --script='#{script}' --testdir='MemoirTests' --flags='-t latex' --ext='.tex'"
+  end
+end
+
+desc 'Run conformance suite'
+task 'test:conformance' => [:build] do |t|
+  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
+
+desc "See how much memory we're losing"
+task 'test:mem' => %w[submodule:exist build] do |t|
+  $: << File.join(File.dirname(__FILE__), "lib")
+  require 'multimarkdown'
+  FileList['test/mem.txt', 'peg-multimarkdown/MarkdownTest/Tests/*.text'].each do |file|
+    printf "%s: \n", file
+    multimarkdown = MultiMarkdown.new(File.read(file),:compatibility)
+    iterations = (ENV['N'] || 100).to_i
+    total, growth = [], []
+    iterations.times do |i|
+      start = Time.now
+      GC.start
+      multimarkdown.to_html
+      duration = Time.now - start
+      GC.start
+      total << `ps -o rss= -p #{Process.pid}`.to_i
+      next if i == 0
+      growth << (total.last - (total[-2] || 0))
+      # puts "%03d: %06.02f ms / %dK used / %dK growth" % [ i, duration, total.last, growth.last ]
+    end
+    average = growth.inject(0) { |sum,x| sum + x } / growth.length
+    printf "  %dK avg growth (per run) / %dK used (after %d runs)\n", average, total.last, iterations
+  end
+end
+
+# ==========================================================
+# Rubyforge
+# ==========================================================
+
+PKGNAME = "pkg/rpeg-multimarkdown2-#{VERS}"
+
+desc 'Publish new release to rubyforge'
+task :release => [ "#{PKGNAME}.gem", "#{PKGNAME}.tar.gz" ] do |t|
+  sh "gem push #{PKGNAME}.gem"
+end

data/bin/rpeg-multimarkdown2

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'multimarkdown2'
+rescue LoadError => boom
+  local_path = File.expand_path(File.dirname(__FILE__))
+  $: << "#{local_path}/../lib"
+  require 'multimarkdown2'
+end
+
+# Option parser -- http://florianpilz.github.com/micro-optparse/
+
+require 'ostruct'
+require 'optparse'
+
+class Parser
+  attr_accessor :banner, :version
+  def initialize
+    @options = []
+    @used_short = []
+    yield self if block_given?
+  end
+
+  def option(name, desc, settings = {})
+    @options << [name, desc, settings]
+  end
+
+  def short_from(name)
+    name.to_s.chars.each do |c|
+      next if @used_short.include?(c) || c == "_"
+      return c # returns from short_from method
+    end
+  end
+
+  def validate(options) # remove this method if you want fewer lines of code and don't need validations
+    options.each_pair do |key, value|
+      opt = @options.find_all{ |o| o[0] == key }.first
+      key = "--" << key.to_s.gsub("_", "-")
+      unless opt[2][:value_in_set].nil? || opt[2][:value_in_set].include?(value)
+        puts "Parameter for #{key} must be in [" << opt[2][:value_in_set].join(", ") << "]" ; exit(1)
+      end
+      unless opt[2][:value_matches].nil? || opt[2][:value_matches] =~ value
+        puts "Parameter for #{key} must match /" << opt[2][:value_matches].source << "/" ; exit(1)
+      end
+      unless opt[2][:value_satisfies].nil? || opt[2][:value_satisfies].call(value)
+        puts "Parameter for #{key} must satisfy given conditions (see description)" ; exit(1)
+      end
+    end
+  end
+
+  def process!(arguments = ARGV)
+    @result = (@default_values || {}).clone # reset or new
+    @optionparser ||= OptionParser.new do |p| # prepare only once
+      @options.each do |o|
+        @used_short << short = o[2][:short] || short_from(o[0])
+        @result[o[0]] = o[2][:default] || false # set default
+        klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
+        desk = o[1] + (o[2][:nodefault] ? "" : " (default is #{@result[o[0]]})")
+        if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
+          p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), desk) {|x| @result[o[0]] = x}
+        else # argument with parameter
+          p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << (o[2][:name] ? "[#{o[2][:name].to_s}]" : ""), klass, desk) {|x| @result[o[0]] = x}
+        end
+      end
+
+      p.banner = @banner unless @banner.nil?
+      p.on_tail("-h", "--help", "Show this message") {puts p ; exit}
+      short = @used_short.include?("v") ? "-V" : "-v"
+      p.on_tail(short, "--version", "Print version") {puts @version ; exit} unless @version.nil?
+      @default_values = @result.clone # save default values to reset @result in subsequent calls
+    end
+
+    begin
+      @optionparser.parse!(arguments)
+    rescue OptionParser::ParseError => e
+      puts e.message ; exit(1)
+    end
+
+    validate(@result) if self.respond_to?("validate")
+    @result
+  end
+end
+
+# Parse options
+options = Parser.new do |p|
+  p.banner = "Ruby interface to MultiMarkdown"
+  p.version = "rpeg-multimarkdown2 2.0.1"
+  p.option :compatibility, "markdown compatibility mode", :default => false
+  p.option :filter_html, "filter out raw HTML except styles", :default => false
+  p.option :process_html, "process MultiMarkdown inside of raw HTML", :default => false
+  p.option :filter_styles, "filter out HTML styles", :default => false
+  p.option :smart, "use smart typography extension", :default => true
+  p.option :notes, "use notes extension", :default => true
+  p.option :output, "send output to FILE (default is stdout)", :name => "FILE", :default => "", :nodefault => true
+  p.option :to, "convert to FORMAT", :name => "FORMAT", :default => "html", :value_in_set => ["html","latex","memoir","beamer","odf","opml"]
+  p.option :extract, "extract and display metadata specified by KEY", :name => "KEY", :default => "", :nodefault => true
+end.process!
+
+# Convert options to MultiMarkdown module's options
+mmopts = []
+mmopts << :filter_html   if options[:filter_html]
+mmopts << :filter_styles if options[:filter_styles]
+mmopts << :process_html  if options[:process_html]
+mmopts << :smart         if options[:smart]
+mmopts << :notes         if options[:notes]
+mmopts << :compatibility if options[:compatibility]
+
+# ARGV will now only contain input filename, if it contains anything
+STDIN.reopen(ARGV[0], 'rb') if ARGV.any?
+multimarkdown = MultiMarkdown.new(STDIN.read,*mmopts)
+STDOUT.reopen(options[:output], 'w') if options[:output]!=""
+
+# Print specified metadata if requested
+if options[:extract]!=""
+  puts multimarkdown.extract_metadata(options[:extract])
+  exit(0)
+end
+
+# Do processing
+case options[:to]
+when "html"
+  STDOUT.write(multimarkdown.to_html)
+when "latex"
+  STDOUT.write(multimarkdown.to_latex)
+else
+  puts "Output other than html & latex not currently supported"
+  exit(1)
+end

data/ext/extconf.h

@@ -0,0 +1,3 @@
+#ifndef EXTCONF_H
+#define EXTCONF_H
+#endif

data/ext/extconf.rb

@@ -0,0 +1,15 @@
+require 'mkmf'
+
+dir_config('peg_multimarkdown')
+
+$objs = %w[markdown.o markdown_lib.o markdown_output.o markdown_parser.o]
+
+if pkg_config = find_executable('pkg-config')
+  $CFLAGS = "-fcommon "+`#{pkg_config} --cflags glib-2.0`
+  $LDFLAGS = `#{pkg_config} --libs glib-2.0`
+else
+  fail "glib2 not found"
+end
+
+create_header
+create_makefile('peg_multimarkdown')

data/ext/markdown.c

@@ -0,0 +1,102 @@
+#include "ruby.h"
+#include "markdown_peg.h"
+
+static VALUE rb_cMultiMarkdown;
+
+int get_exts(VALUE self)
+{
+    int extensions = 0;
+    if ( rb_funcall(self, rb_intern("smart"), 0) == Qtrue )
+        extensions = extensions | EXT_SMART ;
+    if ( rb_funcall(self, rb_intern("notes"), 0) == Qtrue )
+        extensions = extensions | EXT_NOTES ;
+    if ( rb_funcall(self, rb_intern("filter_html"), 0) == Qtrue )
+        extensions = extensions | EXT_FILTER_HTML ;
+    if ( rb_funcall(self, rb_intern("filter_styles"), 0) == Qtrue )
+        extensions = extensions | EXT_FILTER_STYLES ;
+    if ( rb_funcall(self, rb_intern("process_html"), 0) == Qtrue )
+        extensions = extensions | EXT_PROCESS_HTML;
+    /* Compatibility overwrites all other extensions */
+    if ( rb_funcall(self, rb_intern("compatibility"), 0) == Qtrue )
+        extensions = EXT_COMPATIBILITY;
+    return extensions;
+}
+
+static VALUE
+rb_multimarkdown_to_html(int argc, VALUE *argv, VALUE self)
+{
+    /* grab char pointer to multimarkdown input text */
+    VALUE text = rb_funcall(self, rb_intern("text"), 0);
+    Check_Type(text, T_STRING);
+    char * ptext = StringValuePtr(text);
+
+    int extensions = get_exts(self);
+
+    char *html = markdown_to_string(ptext, extensions, HTML_FORMAT);
+    VALUE result = rb_str_new2(html);
+    free(html);
+
+    return result;
+}
+
+static VALUE
+rb_multimarkdown_to_latex(int argc, VALUE *argv, VALUE self)
+{
+    /* grab char pointer to multimarkdown input text */
+    VALUE text = rb_funcall(self, rb_intern("text"), 0);
+    Check_Type(text, T_STRING);
+    char * ptext = StringValuePtr(text);
+
+    int extensions = get_exts(self);
+
+    char *latex = markdown_to_string(ptext, extensions, LATEX_FORMAT);
+    VALUE result = rb_str_new2(latex);
+    free(latex);
+
+    return result;
+}
+
+static VALUE
+rb_multimarkdown_extract_metadata(VALUE self, VALUE key)
+{
+    /* grab char pointer to multimarkdown input text */
+    VALUE text = rb_funcall(self, rb_intern("text"), 0);
+    Check_Type(text, T_STRING);
+    char * ptext = StringValuePtr(text);
+
+    Check_Type(key, T_STRING);
+    char * pkey = StringValuePtr(key);
+
+    int extensions = get_exts(self);
+
+    /* Display metadata on request */
+    char *metadata = extract_metadata_value(ptext, extensions, pkey);
+    VALUE result = rb_str_new2(metadata);
+    free(metadata);
+
+    return result;
+}
+
+void Init_peg_multimarkdown()
+{
+    rb_cMultiMarkdown = rb_define_class("PEGMultiMarkdown", rb_cObject);
+    /*
+     * Document-method: PEGMultiMarkdown#to_html
+     * Return string containing HTML generated from `text`
+     */
+    rb_define_method(rb_cMultiMarkdown, "to_html", rb_multimarkdown_to_html, -1);
+    /*
+     * Document-method: PEGMultiMarkdown#to_latex
+     * Return string containing latex generated from `text`
+     */
+    rb_define_method(rb_cMultiMarkdown, "to_latex", rb_multimarkdown_to_latex, -1);
+    /*
+     * Document-method: PEGMultiMarkdown#extract_metadata
+     * call-seq:
+     *     extract_metadata(key)
+     * Extract metadata specified by `key` from `text`
+     */
+    rb_define_method(rb_cMultiMarkdown, "extract_metadata", rb_multimarkdown_extract_metadata, 1);
+}
+
+// vim: ts=4 sw=4