docubot 0.6.1 → 0.6.2

data/spec/samples/links/root.md

@@ -1,14 +1,14 @@
-[External](http://www.google.com/)
-[Internal](#sub-id)
-[Internal](root.html#sub-id)
-[Internal](sub1/inner1.html)
-[Internal](sub2.html)
-[Internal](sub2/inner2.html)
-[Internal](sub1/../sub2/inner2.html)
-[BROKEN](fork.html)
-[BROKEN](sub1.html)
-[BROKEN](root.md)
-[BROKEN](sub1/inner1.md)
-[BROKEN](#GORKBO)
-
+[External](http://www.google.com/)
+[Internal](#sub-id)
+[Internal](root.html#sub-id)
+[Internal](sub1/inner1.html)
+[Internal](sub2.html)
+[Internal](sub2/inner2.html)
+[Internal](sub1/../sub2/inner2.html)
+[BROKEN](fork.html)
+[BROKEN](sub1.html)
+[BROKEN](root.md)
+[BROKEN](sub1/inner1.md)
+[BROKEN](#GORKBO)
+
 <div id="sub-id">Just in case</div>

data/spec/samples/links/sub1/inner1.md

@@ -1,11 +1,11 @@
-[External](http://phrogz.net)
-[Internal](../root.html)
-[Internal](../root.html#sub-id)
-[Internal](inner1.html)
-[Internal](../sub2.html)
-[Internal](../sub2/inner2.html)
-[File](../sub2/bozo.bin)           
-[BROKEN](inner2.html)
-[BROKEN](../sub1)
-[BROKEN](sub1/inner1.md)
-[BROKEN](../root.html#GORKBO)
+[External](http://phrogz.net)
+[Internal](../root.html)
+[Internal](../root.html#sub-id)
+[Internal](inner1.html)
+[Internal](../sub2.html)
+[Internal](../sub2/inner2.html)
+[File](../sub2/bozo.bin)           
+[BROKEN](inner2.html)
+[BROKEN](../sub1)
+[BROKEN](sub1/inner1.md)
+[BROKEN](../root.html#GORKBO)

data/spec/samples/links/sub2.md

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

data/spec/samples/links/sub2/inner2.md

@@ -1,7 +1,7 @@
-[External](http://phrogz.net/tmp/gkhead.jpg)
-[Internal](../sub1/index.html) Even though there isn't an index.md file.
-[Internal](index.html)         Even though there isn't an index.md file.
-[File](bozo.bin)           
-[BROKEN](../index.html)    Because the global root is not a valid link.
-[BROKEN](../sub1)
-[BROKEN](../index.md)
+[External](http://phrogz.net/tmp/gkhead.jpg)
+[Internal](../sub1/index.html) Even though there isn't an index.md file.
+[Internal](index.html)         Even though there isn't an index.md file.
+[File](bozo.bin)           
+[BROKEN](../index.html)    Because the global root is not a valid link.
+[BROKEN](../sub1)
+[BROKEN](../index.md)

data/spec/samples/simplest/HTML.html

@@ -1,10 +1,10 @@
-<h2>Hello World</h2>
-
-<p>It's the end of the world as we know it, and I feel fine. Because:</p>
-
-<ul>
-	<li>I'm on my medication. Which is delicious.<ul>
-  	<li>I buy it from a store. A candy store.</li>
-	</ul></li>
-	<li>In the end, we're all going to go.</li>
+<h2>Hello World</h2>
+
+<p>It's the end of the world as we know it, and I feel fine. Because:</p>
+
+<ul>
+	<li>I'm on my medication. Which is delicious.<ul>
+  	<li>I buy it from a store. A candy store.</li>
+	</ul></li>
+	<li>In the end, we're all going to go.</li>
 </ul>

data/spec/samples/simplest/Haml.haml

@@ -1,13 +1,13 @@
-%h2 Hello World
-
-%p
-	It's the end of the world as we know it,
-	and I feel fine. Because:
-
-%ul
-	%li
-		I'm on my medication.
-		Which is delicious.
-		%ul
-			%li I buy it from a store. A candy store.
+%h2 Hello World
+
+%p
+	It's the end of the world as we know it,
+	and I feel fine. Because:
+
+%ul
+	%li
+		I'm on my medication.
+		Which is delicious.
+		%ul
+			%li I buy it from a store. A candy store.
 	%li In the end, we're all going to go.

data/spec/samples/simplest/Markdown.md

@@ -1,10 +1,10 @@
-Hello World
------------
-It's the end of the world as we know it,
-and I feel fine. Because:
-
-* I'm on my medication.
-  Which is delicious.
-  * I buy it from a store.
-    A candy store.
+Hello World
+-----------
+It's the end of the world as we know it,
+and I feel fine. Because:
+
+* I'm on my medication.
+  Which is delicious.
+  * I buy it from a store.
+    A candy store.
 * In the end, we're all going to go.

data/spec/samples/simplest/Text.txt

@@ -1,10 +1,10 @@
-Hello World
------------
-It's the end of the world as we know it,
-and I feel fine. Because:
-
-* I'm on my medication.
-  Which is delicious.
-  * I buy it from a store.
-    A candy store.
+Hello World
+-----------
+It's the end of the world as we know it,
+and I feel fine. Because:
+
+* I'm on my medication.
+  Which is delicious.
+  * I buy it from a store.
+    A candy store.
 * In the end, we're all going to go.

data/spec/samples/simplest/Textile.textile

@@ -1,10 +1,10 @@
-h2. Hello World
-
-It's the end of the world as we know it,
-and I feel fine. Because:
-
-* I'm on my medication.
-  Which is delicious.
-** I buy it from a store.
-   A candy store.
+h2. Hello World
+
+It's the end of the world as we know it,
+and I feel fine. Because:
+
+* I'm on my medication.
+  Which is delicious.
+** I buy it from a store.
+   A candy store.
 * In the end, we're all going to go.

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

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

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

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

data/spec/samples/templates/goaway.txt

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

data/spec/samples/templates/onepara_html.html

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

data/spec/samples/templates/onepara_md.md

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

data/spec/samples/templates/twopara_haml.haml

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

data/spec/samples/templates/twopara_textile.textile

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

data/spec/samples/titles/3_renamed.txt

@@ -1,2 +1,2 @@
-title: Third One
+title: Third One
 +++

data/spec/samples/titles/index.txt

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

data/spec/templates.rb

@@ -1,44 +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
+#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

@@ -1,129 +1,129 @@
-#encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
-
-describe "Simplest Table of Contents" do
-	before do
-		Dir.chdir SAMPLES/'simplest' do
-			@bundle = DocuBot::Bundle.new( '.' )
-			@toc    = @bundle.toc
-			@files  = Dir['*']
-		end
-	end
-	
-	it "knows who its bundle is" do
-		@toc.bundle.must_equal @bundle
-	end
-	
-	it "preserves simple names as titles" do
-		@toc.children.length.must_equal @files.length
-		@files.each do |source_file|
-			filename_without_extension = source_file.sub( /\.[^.]+$/, '' )
-			@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.children[i].title.must_equal filename_without_extension
-		end
-	end
-
-	it "has no parent or ancestors" do
-		@toc.parent.must_be_nil
-		@toc.ancestors.must_be_empty
-	end
-	
-	it "is not the parent of any top-level links" do
-		@toc.children.each{ |node| node.parent.wont_equal @toc }
-	end
-	
-	it "is at depth 0 with no root" do
-		@toc.depth.must_equal 0
-	end	
-end
-
-describe "Renamed Table of Contents" do
-	it "honors the title of the root index file" do
-		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
-
-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
+#encoding: UTF-8
+require File.join(File.dirname(__FILE__), "_helper")
+
+describe "Simplest Table of Contents" do
+	before do
+		Dir.chdir SAMPLES/'simplest' do
+			@bundle = DocuBot::Bundle.new( '.' )
+			@toc    = @bundle.toc
+			@files  = Dir['*']
+		end
+	end
+	
+	it "knows who its bundle is" do
+		@toc.bundle.must_equal @bundle
+	end
+	
+	it "preserves simple names as titles" do
+		@toc.children.length.must_equal @files.length
+		@files.each do |source_file|
+			filename_without_extension = source_file.sub( /\.[^.]+$/, '' )
+			@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.children[i].title.must_equal filename_without_extension
+		end
+	end
+
+	it "has no parent or ancestors" do
+		@toc.parent.must_be_nil
+		@toc.ancestors.must_be_empty
+	end
+	
+	it "is not the parent of any top-level links" do
+		@toc.children.each{ |node| node.parent.wont_equal @toc }
+	end
+	
+	it "is at depth 0 with no root" do
+		@toc.depth.must_equal 0
+	end	
+end
+
+describe "Renamed Table of Contents" do
+	it "honors the title of the root index file" do
+		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
+
+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