RubyGems - maruku - Versions diffs - 0.2.13 → 0.3.0 - Mend

maruku 0.2.13 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (86) hide show

data/bin/maruku +23 -15
data/bin/maruku0.3 +37 -0
data/bin/marutest +277 -0
data/docs/changelog-0.3.html +99 -0
data/docs/changelog-0.3.md +84 -0
data/docs/faq.html +46 -0
data/docs/faq.md +32 -0
data/docs/index.html +629 -64
data/docs/markdown_extra2.html +67 -14
data/docs/markdown_syntax.html +631 -94
data/docs/markdown_syntax_2.html +152 -0
data/docs/maruku.html +629 -64
data/docs/maruku.md +108 -105
data/docs/proposal.html +362 -55
data/docs/proposal.md +133 -169
data/docs/todo.html +30 -0
data/lib/maruku.rb +13 -3
data/lib/maruku/errors_management.rb +75 -0
data/lib/maruku/helpers.rb +164 -0
data/lib/maruku/html_helper.rb +33 -13
data/lib/maruku/parse_block.rb +89 -92
data/lib/maruku/parse_doc.rb +43 -18
data/lib/maruku/parse_span.rb +17 -46
data/lib/maruku/parse_span_better.rb +681 -0
data/lib/maruku/string_utils.rb +17 -10
data/lib/maruku/structures.rb +62 -35
data/lib/maruku/structures_iterators.rb +39 -0
data/lib/maruku/tests/benchmark.rb +12 -4
data/lib/maruku/tests/new_parser.rb +318 -0
data/lib/maruku/to_html.rb +113 -44
data/lib/maruku/to_latex.rb +32 -14
data/lib/maruku/to_markdown.rb +110 -0
data/lib/maruku/toc.rb +35 -1
data/lib/maruku/version.rb +10 -1
data/lib/test.rb +29 -0
data/tests/others/escaping.md +6 -4
data/tests/others/links.md +1 -1
data/tests/others/lists_after_paragraph.md +44 -0
data/tests/unittest/abbreviations.md +71 -0
data/tests/unittest/blank.md +43 -0
data/tests/unittest/blanks_in_code.md +131 -0
data/tests/unittest/code.md +64 -0
data/tests/unittest/code2.md +59 -0
data/tests/unittest/code3.md +121 -0
data/tests/unittest/easy.md +36 -0
data/tests/unittest/email.md +39 -0
data/tests/unittest/encoding/iso-8859-1.md +9 -0
data/tests/unittest/encoding/utf-8.md +38 -0
data/tests/unittest/entities.md +174 -0
data/tests/unittest/escaping.md +97 -0
data/tests/unittest/extra_dl.md +81 -0
data/tests/unittest/extra_header_id.md +96 -0
data/tests/unittest/extra_table1.md +78 -0
data/tests/unittest/footnotes.md +120 -0
data/tests/unittest/headers.md +64 -0
data/tests/unittest/hrule.md +77 -0
data/tests/unittest/images.md +114 -0
data/tests/unittest/inline_html.md +185 -0
data/tests/unittest/links.md +162 -0
data/tests/unittest/list1.md +80 -0
data/tests/unittest/list2.md +75 -0
data/tests/unittest/list3.md +111 -0
data/tests/unittest/list4.md +43 -0
data/tests/unittest/lists.md +262 -0
data/tests/unittest/lists_after_paragraph.md +280 -0
data/tests/unittest/lists_ol.md +323 -0
data/tests/unittest/misc_sw.md +751 -0
data/tests/unittest/notyet/escape.md +46 -0
data/tests/unittest/notyet/header_after_par.md +85 -0
data/tests/unittest/notyet/ticks.md +67 -0
data/tests/unittest/notyet/triggering.md +210 -0
data/tests/unittest/one.md +33 -0
data/tests/unittest/paragraph.md +34 -0
data/tests/unittest/paragraph_rules/dont_merge_ref.md +60 -0
data/tests/unittest/paragraph_rules/tab_is_blank.md +43 -0
data/tests/unittest/paragraphs.md +84 -0
data/tests/unittest/recover/recover_links.md +32 -0
data/tests/unittest/references/long_example.md +87 -0
data/tests/unittest/references/spaces_and_numbers.md +27 -0
data/tests/unittest/syntax_hl.md +99 -0
data/tests/unittest/test.md +36 -0
data/tests/unittest/wrapping.md +88 -0
data/tests/utf8-files/simple.md +1 -0
metadata +139 -86
data/lib/maruku/maruku.rb +0 -50
data/tests/a.md +0 -10

data/lib/maruku/to_html.rb CHANGED

@@ -28,7 +28,10 @@ class Maruku
 	include REXML
 	# Render as an HTML fragment (no head, just the content of BODY). (returns a string)
-	def to_html
+	def to_html(context={})
+		indent = context[:indent] || -1
+		ie_hack = context[:ie_hack] ||true
 		div = Element.new 'dummy'
 			children_to_html.each do |e|
 				div << e
@@ -39,26 +42,32 @@ class Maruku
 				div << render_footnotes
 			end
+		doc = Document.new(nil,{:respect_whitespace =>:all})
+		doc << div
+		add_whitespace(doc)
 		# REXML Bug? if indent!=-1 whitespace is not respected for 'pre' elements
 		# containing code.
 		xml =""
-		div.write_children(xml,indent=-1,transitive=false,ie_hack=true)
+		div.write_children(xml,indent,transitive=true,ie_hack)
 		xml
 	end
 	# Render to a complete HTML document (returns a string)
-	def to_html_document
+	def to_html_document(context={})
+		indent = context[:indent] || -1
+		ie_hack = context[:ie_hack] ||true
 		doc = to_html_document_tree
 		xml  = ""
 		# REXML Bug? if indent!=-1 whitespace is not respected for 'pre' elements
 		# containing code.
-		doc.write(xml,indent=-1,transitive=false,ie_hack=true);
+		doc.write(xml,indent,transitive=true,ie_hack);
-		encoding = ( (enc=@meta[:encoding]) ?
-			"encoding='#{enc}'" : "")
+#		encoding = ( (enc=@meta[:encoding]) ?
+#			"encoding='#{enc}'" : "")
-		xhtml10strict  = "<?xml version='1.0' #{encoding}?>
+		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"
 		xhtml10strict + xml
@@ -110,12 +119,30 @@ class Maruku
 			# at the bottom.
 			body << maruku_html_signature
-		root << head
 		root << body
+		add_whitespace(doc)
 		doc
 	end
+	def add_whitespace(element)
+		blocks = ['p','pre','h1','h2','h3','h4','h5','h6',
+			'style','table','div','ul','ol','li','dl','dt',
+			'head','blockquote','tr','thead','td','dd','title',
+			'link','hr']
+		element.get_elements( "//*" ).each do |e|
+			if blocks.include? e.name
+				e.parent.insert_before(e, Text.new("\n"))
+				e.parent.insert_after(e, Text.new("\n"))
+			end
+		end
+		element.get_elements( "//br" ).each do |e|
+			e.parent.insert_after(e, Text.new("\n"))
+		end
+	end
 	# returns "st","nd","rd" or "th" as appropriate
 	def day_suffix(day)
 		case day%10
@@ -168,7 +195,7 @@ class Maruku
 					li.children.last << a
 					ol << li
 				else
-					$stderr.puts "Could not find footnote '#{fid}'"
+					maruku_error"Could not find footnote '#{fid}'"
 				end
 			end
 		div << ol
@@ -230,7 +257,7 @@ class MDElement
 	def section_number
 		return nil if not @doc.meta[:use_numbered_headers]
-		if (s = @meta[:section]) and not s.section_number.empty?
+		if (s = @section) and not s.section_number.empty?
 			 s.section_number.join('.')+". "
 		else
 			nil
@@ -272,12 +299,16 @@ class MDElement
 		lang = self.meta[:lang] || @doc.meta[:code_lang]
 		lang = 'xml' if lang=='html'
-		use_syntax = @doc.meta[:html_use_syntax]
+		use_syntax = get_setting(:html_use_syntax)
 		element =
 		if use_syntax && lang
 			begin
 				convertor = Syntax::Convertors::HTML.for_syntax lang
+				# eliminate trailing newlines otherwise Syntax crashes
+				source = source.gsub(/\n*\Z/,'')
 				html = convertor.convert( source )
 				show_spaces = get_setting(:code_show_spaces)
@@ -290,10 +321,12 @@ class MDElement
 				pre.attributes['class'] = lang
 				pre
 			rescue Object => e
-				$stderr.puts "Error while using the syntax library for code:\n#{source.inspect}"
-				$stderr.puts "Lang is #{lang} object is: "
-				$stderr.puts @meta.inspect
-				$stderr.puts "Exception: #{e.class}: #{e.message}\n\t#{e.backtrace.join("\n\t")}"
+				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")}"
+				tell_user("Using normal PRE because the syntax library did not work.")
 				to_html_code_using_pre(source)
 			end
 		else
@@ -301,7 +334,7 @@ class MDElement
 		end
 		color = get_setting(:code_background_color,DEFAULT_CODE_COLOR)
-		if color
+		if color != DEFAULT_CODE_COLOR
 			element.attributes['style'] = "background-color: #{color};"
 		end
 		element
@@ -309,6 +342,7 @@ class MDElement
 	def to_html_code_using_pre(source)
 		pre = Element.new 'pre'
+		code = Element.new 'code', pre
 		s = source
 		s  = s.gsub(/&/,'&amp;')
@@ -322,17 +356,17 @@ class MDElement
 		text = Text.new(s, true, nil, false )
-		pre << text
+		code << text
 		pre
 	end
 	def to_html_inline_code;
-		pre = Element.new 'tt'
+		pre = Element.new 'code'
 			source = self.meta[:raw_code]
 			pre << source2html(source)
 			color = get_setting(:code_background_color, DEFAULT_CODE_COLOR)
-			if color
+			if color != DEFAULT_CODE_COLOR
 				pre.attributes['style'] = "background-color: #{color};"
 			end
@@ -352,15 +386,33 @@ class MDElement
 	def to_html_link
 		a =  wrap_as_element 'a'
-		id = @meta[:ref_id]
-		ref = @doc.refs[id]
-		if not ref
-			$stderr.puts "Could not find id = '#{id}'"
+		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
 		else
-			url = ref[:url]
-			title = ref[:title]
-			a.attributes['href'] = url
-			a.attributes['title'] = title if title
+			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
 		end
 		a
 	end
@@ -392,42 +444,56 @@ class MDElement
 	def to_html_image
 		a =  Element.new 'img'
-		id = @meta[:ref_id]
-		ref = @doc.refs[id]
-		if not ref
-			$stderr.puts "Could not find id = '#{id}'"
-		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]
+		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
 				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};"+
+				 +" Using SPAN element as replacement."
+				return wrap_as_element('span')
+			end
+			a.attributes['src'] = url
+			a.attributes['title'] = title if title
 		end
 		a
 	end
 	def to_html_raw_html
 		raw_html = @meta[:raw_html]
-		if rexml_doc = @meta[:parsed_html]
+		if rexml_doc = @parsed_html
 			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}"
-#				$stderr.puts s
+				maruku_error s
+				tell_user 'The REXML version you have has a bug, omitting HTML'
 				div = Element.new 'div'
-#				div << Text.new(s)
+				#div << Text.new(s)
 				return div
 			end
 			return root
 		else # invalid
 			# Creates red box with offending HTML
-			$stderr.puts "Malformed HTML: #{raw_html}"
+			tell_user 'Wrapping bad html in a PRE with class "markdown-html-error"'
 			pre = Element.new('pre')
 			pre.attributes['style'] = 'border: solid 3px red; background-color: pink'
 			pre.attributes['class'] = 'markdown-html-error'
@@ -554,6 +620,9 @@ class MDElement
 		e
 	end
+	def to_html_ref_definition; [] end
+	def to_latex_ref_definition; [] end
 end

data/lib/maruku/to_latex.rb CHANGED

@@ -37,14 +37,14 @@ class Maruku
 		body += render_latex_signature
 "\\documentclass{article}
 #{header}
 \\usepackage{hyperref}
 \\usepackage{xspace}
-%\\usepackage[x11names]{xcolor}
 \\usepackage[usenames,dvipsnames]{color}
 \\usepackage[margin=1in]{geometry}
 \\hypersetup{colorlinks=true}
+%\\usepackage{ucs}
+%\\usepackage[utf8x]{inputenc}
 \\begin{document}
 #{body}
 \\end{document}
@@ -176,6 +176,7 @@ class MDElement
 	def wrap_as_span(c)
 		"{#{c} #{children_to_latex}}"
 	end
 	def wrap_as_environment(name)
 "\\begin{#{name}}%
 #{children_to_latex}
@@ -183,6 +184,7 @@ class MDElement
 	end
 	# the ultimate escaping
+	# (is much better than using \verb)
 	def latex_escape(source)
 		s="";
 		source.each_byte do |b| s+= "\\char%d" % b end
@@ -192,12 +194,13 @@ class MDElement
 	def to_latex_inline_code;
 		source = self.meta[:raw_code]
-		# Convert to printable latex chars (is much better than using \verb)
-		s=latex_escape(source)
-		color = latex_color(get_setting(:code_background_color,DEFAULT_CODE_COLOR),'colorbox')
+		# Convert to printable latex chars
+		s = latex_escape(source)
+		color = get_setting(:code_background_color,DEFAULT_CODE_COLOR)
+		colorspec = latex_color(color, 'colorbox')
-		"#{color}{\\tt #{s}}"
+		"#{colorspec}{\\tt #{s}}"
 	end
 	def to_latex_immediate_link
@@ -206,14 +209,29 @@ class MDElement
 	end
 	def to_latex_link
-		id = @meta[:ref_id]
-		ref = @doc.refs[id]
-		if not ref
-			$stderr.puts "Could not find id = '#{id}'"
-			return children_to_latex
+		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
+				$stderr.puts "Could not find id = '#{id}'"
+				return children_to_latex
+			else
+				url = ref[:url]
+				#title = ref[:title] || 'no title'
+				if url[0,1] == '#'
+					url = url[1,url.size]
+					return "\\hyperlink{#{url}}{#{children_to_latex}}"
+				else
+					return "\\href{#{url}}{#{children_to_latex}}"
+				end
+			end
 		else
-			url = ref[:url]
-			#title = ref[:title] || 'no title'
+			url = @meta[:url]
 			if url[0,1] == '#'
 				url = url[1,url.size]

data/lib/maruku/to_markdown.rb ADDED

@@ -0,0 +1,110 @@
+class String
+	# XXX: markdown escaping
+	def to_md(c=nil)
+		to_s
+	end
+	# " andrea censi " => [" andrea ", "censi "]
+	def mysplit
+		split.map{|x| x+" "}
+	end
+end
+class MDElement
+	DefaultLineLength = 50
+	def to_md(context={})
+		children_to_md(context)
+	end
+	def to_md_paragraph(context)
+		line_length = context[:line_length] || DefaultLineLength
+		wrap(@children, line_length)
+	end
+	def to_md_li_span(context)
+		len = (context[:line_length] || DefaultLineLength) - 2
+		s = add_tabs(wrap(@children, len-2), 1, '  ')
+		s[0] = ?*
+		s + "\n"
+	end
+end
+# Some utilities
+class MDElement
+	# Convert each child to html
+	def children_to_md(context)
+		array_to_md(@children, context)
+	end
+	def wrap(array, line_length)
+		out = ""
+		line = ""
+		array.each do |c|
+			if c.kind_of?(MDElement) &&  c.node_type == :linebreak
+				out << line.strip << "  \n"; line="";
+				next
+			end
+			pieces =
+			if c.kind_of? String
+				c.to_md.mysplit
+			else
+				[c.to_md].flatten
+			end
+	#			puts "Pieces: #{pieces.inspect}"
+			pieces.each do |p|
+				if p.size + line.size > line_length
+					out << line.strip << "\n";
+					line = ""
+				end
+				line << p
+			end
+		end
+		out << line.strip << "\n" if line.size > 0
+		out
+	end
+	def array_to_md(array, context, join_char='')
+		e = []
+		array.each do |c|
+			method = c.kind_of?(MDElement) ?
+			   "to_md_#{c.node_type}" : "to_md"
+			if not c.respond_to?(method)
+				#raise "Object does not answer to #{method}: #{c.class} #{c.inspect[0,100]}"
+				tell_user "Using default for #{c.node_type}"
+				method = 'to_md'
+			end
+#			puts "#{c.inspect} created with method #{method}"
+			h =  c.send(method, context)
+			if h.nil?
+				raise "Nil md for #{c.inspect} created with method #{method}"
+			end
+			if h.kind_of?Array
+				e = e + h
+			else
+				e << h
+			end
+		end
+		e.join(join_char)
+	end
+end
+class Maruku
+	alias old_md to_md
+	def to_md(context={})
+		s = old_md(context)
+#		puts s
+		s
+	end
+end