maruku 0.3.0 → 0.4.0

data/lib/maruku/{to_s.rb → output/to_s.rb}

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,8 +16,11 @@
 #   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
+	
 class MDElement
 	
 	# Strips all formatting from the string
@@ -36,4 +40,6 @@ class MDElement
 		title.gsub!(/[^\w_]/,'')
 		title
 	end
+end
+
 end

data/lib/maruku/string_utils.rb

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,29 +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
+#++
 
-module MarukuStrings
+
+# Boring stuff with strings.
+module MaRuKu; module Strings
+	
 	def add_tabs(s,n=1,char="\t")
 		s.split("\n").map{|x| char*n+x }.join("\n")
 	end
-end
-class MDElement
-	include MarukuStrings
-end
-
-class Maruku
 	
-	# Split a string into lines, and chomps the newline
-	def Maruku.split_lines_old(s)
-		a = []
-		s.each_line do |l| 
-			l = l.chomp
-			a << l 
-		end	
-		a
-	end
-
-	def Maruku.split_lines(s)
+	TabSize = 4;
+	
+	def split_lines(s)
 		s.split("\n")
 	end
 	
@@ -111,7 +102,7 @@ class Maruku
 	#     ' 1.  Hello' # => 5
 	
 	def spaces_before_first_char(s)
-		case line_node_type(s)
+		case s.md_type
 		when :ulist
 			i=0;
 			# skip whitespace if present
@@ -179,7 +170,7 @@ class Maruku
 	def dbg_describe_ary(a, prefix='')
 		i = 0 
 		a.each do |l|
-			tell_user "#{prefix} (#{i+=1})##{l}#"
+			puts "#{prefix} (#{i+=1})# #{l.inspect}"
 		end
 	end
 
@@ -187,165 +178,5 @@ class Maruku
 		l =~ /  $/
 	end
 
-	def line_node_type(l)
-		# raw html is like PHP Markdown Extra: at most three spaces before
-		return :code     if number_of_leading_spaces(l)>=4
-		return :footnote_text      if l =~ FootnoteText
-		return :ref_definition if l =~ LinkRegex or l=~ IncompleteLink
-		return :abbreviation if l =~ Abbreviation
-		return :definition if l =~ Definition
-		# I had a bug with emails and urls at the beginning of the 
-		# 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
-		return :header1  if l =~ /^(=)+/ 
-		return :header2  if l =~ /^([-\s])+$/ 
-		return :header3  if l =~ /^(#)+\s*\S+/ 
-		# 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
-	
-	# Example:
-	#     ^:blah blah
-	#     ^: blah blah
-	#     ^   : blah blah
-	Definition = %r{ 
-		^ # begin of line
-		[ ]{0,3} # up to 3 spaces
-		: # colon
-		\s* # whitespace
-		(\S.*) # the text    = $1
-		$ # end of line
-	}x
-	
-	# Example:
-	#     *[HTML]: Hyper Text Markup Language
-	Abbreviation = %r{
-		^  # begin of line
-		\* # one asterisk
-		\[ # opening bracket
-		([^\]]+) # any non-closing bracket:  id = $1
-		\] # closing bracket
-		:  # colon
-		\s* # whitespace
-		(\S.*\S)* #           definition=$2
-		\s* # strip this whitespace
-		$   # end of line
-	}x
-
-	FootnoteText = %r{
-		^\s*\[(\^.+)\]: # id = $1 (including '^')
-		\s*(\S.*)?$    # text = $2 (not obb.)
-	}x
-	
-	# This regex is taken from BlueCloth sources
-	# Link defs are in the form: ^[id]: \n? url "optional title"
-	LinkRegex = %r{
-		^[ ]*\[([^\]]+)\]:		# id = $1
-		  [ ]*
-		<?(\S+)>?				# url = $2
-		  [ ]*
-		(?:# Titles are delimited by "quotes" or (parens).
-			["(']
-			(.+?)			# title = $3
-			[")']			# Matching ) or "
-			\s*(.+)?   # stuff = $4
-		)?	# title is optional
-	  }x
-
-	IncompleteLink = %r{^\s*\[(.+)\]:\s*$}
-
-	HeaderWithId = /^(.*)\{\#([\w_-]+)\}\s*$/
-
-	HeaderWithAttributes = /^(.*)\{(.*)\}\s*$/
-
-	TabSize = 4;
-
-	# if contains a pipe, it could be a table header
-	MightBeTableHeader = %r{\|}
-	# -------------:
-	Sep = /\s*(\:)?\s*-+\s*(\:)?\s*/
-	# | -------------:| ------------------------------ |
-	TableSeparator = %r{^(\|?#{Sep}\|?)+\s*$}
-	
-	
-	EMailAddress = /<([^:]+@[^:]+)>/
-	URL = /^<http:/
 end
-
-class String
-	S = 230
-	MarkdownEscaped = 
-		[["\\",S+0], 
-		 ['`',S+1],
-		 ['*',S+2],
-		['_',S+3],['{',S+4],['}',S+5],['[',S+6],[']',S+7],
-		['(',S+8],[')',S+9],['#',S+10],['.',S+11],
-		['!',S+12],
-		# PHP Markdown extra
-		['|',S+13],[':',S+14], ["+",S+15], ["-",S+16], [">",S+17]]
-
-	MarkdownAdd = 200
-	
-	
-	def escape_md_special!
-		MarkdownEscaped.each do |c|
-			escape_sequence = "\\#{c[0]}"
-			#puts "Escaping -#{escape_sequence}-"
-			escaped ="0"; escaped[0]=c[1]
-			gsub!(escape_sequence, escaped)
-		end
-
-		# But if you surround an * or _ with spaces, 
-		# it’ll be treated as a literal asterisk or underscore.
-		escaped_ast = [S+2].pack('c')
-		gsub!(/(\s)\*(\s|$)/, '\1%s\2' % [escaped_ast] )
-		escaped_under =  [S+3].pack('c')
-		gsub!(/(\s)_(\s|$)/, '\1%s\2' % [escaped_under])
-		
-		self
-	end
-
-	def unescape_md_special!
-		for i in 0..size-1
-			for e in MarkdownEscaped
-				if self[i] == e[1]
-					self[i,1] = e[0]
-				end
-			end
-		end
-		self
-	end
-
-	# Resubstitute '\<char>' as this was a code block
-	def it_was_a_code_block
-		s = ""; tmp =" "
-		each_byte do |b|
-			tmp[0] = b
-			found = false
-			for e in MarkdownEscaped
-				if b == e[1]
-					s << '\\'
-					s << e[0]
-					found = true
-				end
-			end
-			s << tmp if not found
-		end
-		s
-	end
-	
-	def unescape_md_special; dup.unescape_md_special! end
-	def   escape_md_special; dup.  escape_md_special! end
-	
-end
+end

data/lib/maruku/structures.rb

@@ -1,3 +1,4 @@
+#--
 #   Copyright (C) 2006  Andrea Censi  <andrea (at) rubyforge.org>
 #
 # This file is part of Maruku.
@@ -15,9 +16,34 @@
 #   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 Module
+	def safe_attr_accessor2(symbol, klass)
+		attr_reader symbol
+		code = <<-EOF
+		def #{symbol}=(val)  
+			if not val.kind_of? #{klass}
+				s = "Could not assign an object of type \#{val.class} to #{symbol}.\n"
+				s += "Tried to assign\n\#{val.inspect}\nto #{symbol} of object\n"
+				s += "\#{self.inspect}"
+				raise s
+			end
+			@#{symbol} = val
+		end
+		
+EOF
+		module_eval code
+  end
 
+	def safe_attr_accessor(symbol, klass)
+		attr_accessor symbol
+	end
+end
+
+module MaRuKu
 # I did not want to have a class for each possible element. 
 # Instead I opted to have only the class "MDElement"
 # that represents eveything in the document (paragraphs, headers, etc).
@@ -47,90 +73,88 @@
 # from whichever MDElement in the hierarchy.
 
 class MDElement 
-	# XXX List not complete
-	# Allowed: :document, :paragraph, :ul, :ol, :li, 
-	# :li_span, :strong, :emphasis, :link, :email
-	attr_accessor :node_type
+	# See helpers.rb for the list of allowed #node_type values
+	safe_attr_accessor :node_type, Symbol
+	
 	# Children are either Strings or MDElement
-	attr_accessor :children
-	# Hash for metadata
-	# contains :id for :link1
-	# :li :want_my_paragraph
-	#  :header: :level
-	# code, inline_code: :raw_code
-	attr_reader :meta
-	# reference of containing document (document has list of ref)
+	safe_attr_accessor :children, Array
+
+
+#	safe_attr_accessor :meta, Hash
+	
+	# An attribute list, may not be nil
+	safe_attr_accessor :al, Array #Maruku::AttributeList
+
+	# These are the processed attributes
+	safe_attr_accessor :attributes, Hash
+	
+	# Reference of the document (which is of class Maruku)
 	attr_accessor :doc
 	
-	def initialize(node_type_=:unset, children_=[], meta_={} )
+	def initialize(node_type=:unset, children=[], meta={}, 
+			al=MaRuKu::AttributeList.new )
 		super(); 
-		raise 'children is nil' if not children_
-		raise 'meta is nil' if not meta_
+		self.children = children
+		self.node_type = node_type
 		
-		@children = children_
-		@node_type = node_type_
-		@meta = meta_
+		@attributes = {}
+		
+		meta.each do |symbol, value|
+			self.instance_eval "
+			  def #{symbol}; @#{symbol}; end
+			  def #{symbol}=(val); @#{symbol}=val; end"
+			self.send "#{symbol}=", value
+		end
+		
+		self.al = al || AttributeList.new
+
+		self.meta_priv = meta
 	end
 	
+	attr_accessor :meta_priv
+	
 	def ==(o)
 		ok = o.kind_of?(MDElement) &&
 		(self.node_type == o.node_type) &&
-		(self.meta == o.meta) &&
+		(self.meta_priv == o.meta_priv) &&
 		(self.children == o.children)
-		ok
-	end
-	
-	def inspect(compact=true)
-		if compact
-			i2 = inspect2
-			return i2 if i2
-		end
 		
-		"md_el(:%s,%s %s)" %
-		[
-			@node_type,
-			children_inspect(compact), 
-			if @meta.size>0 then 
-				', '+@meta.inspect 
-			else '' end
-		]
-	end
-
-	def children_inspect(compact=true)
-		s = @children.inspect_more(compact,', ')
-		if @children.empty?
-			"[]"
-		elsif s.size < 70
-			s
-		else
-			"[\n"+
-			add_tabs(@children.inspect_more(compact,",\n ",false))+
-			"\n]"
+		if not ok
+#			puts "This:\n"+self.inspect+"\nis different from\n"+o.inspect+"\n\n"
 		end
+		ok
 	end
-	
 end
 
-class String
-	alias inspect_more inspect
-end
+# This represents the whole document and holds global data.
 
-class Array
-	def inspect_more(compact, join_string, add_brackets=true)
-		s  = map {|x| 
-			x.kind_of?(String) ? x.inspect : 
-			x.kind_of?(MDElement) ? x.inspect(compact) : 
-			(raise "WTF #{x.class} #{x.inspect}")
-		}.join(join_string)
+class MDDocument
+	safe_attr_accessor :refs, Hash
+	safe_attr_accessor :footnotes, Hash
+	
+	# This is an hash. The key might be nil.
+	safe_attr_accessor :abbreviations, Hash
+	
+	# Attribute lists definition
+	safe_attr_accessor :ald, Hash
+	
+	# The order in which footnotes are used. Contains the id.
+	safe_attr_accessor :footnotes_order, Array
+	
+	def initialize(s=nil)
+		super(:document)
+		@doc       = self
+
+		self.refs = {}
+		self.footnotes = {}
+		self.footnotes_order = []
+		self.abbreviations = {}
+		self.ald = {}
 		
-		add_brackets ? "[#{s}]" : s
+		parse_doc(s) if s 
 	end
 end
-# The Maruku class represent the whole document 
-# and holds global data.
 
-class Maruku < MDElement
-	attr_accessor :refs
-	attr_accessor :footnotes
-	attr_accessor :abbreviations
-end
+
+end # MaRuKu
+

data/lib/maruku/structures_inspect.rb

@@ -0,0 +1,78 @@
+#--
+#   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
+	alias inspect_more inspect
+end
+
+class Array
+	def inspect_more(compact, join_string, add_brackets=true)
+		s  = map {|x| 
+			x.kind_of?(String) ? x.inspect : 
+			x.kind_of?(MaRuKu::MDElement) ? x.inspect(compact) : 
+			(raise "WTF #{x.class} #{x.inspect}")
+		}.join(join_string)
+		
+		add_brackets ? "[#{s}]" : s
+	end
+end
+
+class Hash
+	def inspect_ordered
+		"{"+map{|k,v| k.inspect + "=>"+v.inspect}.join(',')+"}"
+	end
+end
+
+module MaRuKu
+class MDElement	
+	def inspect(compact=true)
+		if compact
+			i2 = inspect2
+			return i2 if i2
+		end
+		
+		"md_el(:%s,%s,%s,%s)" %
+		[
+			self.node_type,
+			children_inspect(compact), 
+			@meta_priv.inspect_ordered,
+			self.al.inspect
+		]
+	end
+
+	def children_inspect(compact=true)
+		s = @children.inspect_more(compact,', ')
+		if @children.empty?
+			"[]"
+		elsif s.size < 70
+			s
+		else
+			"[\n"+
+			add_tabs(@children.inspect_more(compact,",\n",false))+
+			"\n]"
+		end
+	end
+	
+end
+
+end
+