docubot 0.3.3 → 0.4

data/spec/page.rb

@@ -1,24 +1,50 @@
 #encoding: UTF-8
 require File.join(File.dirname(__FILE__), "_helper")
 
-describe "Pages from 'titletest'" do
+describe "Validating page titles" do
 	before do
-		@bundle = DocuBot::Bundle.new( SAMPLES/'titletest' )
+		@bundle = DocuBot::Bundle.new( SAMPLES/'titles' )
 		@toc    = @bundle.toc
 	end
 	it "knows who its bundle is" do
-		@toc.pages.each{ |page| page.bundle.must_equal @bundle }
+		@toc.children.each{ |node| node.page.bundle.must_equal @bundle }
 	end
-	it "ignores leading numbers for the titles" do
-		@toc.pages.each{ |page| page.title.must_match /^\D/ }
+	it "ignores leading numbers for the titles (unless all numbers)" do
+		@toc.children.each{ |node| node.page.title.must_match /(?:^\D|^\d+$)/ }
 	end
 	it "honors pages specifying their title" do
-		@toc.pages.find{ |page| page.title =~ /renamed/i  }.must_be_nil
-		@toc.pages.find{ |page| page.title == 'Third One' }.wont_be_nil
+		@toc.children.find{ |page| page.title =~ /renamed/i  }.must_be_nil
+		@toc.children.find{ |page| page.title == 'Third One' }.wont_be_nil
 	end
 	it "replaces underscores with spaces in the title" do
 		%w[ First Second Third Fourth Fifth ].each_with_index do |name,i|
-			@toc.pages[i].title.must_equal "#{name} One"
+			@toc.children[i].page.title.must_equal "#{name} One"
 		end
 	end
-end
+	it "doesn't change names of files that are all numbers" do
+		@toc.children.find{ |node| node.page.title == '911' }.wont_be_nil
+	end
+end
+
+describe "Traversing page hierarchy" do
+	before do
+		@out, @err = capture_io do
+			@bundle = DocuBot::Bundle.new( SAMPLES/'links' )
+		end
+	end
+	it "should have #pages returning an array" do
+		@bundle.pages.must_be_kind_of Array
+		@bundle.pages.length.must_equal 6
+	end
+	it "every item should be a Page" do
+		@bundle.pages.each do |page|
+			page.must_be_kind_of DocuBot::Page
+		end
+	end
+end
+
+describe "Testing user variables" do
+	it "should identify if a variable has been defined"
+	it "should inherit variables from the global"
+	it "should override variables from the global"
+end

data/spec/samples/attributes/defaults.haml

@@ -0,0 +1,34 @@
+This page specifies no attributes; what defaults will it get?
+
+%h2#h1 Heading 1
+%p#p1-1 Paragraph Number 1.1
+%p#p1-2 Paragraph Number 1.2
+%ul
+	%li A list of items
+	%li A list of items
+	%li A list of items
+
+%h3#h1-1 Heading 1.1
+%p#p1-1-1 Paragraph Number 1.1.1
+
+%h2#h2 Heading 2
+%h3#h2-1 Heading 2.1
+%h4#h2-1-1 Heading 2.1.1
+%h5#h2-1-1-1 Heading 2.1.1.1
+%p#p2-1-1-1-1 Paragraph Number 2.1.1.1.1
+
+%h3#h2-2 Heading 2.2
+%p#p2-2-1 Paragraph Number 2.2.1
+%dl
+	%dt#dt1 Giggity
+	%dd#dd1 Quagmire
+	%dt#dt2 Zanzibar
+	%dd#dd2 The Best
+
+%p#p2-2-2 Paragraph Number 2.2.2
+
+%h1#h0 Heading 0
+%p#p0-1
+	Paragraph 0.1
+	Whoa, this heading is larger than any other before it!
+

data/spec/samples/attributes/explicit1.haml

@@ -0,0 +1,43 @@
+title: Jiggly Awesome
+keywords: explicit, metasection, attributes/specifying
+no-index: headings, definitions
+auto-section:false
+toc: #h1, #h1-1, #div
+auto-id : true
++++
+%h2#h1 Heading 1
+%p#p1-1 Paragraph Number 1.1
+%p#p1-2 Paragraph Number 1.2
+%ul
+	%li A list of items
+	%li A list of items
+	%li A list of items
+
+%h3#h1-1 Heading 1.1
+%p#p1-1-1 Paragraph Number 1.1.1
+
+%h2#h2 Heading 2
+%h3#h2-1 Heading 2.1
+%h4#h2-1-1 Heading 2.1.1
+%h5#h2-1-1-1 Heading 2.1.1.1
+%p#p2-1-1-1-1 Paragraph Number 2.1.1.1.1
+
+%h3#h2-2 Heading 2.2
+%p#p2-2-1 Paragraph Number 2.2.1
+%dl
+	%dt#dt1 Giggity
+	%dd#dd1 Quagmire
+	%dt#dt2 Zanzibar
+	%dd#dd2 The Best
+
+%p#p2-2-2 Paragraph Number 2.2.2
+
+%h1#h0 Heading 0
+%p#p0-1
+	Paragraph 0.1
+	Whoa, this heading is larger than any other before it!
+
+#div
+	Text content
+	%b is
+	cool.

data/spec/samples/attributes/explicit2.haml

@@ -0,0 +1,42 @@
+title: Combo the Other
+keywords: explicit, metasection, attributes/specifying
+no-index: headings
+auto-section:true
+toc: Heading 1, #h1-1, Giggity, #h0
++++
+%h2#h1 Heading 1
+%p#p1-1 Paragraph Number 1.1
+%p#p1-2 Paragraph Number 1.2
+%ul
+	%li A list of items
+	%li A list of items
+	%li A list of items
+
+%h3#h1-1 Heading 1.1
+%p#p1-1-1 Paragraph Number 1.1.1
+
+%h2#h2 Heading 2
+%h3#h2-1 Heading 2.1
+%h4#h2-1-1 Heading 2.1.1
+%h5#h2-1-1-1 Heading 2.1.1.1
+%p#p2-1-1-1-1 Paragraph Number 2.1.1.1.1
+
+%h3#h2-2 Heading 2.2
+%p#p2-2-1 Paragraph Number 2.2.1
+%dl
+	%dt Giggity
+	%dd#dd1 Quagmire
+	%dt#dt2 Zanzibar
+	%dd#dd2 The Best
+
+%p#p2-2-2 Paragraph Number 2.2.2
+
+%h1#h0 Heading 0
+%p#p0-1
+	Paragraph 0.1
+	Whoa, this heading is larger than any other before it!
+
+#div
+	Text content
+	%b is
+	cool.

data/spec/samples/attributes/hidden.haml

@@ -0,0 +1,40 @@
+auto-id: true
+hide: true
+toc: Heading 1, Heading 2
++++
+%h2 Heading 1
+%p Paragraph Number 1.1
+%p Paragraph Number 1.2
+%ul
+	%li A list of items
+	%li A list of items
+	%li A list of items
+
+%h3 Heading 1.1
+%p Paragraph Number 1.1.1
+
+%h2 Heading 2
+%h3 Heading 2.1
+%h4 Heading 2.1.1
+%h5 Heading 2.1.1.1
+%p Paragraph Number 2.1.1.1.1
+
+%h3 Heading 2.2
+%p Paragraph Number 2.2.1
+%dl
+	%dt#dt1 Giggity
+	%dd#dd1 Quagmire
+	%dt Zanzibar
+	%dd The Best
+
+%p Paragraph Number 2.2.2
+
+%h1 Heading 0
+%p
+	Paragraph 0.1
+	Whoa, this heading is larger than any other before it!
+
+#div
+	Text content
+	%b is
+	cool.

data/spec/samples/attributes/index.md

@@ -0,0 +1,8 @@
+title  : Friggles® The Cat, ©2009
+author :Gavin Kistner
+default: All About Mr. Friggles
+quotes:"It's all about Mr. Benjamin", "I have never seen this cat before in my life!"
+author.email : !@phrogz.net
+author website :http://phrogz.net
+awesome : true
++++

data/spec/samples/collisions/page1.md

@@ -0,0 +1,3 @@
+title: Page 1 (from Markdown)
++++
+This will collide with Page 1 (from Textile)

data/spec/samples/collisions/page1.textile

@@ -0,0 +1,3 @@
+title: Page 1 (from Textile)
++++
+This will collide with Page 1 (from Markdown)

data/spec/samples/collisions/page2.haml

@@ -0,0 +1,4 @@
+title: Page 2 (from haml)
++++
+%p
+	This will collide with Page 2 (from html) and Page 2 (from text)

data/spec/samples/collisions/page2.html

@@ -0,0 +1,3 @@
+title: Page 2 (from html)
++++
+<p>This will collide with Page 2 (from text) and Page 2 (from haml).</p>

data/spec/samples/collisions/page2.txt

@@ -0,0 +1,3 @@
+title: Page 2 (from text)
++++
+This will collide with Page 2 (from html) and Page 2 (from haml)

data/spec/samples/collisions/page3.bin

@@ -0,0 +1 @@
+(Some unrecognized file type.)

data/spec/samples/collisions/page3.md

@@ -0,0 +1,3 @@
+title: Page 3
++++
+This won't collide with page3.bin

data/spec/samples/files/index.md

@@ -0,0 +1,2 @@
+ignore: **/*.psd, **/*.ai, **/Thumbs.db, BUILDING.txt
++++

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

@@ -0,0 +1 @@
+%p Oops! The page you were looking for was not found. (Tee hee!)

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

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

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

@@ -0,0 +1,2 @@
+#pager
+	= contents

data/spec/samples/templates/goaway.txt

@@ -0,0 +1,3 @@
+template: 404
++++
+I DO NOT LIKE YOU

data/spec/samples/templates/onepara_html.html

@@ -0,0 +1,3 @@
+title: 1*1
++++
+<p>Para1</p>

data/spec/samples/templates/onepara_md.md

@@ -0,0 +1,5 @@
+title      : 1*2
+template   : doubler
+multiplier : 3
++++
+Para1

data/spec/samples/templates/twopara_haml.haml

@@ -0,0 +1,7 @@
+title   : 2*1
+template: page
++++
+%p
+	Para1
+%p
+	Para2

data/spec/samples/templates/twopara_textile.textile

@@ -0,0 +1,6 @@
+title: 2*2
+template: doubler
++++
+p. Para1
+
+p. Para2

data/spec/samples/titles/index.txt

@@ -0,0 +1,2 @@
+title   : Title Changin'
++++

data/spec/templates.rb

@@ -1,2 +1,44 @@
 #encoding: UTF-8
 require File.join(File.dirname(__FILE__), "_helper")
+
+describe "Variety Hour" do
+	before do
+		@bundle = DocuBot::Bundle.new( SAMPLES/'templates' )
+		@page_by_title = Hash[ *@bundle.pages.map{ |p| [p.title,p] }.flatten ]
+	end
+	
+	it "uses the 'page' template if not specified" do
+		@page_by_title.must_include '1*1'
+		html = @page_by_title['1*1'].to_html
+		html.must_include 'pager'
+		html.scan(/<p>/).length.must_equal 1
+	end
+	
+	it "passes the page for use by another specified template" do
+		@page_by_title.must_include '1*2'
+		html = @page_by_title['1*2'].to_html
+		html.must_include 'doubler'
+		html.scan(/<p>/).length.must_equal 3
+	end
+	
+	it "can use the 'page' template explicitly" do
+		@page_by_title.must_include '2*1'
+		html = @page_by_title['2*1'].to_html
+		html.must_include 'page'
+		html.scan(/<p>/).length.must_equal 2
+	end
+	
+	it "should have templates handle missing attributes" do
+		@page_by_title.must_include '2*2'
+		html = @page_by_title['2*2'].to_html
+		html.must_include 'doubler'
+		html.scan(/<p>/).length.must_equal 4
+	end
+	
+	it "can have templates that do not include contents" do
+		@page_by_title.must_include 'goaway'
+		html = @page_by_title['goaway'].to_html
+		html.must_include 'Oops!'
+		html.wont_include 'I DO NOT LIKE YOU'
+	end
+end

data/spec/toc.rb

@@ -14,32 +14,18 @@ describe "Simplest Table of Contents" do
 		@toc.bundle.must_equal @bundle
 	end
 	
-	it "responds to queries for undefined attributes" do
-		@toc.never_defined_attribute?.must_equal false
-		@toc.never_defined_attribute.must_be_nil
-	end
-	
-	it "responds to queries for defined attributes" do
-		@toc.title?.must_equal true
-		@toc.title.wont_be_nil
-	end
-	
-	it "defaults to the name 'Table of Contents'" do
-		@toc.title.must_equal "Table of Contents"
-	end
-	
 	it "preserves simple names as titles" do
-		@toc.pages.length.must_equal @files.length
+		@toc.children.length.must_equal @files.length
 		@files.each do |source_file|
 			filename_without_extension = source_file.sub( /\.[^.]+$/, '' )
-			@toc.pages.find{ |page| page.title==filename_without_extension }.wont_be_nil
+			@toc.children.find{ |node| node.title==filename_without_extension }.wont_be_nil
 		end
 	end
 	
 	it "preserves file system ordering" do
 		@files.each_with_index do |source_file,i|
 			filename_without_extension = source_file.sub( /\.[^.]+$/, '' )
-			@toc.pages[i].title.must_equal filename_without_extension
+			@toc.children[i].title.must_equal filename_without_extension
 		end
 	end
 
@@ -48,26 +34,74 @@ describe "Simplest Table of Contents" do
 		@toc.ancestors.must_be_empty
 	end
 	
-	it "is the parent of all top-level pages" do
-		@toc.pages.each{ |page| page.parent.must_equal @toc }
+	it "is not the parent of any top-level links" do
+		@toc.children.each{ |node| node.parent.wont_equal @toc }
 	end
 	
-	it "is not a leaf" do
-		@toc.leaf?.must_equal false
-	end
-
 	it "is at depth 0 with no root" do
 		@toc.depth.must_equal 0
-		@toc.root.must_equal ""
-	end
-	
-	it "raises an error setting a non-standard attribute" do
-		proc{ @toc.title = "Yo!" }.must_raise(NoMethodError)
-	end
+	end	
 end
 
 describe "Renamed Table of Contents" do
 	it "honors the title of the root index file" do
-		DocuBot::Bundle.new(SAMPLES/'titletest').toc.title.must_equal "Title Changin'"
+		DocuBot::Bundle.new(SAMPLES/'titles').global.title.must_equal "Title Changin'"
+	end
+end
+
+describe "Sub-page Links in the Table of Contents" do
+	before do
+		@out, @err = capture_io do
+			@bundle = DocuBot::Bundle.new SAMPLES/'attributes'
+			@toc = @bundle.toc
+		end
+	end
+	
+	it "should find pages by html link" do
+		e1 = @toc.find('explicit1.html')
+		e1.wont_be_nil
+		e1.page.wont_be_nil
+		e1.page.file == 'explicit1.haml'
+	end
+	
+	it "should not have entries for hidden pages" do
+		@bundle.pages_by_title['hidden'].wont_be_empty
+		hidden = @bundle.page_by_html_path['hidden.html']
+		hidden.wont_be_nil
+		@toc.find('hidden.html').must_be_nil
+		@toc.descendants.select{ |node| node.link['hidden.html'] }.must_be_empty
+	end
+	
+	it "should warn about failed TOC requests" do
+		# explicit2.haml has an existing ID on the element for "Heading 1",
+		# so it can't update the HTML id or the TOC request to match.
+		@err.must_include "Heading 1"
+	end
+	
+	it "should have sub-entries" do
+		e2 = @toc.find('explicit2.html')
+
+		e2.children.length.must_equal 3
+		
+		# The first sub-link is not "Heading 1" because explicit2.haml has an existing ID on that element
+		# and so cannot (at this time) change either the HTML id or the TOC request to match.
+		# It is ignored.			
+		kid = e2.children[0]
+		kid.title.must_equal "Heading 1.1"
+		kid.link.must_equal 'explicit2.html#h1-1'
+		kid.page.must_equal e2.page
+
+		kid = e2.children[1]
+		kid.title.must_equal "Giggity"
+		kid.file.must_equal 'explicit2.html'
+		# No assumptions are made about the generated id.
+		kid.page.must_equal e2.page
+
+		kid = e2.children[2]
+		kid.title.must_equal "Heading 0"
+		kid.file.must_equal   'explicit2.html'
+		kid.anchor.must_equal 'h0'
+		kid.link.must_equal   'explicit2.html#h0'
+		kid.page.must_equal e2.page
 	end
 end