maruku 0.2.13 → 0.3.0

data/bin/maruku

@@ -3,23 +3,31 @@
 require 'maruku'
 
 if File.basename($0) =~ /^maruku/
-	# Convert each file 
-	ARGV.each do |f|
-		puts "Opening #{f}"
+	# If we are given filenames, convert each file 
+	if not ARGV.empty?
+		ARGV.each do |f|
+			puts "Opening #{f}"
 	
-		# read file content
-		input =  File.open(f,'r').read
+			# read file content
+			input =  File.open(f,'r').read
 		
-		# create Maruku
-		doc = Maruku.new(input)
-		# convert to a complete html document
-		html = doc.to_html_document
+			# create Maruku
+			doc = Maruku.new(input, {:on_error=>:warning})
+			# convert to a complete html document
+			html = doc.to_html_document( {:indent => -1})
 	
-		# write to file
-		dir = File.dirname(f)
-		filename = File.basename(f, File.extname(f)) + ".html"
+			# write to file
+			dir = File.dirname(f)
+			filename = File.basename(f, File.extname(f)) + ".html"
 
-		out_xml = File.join(dir, filename)	
-		File.open(out_xml,'w') do |f| f.puts html end
+			out_xml = File.join(dir, filename)	
+			File.open(out_xml,'w') do |f| f.puts html end
+		end
+	else
+		# else, act as a filter
+		data = $stdin.read
+		puts Maruku.new(data).to_html
 	end
-end
+end
+
+

data/bin/maruku0.3

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'maruku'
+
+require 'maruku/parse_span_better'
+
+#if File.basename($0) =~ /^maruku/
+	# If we are given filenames, convert each file 
+	if not ARGV.empty?
+		ARGV.each do |f|
+			puts "Opening #{f}"
+	
+			# read file content
+			input =  File.open(f,'r').read
+		
+			# create Maruku
+			doc = Maruku.new(input)
+			
+#			puts doc.inspect
+			# convert to a complete html document
+			html = doc.to_html_document({:indent=>1})
+	
+			# write to file
+			dir = File.dirname(f)
+			filename = File.basename(f, File.extname(f)) + ".html"
+
+			out_xml = File.join(dir, filename)	
+			File.open(out_xml,'w') do |f| f.puts html end
+		end
+	else
+		# else, act as a filter
+		data = $stdin.read
+		puts Maruku.new(data).to_html
+	end
+#eend
+
+

data/bin/marutest

@@ -0,0 +1,277 @@
+#!/usr/bin/env ruby
+
+require 'maruku'
+
+require 'maruku/parse_span_better'
+
+#MARKER = "\n***EOF***\n"
+SPLIT = %r{\n\*\*\*[^\*]+\*\*\*\n}m
+
+def marker(x)
+	"\n*** Output of #{x} ***\n"
+end
+
+TOTEST = [:inspect,:to_html,:to_latex,:to_s,:to_s]
+
+def run_test(filename, its_ok, verbose=true)
+	# read file content
+	input =  (f=File.open(filename,'r')).read; f.close
+	
+	# split the input in sections
+	
+	stuff = input.split(SPLIT)
+
+	comment   = stuff.shift
+	params_s = stuff.shift
+	
+	params = eval(params_s)
+	if params == nil
+		raise "Null params? #{params_s.inspect}"
+	end
+	
+	markdown  = stuff.shift
+
+#	puts "comment: #{markdown.inspect}"	
+#	puts "markdown: #{markdown.inspect}"
+	
+	failed = []
+	relaxed = []
+	crashed = []
+	actual = {}
+	
+	doc = Maruku.new(markdown, params)
+
+	for s in TOTEST
+		begin
+			if s==:to_html
+				actual[s] = doc.to_html
+			else
+				actual[s] = doc.send s
+				raise "Methods #{s} gave nil" if not actual[s]
+			end
+		rescue Exception => e
+			crashed << s
+			actual[s] = e.inspect+ "\n"+ e.backtrace.join("\n")
+			puts actual[s]
+		end
+	end
+	
+
+		begin
+			m = Maruku.new
+			d = m.instance_eval(actual[:inspect])
+		rescue Exception => e
+			s = e.inspect + e.backtrace.join("\n")
+			raise "Inspect is not correct:\n ========\n#{actual[:inspect]}"+
+			"============\n #{s}"
+		end
+
+	expected = {}
+	if (stuff.size < TOTEST.size)
+		$stdout.write " (first time!) "
+		TOTEST.each do |x| expected[x] = actual[x] end
+	else
+		TOTEST.each_index do |i|
+			symbol = TOTEST[i]
+			expected[symbol] = stuff[i]
+#			puts "symbol: #{symbol.inspect} = #{stuff[i].inspect}"
+		end
+	end
+
+	if not its_ok.include? :inspect
+		begin
+			m = Maruku.new
+			d = m.instance_eval(expected[:inspect])
+	#		puts "Eval: #{d.inspect}"
+			expected[:inspect] = d.inspect
+		rescue Exception => e
+			s = e.inspect + e.backtrace.join("\n")
+			raise "Cannot eval user-provided string:\n #{expected[:inspect].to_s}"+
+			"\n #{s}"
+		end
+	end
+
+	
+	TOTEST.each do |x|
+		if actual[x] != expected[x]
+			if its_ok.include? x
+				expected[x] = actual[x]
+				$stdout.write " relax:#{x} "
+				relaxed << x
+			else
+				actual[x] = "-----| WARNING | -----\n" + actual[x]
+				failed << x
+			end
+		end
+	end
+	
+	f = File.open(filename, 'w')
+	
+	f.write comment
+	f.write "\n*** Parameters: ***\n"
+	f.write params.inspect
+	f.write "\n*** Markdown input: ***\n"
+	f.write markdown
+
+	TOTEST.each do |x|
+		f.write marker(x) 
+		f.write expected[x]
+	end
+	f.write "\n*** EOF ***\n"
+	
+	if not failed.empty? or not crashed.empty? 
+		
+		f.puts "\n\n\n\nFailed tests:   #{failed.inspect} \n" 
+	
+		TOTEST.each do |x|
+			f.write marker(x) 
+			f.write actual[x]
+		end
+
+	else
+		f.puts "\n\n\n\tOK!\n\n\n"
+	end
+
+	
+	md_pl = markdown_pl(markdown)
+		
+	f.write "\n*** Output of Markdown.pl ***\n" 
+	f.write md_pl
+	
+	f.write "\n*** Output of Markdown.pl (parsed) ***\n"
+	begin 
+		doc = REXML::Document.new("<div>#{md_pl}</div>",{
+			:compress_whitespace=>['div','p'],
+			:ignore_whitespace_nodes=>['div','p'],
+			:respect_whitespace=>['pre','code']
+		})
+		div = doc.root
+		xml =""
+		div.write_children(xml,indent=1,transitive=true,ie_hack=false)
+		f.write xml
+	rescue Exception=>e
+		f.puts "Error: #{e.inspect}"
+	end
+	f.close
+	
+	
+	return failed, relaxed, crashed
+end
+
+def markdown_pl(markdown)
+	tmp1 = "/tmp/marutest1"
+	tmp2 = "/tmp/marutest2"
+	File.open(tmp1,'w') do |f| f.puts markdown end
+	system "Markdown.pl < #{tmp1} > #{tmp2}"
+	f = File.open(tmp2,'r')
+	s = f.read
+	f.close
+	s
+end
+
+def passed?(args, arg)
+	if args.include? arg
+		args.delete arg
+		true
+	else
+		false
+	end
+end
+
+def marutest
+	args = ARGV.clone
+
+	dont_worry = []
+	TOTEST.each do |x|
+		arg = "ok:#{x}"
+	#	puts arg
+		if passed?(args, arg)
+			dont_worry << x
+		end
+	end
+	
+	if passed?(args, 'ok')
+		dont_worry = TOTEST.clone
+	end
+	
+	if dont_worry.size > 0
+		puts "Relaxed on #{dont_worry.inspect}"
+	end
+	
+
+	failed = {}
+	relaxed = {}
+	
+	args.each do |f|
+		$stdout.write "#{f}\n\t\t"
+		tf, tr, tcrashed = run_test(f, dont_worry)
+		
+		tf = tf + tcrashed
+
+		
+		if tr.size > 0
+			$stdout.write " relax #{tr.inspect} "
+		end
+		
+		if tf.size>0
+			$stdout.write " failed on #{tf.inspect} "
+		else
+			$stdout.write " OK "
+		end
+
+		if tcrashed.size > 0
+			$stdout.write "    CRASHED on #{tcrashed.inspect}"
+		end
+
+			$stdout.write "\n"		
+			
+		failed[f]  = tf
+		relaxed[f]  = tr	
+	end
+	
+	num_failed = 0
+	failed_cat = {}
+
+	puts "\n\n\n**** FINAL REPORT ****\n\n"
+
+	
+	if failed.size > 0
+		failed.each do |file, fl|
+			num_failed += failed.size
+			if fl.size > 0
+				puts "\t#{file}\tfailed on #{fl.inspect}"
+			end
+			fl.each do |x|
+				failed_cat[x] = failed_cat[x] || 0
+				failed_cat[x] = failed_cat[x]  + 1
+			end
+		end
+	end
+
+	if dont_worry.size > 0
+		puts "Relaxed on #{dont_worry.inspect}"
+	end
+
+	if relaxed.size > 0
+		relaxed.each do |file, r|
+			if r.size > 0
+				puts "\t#{file}\t\trelaxed on #{r.inspect}"
+			end
+		end
+	end
+	
+	if failed_cat.size > 0
+		puts "\nCategories:\n"
+	
+		failed_cat.each do |x, num|
+			puts "\t#{x.inspect} \tfailed #{num}/#{args.size}"
+		end
+	end
+	
+	num_failed
+end
+
+
+marutest
+
+

data/docs/changelog-0.3.html

@@ -0,0 +1,99 @@
+<?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'>
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+<head>
+<title></title>
+
+<link href='style.css' rel='stylesheet' type='text/css' />
+</head>
+<body>
+<h2 id='release_notes__version_030_january_3rd_2007'>Release notes - version 0.3.0 (January 3rd, 2007)</h2>
+
+<p>Note: Maruku seems to be very robust, nevertheless it is still beta-level software. So if you want to use it in production environments, please check back in a month or so, while we squash the remaining bugs.</p>
+
+<p>In the meantime, feel free to toy around, and please signal problems, request features, by <a href='http://www.dis.uniroma1.it/~acensi/contact.html'>contacting me</a> or using the <a href='http://rubyforge.org/tracker/?group_id=2795'>tracker</a>. For issues about the Markdown syntax itself and improvements to it, please write to the <a href='http://six.pairlist.net/mailman/listinfo/markdown-discuss'>Markdown-discuss mailing list</a>.</p>
+
+<p>Have fun!</p>
+
+<p>Changes in 0.3.0:</p>
+
+<ul>
+<li>
+<p>A real parser is used instead of a regexp-based system, also for span-level elements..</p>
+
+<p>Now Maruku is almost 2x faster than Bluecloth, while having more features.</p>
+
+<p>Here are some benchmarks:</p>
+
+<pre><code>BlueCloth (to_html): parsing 0.00 sec + rendering 1.54 sec = 1.55 sec 
+Maruku (to_html):    parsing 0.47 sec + rendering 0.38 sec = 0.85 sec 
+Maruku (to_latex):   parsing 0.49 sec + rendering 0.25 sec = 0.73 sec</code></pre>
+
+<p>This is the result of running <code>lib/maruku/tests/benchmark.rb</code> on the Markdown specification.</p>
+</li>
+
+<li>
+<p>Prettier HTML output by adding whitespace.</p>
+</li>
+
+<li>
+<p>Added a full suite of unit-tests for the span-level parser.</p>
+</li>
+
+<li>
+<p>Error management: Having a real parser, Maruku warns you about syntax issues.</p>
+
+<p>The default action is to warn and try to continue. If you do this:</p>
+
+<pre><code>Maruku.new(string, {:on_error =&gt; :raise})
+</code></pre>
+
+<p>then syntax errors will cause an exception to be raised (you can catch this and retry).</p>
+</li>
+
+<li>
+<p>Fixed a series of bugs in handling inline HTML code.</p>
+</li>
+</ul>
+
+<p>Immediate TODO-list:</p>
+
+<ul>
+<li>
+<p>UTF-8 input/output works OK for HTML, however I am having pain trying to export to LaTeX. I want at least Japanese characters support, so if you know how to do this you are very welcome to give me an hand.</p>
+
+<p>For example: in the HTML version, you should see accented characters in this parenthesis: </p>
+
+<blockquote>
+<p>(àèìòù)</p>
+</blockquote>
+
+<p>and Japanese text in these other parenthesis: </p>
+
+<blockquote>
+<p>(カタカナで 私の 名前は アンドレア チェンシ です).</p>
+
+<p>(日本のガルは 大好き、でも、日本語は難しですから、そうぞ 英語話すガルを おしえてください).</p>
+</blockquote>
+
+<p>In the LaTeX version, these do not appear. I know how to do LaTeX with ISO-8859-1 encoding (European characters), but I&apos;m struggling with half-baked solutions for UTF-8 encoded documents.</p>
+</li>
+
+<li>
+<p>Implement the <a href='http://maruku.rubyforge.org/'>new meta-data proposal</a>.</p>
+</li>
+
+<li>
+<p>Exporting to Markdown (pretty printing).</p>
+</li>
+
+<li>
+<p>Exporting to HTML splitting in multiple files.</p>
+</li>
+</ul>
+
+<div class='maruku_signature'>
+<hr />
+<span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown interpreter'>Maruku</a> at 00:06 on Wednesday, January 03rd, 2007.</span></div>
+</body></html>