maiku 0.6.1.maiku

data/lib/maruku/output/to_s.rb

@@ -0,0 +1,56 @@
+#--
+#   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
+	
+class MDElement
+	
+	# Strips all formatting from the string
+	def to_s
+		 children_to_s
+	end
+	
+	def children_to_s
+		@children.join
+	end
+	
+	# Generate an id for headers. Assumes @children is set.
+	def generate_id
+		
+		title = children_to_s
+		title.gsub!(/ /,'_')
+		title.downcase!
+		title.gsub!(/[^\w_]/,'')
+		title.strip!
+		
+		if title.size == 0
+			$uid ||= 0
+			$uid += 1
+			title = "id#{$uid}"
+		end
+
+		# random is a very bad idea
+#		title << "_" + rand(10000).to_s
+		title
+	end
+end
+
+end

data/lib/maruku/string_utils.rb

@@ -0,0 +1,201 @@
+#--
+#   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
+#++
+
+
+# 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
+	
+	TabSize = 4;
+	
+	def split_lines(s)
+		s.gsub("\r","").split("\n")
+	end
+	
+	# This parses email headers. Returns an hash. 
+	#
+	# +hash['data']+ is the message.
+	#
+	# Keys are downcased, space becomes underscore, converted to symbols.
+	#
+	#     My key: true
+	#
+	# becomes:
+	#
+	#     {:my_key => true}
+	#
+	def parse_email_headers(s)
+		keys={}
+		match = (s =~ /\A((\w[\w\s\_\-]+: .*\n)+)\s*\n/)
+		if match != 0
+			keys[:data] = s
+		else
+			keys[:data] = $'
+			headers = $1
+			headers.split("\n").each do |l| 
+# Fails if there are other ':' characters.
+#				k, v = l.split(':')
+				k, v = l.split(':', 2)
+				k, v = normalize_key_and_value(k, v)
+				k = k.to_sym
+#				puts "K = #{k}, V=#{v}"
+				keys[k] = v
+			end
+		end
+		keys
+	end
+
+	# Keys are downcased, space becomes underscore, converted to symbols.
+	def normalize_key_and_value(k,v)
+		v = v ? v.strip : true # no value defaults to true
+		k = k.strip
+		
+		# check synonyms
+		v = true if ['yes','true'].include?(v.to_s.downcase)
+		v = false if ['no','false'].include?(v.to_s.downcase)
+	
+		k = k.downcase.gsub(' ','_')
+		return k, v
+	end
+	
+	# Returns the number of leading spaces, considering that
+	# a tab counts as `TabSize` spaces.
+	def number_of_leading_spaces(s)
+		n=0; i=0;
+		while i < s.size 
+			c = s[i,1]
+			if c == ' '
+				i+=1; n+=1;
+			elsif c == "\t"
+				i+=1; n+=TabSize;
+			else
+				break
+			end
+		end
+		n
+	end
+
+	# This returns the position of the first real char in a list item
+	#
+	# For example: 
+	#     '*Hello' # => 1
+	#     '* Hello' # => 2
+	#     ' * Hello' # => 3
+	#     ' *   Hello' # => 5
+	#     '1.Hello' # => 2
+	#     ' 1.  Hello' # => 5
+	
+	def spaces_before_first_char(s)
+		case s.md_type
+		when :ulist
+			i=0;
+			# skip whitespace if present
+			while s[i,1] =~ /\s/; i+=1 end
+			# skip indicator (+, -, *)
+			i+=1
+			# skip whitespace
+			while s[i,1] =~ /\s/; i+=1 end
+			# find an IAL
+			ial = s[i,s.length - i][/^\{(.*?)\}/]
+			i+= ial.length if ial
+			# skip optional whitespace
+			while s[i,1] =~ /\s/; i+=1 end
+			return [i, ial]
+		when :olist
+			i=0;
+			# skip whitespace
+			while s[i,1] =~ /\s/; i+=1 end
+			# skip digits
+			while s[i,1] =~ /\d/; i+=1 end
+			# skip dot
+			i+=1
+			# skip optional whitespace
+			while s[i,1] =~ /\s/; i+=1 end
+			# find an IAL
+			ial = s[i,s.length - i][/^\{(.*?)\}/]
+			i+= ial.length if ial
+			# skip whitespace
+			while s[i,1] =~ /\s/; i+=1 end
+			return [i, ial]
+		else
+			tell_user "BUG (my bad): '#{s}' is not a list"
+			[0, nil]
+		end
+	end
+
+	# Counts the number of leading '#' in the string
+	def num_leading_hashes(s)
+		i=0;
+		while i<(s.size-1) && (s[i,1]=='#'); i+=1 end
+		i	
+	end
+	
+	# Strips initial and final hashes
+	def strip_hashes(s)
+		s = s[num_leading_hashes(s), s.size]
+		i = s.size-1
+		while i > 0 && (s[i,1] =~ /(#|\s)/); i-=1; end
+		s[0, i+1].strip
+	end
+	
+	# change space to "_" and remove any non-word character
+	def sanitize_ref_id(x)
+		x.strip.downcase.gsub(' ','_').gsub(/[^\w]/,'')
+	end
+
+
+	# removes initial quote
+	def unquote(s)
+		s.gsub(/^>\s?/,'')
+	end
+
+	# toglie al massimo n caratteri
+	def strip_indent(s, n) 
+		i = 0
+		while i < s.size && n>0
+			c = s[i,1]
+			if c == ' '
+				n-=1;
+			elsif c == "\t"
+				n-=TabSize;
+			else
+				break
+			end
+			i+=1
+		end
+		s[i, s.size]
+	end
+
+	def dbg_describe_ary(a, prefix='')
+		i = 0 
+		a.each do |l|
+			puts "#{prefix} (#{i+=1})# #{l.inspect}"
+		end
+	end
+
+	def force_linebreak?(l)
+		l =~ /  $/
+	end
+
+end
+end

data/lib/maruku/structures.rb

@@ -0,0 +1,167 @@
+#--
+#   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 Module
+	def safe_attr_accessor1(symbol, klass)
+		attr_reader symbol
+		code = <<-EOF
+		def #{symbol}=(val)  
+			if not val.kind_of? #{klass}
+				s = "\nCould not assign an object of type \#{val.class} to #{symbol}.\n\n"
+				s += "Tried to assign object of class \#{val.class}:\n"+
+				     "\#{val.inspect}\n"+
+				     "to \#{self.class}::#{symbol} constrained to be of class #{klass}.\n"
+				raise s
+			end
+			@#{symbol} = val
+		end
+		
+EOF
+		module_eval code
+  end
+
+	def safe_attr_accessor2(symbol, klass)
+		attr_accessor symbol
+	end
+	
+	alias  safe_attr_accessor  safe_attr_accessor2
+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).
+#
+# You can tell what it is by the variable `node_type`. 
+#
+# In the instance-variable `children` there are the children. These
+# can be of class 1) String or 2) MDElement. 
+#
+# The @doc variable points to the document to which the MDElement
+# belongs (which is an instance of Maruku, subclass of MDElement).
+#
+# Attributes are contained in the hash `attributes`. 
+# Keys are symbols (downcased, with spaces substituted by underscores)
+#
+# For example, if you write in the source document.
+# 
+#     Title: test document
+#     My property: value
+#     
+#     content content
+#
+# You can access `value` by writing:
+#
+#     @doc.attributes[:my_property] # => 'value'
+#
+# from whichever MDElement in the hierarchy.
+#
+class MDElement 
+	# See helpers.rb for the list of allowed #node_type values
+	safe_attr_accessor :node_type, Symbol
+	
+	# Children are either Strings or MDElement
+	safe_attr_accessor :children, Array
+	
+	# 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={}, 
+			al=MaRuKu::AttributeList.new )
+		super(); 
+		self.children = children
+		self.node_type = node_type
+		
+		@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_priv == o.meta_priv) &&
+		(self.children == o.children)
+		
+		if not ok
+#			puts "This:\n"+self.inspect+"\nis different from\n"+o.inspect+"\n\n"
+		end
+		ok
+	end
+end
+
+# This represents the whole document and holds global data.
+
+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
+	
+	safe_attr_accessor :latex_required_packages, Array
+	
+	safe_attr_accessor :refid2ref, Hash
+	
+	def initialize(s=nil)
+		super(:document)
+		@doc       = self
+
+		self.refs = {}
+		self.footnotes = {}
+		self.footnotes_order = []
+		self.abbreviations = {}
+		self.ald = {}
+		self.latex_required_packages = []
+		
+		parse_doc(s) if s 
+	end
+end
+
+
+end # MaRuKu
+

data/lib/maruku/structures_inspect.rb

@@ -0,0 +1,87 @@
+#--
+#   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 inspect_more(a=nil,b=nil)
+		inspect
+	end
+end
+
+class Object
+	def inspect_more(a=nil,b=nil)
+		inspect
+	end
+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(a=nil,b=nil)
+		"{"+keys.map{|x|x.to_s}.sort.map{|x|x.to_sym}.
+		map{|k| k.inspect + "=>"+self[k].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
+