maruku 0.6.1 → 0.7.0.beta1

data/lib/maruku/output/to_markdown.rb

@@ -1,164 +1,209 @@
-#--
-#   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
-	# XXX: markdown escaping
-	def to_md(c=nil)
-		to_s
-	end
-	
-	# " andrea censi " => [" andrea ", "censi "]
-	def mysplit
-		split.map{|x| x+" "}
-	end
-end
+module MaRuKu::Out::Markdown
+
+  DefaultLineLength = 40
+
+  def to_md(context={})
+    children_to_md(context)
+  end
+
+  # " andrea censi " => [" andrea ", "censi "]
+  def mysplit(c)
+    res = c.split.map {|x| x + " " }
+    if c[0] == ' ' && res[0]
+      res[0] = " " + res[0]
+    end
+    res
+  end
+
+  def to_md_header(context)
+    pounds = "#" * @level
+    "#{pounds} #{children_to_md(context)} #{pounds}\n\n"
+  end
+
+  def to_md_inline_code(context)
+    "`#{@raw_code}`"
+  end
+
+  def to_md_code(context)
+    @raw_code.split("\n").collect { |line| "     " + line}.join("\n") + "\n\n"
+  end
+
+  def to_md_quote(context)
+    line_length = (context[:line_length] || DefaultLineLength) - 2
+    wrap(@children, line_length, context).split(/\n/).collect { |line| "> " + line}.join("\n") + "\n"
+  end
+
+  def to_md_hrule(context)
+    "* * *\n"
+  end
+
+  def to_md_emphasis(context)
+    "*#{children_to_md(context)}*"
+  end
+
+  def to_md_strong(context)
+    "**#{children_to_md(context)}**"
+  end
+
+  def to_md_immediate_link(context)
+    "<#{@url}>"
+  end
+
+  def to_md_email_address(context)
+    "<#{@email}>"
+  end
+
+  def to_md_entity(context)
+    "&#{@entity_name};"
+  end
+
+  def to_md_linebreak(context)
+    "\n"
+  end
+
+  def to_md_paragraph(context)
+    line_length = context[:line_length] || DefaultLineLength
+    wrap(@children, line_length, context)+"\n"
+  end
+
+  def to_md_im_link(context)
+    "[#{children_to_md(context)}](#{@url}#{" \"#{@title}\"" if @title})"
+  end
+
+  def to_md_link(context)
+    "[#{children_to_md(context)}][#{@ref_id}]"
+  end
+
+  def to_md_im_image(context)
+    "![#{children_to_md(context)}](#{@url}#{" \"#{@title}\"" if @title})"
+  end
 
+  def to_md_image(context)
+    "![#{children_to_md(context)}][#{@ref_id}]"
+  end
 
-module MaRuKu; module Out; module Markdown 
-	
-	DefaultLineLength = 40
-	
-	def to_md(context={})
-		children_to_md(context)
-	end
-	
-	def to_md_paragraph(context)
-		line_length = context[:line_length] || DefaultLineLength
-		wrap(@children, line_length, context)+"\n"
-	end
-	
-	def to_md_li_span(context)
-		len = (context[:line_length] || DefaultLineLength) - 2
-		s = add_tabs(wrap(@children, len-2, context), 1, '  ')
-		s[0] = ?*
-		s + "\n"
-	end
-	
-	def to_md_abbr_def(context)
-		"*[#{self.abbr}]: #{self.text}\n"
-	end
-	
-	def to_md_ol(context)
-		len = (context[:line_length] || DefaultLineLength) - 2
-		md = ""
-		self.children.each_with_index do |li, i|
-			s = add_tabs(w=wrap(li.children, len-2, context), 1, '    ')+"\n"
-			s[0,4] = "#{i+1}.  "[0,4]
-#			puts w.inspect
-			md += s
-		end
-		md + "\n"
-	end
-
-	def to_md_ul(context)
-		len = (context[:line_length] || DefaultLineLength) - 2
-		md = ""
-		self.children.each_with_index do |li, i|
-			w = wrap(li.children, len-2, context)
-#			puts "W: "+ w.inspect
-			s = add_indent(w)
-#			puts "S: " +s.inspect
-			s[0,1] = "-"
-			md += s
-		end
-		md + "\n"
-	end
-	
-	def add_indent(s,char="    ")
-		t = s.split("\n").map{|x| char+x }.join("\n")
-		s << ?\n if t[-1] == ?\n
-		s
-	end
-	
-	# Convert each child to html
-	def children_to_md(context)
-		array_to_md(@children, context)
-	end
-	
-	def wrap(array, line_length, context)
-		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(context)].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 << ?\n if not out[-1] == ?\n
-		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 end end
-
-module MaRuKu; class MDDocument
-	alias old_md to_md
-	def to_md(context={})
-		s = old_md(context)
-#		puts s
-		s
-	end	
-end end
+  def to_md_ref_definition(context)
+    "[#{@ref_id}] #{@url}#{" \"#{@title}\"" if @title}"
+  end
+
+  def to_md_abbr_def(context)
+    "*[#{self.abbr}]: #{self.text}\n"
+  end
+
+  def to_md_ol(context)
+    len = (context[:line_length] || DefaultLineLength) - 2
+    md = ""
+    self.children.each_with_index do |li, i|
+      #     s = (w=wrap(li.children, len-2, context)).rstrip.gsub(/^/, '    ')+"\n"
+      #     s[0,4] = "#{i+1}.  "[0,4]
+      #     puts w.inspect
+      s = "#{i+1}. " + wrap(li.children, len-2, context).rstrip + "\n"
+      md += s
+    end
+    md + "\n"
+  end
+
+  def to_md_ul(context)
+    len = (context[:line_length] || DefaultLineLength) - 2
+    md = ""
+    self.children.each_with_index do |li, i|
+      w = wrap(li.children, len-2, context)
+      s = "- " + w
+      #     puts "W: "+ w.inspect
+      #   s = add_indent(w)
+      #     puts "S: " +s.inspect
+      #   s[0,1] = "-"
+      md += s
+    end
+    md + "\n"
+  end
+
+  def add_indent(s,char="    ")
+    t = s.split("\n").map{|x| char+x }.join("\n")
+    s << ?\n if t[-1] == ?\n
+    s
+  end
+
+  # Convert each child to html
+  def children_to_md(context)
+    array_to_md(@children, context)
+  end
+
+  def wrap(array, line_length, context)
+    out = ""
+    line = ""
+    array.each do |c|
+      if c.kind_of?(MaRuKu::MDElement) &&  c.node_type == :linebreak
+        out << line.strip << "  \n"; line="";
+        next
+      end
+
+      pieces =
+        if c.kind_of? String
+          mysplit(c)
+        elsif c.kind_of?(MaRuKu::MDElement)
+          method = "to_md_#{c.node_type}"
+          method = "to_md" unless c.respond_to?(method)
+          [c.send(method, context)].flatten
+        else
+          [c.to_md(context)].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 << ?\n if not out[-1] == ?\n
+    out
+  end
+
+
+  def array_to_md(array, context, join_char='')
+    e = []
+    array.each do |c|
+      if c.is_a?(String)
+        e << c
+      else
+        method = c.kind_of?(MaRuKu::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
+    end
+    e.join(join_char)
+  end
+
+end
+
+module MaRuKu
+  class MDDocument
+    alias old_md to_md
+    def to_md(context={})
+      warn "Maruku#to_md is deprecated and will be removed in a near-future version of Maruku."
+      old_md(context)
+    end
+  end
+end

data/lib/maruku/output/to_s.rb

@@ -1,56 +1,15 @@
-#--
-#   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
+  class MDElement
+
+    # Strips all formatting from the string
+    def to_s
+      warn "Maruku#to_s is deprecated and will be removed or changed in a near-future version of Maruku."
+      children_to_s
+    end
 
+    def children_to_s
+      @children.join
+    end
+  end
 end

data/lib/maruku/string_utils.rb

@@ -1,191 +1,141 @@
-#--
-#   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
-#++
+require 'strscan'
 
+module MaRuKu
+  # Utility functions for dealing with strings.
+  module Strings
+    TAB_SIZE = 4
 
-# 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
+    # Split a string into multiple lines,
+    # on line feeds and/or carriage returns.
+    #
+    # @param s [String]
+    # @return [String]
+    def split_lines(s)
+      s.split(/\r\n|\r|\n/)
+    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
+    # Parses email headers, returning a hash.
+    # `hash[:data]` is the message;
+    # that is, anything past the headers.
+    #
+    # Keys are downcased and converted to symbols;
+    # spaces become underscores. For example:
+    #
+    #     !!!plain
+    #     My key: true
+    #
+    # becomes:
+    #
+    #     {:my_key => true}
+    #
+    # @param s [String] The email
+    # @return [Symbol => String] The header values
+    def parse_email_headers(s)
+      headers = {}
+      scanner = StringScanner.new(s)
 
-	# 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 optional whitespace
-			while s[i,1] =~ /\s/; i+=1 end
-			return i
-		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 whitespace
-			while s[i,1] =~ /\s/; i+=1 end
-			return i
-		else
-			tell_user "BUG (my bad): '#{s}' is not a list"
-			0
-		end
-	end
+      while scanner.scan(/(\w[\w\s\-]+): +(.*)\n/)
+        k, v = normalize_key_and_value(scanner[1], scanner[2])
+        headers[k.to_sym] = v
+      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
+      headers[:data] = scanner.rest
+      headers
+    end
 
+    # This returns the position of the first non-list character
+    # in a list item.
+    #
+    # @example
+    # spaces_before_first_char('*Hello') #=> 1
+    # spaces_before_first_char('* Hello') #=> 2
+    # spaces_before_first_char(' * Hello') #=> 3
+    # spaces_before_first_char(' *   Hello') #=> 5
+    # spaces_before_first_char('1.Hello') #=> 2
+    # spaces_before_first_char(' 1.  Hello') #=> 5
+    #
+    # @param s [String]
+    # @return [Fixnum]
+    def spaces_before_first_char(s)
+      match =
+        case s.md_type
+        when :ulist
+          # whitespace, followed by ('*'|'+'|'-') followed by
+          # more whitespace, followed by an optional IAL, followed
+          # by yet more whitespace
+          s[/^\s*(\*|\+|\-)\s*(\{[:#\.].*?\})?\s*/]
+        when :olist
+          # whitespace, followed by a number, followed by a period,
+          # more whitespace, an optional IAL, and more whitespace
+          s[/^\s*\d+\.\s*(\{[:#\.].*?\})?\s*/]
+        else
+          tell_user "BUG (my bad): '#{s}' is not a list"
+          ''
+        end
+      f = /\{(.*?)\}/.match(match)
+      ial = f[1] if f
+      [match.length, ial]
+    end
 
-	# removes initial quote
-	def unquote(s)
-		s.gsub(/^>\s?/,'')
-	end
+    # Normalize a link reference.
+    #
+    # @param s [String]
+    # @return [String]
+    def sanitize_ref_id(s)
+      s.downcase.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
+    # Remove line-initial `>` characters for a quotation.
+    #
+    # @param s [String]
+    # @return [String]
+    def unquote(s)
+      s.gsub(/^>\s?/, '')
+    end
 
-	def dbg_describe_ary(a, prefix='')
-		i = 0 
-		a.each do |l|
-			puts "#{prefix} (#{i+=1})# #{l.inspect}"
-		end
-	end
+    # Removes indentation from the beginning of `s`,
+    # up to at most `n` spaces.
+    # Tabs are counted as {TAB_SIZE} spaces.
+    #
+    # @param s [String]
+    # @param n [Fixnum]
+    # @return [String]
+    def strip_indent(s, n)
+      while n > 0
+        case s[0, 1]
+        when ' '
+          n -= 1
+        when "\t"
+          n -= TAB_SIZE
+        else
+          break
+        end
+        s = s[1..-1]
+      end
 
-	def force_linebreak?(l)
-		l =~ /  $/
-	end
+      MDLine.new(s)
+    end
 
-end
+    private
+
+    # Normalize the key/value pairs for email headers.
+    # Keys are downcased and converted to symbols;
+    # spaces become underscores.
+    #
+    # Values of `"yes"`, `"true"`, `"no"`, and `"false"`
+    # are converted to appropriate booleans.
+    #
+    # @param k [String]
+    # @param v [String]
+    # @return [Array(String, String or Boolean)]
+    def normalize_key_and_value(k, v)
+      k = k.strip.downcase.gsub(/\s+/, '_').to_sym
+      v = v.strip
+
+      # check synonyms
+      return k, true if %w[yes true].include?(v.downcase)
+      return k, false if %w[no false].include?(v.downcase)
+      return k, v
+    end
+  end
 end