maruku 0.3.0 → 0.4.0

data/lib/maruku/tests/tests.rb

@@ -1,3 +1,23 @@
+#--
+#   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
+#++
+
 
 require 'maruku'
 

data/lib/maruku/toc.rb

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,21 +16,19 @@
 #   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'
 
-
-class Maruku
+module MaRuKu
+	
+class MDDocument
 	# an instance of Section (see below)
 	attr_accessor :toc 
 end
 
-
-
-class MDElement	
 	# This represents a section in the TOC.
 	class Section
-		# a Fixnum, is == header_element.meta[:level]
+		# a Fixnum, is == header_element.level
 		attr_accessor :section_level 
 		
 		# An array of fixnum, like [1,2,5] for Section 1.2.5
@@ -40,25 +39,23 @@ class MDElement
 
 		# Array of immediate children of this element
 		attr_accessor :immediate_children
+		
 		# Array of Section inside this section
 		attr_accessor :section_children
 		
-		
 		def initialize
 			@immediate_children = []
 			@section_children = []
 		end
 	end 
-end
 
-
-class MDElement
 	class Section
 		def inspect(indent=1)
 			s = ""
 			if @header_element
 				s +=  "\_"*indent +  "(#{@section_level})>\t #{@section_number.join('.')} : "
-				s +=  @header_element.children_to_s + " (id: '#{@header_element.meta[:id]}')\n"
+				s +=  @header_element.children_to_s +
+				 " (id: '#{@header_element.attributes[:id]}')\n"
 			else
 				s += "Master\n"
 			end
@@ -75,6 +72,9 @@ class MDElement
 			section_children.each_with_index do |c,i|
 				c.numerate(a.clone.push(i+1))
 			end
+			if h = self.header_element
+				h.attributes[:section_number] = self.section_number
+			end
 		end
 		
 		include REXML
@@ -98,7 +98,7 @@ class MDElement
 				end
 				a = c.header_element.wrap_as_element('a')
 					a.delete_attribute 'id'
-					a.attributes['href'] = "##{c.header_element.meta[:id]}"
+					a.attributes['href'] = "##{c.header_element.attributes[:id]}"
 				li << a
 				li << c.create_toc if c.section_children.size>0
 				ul << li
@@ -119,7 +119,7 @@ class MDElement
 				number = c.header_element.section_number
 				s += number if number
 					text = c.header_element.children_to_latex
-					id = c.header_element.meta[:id]
+					id = c.header_element.attributes[:id]
 				s += "\\hyperlink{#{id}}{#{text}}"
 				s += "\\dotfill \\pageref*{#{id}} \\linebreak\n"
 				s += c.to_latex_rec  if c.section_children.size>0
@@ -129,71 +129,71 @@ class MDElement
 		end
 		
 	end
-end
-
 
-class MDElement
+	class MDDocument
 	
-	
-	def create_toc
-		stack = []
+		def create_toc
+			each_element(:header) do |h|
+				h.attributes[:id] ||= h.generate_id
+			end
 		
-		# the ancestor section
-		s = Section.new
-		s.section_level = 0
+			stack = []
+		
+			# the ancestor section
+			s = Section.new
+			s.section_level = 0
 
-		stack.push s
+			stack.push s
 	
-		i = 0;
-		while i < @children.size
-			
-			while i < @children.size 
-				if @children[i].node_type == :header
-					level = @children[i].meta[:level]
-					break if level <= stack.last.section_level+1
-				end
+			i = 0;
+			while i < @children.size
+				while i < @children.size 
+					if @children[i].node_type == :header
+						level = @children[i].level
+						break if level <= stack.last.section_level+1
+					end
 				
-				stack.last.immediate_children.push @children[i]
-				i += 1
-			end
+					stack.last.immediate_children.push @children[i]
+					i += 1
+				end
 
-			break if i>=@children.size
+				break if i>=@children.size
 			
-			header = @children[i]
-			level = header.meta[:level]
+				header = @children[i]
+				level = header.level
 			
-			if level > stack.last.section_level
-				# this level is inside
+				if level > stack.last.section_level
+					# this level is inside
 				
-				s2 = Section.new
-				s2.section_level = level
-				s2.header_element = header
-				header.instance_variable_set :@section, s2
+					s2 = Section.new
+					s2.section_level = level
+					s2.header_element = header
+					header.instance_variable_set :@section, s2
 				
-				stack.last.section_children.push s2
-				stack.push s2
+					stack.last.section_children.push s2
+					stack.push s2
 				
-				i+=1
-			elsif level == stack.last.section_level
-				# this level is a sibling
-				stack.pop
-			else 
-				# this level is a parent
-				stack.pop
-			end
+					i+=1
+				elsif level == stack.last.section_level
+					# this level is a sibling
+					stack.pop
+				else 
+					# this level is a parent
+					stack.pop
+				end
 			
-		end
+			end
 
-		# If there is only one big header, then assume
-		# it is the master
-		if s.section_children.size == 1
-			s = s.section_children.first
-		end
+			# If there is only one big header, then assume
+			# it is the master
+			if s.section_children.size == 1
+				s = s.section_children.first
+			end
 		
-		# Assign section numbers
-		s.numerate
+			# Assign section numbers
+			s.numerate
 	
-		s
+			s
+		end
 	end
-	
 end

data/lib/maruku/usage/example1.rb

@@ -0,0 +1,33 @@
+require 'maruku'
+
+text = <<EOF
+Chapter 1
+=========
+
+It was a stormy and rainy night.
+
+EOF
+
+invalid = <<EOF
+
+This is a [bad link.
+
+EOF
+
+Maruku.new(text).to_html
+
+s = ""
+
+begin 
+	Maruku.new(invalid, {:on_error => :raise, :error_stream => s})
+	puts "Error! It should have thrown an exception."
+rescue
+	# puts "ok, got error"
+end
+
+begin 
+	Maruku.new(invalid, {:on_error => :warning, :error_stream => s})
+rescue
+	puts "Error! It should not have thrown an exception."
+end
+

data/lib/maruku/version.rb

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,9 +16,10 @@
 #   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 Maruku
-	Version = '0.3.0'
+module MaRuKu
+	Version = '0.4.0'
 	
 	MarukuURL = 'http://maruku.rubyforge.org/'
 	
@@ -29,4 +31,8 @@ class Maruku
 		true
 	end
 	
+	def new_meta_data?
+		true
+	end
+	
 end

data/tests/unittest/abbreviations.md

@@ -17,17 +17,20 @@ Operation Tigra Genesis is going well.
 md_el(:document,[
 	md_par([
 		"The ",
-		 md_el(:abbreviation,["HTML"] , {:title=>"Hyper Text Markup Language"}),
-		 " specification is maintained by the ",
-		 md_el(:abbreviation,["W3C"] , {:title=>"World Wide Web Consortium"}),
-		 "."
+		md_el(:abbr,["HTML"],{:title=>"Hyper Text Markup Language"},[]),
+		" specification is maintained by the ",
+		md_el(:abbr,["W3C"],{:title=>"World Wide Web Consortium"},[]),
+		"."
 	]),
-	 md_par([
+	md_el(:abbr_def,[],{:text=>"Hyper Text Markup Language",:abbr=>"HTML"},[]),
+	md_el(:abbr_def,[],{:text=>"World Wide Web Consortium",:abbr=>"W3C"},[]),
+	md_par([
 		"Operation ",
-		 md_el(:abbreviation,["Tigra Genesis"] ),
-		 " is going well."
-	])
-] )
+		md_el(:abbr,["Tigra Genesis"],{:title=>nil},[]),
+		" is going well."
+	]),
+	md_el(:abbr_def,[],{:text=>nil,:abbr=>"Tigra Genesis"},[])
+],{},[])
 *** Output of to_html ***
 
 <p>The <abbr title='Hyper Text Markup Language'>HTML</abbr> specification is maintained by the <abbr title='World Wide Web Consortium'>W3C</abbr>.</p>
@@ -40,8 +43,16 @@ The HTML specification is maintained by the W3C.
 Operation Tigra Genesis is going well.
 
 
-*** Output of to_s ***
-The HTML specification is maintained by the W3C.Operation Tigra Genesis is going well.
+*** Output of to_md ***
+The HTMLspecification is maintained by
+the W3C.
+
+*[HTML]: Hyper Text Markup Language
+*[W3C]: World Wide Web Consortium
+Operation Tigra Genesisis going well.
+
+*[Tigra Genesis]: 
+
 *** Output of to_s ***
 The HTML specification is maintained by the W3C.Operation Tigra Genesis is going well.
 *** EOF ***
@@ -64,8 +75,8 @@ The HTML specification is maintained by the W3C.Operation Tigra Genesis is going
 
 *** Output of Markdown.pl (parsed) ***
 <p>The HTML specification is maintained by the W3C.</p
-   ><p>*[HTML]: Hyper Text Markup Language
-*[W3C]:  World Wide Web Consortium</p
-   ><p>Operation Tigra Genesis is going well.</p
-   ><p>*[Tigra Genesis]:</p
- >
+    ><p>*[HTML]: Hyper Text Markup Language
+*[W3C]: World Wide Web Consortium</p
+    ><p>Operation Tigra Genesis is going well.</p
+    ><p>*[Tigra Genesis]:</p
+  >

data/tests/unittest/attributes/attributes.md

@@ -0,0 +1,89 @@
+This is a simple test for attributes
+*** Parameters: ***
+{}
+*** Markdown input: ***
+
+Header with attributes	{#header1}	
+----------------------
+
+### Header with attributes ###	{#header2}	
+
+### Header no attributes ###
+
+{warn2}Paragraph with a.
+{#par1}
+
+Paragraph with *emphasis*{hello notfound}
+   {#par2}
+
+{hello}: .chello
+*** Output of inspect ***
+md_el(:document,[
+	md_el(:header,["Header with attributes"],{:level=>2},[[:id, "header1"]]),
+	md_el(:header,["Header with attributes"],{:level=>3},[[:id, "header2"]]),
+	md_el(:header,["Header no attributes"],{:level=>3},[[:id, "par1"]]),
+	md_par([
+		"Paragraph with ",
+		md_em(["emphasis"], [[:ref, "hello"], [:ref, "notfound"]]),
+		md_ial([[:ref, "hello"], [:ref, "notfound"]])
+	], [[:id, "par2"]]),
+	md_el(:ald,[],{:ald_id=>"hello",:ald=>[[:class, "chello"]]},[])
+],{},[])
+*** Output of to_html ***
+
+<h2 id='header1'>Header with attributes</h2>
+
+<h3 id='header2'>Header with attributes</h3>
+
+<h3 id='par1'>Header no attributes</h3>
+
+<p id='par2'>Paragraph with <em class='chello'>emphasis</em></p>
+
+*** Output of to_latex ***
+\hypertarget{header1}{}\subsection*{{Header with attributes}}\label{header1}
+
+\hypertarget{header2}{}\subsubsection*{{Header with attributes}}\label{header2}
+
+\hypertarget{par1}{}\subsubsection*{{Header no attributes}}\label{par1}
+
+Paragraph with {\em emphasis}
+
+
+*** Output of to_md ***
+Header with attributesHeader with attributesHeader no attributesParagraph with emphasis
+*** Output of to_s ***
+Header with attributesHeader with attributesHeader no attributesParagraph with emphasis
+*** EOF ***
+
+
+
+	OK!
+
+
+
+*** Output of Markdown.pl ***
+<h2>Header with attributes  {#header1}  </h2>
+
+<h3>Header with attributes ###  {#header2}</h3>
+
+<h3>Header no attributes</h3>
+
+<p>{warn2}Paragraph with a.
+{#par1}</p>
+
+<p>Paragraph with <em>emphasis</em>{hello notfound}
+   {#par2}</p>
+
+<p>{hello}: .chello</p>
+
+*** Output of Markdown.pl (parsed) ***
+<h2>Header with attributes {#header1} </h2
+    ><h3>Header with attributes ### {#header2}</h3
+    ><h3>Header no attributes</h3
+    ><p>{warn2}Paragraph with a.
+{#par1}</p
+    ><p>Paragraph with <em>emphasis</em
+      >{hello notfound}
+ {#par2}</p
+    ><p>{hello}: .chello</p
+  >

data/tests/unittest/attributes/circular.md

@@ -0,0 +1,51 @@
+
+*** Parameters: ***
+{}
+*** Markdown input: ***
+
+Paragraph
+{a}
+
+
+{a}: b
+{b}: a
+
+*** Output of inspect ***
+md_el(:document,[
+	md_par(["Paragraph"], [[:ref, "a"]]),
+	md_el(:ald,[],{:ald_id=>"a",:ald=>[[:ref, "b"]]},[]),
+	md_el(:ald,[],{:ald_id=>"b",:ald=>[[:ref, "a"]]},[])
+],{},[])
+*** Output of to_html ***
+
+<p>Paragraph</p>
+
+*** Output of to_latex ***
+Paragraph
+
+
+*** Output of to_md ***
+Paragraph
+*** Output of to_s ***
+Paragraph
+*** EOF ***
+
+
+
+	OK!
+
+
+
+*** Output of Markdown.pl ***
+<p>Paragraph
+{a}</p>
+
+<p>{a}: b
+{b}: a</p>
+
+*** Output of Markdown.pl (parsed) ***
+<p>Paragraph
+{a}</p
+    ><p>{a}: b
+{b}: a</p
+  >