maruku 0.6.1 → 0.7.0.beta1

data/lib/maruku/ext/fenced_code.rb

@@ -0,0 +1,97 @@
+# 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'
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#
+# Or:
+#
+# ```ruby
+# puts 'Hello world'
+# ```
+#
+
+#=begin maruku_doc
+# Attribute: :fenced_code_blocks
+# Scope: global, document
+# Summary: Enables fenced code blocks
+#=end
+
+module Maruku::In::Markdown
+  module FencedCode
+    OpenFence = /^([`~]{3,})(\w+)?\s*(\{([^{}]*?|".*?"|'.*?')*\})?\s*$/
+  end
+end
+
+MaRuKu::In::Markdown::register_block_extension(
+  :regexp  => Maruku::In::Markdown::FencedCode::OpenFence,
+  :handler => lambda do |doc, src, context|
+    return false unless doc.get_setting :fenced_code_blocks
+
+    first = src.shift_line
+    first =~ Maruku::In::Markdown::FencedCode::OpenFence
+    close_fence = /^#{$1}[`~]*$/
+    lang = $2
+    ial = $3
+
+    lines = []
+
+    # read until CloseFence
+    while src.cur_line
+      if src.cur_line =~ close_fence
+        src.shift_line
+        break
+      else
+        lines << 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))
+    end
+
+    source = "\n" + lines.join("\n") + "\n"
+    context.push doc.md_codeblock(source, lang, al)
+    true
+  end
+)

data/lib/maruku/ext/math.rb

@@ -1,5 +1,3 @@
-
-
 require 'maruku/ext/math/elements'
 require 'maruku/ext/math/parsing'
 require 'maruku/ext/math/to_latex'
@@ -10,32 +8,30 @@ 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
+#=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
-
+#=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] = [] 
+MaRuKu::Globals[:math_numbered] = []

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

@@ -1,27 +1,21 @@
-module MaRuKu; class MDElement
-	
-	def md_inline_math(math)
-		self.md_el(:inline_math, [], meta={:math=>math})
-	end
+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+)\}/
-		if math =~ reglabel
-			label = $1
-			math.gsub!(reglabel,'')
-		end
-#		puts "Found label = #{label} math #{math.inspect} "
-		num = nil
-		if (label || numerate) && @doc #take number
-			@doc.eqid2eq ||= {}	
-			num = @doc.eqid2eq.size + 1
-			label = "eq#{num}" if not label      # FIXME do id for document
-		end
-		e = self.md_el(:equation, [], meta={:math=>math, :label=>label,:num=>num})
-		if label && @doc #take number
-			@doc.eqid2eq[label] = e
-		end
-		e
-	end
-
-end 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}" unless 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/mathml_engines/blahtex.rb

@@ -1,107 +1,95 @@
-
-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)
-		begin
-			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) 
-				tmp_in = Tempfile.new('maruku_blahtex')
-				f = tmp_in.open
-				f.write tex
-				f.close
-
-				resolution = get_setting(:html_png_resolution)
-
-				options = "--png --use-preview-package --shell-dvipng 'dvipng -D #{resolution}' "
-				options += "--displaymath " if kind == :equation
-				options += ("--temp-directory '%s' " % get_setting(:html_png_dir))
-				options += ("--png-directory '%s'" % get_setting(:html_png_dir))
-
-				cmd = "blahtex #{options} < #{tmp_in.path} > #{result_file}"
-				#$stderr.puts "$ #{cmd}"
-        system cmd
-				tmp_in.delete
-			end
-			
+require 'rexml/document'
+
+module MaRuKu::Out::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 File.exists?(result_file)
       result = File.read(result_file)
-      if result.nil? || result.empty?
-        raise "Blahtex error: empty output"
-      end
-      
-			doc = Document.new(result, {:respect_whitespace =>:all})
-			png = doc.root.elements[1]
-			if png.name != 'png'
-				raise "Blahtex error: \n#{doc}"
-			end
-			depth = png.elements['depth'] || (raise "No depth element in:\n #{doc}")
-			height = png.elements['height'] || (raise "No height element in:\n #{doc}")
-			md5 = png.elements['md5'] || (raise "No md5 element in:\n #{doc}")
-			
-			depth = depth.text.to_f
-			height = height.text.to_f # XXX check != 0
-			md5 = md5.text
-			
-			dir_url = get_setting(:html_png_url)
-			return PNG.new("#{dir_url}#{md5}.png", depth, height)
-		rescue Exception => e
-			maruku_error "Error: #{e}"
-		end
-		nil
-	end
-
-  
-	def convert_to_mathml_blahtex(kind, tex)
-    @@BlahtexCache = PStore.new(get_setting(:latex_cache_file))
-    
-		begin
-			@@BlahtexCache.transaction do 
-				if @@BlahtexCache[tex].nil?
-					tmp_in = Tempfile.new('maruku_blahtex')
-						f = tmp_in.open
-						f.write tex
-						f.close
-					tmp_out = Tempfile.new('maruku_blahtex')
-	
-					options = "--mathml"
-					cmd = "blahtex #{options} < #{tmp_in.path} > #{tmp_out.path}"
-					#$stderr.puts "$ #{cmd}"
-					system cmd
-					tmp_in.delete
-					
-					result = nil
-					File.open(tmp_out.path) do |f| result=f.read end
-						puts result
-					
-          @@BlahtexCache[tex] = result
-				end
-			
-				blahtex = @@BlahtexCache[tex]
-				doc = Document.new(blahtex, {:respect_whitespace =>:all})
-				mathml = doc.root.elements['mathml']
-				if not mathml
-					maruku_error "Blahtex error: \n#{doc}"
-					return nil
-				else
-					return mathml
-				end
-			end
-			
-		rescue Exception => e
-			maruku_error "Error: #{e}"
-		end
-		nil
-	end
-
-end end end
+    else
+      args = [
+              '--png',
+              '--use-preview-package',
+              '--shell-dvipng',
+              "dvipng -D #{Shellwords.shellescape(get_setting(:html_png_resolution).to_s)}",
+              "--temp-directory #{Shellwords.shellescape(get_setting(:html_png_dir))}",
+              "--png-directory #{Shellwords.shellescape(get_setting(:html_png_dir))}"
+             ]
+      args << '--displaymath' if kind == :equation
+
+      result = run_blahtex(tex, args)
+    end
+
+    if result.nil? || result.empty?
+      maruku_error "Blahtex error: empty output"
+      return
+    end
+
+    doc = REXML::Document.new(result)
+    png = doc.root.elements.to_a.first
+    if png.name != 'png'
+      maruku_error "Blahtex error: \n#{doc}"
+      return
+    end
+
+    raise "No depth element in:\n #{doc}" unless depth = png.xpath('//depth')[0]
+    raise "No height element in:\n #{doc}" unless height = png.xpath('//height')[0]
+    raise "No md5 element in:\n #{doc}" unless md5 = png.xpath('//md5')[0]
+
+    depth = depth.text.to_f
+    height = height.text.to_f
+    raise "Height or depth was 0! in \n #{doc}" if height == 0 || depth == 0
+
+    md5 = md5.text
+
+    PNG.new("#{get_setting(:html_png_url)}#{md5}.png", depth, height)
+  rescue => e
+    maruku_error "Error: #{e}"
+    nil
+  end
+
+  def convert_to_mathml_blahtex(kind, tex)
+    result = run_blahtex(tex, %w[--mathml])
+
+    doc = REXML::Document.new(result)
+    mathml = doc.get_elements('//markup').to_a.first
+    unless mathml
+      maruku_error "Blahtex error: \n#{doc}"
+      return nil
+    end
+
+    mathml.name = 'math'
+    mathml.attributes['xmlns'] = "http://www.w3.org/1998/Math/MathML"
+    mathml.attributes['display'] = (kind == :inline) ? :inline : :block
+
+    MaRuKu::HTMLFragment.new(mathml.to_s)
+  rescue => e
+    maruku_error "Error: #{e}"
+    nil
+  end
+
+  private
+
+  # Run blahtex, return output
+  def run_blahtex(tex, args)
+    IO.popen(['blahtex', *args], 'w+') do |blahtex|
+      blahtex.write tex
+      blahtex.close_write
+
+      output = blahtex.read
+      blahtex.close_read
+
+      raise "Error running blahtex" unless $?.success?
+
+      output
+    end
+  end
+end

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

@@ -1,29 +1,36 @@
+module MaRuKu::Out::HTML
+  def convert_to_mathml_itex2mml(kind, tex)
+    return if $already_warned_itex2mml
+    begin
+      require 'itextomml'
+    rescue LoadError => e
+      maruku_error "Could not load package 'itex2mml'.\nPlease install it." unless $already_warned_itex2mml
+      $already_warned_itex2mml = true
+      return nil
+    end
 
-module MaRuKu; module Out; module HTML
+    begin
+      require 'instiki_stringsupport'
+    rescue LoadError
+      require 'itex_stringsupport'
+    end
 
-	def convert_to_mathml_itex2mml(kind, tex)
-		begin
-			if not $itex2mml_parser
-				require 'itextomml'
-				$itex2mml_parser =  Itex2MML::Parser.new
-			end
-			
-			itex_method = {:equation=>:block_filter,:inline=>:inline_filter}
-			
-			mathml =  $itex2mml_parser.send(itex_method[kind], tex)
-			doc = Document.new(mathml, {:respect_whitespace =>:all}).root
-			return doc
-		rescue LoadError => e
-			maruku_error "Could not load package 'itex2mml'.\n"+ "Please install it." 			unless $already_warned_itex2mml 
-			$already_warned_itex2mml = true
-		rescue REXML::ParseException => e
-			maruku_error "Invalid MathML TeX: \n#{add_tabs(tex,1,'tex>')}"+
-				"\n\n #{e.inspect}"
-		rescue 
-			maruku_error "Could not produce MathML TeX: \n#{tex}"+
-				"\n\n #{e.inspect}"
-		end
-		nil
-	end
+    parser = Itex2MML::Parser.new
+    mathml =
+      case kind
+      when :equation
+        parser.block_filter(tex)
+      when :inline
+        parser.inline_filter(tex)
+      else
+        maruku_error "Unknown itex2mml kind: #{kind}"
+        return
+      end
+
+    MaRuKu::HTMLFragment.new(mathml.to_utf8)
+  rescue => e
+    maruku_error "Invalid MathML TeX: \n#{tex.gsub(/^/, 'tex>')}\n\n #{e.inspect}"
+    nil
+  end
+end
 
-end end end