docubot 0.6.1 → 0.6.2

data/lib/docubot/converter.rb

@@ -1,28 +1,28 @@
-# encoding: UTF-8
-module DocuBot
-	module Converter
-		@by_type = {}
-		def self.to_convert( *types, &block )
-			types.each{ |type| @by_type[type.to_s] = block }
-		end
-		def self.by_type
-			@by_type
-		end
-		def self.types
-			@by_type.keys
-		end
-	end
-
-	def self.convert_to_html( page, source, type )
-		if converter = DocuBot::Converter.by_type[ type.to_s ]
-			puts "Converting #{type}: #{source.inspect[0..60]}" if $DEBUG
-			converter[ page, source ]
-		else
-			raise "No converter found for type #{type}"
-		end
-	end
-end
-
-Dir[ DocuBot::DIR/'docubot/converters/*.rb' ].each do |converter|
-	require converter
-end
+# encoding: UTF-8
+module DocuBot
+	module Converter
+		@by_type = {}
+		def self.to_convert( *types, &block )
+			types.each{ |type| @by_type[type.to_s] = block }
+		end
+		def self.by_type
+			@by_type
+		end
+		def self.types
+			@by_type.keys
+		end
+	end
+
+	def self.convert_to_html( page, source, type )
+		if converter = DocuBot::Converter.by_type[ type.to_s ]
+			puts "Converting #{type}: #{source.inspect[0..60]}" if $DEBUG
+			converter[ page, source ]
+		else
+			raise "No converter found for type #{type}"
+		end
+	end
+end
+
+Dir[ DocuBot::DIR/'docubot/converters/*.rb' ].each do |converter|
+	require converter
+end

data/lib/docubot/converters/haml.rb

@@ -1,9 +1,9 @@
-# encoding: UTF-8
-require 'rubygems'
-require 'haml'
-options = { :format=>:html4, :ugly=>true }
-options.merge!( :encoding=>'utf-8' ) if Object.const_defined? "Encoding"
-
-DocuBot::Converter.to_convert :haml do |page, source|
-	Haml::Engine.new( source, options ).render( page, :page=>page, :global=>page.bundle.global, :root=>page.root )
-end
+# encoding: UTF-8
+require 'rubygems'
+require 'haml'
+options = { :format=>:html4, :ugly=>true }
+options.merge!( :encoding=>'utf-8' ) if Object.const_defined? "Encoding"
+
+DocuBot::Converter.to_convert :haml do |page, source|
+	Haml::Engine.new( source, options ).render( page, :page=>page, :global=>page.bundle.global, :root=>page.root )
+end

data/lib/docubot/converters/markdown.rb

@@ -1,14 +1,14 @@
-# encoding: UTF-8
-require 'rubygems'
-begin
-	require 'bluecloth'
-	DocuBot::Converter.to_convert :md, :markdown do |page, source|
-		# BlueCloth 2.0.5 takes UTF-8 source and returns ASCII-8BIT
-		result = BlueCloth.new(source).to_html
-		result.encode!( 'UTF-8', :undef=>:replace ) if Object.const_defined? "Encoding"
-		result		
-	end
-rescue LoadError
-	warn "Unable to load bluecloth gem; *.markdown/*.md markup will not be recognized as a page."
-end
-
+# encoding: UTF-8
+require 'rubygems'
+begin
+	require 'bluecloth'
+	DocuBot::Converter.to_convert :md, :markdown do |page, source|
+		# BlueCloth 2.0.5 takes UTF-8 source and returns ASCII-8BIT
+		result = BlueCloth.new(source).to_html
+		result.encode!( 'UTF-8', :undef=>:replace ) if Object.const_defined? "Encoding"
+		result		
+	end
+rescue LoadError
+	warn "Unable to load bluecloth gem; *.markdown/*.md markup will not be recognized as a page."
+end
+

data/lib/docubot/index.rb

@@ -1,67 +1,67 @@
-# encoding: UTF-8
-
-# The index links keywords to a particular page.
-#
-# Keywords are added to the index by:
-#  * Having a "keywords" entry in the metasection, e.g.
-#    keywords: Rigid Bodies, Dynamic, Physical Mesh
-#  * Surrounding a word or phrase on the page with two @ characters, e.g.
-#    The purpose of a @@physical mesh@@ is to...
-#  * Having an "index: headings" entry in the metasection, causing each
-#    heading on the page to be added to the index.
-#  * Having an "index: definitions" entry in the metasection, causing each
-#    <dt>...</dt> on the page to be added to the index.
-#    (May be combined with the above as "index: headings definitions".)
-#
-# As shown above, terms may be referenced in title or lowercase.
-# Names with capital letters will be favored over lowercase in the index.
-class DocuBot::Index
-	attr_reader :entries
-	def initialize( bundle )
-		@bundle    = bundle
-		@entries   = Hash.new{|h,k|h[k]=[]} # key points to array of DocuBot::Pages
-		@downcased = {}
-		#TODO: support links to sub-sections instead of just pages
-	end
-	
-	# Run through the 'keywords' and 'index' meta attribute for a page and add entries
-	# Note: in-content @@keyword@@ marks are processed by snippets/index_entries.rb 
-	def process_page( page )
-		page.keywords.split(/,\s*/).each{ |key| add( key, page ) } if page.keywords?
-
-		# FIXME: This is substantially slower (but way more correct) than regexp only.
-		unless page['no-index'] && page['no-index'].include?( 'headings' )
-			%w[h1 h2 h3 h4 h5 h6].each do |hn|
-				page.nokodoc.css(hn).each{ |head| add( head.inner_text, page ) }
-			end
-		end
-
-		unless page['no-index'] && page['no-index'].include?( 'definitions' )
-			page.nokodoc.css("dt").each{ |defn| add( defn.inner_text, page ) }
-		end
-	end
-	
-	def add( term, page )
-		term.strip!
-		term.gsub!(/<[^>]+>/,'')
-		down = term.downcase
-		if existing = @downcased[ down ]
-			# The existing entry might be early-arriving all-lowercase.
-			# If the new term has more capital letters, it wins.
-			if term.scan(/[A-Z]/).length > existing.scan(/[A-Z]/).length
-				@downcased[ down ] = term
-				@entries[ term ] = @entries[ existing ]
-				@entries.delete( existing )
-			else
-				term = existing
-			end
-		end
-		@entries[ term ] << page
-		@entries[ term ].uniq!
-		@downcased[ down ] = term
-	end
-	
-	def each
-		@entries.each{ |term, pages| yield term, pages }
-	end
-end
+# encoding: UTF-8
+
+# The index links keywords to a particular page.
+#
+# Keywords are added to the index by:
+#  * Having a "keywords" entry in the metasection, e.g.
+#    keywords: Rigid Bodies, Dynamic, Physical Mesh
+#  * Surrounding a word or phrase on the page with two @ characters, e.g.
+#    The purpose of a @@physical mesh@@ is to...
+#  * Having an "index: headings" entry in the metasection, causing each
+#    heading on the page to be added to the index.
+#  * Having an "index: definitions" entry in the metasection, causing each
+#    <dt>...</dt> on the page to be added to the index.
+#    (May be combined with the above as "index: headings definitions".)
+#
+# As shown above, terms may be referenced in title or lowercase.
+# Names with capital letters will be favored over lowercase in the index.
+class DocuBot::Index
+	attr_reader :entries
+	def initialize( bundle )
+		@bundle    = bundle
+		@entries   = Hash.new{|h,k|h[k]=[]} # key points to array of DocuBot::Pages
+		@downcased = {}
+		#TODO: support links to sub-sections instead of just pages
+	end
+	
+	# Run through the 'keywords' and 'index' meta attribute for a page and add entries
+	# Note: in-content @@keyword@@ marks are processed by snippets/index_entries.rb 
+	def process_page( page )
+		page.keywords.split(/,\s*/).each{ |key| add( key, page ) } if page.keywords?
+
+		# FIXME: This is substantially slower (but way more correct) than regexp only.
+		unless page['no-index'] && page['no-index'].include?( 'headings' )
+			%w[h1 h2 h3 h4 h5 h6].each do |hn|
+				page.nokodoc.css(hn).each{ |head| add( head.inner_text, page ) }
+			end
+		end
+
+		unless page['no-index'] && page['no-index'].include?( 'definitions' )
+			page.nokodoc.css("dt").each{ |defn| add( defn.inner_text, page ) }
+		end
+	end
+	
+	def add( term, page )
+		term.strip!
+		term.gsub!(/<[^>]+>/,'')
+		down = term.downcase
+		if existing = @downcased[ down ]
+			# The existing entry might be early-arriving all-lowercase.
+			# If the new term has more capital letters, it wins.
+			if term.scan(/[A-Z]/).length > existing.scan(/[A-Z]/).length
+				@downcased[ down ] = term
+				@entries[ term ] = @entries[ existing ]
+				@entries.delete( existing )
+			else
+				term = existing
+			end
+		end
+		@entries[ term ] << page
+		@entries[ term ].uniq!
+		@downcased[ down ] = term
+	end
+	
+	def each
+		@entries.each{ |term, pages| yield term, pages }
+	end
+end

data/lib/docubot/link_tree.rb

@@ -1,111 +1,111 @@
-# encoding: UTF-8
-module DocuBot::LinkTree; end
-
-class DocuBot::LinkTree::Node
-	attr_accessor :title, :link, :page, :parent
-	
-	def initialize( title=nil, link=nil, page=nil )
-		@title,@link,@page = title,link,page
-		@children = []
-	end
-	
-	def anchor
-		@link[/#(.+)/,1]
-	end
-	
-	def file
-		@link.sub(/#.+/,'')
-	end
-	
-	def leaf?
-		!@children.any?{ |node| node.page != @page }
-	end
-
-	# Add a new link underneath a link to its logical parent
-	def add_to_link_hierarchy( title, link, page=nil )
-		node = DocuBot::LinkTree::Node.new( title, link, page )
-		parent_link = if node.anchor
-			node.file
-		elsif File.basename(link)=='index.html'
-			File.dirname(File.dirname(link))/'index.html'
-		else
-			(File.dirname(link) / 'index.html')
-		end
-		#puts "Adding #{title.inspect} (#{link}) to hierarchy under #{parent_link}"
-		parent = descendants.find{ |n| n.link==parent_link } || self
-		parent << node
-	end
-
-	def <<( node )
-		node.parent = self
-		@children << node
-	end
-	
-	def []( child_index )
-		@children[child_index]
-	end
-	
-	def children( parent_link=nil, &block )
-		if parent_link
-			root = find( parent_link )
-			root ? root.children( &block ) : []
-		else
-			@children
-		end
-	end
-	
-	def descendants
-		( @children + @children.map{ |child| child.descendants } ).flatten
-	end
-	
-	def find( link )
-		# TODO: this is eminently cachable
-		descendants.find{ |node| node.link==link }
-	end
-	
-	def depth
-		# Cached assuming no one is going to shuffle the nodes after placement
-		@depth ||= ancestors.length
-	end
-	
-	def ancestors
-		# Cached assuming no one is going to shuffle the nodes after placement
-		return @ancestors if @ancestors
-		@ancestors = []
-		node = self
-		@ancestors << node while node = node.parent
-		@ancestors.reverse!
-	end
-	
-	def to_s
-		"#{@title} (#{@link}) - #{@page && @page.title}"
-	end
-	
-	def to_txt( depth=0 )
-		indent = "  "*depth
-		[
-			indent+to_s,
-			children.map{|kid|kid.to_txt(depth+1)}
-		].flatten.join("\n")
-	end
-end
-
-class DocuBot::LinkTree::Root < DocuBot::LinkTree::Node
-	undef_method :title
-	undef_method :link
-	undef_method :page
-	attr_reader :bundle
-	def initialize( bundle )
-		@bundle   = bundle
-		@children = []
-	end
-
-	def <<( node )
-		node.parent = nil
-		@children << node
-	end
-	
-	def to_s
-		"(Table of Contents)"
-	end
-end
+# encoding: UTF-8
+module DocuBot::LinkTree; end
+
+class DocuBot::LinkTree::Node
+	attr_accessor :title, :link, :page, :parent
+	
+	def initialize( title=nil, link=nil, page=nil )
+		@title,@link,@page = title,link,page
+		@children = []
+	end
+	
+	def anchor
+		@link[/#(.+)/,1]
+	end
+	
+	def file
+		@link.sub(/#.+/,'')
+	end
+	
+	def leaf?
+		!@children.any?{ |node| node.page != @page }
+	end
+
+	# Add a new link underneath a link to its logical parent
+	def add_to_link_hierarchy( title, link, page=nil )
+		node = DocuBot::LinkTree::Node.new( title, link, page )
+		parent_link = if node.anchor
+			node.file
+		elsif File.basename(link)=='index.html'
+			File.dirname(File.dirname(link))/'index.html'
+		else
+			(File.dirname(link) / 'index.html')
+		end
+		#puts "Adding #{title.inspect} (#{link}) to hierarchy under #{parent_link}"
+		parent = descendants.find{ |n| n.link==parent_link } || self
+		parent << node
+	end
+
+	def <<( node )
+		node.parent = self
+		@children << node
+	end
+	
+	def []( child_index )
+		@children[child_index]
+	end
+	
+	def children( parent_link=nil, &block )
+		if parent_link
+			root = find( parent_link )
+			root ? root.children( &block ) : []
+		else
+			@children
+		end
+	end
+	
+	def descendants
+		( @children + @children.map{ |child| child.descendants } ).flatten
+	end
+	
+	def find( link )
+		# TODO: this is eminently cachable
+		descendants.find{ |node| node.link==link }
+	end
+	
+	def depth
+		# Cached assuming no one is going to shuffle the nodes after placement
+		@depth ||= ancestors.length
+	end
+	
+	def ancestors
+		# Cached assuming no one is going to shuffle the nodes after placement
+		return @ancestors if @ancestors
+		@ancestors = []
+		node = self
+		@ancestors << node while node = node.parent
+		@ancestors.reverse!
+	end
+	
+	def to_s
+		"#{@title} (#{@link}) - #{@page && @page.title}"
+	end
+	
+	def to_txt( depth=0 )
+		indent = "  "*depth
+		[
+			indent+to_s,
+			children.map{|kid|kid.to_txt(depth+1)}
+		].flatten.join("\n")
+	end
+end
+
+class DocuBot::LinkTree::Root < DocuBot::LinkTree::Node
+	undef_method :title
+	undef_method :link
+	undef_method :page
+	attr_reader :bundle
+	def initialize( bundle )
+		@bundle   = bundle
+		@children = []
+	end
+
+	def <<( node )
+		node.parent = nil
+		@children << node
+	end
+	
+	def to_s
+		"(Table of Contents)"
+	end
+end