patcito-maruku 0.6.0

data/lib/maruku/defaults.rb

@@ -0,0 +1,69 @@
+#   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
+#
+# This file is part of Maruku.
+#
+#   Maruku 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.
+#
+#   Maruku 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 Maruku; if not, write to the Free Software
+#   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+module MaRuKu
+
+  Globals = {
+    :unsafe_features => false,
+    :on_error => :warning,
+    
+    :yaml_frontmatter => false,
+
+    :use_numbered_headers => false,
+
+    :maruku_signature => false,
+    :code_background_color => '#fef',
+    :code_show_spaces => false,
+
+    :filter_html => false,
+    
+    :html_math_output_mathjax => true,
+    :html_math_output_span_equations => false,
+
+    :html_math_output_mathml => true, # also set :html_math_engine
+    :html_math_engine => 'none', #ritex, itex2mml
+
+    :html_math_output_png => false,
+    :html_png_engine => 'none',
+    :html_png_dir => 'pngs',
+    :html_png_url => 'pngs/',
+    :html_png_resolution => 200,
+
+    :html_use_syntax => false,
+
+    :latex_use_listings => false,
+    :latex_cjk => false,
+    :latex_cache_file  => "blahtex_cache.pstore", # cache file for blahtex filter
+
+    :debug_keep_ials => false,
+    :doc_prefix => ''
+  }
+
+  class MDElement
+    def get_setting(sym)
+      return attributes[sym] if attributes.has_key?(sym)
+      return doc.attributes[sym] if doc && doc.attributes.has_key?(sym)
+      return MaRuKu::Globals[sym] if MaRuKu::Globals.has_key?(sym)
+
+      $stderr.puts "Bug: no default for #{sym.inspect}"
+      nil
+    end
+  end
+
+end

data/lib/maruku/errors.rb

@@ -0,0 +1,89 @@
+#   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
+#
+# This file is part of Maruku.
+#
+#   Maruku 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.
+#
+#   Maruku 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 Maruku; if not, write to the Free Software
+#   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+module MaRuKu
+  class Exception < RuntimeError; end
+
+  module Errors
+    FRAME_WIDTH = 75
+
+    # Properly handles a formatting error.
+    # All such errors go through this method.
+    #
+    # The behavior depends on {MaRuKu::Globals `MaRuKu::Globals[:on_error]`}.
+    # If this is `:warning`, this prints the error to stderr
+    # (or `@error_stream if` it's defined) and tries to continue.
+    # If `:on_error` is `:ignore`, this doesn't print anything
+    # and tries to continue. If it's `:raise`, this raises a {MaRuKu::Exception}.
+    #
+    # By default, `:on_error` is set to `:warning`.
+    #
+    # @overload def maruku_error(s, src = nil, con = nil)
+    # @param s [String] The text of the error
+    # @param src [#describe, nil] The source of the error
+    # @param con [#describe, nil] The context of the error
+    # @raise [MaRuKu::Exception] If `:on_error` is set to `:raise`
+    def maruku_error(*args)
+      policy = get_setting(:on_error)
+
+      case policy
+      when :ignore
+      when :raise
+        raise_error create_frame(describe_error(*args))
+      when :warning
+        tell_user create_frame(describe_error(*args))
+      else
+        raise "Unknown on_error policy: #{policy.inspect}"
+      end
+    end
+
+    def maruku_recover(*args)
+      tell_user create_frame(describe_error(*args))
+    end
+    alias error maruku_error
+
+    def raise_error(s)
+      raise MaRuKu::Exception, s, caller
+    end
+
+    def tell_user(s)
+      (self.attributes[:error_stream] || $stderr) << s
+    end
+
+    private
+
+    def create_frame(s)
+      "\n" + <<FRAME
+ #{"_" * FRAME_WIDTH}
+| Maruku tells you:
++#{"-" * FRAME_WIDTH}
+#{s.gsub(/^/, '| ').rstrip}
++#{"-" * FRAME_WIDTH}
+#{caller[0...5].join("\n").gsub(/^/, '!')}
+\\#{"_" * FRAME_WIDTH}
+FRAME
+    end
+
+    def describe_error(s, src = nil, con = nil)
+      s += "\n#{src.describe}\n" if src
+      s += "\n#{con.describe}\n" if con
+      s
+    end
+  end
+end

data/lib/maruku/ext/div.rb

@@ -0,0 +1,121 @@
+#+-----------------------------------{.warning}------
+#| this is the last warning!
+#|
+#| please, go away!
+#|
+#| +------------------------------------- {.menace} --
+#| | or else terrible things will happen
+#| +--------------------------------------------------
+#+---------------------------------------------------
+
+# TODO: Scope these properly
+OpenDiv = /^[ ]{0,3}\+\-\-+\s*(\{([^{}]*?|".*?"|'.*?')*\})?\s*\-*\s*$/
+CloseDiv = /^[ ]{0,3}\=\-\-+\s*(\{([^{}]*?|".*?"|'.*?')*\})?\s*\-*\s*$/
+StartPipe = /^[ ]{0,3}\|(.*)$/ # $1 is rest of line
+DecorativeClosing = OpenDiv
+
+MaRuKu::In::Markdown.register_block_extension(
+  :regexp  => OpenDiv,
+  :handler => lambda do |doc, src, context|
+    first = src.shift_line
+    ial_at_beginning = first[OpenDiv, 1]
+    ial_at_end = nil
+
+    lines = []
+    # if second line starts with "|"
+    if src.cur_line =~ StartPipe
+      # then we read until no more "|"
+      while src.cur_line && src.cur_line =~ StartPipe
+        lines.push $1
+        src.shift_line
+      end
+      if src.cur_line =~ DecorativeClosing
+        ial_at_end = $1
+        src.shift_line
+      end
+    else
+      # else we read until CloseDiv
+      divs_open = 1
+      while src.cur_line && divs_open > 0
+        if src.cur_line =~ CloseDiv
+          divs_open -= 1
+          if divs_open == 0
+            ial_at_end = $1
+            src.shift_line
+            break
+          else
+            lines.push src.shift_line
+          end
+        else
+          if src.cur_line =~ OpenDiv
+            divs_open += 1
+          end
+          lines.push src.shift_line
+        end
+      end
+
+      if divs_open > 0
+        doc.maruku_error("At end of input, I still have #{divs_open} DIVs open.",
+          src, context)
+        next true
+      end
+    end
+
+    ial_at_beginning = nil unless ial_at_beginning && ial_at_beginning.size > 0
+    ial_at_end = nil unless ial_at_end && ial_at_end.size > 0
+
+    if ial_at_beginning && ial_at_end
+      doc.maruku_error("Found two conflicting IALs: #{ial_at_beginning.inspect} and #{ial_at_end.inspect}",
+        src, context)
+    end
+
+    al_string = ial_at_beginning || ial_at_end
+    al = nil
+
+    if al_string =~ /^\{(.*)\}\s*$/
+      al = al_string && doc.read_attribute_list(
+        MaRuKu::In::Markdown::SpanLevelParser::CharSource.new($1),
+        nil, [nil])
+    end
+
+    context.push(
+      doc.md_div(
+        doc.parse_blocks(
+          MaRuKu::In::Markdown::BlockLevelParser::LineSource.new(lines)),
+        al))
+    true
+  end)
+
+module MaRuKu
+  class MDElement
+    def md_div(children, al = nil)
+      type = label = num = nil
+      doc.refid2ref ||= {}
+      if al
+        al.each do |k, v|
+          case k
+          when :class; type = $1 if v =~ /^num_(\w*)/
+          when :id; label = v
+          end
+        end
+      end
+
+      if type
+        doc.refid2ref[type] ||= {}
+        num = doc.refid2ref[type].length + 1
+      end
+
+      e = self.md_el(:div, children, {:label => label, :type => type, :num => num}, al)
+      doc.refid2ref[type].update(label => e) if type && label
+      e
+    end
+  end
+
+  module Out
+    module HTML
+      def to_html_div
+        add_ws wrap_as_element('div')
+      end
+    end
+  end
+end

data/lib/maruku/ext/fenced_code.rb

@@ -0,0 +1,78 @@
+# fenced_code.rb -- Maruku extension for fenced code blocks
+#
+# Copyright (C) 2009 Jason R. Blevins
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the names of the copyright holders nor the names of any
+#    contributors may be used to endorse or promote products derived from this
+#    software 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 HOLDER 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.
+#
+# Fenced code blocks begin with three or more tildes and are terminated
+# by a closing line with at least as many tildes as the opening line.
+# Optionally, an attribute list may appear at the end of the opening
+# line.  For example:
+#
+# ~~~~~~~~~~~~~ {: lang=ruby }
+# puts 'Hello world'
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+OpenFence = /^(~~~+?)\s*(\{([^{}]*?|".*?"|'.*?')*\})?\s*$/
+
+MaRuKu::In::Markdown::register_block_extension(
+	:regexp  => OpenFence,
+	:handler => lambda { |doc, src, context|
+
+	first = src.shift_line
+	first =~ OpenFence
+	close_fence = /^#{$1}~*$/
+	ial = $2
+
+	lines = []
+
+	# read until CloseFence
+	while src.cur_line
+		if src.cur_line =~ close_fence
+			src.shift_line
+			break
+		else
+			lines.push src.shift_line
+		end
+	end
+
+	ial = nil unless (ial && ial.size > 0)
+	al = nil
+
+	if ial =~ /^\{(.*?)\}\s*$/
+		inside = $1
+		cs = MaRuKu::In::Markdown::SpanLevelParser::CharSource
+		al = ial &&
+			doc.read_attribute_list(cs.new(inside),
+				its_context=nil, break_on=[nil])
+	end
+
+	source = lines.join("\n")
+	context.push doc.md_codeblock(source, al)
+	true
+})

data/lib/maruku/ext/math.rb

@@ -0,0 +1,37 @@
+require 'maruku/ext/math/elements'
+require 'maruku/ext/math/parsing'
+require 'maruku/ext/math/to_latex'
+require 'maruku/ext/math/to_html'
+
+require 'maruku/ext/math/mathml_engines/none'
+require 'maruku/ext/math/mathml_engines/ritex'
+require 'maruku/ext/math/mathml_engines/itex2mml'
+require 'maruku/ext/math/mathml_engines/blahtex'
+
+=begin maruku_doc
+Attribute: math_enabled
+Scope: global, document
+Summary: Enables parsing of LaTeX math 
+
+To explicitly disable the math parsing:
+
+	Maruku.new(string, {:math_enabled => false})
+	{:ruby}
+	
+=end
+
+MaRuKu::Globals[:math_enabled] = true
+
+
+=begin maruku_doc
+Attribute: math_numbered
+Scope: global, document
+Summary: Math openings which should be numerated
+
+Array containing any of `'\\['`, `'\\begin{equation}'`, `'$$'`.
+
+	MaRuKu::Globals[:math_numbered] = ['\\[']
+	
+=end
+
+MaRuKu::Globals[:math_numbered] = [] 

data/lib/maruku/ext/math/elements.rb

@@ -0,0 +1,21 @@
+module MaRuKu
+  class MDElement
+    def md_inline_math(math)
+      self.md_el(:inline_math, [], :math => math)
+    end
+
+    def md_equation(math, label, numerate)
+      reglabel = /\\label\{(\w+)\}/
+      math = math.gsub(reglabel, '') if label = math[reglabel, 1]
+      num = nil
+      if (label || numerate) && @doc # take number
+        @doc.eqid2eq ||= {}
+        num = @doc.eqid2eq.size + 1
+        label = "eq#{num}" if not label # TODO do id for document
+      end
+      e = self.md_el(:equation, [], :math => math, :label => label, :num => num)
+      @doc.eqid2eq[label] = e if label && @doc # take number
+      e
+    end
+  end
+end

data/lib/maruku/ext/math/latex_fix.rb

@@ -0,0 +1,12 @@
+class String
+	# fix some LaTeX command-name clashes
+	def fix_latex
+		if #{html_math_engine} == 'itex2mml'
+			s = self.gsub("\\mathop{", "\\operatorname{")
+			s.gsub!(/\\begin\{svg\}.*?\\end\{svg\}/m, " ")
+                        s.gsub("\\space{", "\\itexspace{")
+		else
+			self
+		end
+	end
+end

data/lib/maruku/ext/math/mathml_engines/blahtex.rb

@@ -0,0 +1,93 @@
+require 'tempfile'
+require 'fileutils'
+require 'digest/md5'
+require 'pstore'
+
+module MaRuKu
+  module Out
+    module HTML
+      PNG = Struct.new(:src, :depth, :height)
+
+      def convert_to_png_blahtex(kind, tex)
+        FileUtils.mkdir_p get_setting(:html_png_dir)
+
+        # first, we check whether this image has already been processed
+        md5sum = Digest::MD5.hexdigest(tex + " params: ")
+        result_file = File.join(get_setting(:html_png_dir), md5sum + ".txt")
+
+        if not File.exists?(result_file)
+          Tempfile.open('maruku_blahtex') do |tmp_in|
+            tmp_in.write tex
+            tmp_in.close
+
+            # It's important taht we don't replace *all* newlines,
+            # because newlines in arguments get escaped as "'\n'".
+            system <<COMMAND.gsub("\n  ", " ")
+blahtex --png --use-preview-package
+  --shell-dvipng #{shellescape("dvipng -D #{shellescape(get_setting(:html_png_resolution).to_s)}")}
+  #{'--displaymath' if kind == :equation}
+  --temp-directory #{shellescape(get_setting(:html_png_dir))}
+  --png-directory #{shellescape(get_setting(:html_png_dir))}
+  < #{shellescape(tmp_in.path)}
+  > #{shellescape(result_file)}
+COMMAND
+          end
+        end
+
+        result = File.read(result_file)
+        if result.nil? || result.empty?
+          maruku_error "Blahtex error: empty output"
+          return
+        end
+
+        doc = Document.new(result, :respect_whitespace => :all)
+        png = doc.root.elements[1]
+        if png.name != 'png'
+          maruku_error "Blahtex error: \n#{doc}"
+          return
+        end
+
+        raise "No depth element in:\n #{doc}" unless depth = png.elements['depth']
+        raise "No height element in:\n #{doc}" unless height = png.elements['height']
+        raise "No md5 element in:\n #{doc}" unless md5 = png.elements['md5']
+
+        depth = depth.text.to_f
+        height = height.text.to_f # TODO: check != 0
+        md5 = md5.text
+
+        PNG.new("#{get_setting(:html_png_url)}#{md5}.png", depth, height)
+      rescue Exception => e
+        maruku_error "Error: #{e}"
+      end
+
+
+      def convert_to_mathml_blahtex(kind, tex)
+        @@BlahtexCache ||= PStore.new(get_setting(:latex_cache_file))
+
+        @@BlahtexCache.transaction do
+          if @@BlahtexCache[tex].nil?
+            Tempfile.open('maruku_blahtex') do |tmp_in|
+              tmp_in.write tex
+
+              Tempfile.new('maruku_blahtex') do |tmp_out|
+                system "blahtex --mathml < #{shellescape(tmp_in.path)} > #{shellescape(tmp_out.path)}"
+                @@BlahtexCache[tex] = tmp_out.read
+              end
+            end
+          end
+
+          blahtex = @@BlahtexCache[tex]
+          doc = Document.new(blahtex, :respect_whitespace => :all)
+          unless mathml = doc.root.elements['mathml']
+            maruku_error "Blahtex error: \n#{doc}"
+            return
+          end
+
+          return mathml
+        end
+      rescue Exception => e
+        maruku_error "Error: #{e}"
+      end
+    end
+  end
+end