maruku 0.2.12 → 0.2.13

data/lib/maruku.rb

@@ -22,6 +22,9 @@ require 'maruku/structures'
 # Code for parsing whole Markdown documents
 require 'maruku/parse_doc'
 
+# A class for reading and sanitizing inline HTML
+require 'maruku/html_helper'
+
 # Code for parsing Markdown block-level elements
 require 'maruku/parse_block'
 

data/lib/maruku/html_helper.rb

@@ -0,0 +1,103 @@
+
+class Maruku
+
+# this class helps me read and sanitize code blocks
+
+	class HTMLHelper
+		Tag = %r{^<(/)?(\w+)([^>]*)>}m
+		EverythingElse = %r{^[^<]+}m
+		CommentStart = %r{^<!--}x
+		CommentEnd = %r{^.*-->}
+		TO_SANITIZE = ['img','hr'] 
+		
+		attr_accessor :inside_comment
+		
+		def initialize 
+			@rest = ""
+			@tag_stack = []
+			@m = nil
+			@already = ""
+			@inside_comment = false
+		end
+		
+		def eat_this(line)
+			@rest = line + "\n" + @rest
+			
+			until @rest.empty?
+				if @inside_comment
+					if @m = CommentEnd.match(@rest)
+						@inside_comment = false
+						@already += @m.pre_match + @m.to_s
+						@rest = @m.post_match
+					elsif @m = EverythingElse.match(@rest)
+						@already += @m.pre_match + @m.to_s
+						@rest = @m.post_match
+					end
+				else
+					if @m = CommentStart.match(@rest)
+						@inside_comment = true
+						@already += @m.pre_match + @m.to_s
+						@rest = @m.post_match
+					elsif @m = Tag.match(@rest)
+						@already += @m.pre_match
+						@rest = @m.post_match
+					
+						is_closing = !!@m[1]
+						tag = @m[2]
+						attributes = @m[3]
+						
+						is_single = false
+						if attributes =~ /\A(.*)\/\Z/
+							attributes = $1
+							is_single = true
+						end
+					
+						if TO_SANITIZE.include? tag 
+							@already +=  '<%s %s />' % [tag, attributes]
+						elsif is_closing
+							@already += @m.to_s
+							if @tag_stack.last != tag
+								error "Malformed: tag <#{tag}> "+
+								      "closes <#{@tag_stack.last}>"
+							end
+							if @tag_stack.empty?
+								error "Malformed: closing tag #{tag.inspect} "+
+								      "in empty list"
+							end 
+							@tag_stack.pop
+						elsif not is_single
+							@tag_stack.push tag
+							@already += @m.to_s
+						end
+					elsif @m = EverythingElse.match(@rest)
+						@already += @m.pre_match + @m.to_s
+						@rest = @m.post_match
+					else
+#						puts "No match??? #{@rest.inspect}"
+					end
+				end # not inside comment
+				
+#				puts inspect
+#				puts "Read: #{@tag_stack.inspect}"
+			end
+		end
+
+
+		def error(s)
+			raise "Error: #{s} "+ inspect
+		end
+
+		def inspect; "HTML READER\n comment=#{inside_comment} "+
+			"match=#{@m.to_s.inspect}"+
+			"\n * * * BEFORE * * *\n#{@already.inspect}"+
+			"\n * * * AFTER  * * *\n#{@rest.inspect}"+
+			"\n * * * TAGS stack * * *\n#{@tag_stack.inspect}"
+		end
+		def stuff_you_read
+			@already
+		end
+		def is_finished?
+			not @inside_comment and @tag_stack.empty?
+		end
+	end
+end

data/lib/maruku/maruku.rb

@@ -0,0 +1,50 @@
+#   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
+
+# Structures definition
+require 'maruku/structures'
+
+# Code for parsing whole Markdown documents
+require 'maruku/parse_doc'
+
+# Code for parsing Markdown block-level elements
+require 'maruku/parse_block'
+
+# Code for parsing Markdown span-level elements
+require 'maruku/parse_span'
+
+# Ugly things kept in a closet
+require 'maruku/string_utils'
+
+# Code for creating a table of contents
+require 'maruku/toc'
+
+# Version and URL
+require 'maruku/version'
+
+
+# Exporting to html
+require 'maruku/to_html'
+
+# Exporting to latex
+require 'maruku/to_latex'
+require 'maruku/to_latex_strings'
+require 'maruku/to_latex_entities'
+
+# Exporting to text: strips all formatting (not complete)
+require 'maruku/to_s'

data/lib/maruku/parse_block.rb

@@ -70,7 +70,7 @@ class Maruku
 					end
 				when :quote;    output << read_quote
 				when :code;     e = read_code; output << e if e
-				when :raw_html; output << read_raw_html
+				when :raw_html; e = read_raw_html; output << e if e
 
 				# these do not produce output
 				when :footnote_text; read_footnote_text
@@ -81,7 +81,8 @@ class Maruku
 				# warn if we forgot something
 				else
 					node_type = cur_line_node_type
-					$stderr.puts "Ignoring line '#{shift_line}' type = #{node_type}"
+					line = shift_line
+#					$stderr.puts "Ignoring line '#{line}' type = #{node_type}"
 			end
 			
 			if current_metadata and output.last
@@ -155,13 +156,18 @@ class Maruku
 		e
 	end
 
+	# returns an hash
+	def parse_attributes(s)
+		{:id => s[1,s.size]}
+	end
 	# reads a header like '#### header ####'
+	
 	def read_header3
 		e = create_md_element(:header)
 		line = shift_line.strip
-		if line =~ HeaderWithId 
+		if line =~ HeaderWithAttributes
 			line = $1.strip
-			e.meta[:id] = $2
+			e.meta.merge! parse_attributes($2)
 		end
 		
 		e.meta[:level] = num_leading_hashes(line)
@@ -172,37 +178,39 @@ class Maruku
 
 		e
 	end
-	
-	
-	def read_raw_html
-		lines = []
-		
-		cur_line =~ %r{^<(\w+)}
-		tag = $1 
-#		puts "Start tag = #{tag} "
-		
-		while cur_line 
-			break if (number_of_leading_spaces(cur_line) == 0) &&
-				(not [:raw_html, :empty].include?  cur_line_node_type)
 
-			lines << shift_line
-			# check for a closing tag
-			if (lines.last =~ %r{^</(\w+)}|| 
-				lines.last =~ %r{</(\w+)>\s*$})  && $1 == tag
-				break
+
+	def read_raw_html
+#		raw_html = ""
+		
+		h = HTMLHelper.new
+		begin 
+			l=shift_line
+			h.eat_this l
+#			puts "\nBLOCK:\nhtml -> #{l.inspect}"
+			while cur_line and not h.is_finished? 
+				l=shift_line
+#				puts "html -> #{l.inspect}"
+				h.eat_this l
 			end
+		rescue Exception => e
+			puts e.inspect
+#			puts h.inspect
 		end
 		
-#		dbg_describe_ary(lines, 'HTML')
-
-		raw_html = lines.join("\n")
-
+		raw_html = h.stuff_you_read
+		
 		e = create_md_element(:raw_html)
 
 		begin
+			# remove newlines and whitespace at begin
+			# end end of string, or else REXML gets confused
+			raw_html = raw_html.gsub(/\A\s*</,'<').
+			                    gsub(/>[\s\n]*\Z/,'>')
 			e.meta[:parsed_html] = Document.new(raw_html)
 		rescue 
-			$stderr.puts "Malformed block of HTML:\n#{raw_html}"
+			#$stderr.puts "Malformed block of HTML:\n#{raw_html}"
+			#puts h.inspect
 		end
 		
 		e.meta[:raw_html] = raw_html
@@ -359,12 +367,16 @@ class Maruku
 		while lines.last && lines.last.strip.size == 0
 			lines.pop 
 		end
+
+		while lines.first && lines.first.strip.size == 0
+			lines.shift 
+		end
 		
 		return nil if lines.empty?
 
 		source = lines.join("\n")
 		# ignore trailing lines 
-		source = source.gsub(/\n+\Z/,'')
+#		source = source.gsub(/\n+\Z/,'')
 		
 #		dbg_describe_ary(lines, 'CODE')
 		e.meta[:raw_code] = source

data/lib/maruku/parse_doc.rb

@@ -33,7 +33,9 @@ class Maruku
 		@stack = []
 		
 		@meta = parse_email_headers(s)
-		lines =  split_lines(@meta[:data])
+		data = @meta[:data]
+		@meta.delete :data
+		lines =  split_lines(data)
 		@children = parse_lines_as_markdown(lines)
 		
 		self.search_abbreviations

data/lib/maruku/string_utils.rb

@@ -191,6 +191,7 @@ class Maruku
 		# line that were mistaken for raw_html
 		return :text if l=~EMailAddress or l=~ URL
 		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 :empty    if l.strip.size == 0
@@ -200,8 +201,10 @@ class Maruku
 		# 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 =~ /^@/
+		return :m2ref    if l =~ /^\s{0,3}\{[\w\d\s]+\}:/
 		return :text
 	end
 	
@@ -257,6 +260,8 @@ class Maruku
 
 	HeaderWithId = /^(.*)\{\#([\w_-]+)\}\s*$/
 
+	HeaderWithAttributes = /^(.*)\{(.*)\}\s*$/
+
 	TabSize = 4;
 
 	# if contains a pipe, it could be a table header

data/lib/maruku/tests/benchmark.rb

@@ -0,0 +1,42 @@
+require 'maruku'
+require 'bluecloth'
+
+data = $stdin.read
+
+num = 10
+
+stats = 
+[
+	
+	[BlueCloth, :to_html],
+	[Maruku,    :to_html],
+	[Maruku,    :to_latex]
+	
+].map do |c, method|
+	puts "Computing for #{c}"
+
+	start = Time.now
+	doc = nil
+	for i in 1..num
+		puts "#{i}"
+		doc = c.new(data)
+	end
+	stop = Time.now
+	parsing = (stop-start)/num
+
+	start = Time.now
+	for i in 1..num
+		puts "#{i}"
+		s = doc.send method
+	end
+	stop = Time.now
+	rendering = (stop-start)/num
+
+	[c, method, parsing, rendering]
+end
+
+for c, method, parsing, rendering in stats
+	puts ("%s (%s): parsing %0.2f sec + rendering %0.2f sec "+
+	"= %0.2f sec ") % [c, method, parsing,rendering,parsing+rendering]
+end
+

data/lib/maruku/tests/tests.rb

@@ -0,0 +1,116 @@
+
+require 'maruku'
+
+class Maruku
+	
+	
+	def Maruku.failed(test, doc, s)
+		raise "Test failed: #{s}\n*****\n#{test}\n*****\n"+
+		"#{doc.inspect}\n*****\n{doc.to_html}"
+	end
+
+	def Maruku.metaTests
+		ref = {:id => 'id1', :class => ['class1','class2'], 
+			:style=> 'Style is : important = for all } things'}
+	
+		
+		tests = MetaTests.split('***')
+		for test in tests
+			#puts "Test: #{test.inspect}"
+			doc = Maruku.new(test)
+			
+			doc.children.size == 1 ||
+			failed(test, doc, "children != 1") 
+				
+			
+			h = doc.children[0]
+			
+			h.node_type==:header ||
+			failed(test, doc, "child not header") 
+			
+#			puts doc.inspect
+#			puts doc.to_html
+		end
+	end
+	
+MetaTests = <<EOF
+
+# Head # {ref1 ref2 ref3}
+
+{ref1}: id: id1; class: class1
+{ref2}: class: class2
+{ref3}: style: "Style is : important = for all } things"  
+
+***
+
+# Head # {ref1 ref3 ref2}
+
+{ref1}: id: id1; class: class1
+{ref2}: class: class2
+{ref3}: style: "Style is : important = for all } things"  
+
+***
+
+# Head # {ref1 ref2 ref3}
+
+{ref1}: id= id1; class=class1
+{ref2}: class=class2
+{ref3}: style="Style is : important = for all } things"
+
+***
+
+# Head # {ref1 ref2 ref3}
+
+{ref1}: id=id1 class=class1
+{ref2}: class=class2
+{ref3}: style="Style is : important = for all } things"
+
+***
+# Head # {ref1 ref2 ref3}
+
+{ref1}: id:id1	class:class1
+{ref2}: class : class2
+{ref3}: style	=	"Style is : important = for all } things"
+
+***
+# Head # {ref1 ref2 ref3}
+
+{ref1}: id:id1	class:class1
+  {ref2}: class : class2
+   {ref3}: style	=	"Style is : important = for all } things"
+
+***
+
+# Head # {#id1 .class1 ref2 ref3}
+
+{ref2}: class : class2
+{ref3}: style	=	"Style is : important = for all } things"
+
+***
+
+# Head #  	 {  #id1	.class1	 	ref2	  ref3	}
+
+{ref2}: class : class2
+{ref3}: style	=	"Style is : important = for all } things"
+
+***
+
+# Head #  	 {  id=id1	class=class1	 	ref2	  ref3	}
+
+{ref2}: class : class2
+{ref3}: style	=	"Style is : important = for all } things"
+
+***
+
+# Head #  	 {  id:id1	class="class1" class:"class2"  style="Style is : important = for all } things"}
+
+EOF
+
+end
+
+if File.basename($0) == 'tests.rb'
+	Maruku.metaTests
+	
+end
+
+