maruku 0.3.0 → 0.4.0

data/lib/maruku/input/type_detection.rb

@@ -0,0 +1,137 @@
+#--
+#   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
+#++
+
+class String
+	include MaRuKu::Strings
+	def md_type()
+		@md_type ||= line_md_type(self)
+	end
+end
+
+class NilClass
+	def md_type() nil end
+	
+end
+
+# This code does the classification of lines for block-level parsing.
+module MaRuKu; module Strings
+	
+	def line_md_type(l)
+		# The order of evaluation is important (:text is a catch-all)
+		return :text   if l =~ /^[a-zA-Z]/
+		return :code             if number_of_leading_spaces(l)>=4
+		return :empty    if l =~ /^\s*$/
+		return :footnote_text    if l =~ FootnoteText
+		return :ref_definition   if l =~ LinkRegex or l=~ IncompleteLink
+		return :abbreviation     if l =~ Abbreviation
+		return :definition       if l =~ Definition
+		# I had a bug with emails and urls at the beginning of the 
+		# line that were mistaken for raw_html
+		return :text     if l=~EMailAddress or l=~ URL
+		# raw html is like PHP Markdown Extra: at most three spaces before
+		return :raw_html if l =~ %r{^[ ]?[ ]?[ ]?</?\s*\w+}
+		return :raw_html if l =~ %r{[ ]{0,3}<\!\-\-}
+		return :ulist    if l =~ /^\s?([\*\-\+])\s+.*\w+/
+		return :olist    if l =~ /^\s?\d+\..*\w+/
+		return :header1  if l =~ /^(=)+/ 
+		return :header2  if l =~ /^([-\s])+$/ 
+		return :header3  if l =~ /^(#)+\s*\S+/ 
+		# at least three asterisks on a line, and only whitespace
+		return :hrule    if l =~ /^(\s*\*\s*){3,1000}$/ 
+		return :hrule    if l =~ /^(\s*-\s*){3,1000}$/ # or hyphens
+		return :hrule    if l =~ /^(\s*_\s*){3,1000}$/ # or underscores	
+		return :quote    if l =~ /^>/
+		return :metadata if l =~ /^@/
+#		if @@new_meta_data?
+			return :ald   if l =~ AttributeDefinitionList
+			return :ial   if l =~ /^\s{0,3}\{.*\}/
+#		end
+		return :text # else, it's just text
+	end
+
+	# $1 = id   $2 = attribute list
+	AttributeDefinitionList = /^\s{0,3}\{([\w\d\s]+)\}:\s*(.*)\s*$/
+
+	# Example:
+	#     ^:blah blah
+	#     ^: blah blah
+	#     ^   : blah blah
+	Definition = %r{ 
+		^ # begin of line
+		[ ]{0,3} # up to 3 spaces
+		: # colon
+		\s* # whitespace
+		(\S.*) # the text    = $1
+		$ # end of line
+	}x
+
+	# Example:
+	#     *[HTML]: Hyper Text Markup Language
+	Abbreviation = %r{
+		^  # begin of line
+		\* # one asterisk
+		\[ # opening bracket
+		([^\]]+) # any non-closing bracket:  id = $1
+		\] # closing bracket
+		:  # colon
+		\s* # whitespace
+		(\S.*\S)* #           definition=$2
+		\s* # strip this whitespace
+		$   # end of line
+	}x
+
+	FootnoteText = %r{
+		^\s*\[(\^.+)\]: # id = $1 (including '^')
+		\s*(\S.*)?$    # text = $2 (not obb.)
+	}x
+
+	# This regex is taken from BlueCloth sources
+	# Link defs are in the form: ^[id]: \n? url "optional title"
+	LinkRegex = %r{
+		^[ ]*\[([^\]]+)\]:		# id = $1
+		  [ ]*
+		<?(\S+)>?				# url = $2
+		  [ ]*
+		(?:# Titles are delimited by "quotes" or (parens).
+			["(']
+			(.+?)			# title = $3
+			[")']			# Matching ) or "
+			\s*(.+)?   # stuff = $4
+		)?	# title is optional
+	  }x
+
+	IncompleteLink = %r{^\s*\[(.+)\]:\s*$}
+
+	HeaderWithId = /^(.*)\{\#([\w_-]+)\}\s*$/
+
+	HeaderWithAttributes = /^(.*)\{(.*)\}\s*$/
+
+
+	# if contains a pipe, it could be a table header
+	MightBeTableHeader = %r{\|}
+	# -------------:
+	Sep = /\s*(\:)?\s*-+\s*(\:)?\s*/
+	# | -------------:| ------------------------------ |
+	TableSeparator = %r{^(\|?#{Sep}\|?)+\s*$}
+
+
+	EMailAddress = /<([^:]+@[^:]+)>/
+	URL = /^<http:/
+end end

data/lib/maruku/maruku.rb

@@ -0,0 +1,33 @@
+#--
+#   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
+#++
+
+
+# The Maruku class is the public interface
+
+class Maruku
+	
+	def initialize(s=nil, meta={})
+		super(nil)
+		self.attributes.merge! meta
+		if s
+			parse_doc(s)
+		end
+	end
+end

data/lib/maruku/{to_html.rb → output/to_html.rb}

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,6 +16,7 @@
 #   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
+#++
 
 
 require 'rexml/document'
@@ -24,9 +26,27 @@ require 'syntax'
 require 'syntax/convertors/html'
 
 
-class Maruku
-	include REXML
+class String
+	# A string is rendered into HTML by creating
+	# a REXML::Text node. REXML takes care of all the encoding.
+	def to_html
+		REXML::Text.new(self)
+	end
+end
+
+
+class REXML::Element
+	# We only want to output the children in Maruku::to_html
+	 public :write_children 
+end
+
+
 
+# This module groups all functions related to HTML export.
+module MaRuKu; module Out; module HTML
+	include REXML
+	include MaRuKu::Defaults
+	
 	# Render as an HTML fragment (no head, just the content of BODY). (returns a string)
 	def to_html(context={})
 		indent = context[:indent] || -1
@@ -38,13 +58,13 @@ class Maruku
 			end
 
 			# render footnotes
-			if @doc.meta[:footnotes_used]
+			if @doc.footnotes_order.size > 0
 				div << render_footnotes
 			end
 		
 		doc = Document.new(nil,{:respect_whitespace =>:all})
 		doc << div
-		add_whitespace(doc)
+		#add_whitespace(doc)
 		
 		# REXML Bug? if indent!=-1 whitespace is not respected for 'pre' elements
 		# containing code.
@@ -63,10 +83,7 @@ class Maruku
 		# REXML Bug? if indent!=-1 whitespace is not respected for 'pre' elements
 		# containing code.
 		doc.write(xml,indent,transitive=true,ie_hack);
-		
-#		encoding = ( (enc=@meta[:encoding]) ? 
-#			"encoding='#{enc}'" : "")
-		
+				
 		xhtml10strict  = "<?xml version='1.0' encoding='utf-8'?>
 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>\n"
@@ -81,20 +98,27 @@ class Maruku
 		root = Element.new('html', doc)
 		root.add_namespace('http://www.w3.org/1999/xhtml')
 		
-		lang = @meta[:lang] || 'en'
+		lang = @attributes[:lang] || 'en'
 		root.attributes['lang'] = lang
 		root.attributes['xml:lang'] = lang
 		
 		head = Element.new 'head', root
 		
+			#<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
+			me = Element.new 'meta', head
+			me.attributes['http-equiv'] = 'Content-type'
+			me.attributes['content'] = 'text/html; charset=utf-8'	
+		
 			# Create title element
-			doc_title = @meta[:title] || @meta[:subject] || ""
-			title = Element.new 'title'
+			doc_title = @attributes[:title] || @attributes[:subject] || ""
+			title = Element.new 'title', head
 				title << Text.new(doc_title)
-			head << title
+				
+			# Encoding
 			
 			
-			css = @meta[:css]
+			
+			css = @attributes[:css]
 			if css
 				# <link type="text/css" rel="stylesheet" href="..." />
 				link = Element.new 'link'
@@ -111,7 +135,7 @@ class Maruku
 			end
 
 			# render footnotes
-			if @doc.meta[:footnotes_used]
+			if @doc.footnotes_order.size > 0
 				body << render_footnotes
 			end
 			
@@ -121,7 +145,7 @@ class Maruku
 			
 		root << body
 		
-		add_whitespace(doc)
+	#	add_whitespace(doc)
 		doc
 	end
 	
@@ -182,17 +206,17 @@ class Maruku
 		div.attributes['class'] = 'footnotes'
 		div <<  Element.new('hr')
 			ol = Element.new 'ol'
-			@doc.meta[:footnotes_used].each_with_index do |fid, i| num = i+1
-				f = @footnotes[fid]
+			@doc.footnotes_order.each_with_index do |fid, i| num = i+1
+				f = self.footnotes[fid]
 				if f
-					li =  f.wrap_as_element('li')
+					li = f.wrap_as_element('li')
 					li.attributes['id'] = "fn:#{num}"
 					
 					a = Element.new 'a'
 						a.attributes['href'] = "#fnref:#{num}"
 						a.attributes['rev'] = 'footnote'
 						a<< Text.new('&#8617;', true, nil, true)
-					li.children.last << a
+					li.insert_after(li.children.last, a)
 					ol << li
 				else
 					maruku_error"Could not find footnote '#{fid}'"
@@ -201,17 +225,7 @@ class Maruku
 		div << ol
 		div
 	end
-end
-
-class String
-	# A string is rendered into HTML by creating
-	# a REXML::Text node. REXML takes care of all the encoding.
-	def to_html
-		REXML::Text.new(self)
-	end
-end
 
-class MDElement
 
 	def to_html_hrule; Element.new 'hr' end
 	def to_html_linebreak; Element.new 'br' end
@@ -222,43 +236,47 @@ class MDElement
 	def wrap_as_element(name)
 		m = create_html_element name
 			children_to_html.each do |e| m << e; end
+			
+#			m << Comment.new( "{"+self.al.to_md+"}") if not self.al.empty?
+#			m << Comment.new( @attributes.inspect) if not @attributes.empty?
 		m
 	end
 	
 	def create_html_element(name)
 		m = Element.new name
-			if @meta[:id] then m.attributes['id'] = @meta[:id].to_s end
-			if @meta[:style] then m.attributes['style'] = @meta[:style].to_s end
-			if @meta[:class] then m.attributes['class'] = @meta[:class].to_s end
+			if (v=@attributes[:id]   ) then m.attributes['id'   ] = v.to_s end
+			if (v=@attributes[:style]) then m.attributes['style'] = v.to_s end
+			if (v=@attributes[:class]) then m.attributes['class'] = v.to_s end
 		m
 	end
 
-	def to_html_paragraph; wrap_as_element('p')                end
 	
 	def to_html_ul
-		if @meta[:toc]
+		if @attributes[:toc]
 			# render toc
 			html_toc = @doc.toc.to_html
 			return html_toc
 		else
-			wrap_as_element('ul')               
+			add_ws  wrap_as_element('ul')               
 		end
 	end
 	
 	
-	def to_html_ol;        wrap_as_element('ol')               end
-	def to_html_li;        wrap_as_element('li')               end
-	def to_html_li_span;   wrap_as_element('li')               end
-	def to_html_quote;     wrap_as_element('blockquote')       end
+	def to_html_paragraph; add_ws wrap_as_element('p')                end
+	def to_html_ol;        add_ws wrap_as_element('ol')        end
+	def to_html_li;        add_ws wrap_as_element('li')        end
+	def to_html_li_span;   add_ws wrap_as_element('li')        end
+	def to_html_quote;     add_ws wrap_as_element('blockquote')  end
 	def to_html_strong;    wrap_as_element('strong')           end
 	def to_html_emphasis;  wrap_as_element('em')               end
 
 	# nil if not applicable, else string
 	def section_number
-		return nil if not @doc.meta[:use_numbered_headers]
+		return nil if not @doc.attributes[:use_numbered_headers]
 		
-		if (s = @section) and not s.section_number.empty?
-			 s.section_number.join('.')+". "
+		n = @attributes[:section_number]
+		if n && (not n.empty?)
+			 n.join('.')+". "
 		else
 			nil
 		end
@@ -278,13 +296,13 @@ class MDElement
 	end
 	
 	def to_html_header
-		element_name = "h#{@meta[:level]}" 
+		element_name = "h#{self.level}" 
 		h = wrap_as_element element_name
 		
 		if span = render_section_number
 			h.insert_before(h.children.first, span)
 		end
-		h
+		add_ws h
 	end
 
 	def source2html(source)
@@ -294,9 +312,9 @@ class MDElement
 	end
 		
 	def to_html_code; 
-		source = self.meta[:raw_code]	
+		source = self.raw_code
 
-		lang = self.meta[:lang] || @doc.meta[:code_lang] 
+		lang = @attributes[:lang] || @doc.attributes[:code_lang] 
 
 		lang = 'xml' if lang=='html'
 		use_syntax = get_setting(:html_use_syntax)
@@ -322,9 +340,9 @@ class MDElement
 				pre
 			rescue Object => e
 				maruku_error"Error while using the syntax library for code:\n#{source.inspect}"+
-				 "Lang is #{lang} object is: "+
-				  @meta.inspect + 
-				"Exception: #{e.class}: #{e.message}\n\t#{e.backtrace.join("\n\t")}"
+				 "Lang is #{lang} object is: \n"+
+				  self.inspect + 
+				"\nException: #{e.class}: #{e.message}\n\t#{e.backtrace.join("\n\t")}"
 				
 				tell_user("Using normal PRE because the syntax library did not work.")
 				to_html_code_using_pre(source)
@@ -362,7 +380,7 @@ class MDElement
 
 	def to_html_inline_code; 
 		pre = Element.new 'code'
-			source = self.meta[:raw_code]
+			source = self.raw_code
 			pre << source2html(source) 
 			
 			color = get_setting(:code_background_color, DEFAULT_CODE_COLOR)
@@ -375,9 +393,8 @@ class MDElement
 
 	def to_html_immediate_link
 		a = Element.new 'a'
-		url = @meta[:url]
-		text = url
-		text = text.gsub(/^mailto:/,'') # don't show mailto
+		url = self.url
+		text = url.gsub(/^mailto:/,'') # don't show mailto
 		a << Text.new(text)
 		a.attributes['href'] = url
 		a
@@ -385,38 +402,43 @@ class MDElement
 	
 	def to_html_link
 		a =  wrap_as_element 'a'
+		id = self.ref_id
+		# if empty, use text
+		if id.size == 0
+			id = children.to_s.downcase
+		end
 		
-		if id = @meta[:ref_id]
-			# if empty, use text
-			if id.size == 0
-				id = children.to_s.downcase
-			end
-			ref = @doc.refs[id]
-			if not ref
-				maruku_error"Could not find ref_id = #{id.inspect} for #{self.inspect}"
-				tell_user "Not creating a link for ref_id = #{id.inspect}."
-				return wrap_as_element('span')
-			else
-				url = ref[:url]
-				title = ref[:title]
-				a.attributes['href'] = url
-				a.attributes['title'] = title if title
-			end
+		if ref = @doc.refs[id]
+			url = ref[:url]
+			title = ref[:title]
+			a.attributes['href']=url if url
+			a.attributes['title']=title if title
 		else
-			url = @meta[:url]
-			title = @meta[:title]
-			if url
-				a.attributes['href'] = url
-				a.attributes['title'] = title if title
-			else
-				maruku_error"Could not find url in #{self.inspect}"
-				tell_user "Not creating a link for ref_id = #{id.inspect}."
-				return wrap_as_element('span')
-			end
+			maruku_error"Could not find ref_id = #{id.inspect} for #{self.inspect}"
+			tell_user "Not creating a link for ref_id = #{id.inspect}."
+			return wrap_as_element('span')
 		end
-		a
+		return a
+	end
+	
+	def to_html_im_link
+		a =  wrap_as_element 'a'
+		url = self.url
+		title = self.title
+		if url
+			a.attributes['href'] = url
+			a.attributes['title'] = title if title
+		else
+			maruku_error"Could not find url in #{self.inspect}"
+			tell_user "Not creating a link for ref_id = #{id.inspect}."
+			return wrap_as_element('span')
+		end
+		return a
 	end
 	
+	def add_ws(e)
+		[Text.new("\n"), e, Text.new("\n")]
+	end
 ##### Email address
 	
 	def obfuscate(s)
@@ -428,7 +450,7 @@ class MDElement
 	end
 	
 	def to_html_email_address
-		email = @meta[:email]
+		email = self.email
 		a = Element.new 'a'
 			#a.attributes['href'] = Text.new("mailto:"+obfuscate(email),false,nil,true)
 			#a.attributes.add Attribute.new('href',Text.new(
@@ -444,42 +466,43 @@ class MDElement
 
 	def to_html_image
 		a =  Element.new 'img'
-		if id = @meta[:ref_id]
-			ref = @doc.refs[id]
-			if not ref
-				maruku_error"Could not find id = #{id.inspect} for\n #{self.inspect}"
-				tell_user "Could not create image with ref_id = #{id.inspect};"+
-				 +" Using SPAN element as replacement."
-				return wrap_as_element('span')
-			else
-				url = ref[:url]
-				a.attributes['src'] = url
-	#			puts ref.inspect
-				[:title, :class, :style].each do |s| 
-					if ref[s] then
-						a.attributes[s.to_s] = ref[s]
-					end
+		id = self.ref_id
+		if ref = @doc.refs[id]
+			url = ref[:url]
+			a.attributes['src'] = url
+			[:title, :class, :style].each do |s| 
+				if ref[s] then
+					a.attributes[s.to_s] = ref[s]
 				end
 			end
 		else
-			url = @meta[:url]
-			title = @meta[:title] 
-			if not url
-				maruku_error"Image with no ID or url: #{self.inspect}"
-				tell_user "Could not create image with ref_id = #{id.inspect};"+
+			maruku_error"Could not find id = #{id.inspect} for\n #{self.inspect}"
+			tell_user "Could not create image with ref_id = #{id.inspect};"+
 				 +" Using SPAN element as replacement."
 				return wrap_as_element('span')
-			end
-			a.attributes['src'] = url
-			a.attributes['title'] = title if title
 		end
-		a
+		return a
+	end
+	
+	def to_html_im_image
+		a =  Element.new 'img'
+		url = self.url
+		title = self.title
+		if not url
+			maruku_error"Image with no url: #{self.inspect}"
+			tell_user "Could not create image with ref_id = #{id.inspect};"+
+			 +" Using SPAN element as replacement."
+			return wrap_as_element('span')
+		end
+		a.attributes['src'] = url
+		a.attributes['title'] = title if title
+		return a
 	end
 
 	def to_html_raw_html
-		raw_html = @meta[:raw_html]
+		raw_html = self.raw_html
 		if rexml_doc = @parsed_html
-			root =  rexml_doc.root
+			root = rexml_doc.root
 			if root.nil?
 				s = "Bug in REXML: root() of Document is nil: \n#{rexml_doc.inspect}\n"+
 				"Raw HTML:\n#{raw_html.inspect}"
@@ -490,10 +513,13 @@ class MDElement
 				return div
 			end
 			
-			return root
+			# copies the @children array (FIXME is it deep?)
+			elements =  root.to_a 
+			return elements
 		else # invalid
 			# Creates red box with offending HTML
-			tell_user 'Wrapping bad html in a PRE with class "markdown-html-error"'
+			tell_user "Wrapping bad html in a PRE with class 'markdown-html-error'\n"+
+				add_tabs(raw_html,1,'|')
 			pre = Element.new('pre')
 			pre.attributes['style'] = 'border: solid 3px red; background-color: pink'
 			pre.attributes['class'] = 'markdown-html-error'
@@ -502,18 +528,18 @@ class MDElement
 		end
 	end
 
-	def to_html_abbreviation
+	def to_html_abbr
 		abbr = Element.new 'abbr'
 		abbr << Text.new(children[0])
-		abbr.attributes['title'] = self.meta[:title] if self.meta[:title]
+		abbr.attributes['title'] = self.title if self.title
 		abbr
 	end
 	
 	def to_html_footnote_reference
-		id = @meta[:footnote_id]
+		id = self.footnote_id
 		
 		# save the order of used footnotes
-		order = (@doc.meta[:footnotes_used] ||= [])
+		order = @doc.footnotes_order
 		
 		# take next number
 		order << id
@@ -541,7 +567,7 @@ class MDElement
 
 ## Table ###	
 	def to_html_table
-		align = @meta[:align]
+		align = self.align
 		num_columns = align.size
 
 		head = @children.slice(0, num_columns)
@@ -577,18 +603,10 @@ class MDElement
 	def to_html_cell; wrap_as_element('td') end
 	
 	def to_html_entity 
-		entity_name = @meta[:entity_name]
+		entity_name = self.entity_name
 		Text.new('&%s;' % [entity_name])
 	end
-end
 
-# We only want to output the children in Maruku::to_html
-class REXML::Element; public :write_children end
-
-# Some utilities
-class MDElement
-	include REXML
-	
 	# Convert each child to html
 	def children_to_html
 		array_to_html(@children)
@@ -599,18 +617,19 @@ class MDElement
 		array.each do |c|
 			method = c.kind_of?(MDElement) ? 
 			   "to_html_#{c.node_type}" : "to_html"
-			
+
 			if not c.respond_to?(method)
-				raise "Object does not answer to #{method}: #{c.class} #{c.inspect}"
+				#raise "Object does not answer to #{method}: #{c.class} #{c.inspect}"
+				next
 			end
-			
+
 			h =  c.send(method)
-			
+
 			if h.nil?
 				raise "Nil html created by method  #{method}:\n#{h.inspect}\n"+
 				" for object #{c.inspect[0,300]}"
 			end
-			
+
 			if h.kind_of?Array
 				e = e + h #h.each do |hh| e << hh end
 			else
@@ -619,10 +638,10 @@ class MDElement
 		end
 		e
 	end
-	
+
 	def to_html_ref_definition; [] end
 	def to_latex_ref_definition; [] end
-	
-end
-
 
+end # HTML
+end # out
+end # MaRuKu