RubyGems - docubot - Versions diffs - 0.3.3 → 0.4 - Mend

docubot 0.3.3 → 0.4

Files changed (80) hide show

data/bin/docubot +5 -1
data/lib/docubot.rb +4 -2
data/lib/docubot/bundle.rb +109 -61
data/lib/docubot/converter.rb +4 -1
data/lib/docubot/converters/haml.rb +1 -1
data/lib/docubot/glossary.rb +3 -0
data/lib/docubot/link_tree.rb +109 -0
data/lib/docubot/metasection.rb +61 -0
data/lib/docubot/page.rb +40 -118
data/lib/docubot/shells/docubot-help/3_Advanced_Topics/Controlling the Table of Contents.md +2 -4
data/lib/docubot/shells/nvphysx/_templates/_root/common.css +10 -5
data/lib/docubot/shells/nvphysx/_templates/_root/glossary.css +1 -0
data/lib/docubot/shells/nvphysx/_templates/_root/glossary.js +11 -1
data/lib/docubot/shells/nvphysx/_templates/section.haml +9 -0
data/lib/docubot/templates/index.haml +13 -20
data/lib/docubot/templates/section.haml +1 -4
data/lib/docubot/templates/toc.haml +2 -11
data/lib/docubot/templates/top.haml +7 -4
data/lib/docubot/writers/chm.rb +6 -5
data/lib/docubot/writers/chm/hhc.erb +35 -12
data/lib/docubot/writers/chm/hhk.erb +1 -1
data/lib/docubot/writers/chm/hhp.erb +2 -2
data/lib/docubot/writers/html.rb +33 -23
data/spec/_all.rb +1 -0
data/spec/_helper.rb +10 -0
data/spec/bundle.rb +193 -2
data/spec/global.rb +28 -0
data/spec/glossary.rb +13 -11
data/spec/page.rb +35 -9
data/spec/samples/attributes/defaults.haml +34 -0
data/spec/samples/attributes/explicit1.haml +43 -0
data/spec/samples/attributes/explicit2.haml +42 -0
data/spec/samples/attributes/hidden.haml +40 -0
data/spec/samples/attributes/index.md +8 -0
data/spec/samples/collisions/page1.md +3 -0
data/spec/samples/collisions/page1.textile +3 -0
data/spec/samples/collisions/page2.haml +4 -0
data/spec/samples/collisions/page2.html +3 -0
data/spec/samples/collisions/page2.txt +3 -0
data/spec/samples/collisions/page3.bin +1 -0
data/spec/samples/collisions/page3.md +3 -0
data/spec/samples/{link_test/sub2/bozo.bin → files/BUILDING.txt} +0 -0
data/spec/samples/{titletest/1 First One.txt → files/_static/Thumbs.db} +0 -0
data/spec/samples/{titletest/2_Second_One.txt → files/_static/foo.ai} +0 -0
data/spec/samples/{titletest/4 Fourth_One.txt → files/_static/foo.png} +0 -0
data/spec/samples/{titletest/5_Fifth One.txt → files/_static/foo.psd} +0 -0
data/spec/samples/files/another.md +0 -0
data/spec/samples/files/common.css +0 -0
data/spec/samples/files/first.textile +0 -0
data/spec/samples/files/index.md +2 -0
data/spec/samples/files/section/foo.jpg +0 -0
data/spec/samples/files/section/page.haml +0 -0
data/spec/samples/files/section/sub section/Thumbs.db b/data/spec/samples/files/section/sub → section/Thumbs.db +0 -0
data/spec/samples/files/section/sub section/foo.gif b/data/spec/samples/files/section/sub → section/foo.gif +0 -0
data/spec/samples/files/section/sub section/page.txt b/data/spec/samples/files/section/sub → section/page.txt +0 -0
data/spec/samples/{link_test → links}/index.txt +0 -0
data/spec/samples/{link_test → links}/root.md +0 -0
data/spec/samples/{link_test → links}/sub1/inner1.md +0 -0
data/spec/samples/{link_test → links}/sub2.md +0 -0
data/spec/samples/links/sub2/bozo.bin +0 -0
data/spec/samples/{link_test → links}/sub2/inner2.md +0 -0
data/spec/samples/templates/_templates/404.haml +1 -0
data/spec/samples/templates/_templates/doubler.haml +7 -0
data/spec/samples/templates/_templates/page.haml +2 -0
data/spec/samples/templates/goaway.txt +3 -0
data/spec/samples/templates/onepara_html.html +3 -0
data/spec/samples/templates/onepara_md.md +5 -0
data/spec/samples/templates/twopara_haml.haml +7 -0
data/spec/samples/templates/twopara_textile.textile +6 -0
data/spec/samples/titles/1 First One.txt b/data/spec/samples/titles/1 First → One.txt +0 -0
data/spec/samples/titles/2_Second_One.txt +0 -0
data/spec/samples/{titletest → titles}/3_renamed.txt +0 -0
data/spec/samples/titles/4 Fourth_One.txt b/data/spec/samples/titles/4 → Fourth_One.txt +0 -0
data/spec/samples/titles/5_Fifth One.txt b/data/spec/samples/titles/5_Fifth → One.txt +0 -0
data/spec/samples/titles/911.txt +0 -0
data/spec/samples/titles/index.txt +2 -0
data/spec/templates.rb +42 -0
data/spec/toc.rb +64 -30
metadata +53 -14
data/spec/samples/titletest/index.txt +0 -2

data/lib/docubot/writers/chm/hhc.erb CHANGED

@@ -3,22 +3,45 @@
 <HEAD>
 <meta name="GENERATOR" content="Microsoft&reg; HTML Help Workshop 4.1">
 <!-- Sitemap 1.0 -->
-<%@write_section = lambda do |page| %>
+<%
+ICON = {
+	:book       => 1,
+	:folder     => 5,
+	:question   => 9,
+	:page       => 11,
+	:internet   => 13,
+	:info       => 17,
+	:shortcut   => 19,
+	:letter     => 23,
+	:attachment => 25,
+	:contact    => 27,
+	:sound      => 29,
+	:cd         => 31,
+	:movie      => 33,
+	:list       => 35,
+	:idea       => 37,
+	:note       => 39,
+	:tool       => 41
+}
+@write_section = lambda do |node|
+	%>
 <UL>
-	<%page.pages.each do |child|%>
-		<%next if child.hide%>
+	<%node.children.each do |child|
+		icon = if child.anchor
+			ICON[:info]
+		elsif child.page.icon
+			ICON[ child.page.icon.downcase.to_sym ] || child.page.icon
+		else
+			child.leaf? ? ICON[:page] : ICON[:book]
+		end
+		%>
 		<LI> <OBJECT type="text/sitemap">
 			<param name="Name" value="<%=CGI.escapeHTML child.title%>">
-			<param name="Local" value="<%=FileUtils.win_path( @html_path / child.html_path ).gsub('&','%26')%>">
-			<%if child.icon?
-				%><param name="ImageNumber" value="<%=child.icon%>"><%
-			elsif child.sublink?
-				%><param name="ImageNumber" value="17"><%
-			elsif child.leaf?
-				%><param name="ImageNumber" value="11"><%
-			end%>
+			<param name="Local" value="<%=FileUtils.win_path( @html_path / child.link ).gsub('&','%26')%>">
+			<param name="ImageNumber" value="<%=icon%>">
 			</OBJECT>
-		<%@write_section[child] unless child.pages.empty?%>
+		<%@write_section[child] unless child.children.empty?%>
 	<%end%>
 </UL>
 <%end%>

data/lib/docubot/writers/chm/hhk.erb CHANGED

@@ -8,7 +8,7 @@
    <param name="FrameName" value="right">
 </OBJECT>
 <UL>
-<%@toc.index.each do |entry,pages|%>
+<%@global.index.each do |entry,pages|%>
    <LI> <OBJECT type="text/sitemap">
 	   <param name="Name" value="<%=entry%>">
 	   <param name="Local" value="<%=FileUtils.win_path( @html_path/pages.first.html_path )%>">

data/lib/docubot/writers/chm/hhp.erb CHANGED

@@ -7,11 +7,11 @@ Index file="<%=FileUtils.win_path @hhk%>"
 <%end%>Display compile progress=No
 Full-text search=Yes
 Language=0x409 English (United States)
-Title=<%=@toc.title%>
+Title=<%=@global.title%>
 [FILES]
-<%@toc.descendants.each do |page|
+<%@bundle.pages.each do |page|
 	%><%=FileUtils.win_path( @html_path/page.html_path) %>
 <%end
 @bundle.extras.each do |file|

data/lib/docubot/writers/html.rb CHANGED

@@ -12,6 +12,8 @@ class DocuBot::HTMLWriter < DocuBot::Writer
 		master_templates = DocuBot::TEMPLATE_DIR
 		source_templates = source/'_templates'
+		master_root = master_templates/'_root'
+		source_root = source_templates/'_root'
 		# Copy any files found in the source directory that weren't made into pages
 		@bundle.extras.each do |file|
@@ -33,26 +35,34 @@ class DocuBot::HTMLWriter < DocuBot::Writer
 			o = Object.new
 			# Write out every page
-			template = File.exists?( source_templates/'top.haml' ) ? source_templates/'top.haml' : master_templates/'top.haml'
-			template = Haml::Engine.new( IO.read( template ), HAML_OPTIONS )
-			@bundle.toc.descendants.each do |page|
-				next if page.sublink?
-				contents = page.to_html
-				root = "../" * page.depth
-				html = template.render( o, :page=>page, :contents=>contents, :global=>@bundle.toc, :root=>root )
-				FileUtils.mkdir_p( File.dirname( page.html_path ) )
-				File.open( page.html_path, 'w' ){ |f| f << html }
-			end
+			top = File.exists?( source_templates/'top.haml' ) ? source_templates/'top.haml' : master_templates/'top.haml'
+			top = Haml::Engine.new( IO.read( top ), HAML_OPTIONS )
+			@bundle.toc.descendants.each do |node|
+				next if node.anchor
+				contents = node.page.to_html
+				template = node.page.template # Call page.to_html first to ensure page.template is set
-			# Write out the TOC and Index (even though the CHM won't use them, others may)
-			{ 'toc.haml'=>'_toc.html', 'index.haml'=>'_index.html' }.each do |haml,output|
-				File.open( output, 'w' ) do |f|
-					template = File.exists?( source_templates/haml ) ? source_templates/haml : master_templates/haml
-					template = Haml::Engine.new( IO.read( template ), HAML_OPTIONS )
-					f << template.render( o, :toc=>@bundle.toc, :global=>@bundle.toc, :root=>'' )
-				end
+				custom_js = "#{template}.js"
+				custom_js = nil unless File.exists?( source_root/custom_js ) || File.exists?( master_root/custom_js )
+				custom_css = "#{template}.css"
+				custom_css = nil unless File.exists?( source_root/custom_css ) || File.exists?( master_root/custom_css )
+				variables = {
+					:page       => node.page,
+					:contents   => contents,
+					:global     => @bundle.global,
+					:root       => node.root,
+					:breadcrumb => node.ancestors,
+					:custom_js  => custom_js,
+					:custom_css => custom_css
+				}
+				html = top.render( o, variables )
+				FileUtils.mkdir_p( File.dirname( node.file ) )
+				File.open( node.file, 'w' ){ |f| f << html }
 			end
 			File.open( 'glossary-terms.js', 'w' ){ |f| f << @bundle.glossary.to_js }
 		end
@@ -61,13 +71,13 @@ class DocuBot::HTMLWriter < DocuBot::Writer
 end
 module Haml::Helpers
-	def li_pages_for( page )
-		page.pages.each do |child|
-			haml_tag :li do
-				haml_tag :a, :href=>child.html_path do
+	def li_pages_for( node )
+		node.children.each do |child|
+			haml_tag :li, :class=>(child.anchor ? 'sublink' : child.children.empty? ? 'section' : 'page' ) do
+				haml_tag :a, :href=>child.link do
 					haml_concat child.title
 				end
-				unless child.pages.empty?
+				unless child.children.empty?
 					haml_tag :ul do
 						li_pages_for child
 					end

data/spec/_all.rb CHANGED

@@ -1,5 +1,6 @@
 #encoding: UTF-8
 $: << '..'
+require 'spec/global'
 require 'spec/bundle'
 require 'spec/toc'
 require 'spec/converters'

data/spec/_helper.rb CHANGED

@@ -4,3 +4,13 @@ require 'minitest/spec'
 require 'docubot'
 SAMPLES = File.dirname(__FILE__)/'samples'
 MiniTest::Unit.autorun
+class MiniTest::Spec
+	class << self
+		alias_method :__it__, :it
+	end
+	def self.it desc, &block
+		block ||= proc{ skip "(no tests defined)" }
+		__it__( desc, &block )
+	end
+end

data/spec/bundle.rb CHANGED

@@ -18,7 +18,7 @@ describe "Bundle from empty directory" do
 	it "should have an empty TOC" do
 		@bundle.toc.wont_be_nil
-		@bundle.toc.pages.must_be_empty
+		@bundle.toc.descendants.must_be_empty
 	end
 	it "should have an empty index" do
@@ -61,7 +61,7 @@ end
 describe "Gathering links" do
 	before do
 		@out, @err = capture_io do
-			@bundle = DocuBot::Bundle.new SAMPLES/'link_test'
+			@bundle = DocuBot::Bundle.new SAMPLES/'links'
 		end
 	end
@@ -140,3 +140,194 @@ describe "Gathering links" do
 		end
 	end
 end
+describe "Identifying Conflicts" do
+	it "should raise when multiple pages will write to the same html" do
+		proc{
+			@bundle = DocuBot::Bundle.new( SAMPLES/'collisions' )
+		}.must_raise(DocuBot::Bundle::PageCollision)
+	end
+	it "should include the title and filename of every conflicting page" do
+		begin
+			@bundle = DocuBot::Bundle.new( SAMPLES/'collisions' )
+		rescue DocuBot::Bundle::PageCollision => e
+			e.message.must_include "page1.md"
+			e.message.must_include "page1.textile"
+			e.message.must_include "Page 1 (from Markdown)"
+			e.message.must_include "Page 1 (from Textile)"
+			e.message.must_include "page2.html"
+			e.message.must_include "page2.txt"
+			e.message.must_include "page2.haml"
+			e.message.must_include "Page 2 (from html)"
+			e.message.must_include "Page 2 (from text)"
+			e.message.must_include "Page 2 (from haml)"
+			e.message.wont_include "page3.md"
+			e.message.wont_include "page3.bin"
+			e.message.wont_include "Page 3"
+		end
+	end
+end
+describe "Bundle with Extra Files" do
+	before do
+		@out, @err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'files' )
+		end
+	end
+	it "should keep track of extra files seen" do
+		@bundle.extras.wont_be_nil
+		static_files = %w[ common.css _static/foo.png section/foo.jpg ]
+		static_files << "section/sub section/foo.gif"
+		static_files.each do |path|
+			@bundle.extras.must_include path
+		end
+	end
+	it "should not count page sources as extra files" do
+		page_files = %w[ index.md another.md first.textile section/page.haml ]
+		page_files << "section/sub section/page.txt"
+		page_files.each do |path|
+			@bundle.extras.wont_include path
+		end
+	end
+	it "should skip files specified by global glob matches" do
+		@bundle.global.ignore.as_list.must_equal %w[ **/*.psd **/*.ai **/Thumbs.db BUILDING.txt ]
+		bad_files = %w[ _static/foo.ai _static/foo.psd _static/Thumbs.db ]
+		bad_files << "section/sub section/Thumbs.db"
+		bad_files.each do |path|
+			@bundle.extras.wont_include path
+		end
+	end
+	it "should not count ignored files as the source for pages" do
+		@bundle.pages.find{ |page| page.file == 'BUILDING.txt' }.must_be_nil
+		@bundle.page_by_file_path['BUILDING.txt'].must_be_nil
+	end
+end
+describe "Pages in bundles" do
+	before do
+		@titles = [ 'First One', 'Second One', 'Third One', 'Fourth One', 'Fifth One', '911' ]
+		Dir.chdir SAMPLES/'links' do
+			@files = Dir['**/*'] - %w[ index.txt sub2/bozo.bin ]
+			@htmls = @files.map{ |path|
+				path[/\.[^.]+$/] ? path.gsub(/\.[^.]+$/,'.html') : path/'index.html'
+			}
+		end
+		@out, @err = capture_io do
+			@titles_bundle = DocuBot::Bundle.new SAMPLES/'titles'
+			@links_bundle  = DocuBot::Bundle.new SAMPLES/'links'
+		end
+	end
+	it "should allow you to find arrays of pages by title" do
+		@titles_bundle.pages_by_title.wont_be_nil
+		@titles.each do |page_title|
+			pages = @titles_bundle.pages_by_title[page_title]
+			pages.must_be_kind_of Array
+			pages.length.must_equal 1
+			pages.first.must_be_kind_of DocuBot::Page
+		end
+	end
+	it "should return an empty array for a non-existent page" do
+		pages = @titles_bundle.pages_by_title['NONE SUCH']
+		pages.must_be_kind_of Array
+		pages.length.must_equal 0
+	end
+	it "should not include the main index file in the titles" do
+		pages = @titles_bundle.pages_by_title["Title Changin'"]
+		pages.must_be_kind_of Array
+		pages.length.must_equal 0
+	end
+	it "should give access to pages by source file path" do
+		@links_bundle.page_by_file_path.wont_be_nil
+		@files.each do |path|
+			@links_bundle.page_by_file_path[path].must_be_kind_of DocuBot::Page
+		end
+	end
+	it "should return nil for an unfound file path" do
+		@links_bundle.page_by_file_path['NONE SUCH'].must_be_nil
+	end
+	it "should not include raw files in the file paths" do
+		@links_bundle.page_by_file_path['sub2/bozo.bin'].must_be_nil
+	end
+	it "should give access to pages by html file path" do
+		@links_bundle.page_by_html_path.wont_be_nil
+		@htmls.each do |path|
+			p path unless @links_bundle.page_by_html_path[path]
+			@links_bundle.page_by_html_path[path].wont_be_nil
+			@links_bundle.page_by_html_path[path].must_be_kind_of DocuBot::Page
+		end
+	end
+	it "should return nil for an unfound html path" do
+		@links_bundle.page_by_html_path['NONE SUCH'].must_be_nil
+	end
+	it "should not include raw files in the html paths" do
+		@links_bundle.page_by_html_path['sub2/bozo.bin'].must_be_nil
+	end
+end
+describe "Global bundle attributes" do
+	before do
+		@out, @err = capture_io do
+			@bundle = DocuBot::Bundle.new SAMPLES/'attributes'
+		end
+	end
+	it "should have a global object" do
+		@bundle.global.wont_be_nil
+	end
+	it "should be indexable by method and return strings" do
+		@bundle.global.author.must_equal  "Gavin Kistner"
+		@bundle.global.default.must_equal "All About Mr. Friggles"
+		@bundle.global.quotes.must_equal  %q{"It's all about Mr. Benjamin", "I have never seen this cat before in my life!"}
+		@bundle.global.awesome.must_equal "true"
+	end
+	it "should be indexable by string" do
+		@bundle.global['author.email'].must_equal "!@phrogz.net"
+		@bundle.global['author website'].must_equal "http://phrogz.net"
+	end
+	it "should use utf8 for the strings" do
+		if Object.const_defined? :Encoding
+			Encoding.compatible?( @bundle.global.title, "UTF-8™")
+		end
+		@bundle.global.title.must_equal "Friggles® The Cat, ©2009"
+	end
+	it "should allow casting values to boolean" do
+		@bundle.global.awesome.as_boolean.must_equal true
+	end
+	it "should allow casting values to arrays of strings" do
+		quotes = @bundle.global.quotes.as_list
+		quotes.must_be_kind_of Array
+		quotes.must_equal [ "It's all about Mr. Benjamin", "I have never seen this cat before in my life!" ]
+	end
+end
+describe "Page attributes" do
+	before do
+		@out, @err = capture_io do
+			@bundle = DocuBot::Bundle.new SAMPLES/'attributes'
+		end
+	end
+	it "does something" do
+	end
+end

data/spec/global.rb ADDED

@@ -0,0 +1,28 @@
+#encoding: UTF-8
+require File.join(File.dirname(__FILE__), "_helper")
+# http://www.w3.org/TR/html4/types.html#type-id
+# We disallow colons or periods in the ID because they mess up CSS selectors
+# We require an octothorpe at the front because it makes life easier
+VALID_ID = /#[a-z][\w-]*/i
+describe "Generating IDs from Text" do
+	it "must create a valid identifier from a variety of input" do
+		DocuBot.id_from_text("foo").must_match VALID_ID
+		DocuBot.id_from_text("foo-bar").must_match VALID_ID
+		DocuBot.id_from_text("Foo-Bar").must_match VALID_ID
+		DocuBot.id_from_text("foo bar").must_match VALID_ID
+		DocuBot.id_from_text(" foo").must_match VALID_ID
+		DocuBot.id_from_text("foo ").must_match VALID_ID
+		DocuBot.id_from_text(" foo ").must_match VALID_ID
+		DocuBot.id_from_text("foo:bar").must_match VALID_ID
+		DocuBot.id_from_text("foo.bar").must_match VALID_ID
+		DocuBot.id_from_text("foo!bar").must_match VALID_ID
+		DocuBot.id_from_text("foo?!bar").must_match VALID_ID
+		DocuBot.id_from_text("foo(bar)").must_match VALID_ID
+		DocuBot.id_from_text("(foo)bar").must_match VALID_ID
+		DocuBot.id_from_text("!foo bar").must_match VALID_ID
+		DocuBot.id_from_text("foo: bar").must_match VALID_ID
+		DocuBot.id_from_text("!!!").wont_match VALID_ID
+	end
+end

data/spec/glossary.rb CHANGED

@@ -13,8 +13,8 @@ describe "Glossary Scanner" do
 		@out, @err = capture_io do
 			@bundle   = DocuBot::Bundle.new SAMPLES/'glossary'
 			@glossary = @bundle.glossary
-			@page     = @bundle.toc.every_page.find{ |page| page.title=='Glossary' }
-			@fulldoc  = Nokogiri::HTML( @page.to_html )
+			@page     = @bundle.pages_by_title['Glossary'].first
+			@fulldoc  = Nokogiri::HTML::DocumentFragment.parse( @page.to_html )
 		end
 	end
@@ -34,9 +34,9 @@ describe "Glossary Scanner" do
 		@glossary.entries.values.each do |defn|
 			defn.must_be_kind_of DocuBot::Page
 		end
-		@glossary.entries["Secret Term"].hide.must_equal true
+		@glossary.entries["Secret Term"].hide.as_boolean.must_equal true
 	end
 	it "supports iterating over the entries with each" do
 		count = 0
 		@glossary.each do |page,defn|
@@ -47,26 +47,28 @@ describe "Glossary Scanner" do
 		count.must_equal @all_terms.length
 	end
 	it "uses converters for page content" do
 		@expected_paragraphs.each do |term,paras|
-			@glossary.entries[term].nokodoc.xpath('//p').length.must_equal paras
+			@glossary.entries[term].nokodoc.xpath('.//p').length.must_equal paras
 		end
 	end
 	it "supports a glossary template that generates HTML for terms" do
-		definitions = @fulldoc.xpath('//dt')
+		definitions = @fulldoc.xpath('.//dt')
 		@expected_paragraphs.each do |term,paras|
 			dt = definitions.find{ |node| node.inner_text==term }
 			dt.wont_be_nil
-			dt.next_element.xpath('.//p').length.must_equal paras
+			if dt.next_element.xpath('.//p').length != paras
+				puts dt.next_element.to_html
+			end
+			dt.next_element.xpath('.//p').length.must_equal paras
 		end
 	end
 	it "does not include hidden pages in the output" do
-		definitions = @fulldoc.xpath('//dt')
+		definitions = @fulldoc.xpath('.//dt')
 		@hidden_terms.each do |term|
-			@fulldoc.at_xpath("//dt[text()='#{term}']").must_be_nil
+			@fulldoc.at_xpath(".//dt[text()='#{term}']").must_be_nil
 		end
 	end
 end