docubot 0.4 → 0.5

data/lib/docubot.rb

@@ -20,7 +20,7 @@ module FileUtils
 end
 
 module DocuBot
-	VERSION = '0.4'
+	VERSION = '0.5'
 	DIR     = File.expand_path( File.dirname( __FILE__ ) )
 	
 	TEMPLATE_DIR = DIR / 'docubot/templates'

data/lib/docubot/bundle.rb

@@ -20,7 +20,7 @@ class DocuBot::Bundle
 		Dir.chdir( @source ) do
 			# This might be nil; MetaSection.new is OK with that.
 			index_file = Dir[ *DocuBot::Converter.types.map{|t| "index.#{t}"} ][ 0 ]
-			@global = DocuBot::MetaSection.new( {}, index_file )
+			@global = DocuBot::MetaSection.new( {:title=>'DocuBot Documentation'}, index_file )
 			@global.glossary = @glossary
 			@global.index    = @index
 			@global.toc      = @toc
@@ -28,10 +28,12 @@ class DocuBot::Bundle
 			files_and_folders = Dir[ '**/*' ]
 			
 			# index files are handled by Page.new for a directory; no sections for special folders (but process contents)
-			files_and_folders.reject!{ |path| name = File.basename( path ); name =~ /^(?:index\.[^.]+|_static|_glossary)$/ }
+			files_and_folders.reject!{ |path| name = File.basename( path ); name =~ /^(?:index\.[^.]+)$/ }
 			
 			# All files in the _templates directory should be ignored
-			files_and_folders.reject!{ |f| f =~ /^_templates\b/ }
+			files_and_folders.reject!{ |f| f =~ /(?:^|\/)_/ }
+			files_and_folders.concat Dir[ '_static/**/*' ]
+			files_and_folders.concat Dir[ '_glossary/**/*' ]
 
 			@global.ignore.as_list.each do |glob|
 				files_and_folders = files_and_folders - Dir[glob]
@@ -101,32 +103,27 @@ class DocuBot::Bundle
 		@file_links     = Hash.new{ |h,k| h[k]=[] }
 		@broken_links   = Hash.new{ |h,k| h[k]=[] }
 
-		page_by_html_path = {}
-		page_by_orig_path = {}
-		@pages.each do |page|
-			page_by_html_path[page.html_path] = page
-			page_by_orig_path[page.file]      = page if page.file
-		end
-
 		Dir.chdir( @source ) do 
 			@pages.each do |page|
-				page.nokodoc.xpath('.//a/@href').each do |href|
-					href=href.content
+				# TODO: set the xpath to .//a/@href once this is fixed: http://github.com/tenderlove/nokogiri/issues/#issue/213
+				page.nokodoc.xpath('.//a').each do |a|
+					next unless href = a['href']
+					href = CGI.unescape(href)
 					if href=~%r{^[a-z]+://}i
 						@external_links[page] << href
 					else
-						id   = href[/#[a-z][\w.:-]*/i]
-						file = href.sub(/#.+/,'')
+						id   = href[/#([a-z][\w.:-]*)?/i]
+						file = href.sub(/#.*/,'')
 						path = file.empty? ? page.html_path : Pathname.new( File.dirname(page.html_path) / file ).cleanpath.to_s
-						if target=page_by_html_path[path]
-							if !id || target.nokodoc.at_css(id)
+						if target=@page_by_html_path[path]
+							if !id || id == "#" || target.nokodoc.at_css(id)
 								@internal_links[page] << href
 							else
 								warn "Could not find internal link for #{id.inspect} on #{page.html_path.inspect}" if id 
 								@broken_links[page] << href
 							end
 						else
-							if File.file?(path) && !page_by_orig_path[path]
+							if File.file?(path) && !@page_by_file_path[path]
 								@file_links[page] << href
 							else
 								@broken_links[page] << href

data/lib/docubot/link_tree.rb

@@ -32,7 +32,7 @@ class DocuBot::LinkTree::Node
 			(File.dirname(link) / 'index.html')
 		end
 		#puts "Adding #{title.inspect} (#{link}) to hierarchy under #{parent_link}"
-		parent = descendants.find{ |node| node.link==parent_link } || self
+		parent = descendants.find{ |n| n.link==parent_link } || self
 		parent << node
 	end
 
@@ -41,6 +41,10 @@ class DocuBot::LinkTree::Node
 		@children << node
 	end
 	
+	def []( child_index )
+		@children[child_index]
+	end
+	
 	def children( parent_link=nil, &block )
 		if parent_link
 			root = find( parent_link )
@@ -60,19 +64,17 @@ class DocuBot::LinkTree::Node
 	end
 	
 	def depth
-		# Assuming no one is going to shuffle the nodes after placement
+		# Cached assuming no one is going to shuffle the nodes after placement
 		@depth ||= ancestors.length
 	end
 	
-	def root
-		@root ||= "../" * (depth + ( leaf? ? 0 : 1 ))
-	end
-	
 	def ancestors
-		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!
+		@ancestors << node while node = node.parent
+		@ancestors.reverse!
 	end
 	
 	def to_s

data/lib/docubot/page.rb

@@ -7,9 +7,18 @@ class DocuBot::Page
 
 	attr_reader :type, :folder, :file, :meta, :nokodoc, :bundle
 
+	def self.title( source_path )
+	  # File#basename might return the same string
+		title = File.basename( source_path ).dup
+		title.sub!(/\.[^.\s]+$/,'') unless File.directory?( source_path )
+		title.gsub!( '_', ' ' )
+		title.sub!( /^\d+\s/, '' )
+		title
+	end
+
 	def initialize( bundle, source_path, title=nil )
 		puts "#{self.class}.new( #{source_path.inspect}, #{title.inspect}, #{type.inspect} )" if $DEBUG
-		title ||= File.basename( source_path ).sub( /\.[^.]+$/, '' ).gsub( '_', ' ' ).sub( /^\d+\s/, '' )
+		title ||= self.class.title( source_path )
 		@bundle = bundle
 		@file  = source_path
 		if File.directory?( @file )

data/lib/docubot/shells/nvphysx/_templates/top.haml

@@ -25,4 +25,4 @@
 				#glossary-defn
 			#mainbody= contents
 			#pagefooter
-				Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company? }.
+				Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company }.

data/lib/docubot/templates/top.haml

@@ -22,11 +22,11 @@
 						%span.sep >
 					= page.title
 				%h1#title= page.title
-				- if page.author?
+				- if page.author
 					#author= page.author
 			#pagebody
 				#glossary-box
 				#mainbody= contents
 				#pagefooter
-					Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company? }.
+					Copyright ©#{Time.now.year}#{ " #{global.company}" if global.company }.
 					All Rights Reserved.

data/lib/docubot/writers/chm.rb

@@ -5,13 +5,41 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 	handles_type :chm
 	
 	SUPPORT = DocuBot::Writer::DIR / 'chm'
+
+  attr_reader :chm_path, :hhc, :hhp, :hhk, :default_topic
+	
+	def initialize( bundle )
+	  super
+		@toc = @bundle.toc
+		@global = @bundle.global
+		if @global.default
+			# User tried to specify the default page
+			@default_topic = @bundle.pages_by_title[ @global.default ].first
+			if @default_topic
+				if @default_topic.file =~ /\s/
+					warn "'#{@global.default}' cannot be the default CHM page; it has a space in the file name."
+					@default_topic = nil
+				end
+			else
+				warn "The requested default page '#{@global.default}' could not be found. (Did the title change?)"
+			end
+		end
+		if @default_topic.nil?
+  		@default_topic = @toc.descendants.find{ |node| node.link =~ /^\S+$/ }
+  		@default_topic &&= @default_topic.page
+  	end
+		warn "No default page is set, because no page has a path without spaces." unless @default_topic	  
+
+	end
 	
 	def write( destination=nil )
 		super( nil )
+
 		lap = Time.now
-		@chm_path = destination || "#{@bundle.source}.chm"
-		@toc = @bundle.toc
-		@global = @bundle.global
+		@chm_path = File.expand_path( destination || "#{@bundle.source}.chm" )
+		@hhc = @chm_path.sub( /[^.]+$/, 'hhc' )
+		@hhp = @chm_path.sub( /[^.]+$/, 'hhp' )
+		@hhk = @chm_path.sub( /[^.]+$/, 'hhk' )
 		write_hhc
 		write_hhk
 		write_hhp
@@ -55,37 +83,18 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 	end
 
 	def write_hhc
-		@hhc = @chm_path.sub( /[^.]+$/, 'hhc' )
 		File.open( @hhc, 'w' ) do |f|
 			f << ERB.new( IO.read( SUPPORT / 'hhc.erb' ) ).result( binding )
 		end
 	end
 
 	def write_hhp
-		@hhp = @chm_path.sub( /[^.]+$/, 'hhp' )
-
-		if @global.default
-			# User tried to specify the default page
-			@default_topic = @bundle.pages_by_title[ @global.default ].first
-			if @default_topic
-				if @default_topic.file =~ /\s/
-					warn "'#{@toc.default}' cannot be the default CHM page; it has a space in the file name."
-					@default_topic = nil
-				end
-			else
-				warn "The requested default page '#{@global.default}' could not be found. (Did the title change?)"
-			end
-		end
-		@default_topic ||= @toc.descendants.find{ |node| node.link =~ /^\S+$/ }
-		warn "No default page is set, because no page has a path without spaces." unless @default_topic
-
 		File.open( @hhp, 'w' ) do |f|
 			f << ERB.new( IO.read( SUPPORT / 'hhp.erb' ) ).result( binding )
 		end
 	end
 
 	def write_hhk
-		@hhk = @chm_path.sub( /[^.]+$/, 'hhk' )
 		File.open( @hhk, 'w' ) do |f|
 			f << ERB.new( IO.read( SUPPORT / 'hhk.erb' ) ).result( binding )
 		end

data/lib/docubot/writers/html.rb

@@ -53,7 +53,7 @@ class DocuBot::HTMLWriter < DocuBot::Writer
 					:page       => node.page,
 					:contents   => contents,
 					:global     => @bundle.global,
-					:root       => node.root,
+					:root       => node.page.root,
 					:breadcrumb => node.ancestors,
 					:custom_js  => custom_js,
 					:custom_css => custom_css

data/spec/_helper.rb

@@ -1,5 +1,6 @@
 $: << File.join( File.dirname(__FILE__), '..' )
 $: << File.join( File.dirname(__FILE__), '..', 'lib' )
+require 'rubygems'
 require 'minitest/spec'
 require 'docubot'
 SAMPLES = File.dirname(__FILE__)/'samples'

data/spec/bundle.rb

@@ -109,6 +109,7 @@ describe "Gathering links" do
 			../root.html inner1.html ../sub2.html ../sub2/inner2.html
 			../sub1/index.html index.html
 		]
+		known_internal << "one two three.html"
 		all_internal = @bundle.internal_links.values.flatten
 		known_internal.each do |link|
 			all_internal.must_include link
@@ -122,6 +123,15 @@ describe "Gathering links" do
 			all_file_links.must_include link
 		end		
 	end
+
+	it "should identify valid links to internal files at the root" do
+		@bundle = DocuBot::Bundle.new SAMPLES/'hierarchy'
+		known_file_links = %w[ main.css ../main.css ../../main.css ../../../main.css ]
+		all_file_links = @bundle.file_links.values.flatten
+		known_file_links.each do |link|
+			all_file_links.must_include link
+		end		
+	end
 	
 	it "should identify and warn about invalid sub-page anchors" do
 		known_broken = %w[ #GORKBO ../root.html#GORKBO ]
@@ -327,7 +337,4 @@ describe "Page attributes" do
 		end
 	end
 	
-	it "does something" do
-		
-	end
 end

data/spec/chm.rb

@@ -0,0 +1,44 @@
+#encoding: UTF-8
+require File.join(File.dirname(__FILE__), "_helper")
+
+describe "CHM Writer default topic" do
+	it "should pick the first valid page as the default if not specified" do
+		out, err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'titles' )
+			@writer = DocuBot::CHMWriter.new( @bundle )
+		end
+		@writer.default_topic.must_be_kind_of DocuBot::Page
+		# The page 'First One' can't be used as a default because it has a space in the file name
+		@writer.default_topic.must_equal @bundle.pages.find{ |page| page.title=='Second One' }
+	end
+	
+	it "should use a valid specified default page" do
+		out, err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'default_topic' )
+			@writer = DocuBot::CHMWriter.new( @bundle )
+		end
+		@writer.default_topic.must_be_kind_of DocuBot::Page
+		@writer.default_topic.must_equal @bundle.pages.find{ |page| page.title=='Awesomesauce' }
+	end
+	
+	it "should warn about an invalid default topic" do
+		out, err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'attributes' )
+			@writer = DocuBot::CHMWriter.new( @bundle )
+		end
+		err.must_include "All About Mr. Friggles"  
+		@writer.default_topic.must_be_kind_of DocuBot::Page
+		@writer.default_topic.must_equal @bundle.pages.find{ |page| page.title=='defaults' }
+	end
+	
+	it "should warn about a default topic with space in the file name" do
+		out, err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'default_topic_2' )
+			@writer = DocuBot::CHMWriter.new( @bundle )
+		end
+		err.must_include "Excellence"  
+		@writer.default_topic.must_be_kind_of DocuBot::Page
+		@writer.default_topic.must_equal @bundle.pages.find{ |page| page.title=='Awesomesauce' }
+	end
+	
+end

data/spec/page.rb

@@ -10,7 +10,7 @@ describe "Validating page titles" do
 		@toc.children.each{ |node| node.page.bundle.must_equal @bundle }
 	end
 	it "ignores leading numbers for the titles (unless all numbers)" do
-		@toc.children.each{ |node| node.page.title.must_match /(?:^\D|^\d+$)/ }
+		@toc.children.each{ |node| node.page.title.must_match /(?:^\D|^\d+$|^\d+(?:.\d+)+.*$)/ }
 	end
 	it "honors pages specifying their title" do
 		@toc.children.find{ |page| page.title =~ /renamed/i  }.must_be_nil
@@ -24,6 +24,10 @@ describe "Validating page titles" do
 	it "doesn't change names of files that are all numbers" do
 		@toc.children.find{ |node| node.page.title == '911' }.wont_be_nil
 	end
+	it "doesn't change names of files that lead with dotted numerics" do
+		@toc.children.find{ |node| node.page.title == '6.1 More' }.wont_be_nil
+		@toc.children.find{ |node| node.page.title == '6.2 Even More' }.wont_be_nil
+	end
 end
 
 describe "Traversing page hierarchy" do
@@ -34,7 +38,7 @@ describe "Traversing page hierarchy" do
 	end
 	it "should have #pages returning an array" do
 		@bundle.pages.must_be_kind_of Array
-		@bundle.pages.length.must_equal 6
+		@bundle.pages.length.must_equal 7
 	end
 	it "every item should be a Page" do
 		@bundle.pages.each do |page|
@@ -43,6 +47,32 @@ describe "Traversing page hierarchy" do
 	end
 end
 
+describe "Page Roots" do
+	before do
+		@out, @err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'hierarchy' )
+		end
+	end
+	
+	it "should not find any missing links creating the bundle" do
+		# The bundle uses root in the page templates extensively
+		@err.must_be_empty
+	end
+	
+	it "should have an empty root for pages at the root" do
+		@bundle.page_by_html_path['main.html'].root.must_equal ""
+	end
+	
+	it "should have a root appropriate to the HTML depth" do
+		@bundle.page_by_html_path['1/page.html'].root.must_equal "../"
+		@bundle.page_by_html_path['1/index.html'].root.must_equal "../"
+		@bundle.page_by_html_path['1/1.1/page.html'].root.must_equal "../../"
+		@bundle.page_by_html_path['1/1.1/index.html'].root.must_equal "../../"
+		@bundle.page_by_html_path['1/1.1/1.1.1/page.html'].root.must_equal "../../../"
+		@bundle.page_by_html_path['1/1.1/1.1.1/index.html'].root.must_equal "../../../"
+	end
+end
+
 describe "Testing user variables" do
 	it "should identify if a variable has been defined"
 	it "should inherit variables from the global"

data/spec/samples/default_topic/Alpha.md

@@ -0,0 +1,3 @@
+title: Excellence
++++
+This is the first page.

data/spec/samples/default_topic/Zeta.md

@@ -0,0 +1,3 @@
+title: Awesomesauce
++++
+This is the second page.

data/spec/samples/default_topic/index.txt

@@ -0,0 +1,2 @@
+default: Awesomesauce
++++

data/spec/samples/default_topic_2/Alpha Space.md

@@ -0,0 +1,3 @@
+title: Excellence
++++
+This is the first page.

data/spec/samples/default_topic_2/Zeta.md

@@ -0,0 +1,3 @@
+title: Awesomesauce
++++
+This is the second page.

data/spec/samples/default_topic_2/index.txt

@@ -0,0 +1,2 @@
+default: Excellence
++++

data/spec/samples/hierarchy/1/1.1/1.1.1/index.haml

@@ -0,0 +1 @@
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/1/1.1/1.1.1/page.haml

@@ -0,0 +1,3 @@
+title:1.1.1p
++++
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/1/1.1/page.haml

@@ -0,0 +1,3 @@
+title:1.1p
++++
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/1/page.haml

@@ -0,0 +1,3 @@
+title:1p
++++
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/2/2.1/2.1.1/page.haml

@@ -0,0 +1,3 @@
+title: 2.1.1p
++++
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/2/2.1/index.haml

@@ -0,0 +1 @@
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/2/2.1/page.haml

@@ -0,0 +1,3 @@
+title: 2.1p
++++
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/2/page.haml

@@ -0,0 +1,3 @@
+title:2p
++++
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/main.css

@@ -0,0 +1 @@
+body { background:red }

data/spec/samples/hierarchy/main.haml

@@ -0,0 +1 @@
+%a(href="#{root}main.css") Linked

data/spec/samples/hierarchy/toc.md

@@ -0,0 +1,2 @@
+template: toc
++++

data/spec/samples/links/one two three.textile

@@ -0,0 +1 @@
+one two three

data/spec/samples/links/sub2.md

@@ -1,3 +1,4 @@
 [External](HTTP://NONEXISTENT.SITE)
 [File](sub2/bozo.bin)           
 [BROKEN](sub2/GORKBO.bin)           
+[SPACES](one%20two%20three.html)

data/spec/samples/templates/_templates/doubler.haml

@@ -1,5 +1,5 @@
 #doubler
-	- if page.multiplier?
+	- if page.multiplier
 		- page.multiplier.to_i.times do
 			= contents
 	- else

data/spec/toc.rb

@@ -104,4 +104,26 @@ describe "Sub-page Links in the Table of Contents" do
 		kid.link.must_equal   'explicit2.html#h0'
 		kid.page.must_equal e2.page
 	end
+end
+
+describe "ToC with Deep Hierarchy" do
+	before do
+		@bundle = DocuBot::Bundle.new SAMPLES/'hierarchy'
+	end
+	
+	it "should match the expected hierarchy" do
+		@bundle.toc[0].page.title.must_equal '1'
+		@bundle.toc[0][0].page.title.must_equal '1.1'
+		@bundle.toc[0][0][0].page.title.must_equal '1.1.1'
+		@bundle.toc[0][0][0][0].page.title.must_equal '1.1.1p'
+		@bundle.toc[0][0][1].page.title.must_equal '1.1p'
+		@bundle.toc[0][1].page.title.must_equal '1p'
+		@bundle.toc[1].page.title.must_equal '2'
+		@bundle.toc[1][0].page.title.must_equal '2.1'
+		@bundle.toc[1][0][0].page.title.must_equal '2.1.1'
+		@bundle.toc[1][0][0][0].page.title.must_equal '2.1.1p'
+		@bundle.toc[1][0][1].page.title.must_equal '2.1p'
+		@bundle.toc[1][1].page.title.must_equal '2p'
+		@bundle.toc[2].page.title.must_equal 'main'
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: docubot
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: "0.5"
 platform: ruby
 authors: 
 - Gavin Kistner
@@ -150,6 +150,7 @@ files:
 - lib/docubot/writers/html.rb
 - lib/docubot.rb
 - spec/bundle.rb
+- spec/chm.rb
 - spec/command.rb
 - spec/converters.rb
 - spec/global.rb
@@ -168,6 +169,12 @@ files:
 - spec/samples/collisions/page2.txt
 - spec/samples/collisions/page3.bin
 - spec/samples/collisions/page3.md
+- spec/samples/default_topic/Alpha.md
+- spec/samples/default_topic/index.txt
+- spec/samples/default_topic/Zeta.md
+- spec/samples/default_topic_2/Alpha Space.md
+- spec/samples/default_topic_2/index.txt
+- spec/samples/default_topic_2/Zeta.md
 - spec/samples/files/another.md
 - spec/samples/files/BUILDING.txt
 - spec/samples/files/common.css
@@ -187,7 +194,19 @@ files:
 - spec/samples/glossary/_glossary/complex.haml
 - spec/samples/glossary/_glossary/project_x.md
 - spec/samples/glossary/_glossary/Simple Term.md
+- spec/samples/hierarchy/1/1.1/1.1.1/index.haml
+- spec/samples/hierarchy/1/1.1/1.1.1/page.haml
+- spec/samples/hierarchy/1/1.1/page.haml
+- spec/samples/hierarchy/1/page.haml
+- spec/samples/hierarchy/2/2.1/2.1.1/page.haml
+- spec/samples/hierarchy/2/2.1/index.haml
+- spec/samples/hierarchy/2/2.1/page.haml
+- spec/samples/hierarchy/2/page.haml
+- spec/samples/hierarchy/main.css
+- spec/samples/hierarchy/main.haml
+- spec/samples/hierarchy/toc.md
 - spec/samples/links/index.txt
+- spec/samples/links/one two three.textile
 - spec/samples/links/root.md
 - spec/samples/links/sub1/inner1.md
 - spec/samples/links/sub2/bozo.bin
@@ -211,6 +230,7 @@ files:
 - spec/samples/titles/3_renamed.txt
 - spec/samples/titles/4 Fourth_One.txt
 - spec/samples/titles/5_Fifth One.txt
+- spec/samples/titles/6.1 More.md
 - spec/samples/titles/911.txt
 - spec/samples/titles/index.txt
 - spec/templates.rb