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

maruku 0.3.0 → 0.4.0

Files changed (108) hide show

data/bin/{maruku0.3 → marudown} +6 -14
data/bin/maruku +1 -1
data/bin/marutest +37 -9
data/docs/TOFIX.html +22 -0
data/docs/TOFIX.md +3 -0
data/docs/changelog-0.2.13.html +30 -0
data/docs/changelog-0.2.13.md +6 -0
data/docs/changelog-0.3.html +19 -5
data/docs/faq.html +51 -40
data/docs/faq.md +3 -3
data/docs/hidden_o_n_squared.md +10 -0
data/docs/index.html +84 -396
data/docs/markdown_syntax.html +139 -330
data/docs/markdown_syntax.md +80 -93
data/docs/maruku.html +84 -396
data/docs/maruku.md +88 -158
data/docs/proposal.html +13 -106
data/docs/proposal.md +3 -3
data/docs/todo.html +38 -28
data/lib/maruku.rb +77 -11
data/lib/maruku/attributes.rb +186 -0
data/lib/maruku/defaults.rb +40 -0
data/lib/maruku/errors_management.rb +55 -39
data/lib/maruku/helpers.rb +156 -72
data/lib/maruku/input/charsource.rb +319 -0
data/lib/maruku/{html_helper.rb → input/html_helper.rb} +30 -9
data/lib/maruku/input/linesource.rb +111 -0
data/lib/maruku/input/parse_block.rb +562 -0
data/lib/maruku/{parse_doc.rb → input/parse_doc.rb} +60 -28
data/lib/maruku/{parse_span_better.rb → input/parse_span_better.rb} +226 -256
data/lib/maruku/input/type_detection.rb +137 -0
data/lib/maruku/maruku.rb +33 -0
data/lib/maruku/{to_html.rb → output/to_html.rb} +151 -132
data/lib/maruku/{to_latex.rb → output/to_latex.rb} +31 -35
data/lib/maruku/{to_latex_entities.rb → output/to_latex_entities.rb} +25 -3
data/lib/maruku/output/to_latex_strings.rb +64 -0
data/lib/maruku/output/to_markdown.rb +164 -0
data/lib/maruku/{to_s.rb → output/to_s.rb} +6 -0
data/lib/maruku/string_utils.rb +12 -181
data/lib/maruku/structures.rb +91 -67
data/lib/maruku/structures_inspect.rb +78 -0
data/lib/maruku/structures_iterators.rb +24 -2
data/lib/maruku/tests/benchmark.rb +41 -9
data/lib/maruku/tests/new_parser.rb +317 -286
data/lib/maruku/tests/tests.rb +20 -0
data/lib/maruku/toc.rb +64 -64
data/lib/maruku/usage/example1.rb +33 -0
data/lib/maruku/version.rb +8 -2
data/tests/unittest/abbreviations.md +27 -16
data/tests/unittest/attributes/attributes.md +89 -0
data/tests/unittest/attributes/circular.md +51 -0
data/tests/unittest/attributes/default.md +47 -0
data/tests/unittest/blank.md +10 -6
data/tests/unittest/blanks_in_code.md +26 -26
data/tests/unittest/code.md +9 -9
data/tests/unittest/code2.md +12 -13
data/tests/unittest/code3.md +34 -34
data/tests/unittest/easy.md +9 -7
data/tests/unittest/email.md +9 -7
data/tests/unittest/encoding/iso-8859-1.md +41 -4
data/tests/unittest/encoding/utf-8.md +6 -5
data/tests/unittest/entities.md +52 -80
data/tests/unittest/escaping.md +47 -35
data/tests/unittest/extra_dl.md +19 -29
data/tests/unittest/extra_header_id.md +31 -24
data/tests/unittest/extra_table1.md +14 -32
data/tests/unittest/footnotes.md +58 -42
data/tests/unittest/headers.md +11 -11
data/tests/unittest/hrule.md +14 -24
data/tests/unittest/images.md +41 -26
data/tests/unittest/inline_html.md +104 -56
data/tests/unittest/inline_html2.md +38 -0
data/tests/unittest/links.md +74 -33
data/tests/unittest/list1.md +18 -15
data/tests/unittest/list2.md +31 -13
data/tests/unittest/list3.md +29 -28
data/tests/unittest/list4.md +103 -12
data/tests/unittest/lists.md +86 -53
data/tests/unittest/lists6.md +53 -0
data/tests/unittest/lists7.md +31 -0
data/tests/unittest/lists_after_paragraph.md +105 -71
data/tests/unittest/lists_ol.md +149 -73
data/tests/unittest/misc_sw.md +366 -326
data/tests/unittest/notyet/escape.md +10 -10
data/tests/unittest/notyet/header_after_par.md +20 -14
data/tests/unittest/notyet/ticks.md +8 -35
data/tests/unittest/notyet/triggering.md +72 -45
data/tests/unittest/olist.md +78 -0
data/tests/unittest/one.md +5 -3
data/tests/unittest/paragraph.md +5 -3
data/tests/unittest/paragraph_rules/dont_merge_ref.md +15 -9
data/tests/unittest/paragraph_rules/tab_is_blank.md +9 -5
data/tests/unittest/paragraphs.md +21 -26
data/tests/unittest/recover/recover_links.md +6 -5
data/tests/unittest/references/long_example.md +39 -30
data/tests/unittest/references/spaces_and_numbers.md +2 -2
data/tests/unittest/syntax_hl.md +33 -31
data/tests/unittest/test.md +4 -6
data/tests/unittest/wrapping.md +43 -26
metadata +160 -139
data/docs/markdown_extra2.html +0 -87
data/docs/markdown_extra2.md +0 -83
data/docs/markdown_syntax_2.html +0 -152
data/lib/maruku/parse_block.rb +0 -564
data/lib/maruku/parse_span.rb +0 -451
data/lib/maruku/to_latex_strings.rb +0 -59
data/lib/maruku/to_markdown.rb +0 -110
data/lib/test.rb +0 -29

data/docs/proposal.md CHANGED Viewed

@@ -14,9 +14,9 @@ Last updated **January 2nd, 2007**: integrated topics
 discussed in mailing list.
 *Table of contents:*
-> @toc
-> * Table of contents
+> * Table of contents
+> {toc}
 Overview
 --------
@@ -113,7 +113,6 @@ So this is not legal:
 Attribute lists may be indented up to 3 spaces:
-@ code_show_spaces
 	Paragraph1
 	 {ok}
@@ -122,6 +121,7 @@ Attribute lists may be indented up to 3 spaces:
 	Paragraph2
 	   {ok}
+{code_show_spaces}
 ### For headers ###

data/docs/todo.html CHANGED Viewed

@@ -1,30 +1,40 @@
-<?xml version='1.0' ?>
+<?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
-    ></head
-    ><head
-      ><title></title
-    ></head
-    ><body
-      ><ul
-        ><li
-          ><p>Export to HTML * Include RubyPants</p
-        ></li
-        ><li
-          ><p>Export to PDF * support for images</p
-        ></li
-        ><li
-          ><p>Export to Markdown (pretty-printing)</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 17:47 on Sunday, December 31st, 2006.</span
-      ></div
-    ></body
-  ></html
->
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+<head><meta content='text/html; charset=utf-8' http-equiv='Content-type' />
+<title></title>
+</head>
+<body>
+<ul>
+<li>
+<p>Export to HTML</p>
+<ul>
+<li>Include RubyPants</li>
+</ul>
+</li>
+<li>
+<p>Export to PDF</p>
+<ul>
+<li>support for images</li>
+</ul>
+</li>
+<li>
+<p>Export to Markdown (pretty-printing)</p>
+</li>
+</ul>
+<div class='footnotes'>
+<hr />
+<ol />
+</div>
+<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 20:36 on Friday, January 05th, 2007.</span></div>
+</body></html>

data/lib/maruku.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,32 +16,94 @@
 #   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
+#++
+# :include:MaRuKu.txt
+module MaRuKu
+	module In
+		module Markdown
+			module SpanLevelParser; end
+			module BlockLevelParser; end
+		end
+		# more to come?
+	end
+	module Out
+		# Functions for exporting to MarkDown.
+		module Markdown; end
+		# Functions for exporting to HTML.
+		module HTML; end
+		# Functions for exporting to Latex
+		module Latex; end
+	end
+	# These are strings utilities.
+	module Strings; end
+	module Helpers; end
+	module Errors; end
+	module Defaults; end
+	class MDElement
+		include Defaults
+		include MaRuKu
+		include Out::Markdown
+		include Out::HTML
+		include Out::Latex
+		include Strings
+		include Helpers
+		include Errors
+	end
+	class MDDocument < MDElement
+		include In::Markdown::SpanLevelParser
+		include In::Markdown::BlockLevelParser
+	end
+end
+# This is the public interface
+class Maruku < MaRuKu::MDDocument; end
+require 'rexml/document'
 # Structures definition
 require 'maruku/structures'
+require 'maruku/structures_inspect'
+require 'maruku/defaults'
 # Less typing
 require 'maruku/helpers'
 # Code for parsing whole Markdown documents
-require 'maruku/parse_doc'
+require 'maruku/input/parse_doc'
 # Ugly things kept in a closet
 require 'maruku/string_utils'
+require 'maruku/input/linesource'
+require 'maruku/input/type_detection'
 # A class for reading and sanitizing inline HTML
-require 'maruku/html_helper'
+require 'maruku/input/html_helper'
 # Code for parsing Markdown block-level elements
-require 'maruku/parse_block'
+require 'maruku/input/parse_block'
 # Code for parsing Markdown span-level elements
-require 'maruku/parse_span_better'
+require 'maruku/input/charsource'
+require 'maruku/input/parse_span_better'
+require 'maruku/attributes'
 require 'maruku/structures_iterators'
 require 'maruku/errors_management'
 # Code for creating a table of contents
 require 'maruku/toc'
@@ -49,15 +112,18 @@ require 'maruku/version'
 # Exporting to html
-require 'maruku/to_html'
+require 'maruku/output/to_html'
 # Exporting to latex
-require 'maruku/to_latex'
-require 'maruku/to_latex_strings'
-require 'maruku/to_latex_entities'
+require 'maruku/output/to_latex'
+require 'maruku/output/to_latex_strings'
+require 'maruku/output/to_latex_entities'
 # Pretty print
-require 'maruku/to_markdown'
+require 'maruku/output/to_markdown'
 # Exporting to text: strips all formatting (not complete)
-require 'maruku/to_s'
+require 'maruku/output/to_s'
+# class Maruku is the global interface
+require 'maruku/maruku'

data/lib/maruku/attributes.rb ADDED Viewed

@@ -0,0 +1,186 @@
+#--
+#   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
+	def quote_if_needed
+		if /[\s\'\"]/.match self
+			inspect
+		else
+			self
+		end
+	end
+end
+module MaRuKu;
+	class AttributeList < Array
+		# An attribute list becomes
+		# {#id .cl key="val" ref}
+		# [ [:id, 'id'], [:class, 'id'], ['key', 'val'], [ :ref, 'ref' ]]
+		private :push
+		def push_key_val(key, val);
+			raise "Bad #{key.inspect}=#{val.inspect}" if not key and val
+			push [key, val]
+		end
+		def push_ref(ref_id);
+			raise "Bad :ref #{ref_id.inspect}" if not ref_id
+			push [:ref, ref_id]
+		end
+		def push_class(val);
+			raise "Bad :id #{val.inspect}" if not val
+			push [:class,  val]
+		end
+		def push_id(val);
+			raise "Bad :id #{val.inspect}" if not val
+			push [:id,  val]
+		end
+		def to_s
+			map do |k,v|
+				case k
+				when :id;    "#" + v.quote_if_needed
+				when :class; "." + v.quote_if_needed
+				when :ref;    v.quote_if_needed
+				else k.quote_if_needed + "=" + v.quote_if_needed
+				end
+			end . join(' ')
+		end
+		alias to_md to_s
+	end
+end
+module MaRuKu; module In; module Markdown; module SpanLevelParser
+	def unit_tests_for_attribute_lists
+		[
+			[ "",     [], "Empty lists are allowed" ],
+			[ "=",    :throw, "Bad char to begin a list with." ],
+			[ "a =b", :throw, "No whitespace before `=`." ],
+			[ "a= b", :throw, "No whitespace after `=`." ],
+			[ "'a'",  [[:ref, 'a']], "Quoted value." ],
+			[ '"a"'   ],
+			[ "a=b",  [['a','b']], "Simple key/val" ],
+			[ "'a'=b"   ],
+			[ "'a'='b'" ],
+			[ "a='b'"   ],
+			[ 'a="b\'"',  [['a',"b\'"]], "Key/val with quotes" ],
+			[ 'a=b\''],
+			[ 'a="\\\'b\'"',  [['a',"\'b\'"]], "Key/val with quotes" ],
+			['"', :throw, "Unclosed quotes"],
+			["'"],
+			["'a "],
+			['"a '],
+			[ "#a",  [[:id, 'a']], "Simple ID" ],
+			[ "#'a'" ],
+			[ '#"a"' ],
+			[ "#",  :throw, "Unfinished '#'." ],
+			[ ".",  :throw, "Unfinished '.'." ],
+			[ "# a",  :throw, "No white-space after '#'." ],
+			[ ". a",  :throw, "No white-space after '.' ." ],
+			[ "a=b c=d",  [['a','b'],['c','d']], "Tabbing" ],
+			[ " \ta=b \tc='d' "],
+			[ "\t a=b\t c='d'\t\t"],
+			[ ".\"a'",  :throw, "Mixing quotes is bad." ],
+		].map { |s, expected, comment|
+			@expected = (expected ||= @expected)
+			@comment  = (comment  ||= (last=@comment) )
+			(comment == last && (comment += (@count+=1).to_s)) || @count = 1
+			expected = [md_ial(expected)] if expected.kind_of? Array
+			["{#{s}}", expected, "Attributes: #{comment}"]
+		}
+	end
+	def md_al(s=[]); AttributeList.new(s) end
+	# returns nil or an AttributeList
+	def read_attribute_list(src, con, break_on_chars)
+		separators = break_on_chars + [?=,?\ ,?\t]
+		escaped = Maruku::EscapedCharInQuotes
+		al = AttributeList.new
+		while true
+			src.consume_whitespace
+			break if break_on_chars.include? src.cur_char
+			case src.cur_char
+			when nil
+				maruku_error "Attribute list terminated by EOF:\n "+
+				             "#{al.inspect}" , src, con
+				tell_user "I try to continue and return partial attribute list:\n"+
+					al.inspect
+				break
+			when ?=     # error
+				maruku_error "In attribute lists, cannot start identifier with `=`."
+				tell_user "I try to continue"
+				src.ignore_char
+			when ?#     # id definition
+				src.ignore_char
+				if id = read_quoted_or_unquoted(src, con, escaped, separators)
+					al.push_id id
+				else
+					maruku_error 'Could not read `id` attribute.', src, con
+					tell_user 'Trying to ignore bad `id` attribute.'
+				end
+			when ?.     # class definition
+				src.ignore_char
+				if klass = read_quoted_or_unquoted(src, con, escaped, separators)
+					al.push_class klass
+				else
+					maruku_error 'Could not read `class` attribute.', src, con
+					tell_user 'Trying to ignore bad `class` attribute.'
+				end
+			else
+				if key = read_quoted_or_unquoted(src, con, escaped, separators)
+					if src.cur_char == ?=
+						src.ignore_char # skip the =
+						if val = read_quoted_or_unquoted(src, con, escaped, separators)
+							al.push_key_val(key, val)
+						else
+							maruku_error "Could not read value for key #{key.inspect}.",
+								src, con
+							tell_user "Ignoring key #{key.inspect}."
+						end
+					else
+						al.push_ref key
+					end
+				else
+					maruku_error 'Could not read key or reference.'
+				end
+			end # case
+		end # while true
+		al
+	end
+end end end end
+#module MaRuKu; module In; module Markdown; module SpanLevelParser

data/lib/maruku/defaults.rb ADDED Viewed

@@ -0,0 +1,40 @@
+#--
+#   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
+#++
+module MaRuKu
+module Defaults
+	DEFAULT_CODE_COLOR = '#ffaaff'
+	DefaultAttributes = <<EOF
+{header}:      .mrk-header
+{paragraph}:   .mrk-par
+{strong}:      .mrk-strong
+{emphasis}:    .mrk-em
+{code}:        .mrk-code
+{code_block}:  .mrk-code_block
+{example}:  pre_filter=""
+EOF
+end
+end