docubot 0.3 → 0.3.2

data/spec/samples/simplest/HTML.html

@@ -0,0 +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>
+</ul>

data/spec/samples/simplest/Haml.haml

@@ -0,0 +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.
+	%li In the end, we're all going to go.

data/spec/samples/simplest/Markdown.md

@@ -0,0 +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.
+* In the end, we're all going to go.

data/spec/samples/simplest/Text.txt

@@ -0,0 +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.
+* In the end, we're all going to go.

data/spec/samples/simplest/Textile.textile

@@ -0,0 +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.
+* In the end, we're all going to go.

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

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

data/spec/samples/titletest/index.txt

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

data/spec/templates.rb

@@ -0,0 +1,2 @@
+#encoding: UTF-8
+require File.join(File.dirname(__FILE__), "_helper")

data/spec/toc.rb

@@ -0,0 +1,73 @@
+#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 "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
+		@files.each do |source_file|
+			filename_without_extension = source_file.sub( /\.[^.]+$/, '' )
+			@toc.pages.find{ |page| page.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
+		end
+	end
+
+	it "has no parent or ancestors" do
+		@toc.parent.must_be_nil
+		@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 }
+	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
+
+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'"
+	end
+end

data/spec/writer/chm.rb

@@ -0,0 +1,2 @@
+#encoding: UTF-8
+require File.join(File.dirname(__FILE__), "..", "_helper")

data/spec/writer/html.rb

@@ -0,0 +1,2 @@
+#encoding: UTF-8
+require File.join(File.dirname(__FILE__), "..", "_helper")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: docubot
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.3.2
 platform: ruby
 authors: 
 - Gavin Kistner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-16 00:00:00 -07:00
+date: 2010-01-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: DocuBot creates HTML or CHM documentation from a hierarchy of files, supporting markups like Markdown, Textile, and Haml.
 email: gavin@phrogz.net
 executables: 
@@ -74,11 +84,11 @@ files:
 - lib/docubot/index.rb
 - lib/docubot/page.rb
 - lib/docubot/shells/default/0_License.md
-- lib/docubot/shells/default/_static/logo.png
 - lib/docubot/shells/default/Appendix/Glossary.md
 - lib/docubot/shells/default/Appendix/Index_Page.md
 - lib/docubot/shells/default/Appendix/Table of Contents.md
 - lib/docubot/shells/default/index.txt
+- lib/docubot/shells/default/_static/logo.png
 - lib/docubot/shells/docubot-help/0_License.md
 - lib/docubot/shells/docubot-help/1_Getting_Started.md
 - lib/docubot/shells/docubot-help/2_Basic_Concepts/0 The Metasection.md
@@ -94,21 +104,41 @@ files:
 - lib/docubot/shells/docubot-help/4_Appendix/Glossary.md
 - lib/docubot/shells/docubot-help/4_Appendix/Index_Page.md
 - lib/docubot/shells/docubot-help/4_Appendix/Table of Contents.md
+- lib/docubot/shells/docubot-help/index.txt
 - lib/docubot/shells/docubot-help/_glossary/Template.md
 - lib/docubot/shells/docubot-help/_static/glider.png
-- lib/docubot/shells/docubot-help/index.txt
+- lib/docubot/shells/nvphysx/0_License.md
+- lib/docubot/shells/nvphysx/1_Getting_Started.haml
+- lib/docubot/shells/nvphysx/Appendix/Glossary.md
+- lib/docubot/shells/nvphysx/index.txt
+- lib/docubot/shells/nvphysx/_glossary/APEX.md
+- lib/docubot/shells/nvphysx/_glossary/NVIDIA.md
+- lib/docubot/shells/nvphysx/_glossary/PhysX.textile
+- lib/docubot/shells/nvphysx/_static/NVBadge_3D.png
+- lib/docubot/shells/nvphysx/_static/PhysXbyNV_Black.png
+- lib/docubot/shells/nvphysx/_templates/top.haml
+- lib/docubot/shells/nvphysx/_templates/_root/bg_green_bar_revised.gif
+- lib/docubot/shells/nvphysx/_templates/_root/close.png
+- lib/docubot/shells/nvphysx/_templates/_root/common.css
+- lib/docubot/shells/nvphysx/_templates/_root/glossary.css
+- lib/docubot/shells/nvphysx/_templates/_root/glossary.js
+- lib/docubot/shells/nvphysx/_templates/_root/nvdevtools.js
+- lib/docubot/shells/nvphysx/_templates/_root/nvidia-logo.gif
+- lib/docubot/shells/nvphysx/_templates/_root/right-sidebar.png
 - lib/docubot/snippet.rb
 - lib/docubot/snippets/glossary.rb
 - lib/docubot/snippets/index_entries.rb
-- lib/docubot/templates/_root/common.css
-- lib/docubot/templates/_root/toc.css
-- lib/docubot/templates/_root/toc.js
 - lib/docubot/templates/glossary.haml
 - lib/docubot/templates/index.haml
 - lib/docubot/templates/page.haml
 - lib/docubot/templates/section.haml
 - lib/docubot/templates/toc.haml
 - lib/docubot/templates/top.haml
+- lib/docubot/templates/_root/common.css
+- lib/docubot/templates/_root/glossary.css
+- lib/docubot/templates/_root/glossary.js
+- lib/docubot/templates/_root/toc.css
+- lib/docubot/templates/_root/toc.js
 - lib/docubot/writer.rb
 - lib/docubot/writers/chm/hhc.erb
 - lib/docubot/writers/chm/hhk.erb
@@ -116,32 +146,40 @@ files:
 - lib/docubot/writers/chm.rb
 - lib/docubot/writers/html.rb
 - lib/docubot.rb
-- test/all.rb
-- test/site1/A Slight Change of Heart/1 Ze First Page in Ze Section.md
-- test/site1/A Slight Change of Heart/2 Another Page in the Section.md
-- test/site1/A Slight Change of Heart/3_more_crap.haml
-- test/site1/appendices/gkheadftw.html
-- test/site1/appendices/index.md
-- test/site1/headers.md
-- test/site1/preamble.haml
-- test/site1/raw.textile
-- test/site1_html/_index.html
-- test/site1_html/_toc.html
-- test/site1_html/A Slight Change of Heart/1 Ze First Page in Ze Section.html
-- test/site1_html/A Slight Change of Heart/2 Another Page in the Section.html
-- test/site1_html/A Slight Change of Heart/3_more_crap.html
-- test/site1_html/A Slight Change of Heart/3_more_crap.html#frist-post
-- test/site1_html/A Slight Change of Heart/3_more_crap.html#moar
-- test/site1_html/A Slight Change of Heart/index.html
-- test/site1_html/appendices/gkheadftw.html
-- test/site1_html/appendices/index.html
-- test/site1_html/common.css
-- test/site1_html/glossary-terms.js
-- test/site1_html/headers.html
-- test/site1_html/preamble.html
-- test/site1_html/raw.html
-- test/site1_html/toc.css
-- test/site1_html/toc.js
+- spec/bundle.rb
+- spec/command.rb
+- spec/converters.rb
+- spec/glossary.rb
+- spec/index.rb
+- spec/page.rb
+- spec/samples/glossary/Glossary.txt
+- spec/samples/glossary/Some Page.md
+- spec/samples/glossary/_glossary/complex.haml
+- spec/samples/glossary/_glossary/project_x.md
+- spec/samples/glossary/_glossary/Simple Term.md
+- spec/samples/link_test/index.txt
+- spec/samples/link_test/root.md
+- spec/samples/link_test/sub1/inner1.md
+- spec/samples/link_test/sub2/bozo.bin
+- spec/samples/link_test/sub2/inner2.md
+- spec/samples/link_test/sub2.md
+- spec/samples/simplest/Haml.haml
+- spec/samples/simplest/HTML.html
+- spec/samples/simplest/Markdown.md
+- spec/samples/simplest/Text.txt
+- spec/samples/simplest/Textile.textile
+- spec/samples/titletest/1 First One.txt
+- spec/samples/titletest/2_Second_One.txt
+- spec/samples/titletest/3_renamed.txt
+- spec/samples/titletest/4 Fourth_One.txt
+- spec/samples/titletest/5_Fifth One.txt
+- spec/samples/titletest/index.txt
+- spec/templates.rb
+- spec/toc.rb
+- spec/writer/chm.rb
+- spec/writer/html.rb
+- spec/_all.rb
+- spec/_helper.rb
 has_rdoc: true
 homepage: http://github.com/Phrogz/docubot
 licenses: []
@@ -164,15 +202,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
   version: 
 requirements: 
-- Windows with HTML Help Workshop installed.
+- Windows with HTML Help Workshop installed and hhc.exe in the %PATH%.
 - Haml gem for template interpretation.
 - Nokogiri gem for parsing HTML after creation (and manipulating).
 - BlueCloth gem for Markdown conversion.
 - RedCloth gem for Textile conversion.
+- MiniTest gem for running specifications.
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Create documentation from a hierarchy of text files.
 test_files: 
-- test/all.rb
+- spec/_all.rb

data/test/all.rb

@@ -1,8 +0,0 @@
-# encoding: UTF-8
-
-require 'docubot'
-# I'm too lazy to enter the syntax for directory with spaces
-# So just find the 3_more_crap.md file that has metadata.
-file = Dir['**/**'].grep( /3/ ).first
-x = DocuBot::Page.from_file( file )
-p x.title?, x.title, x.foo?, x.foo

data/test/site1/A Slight Change of Heart/1 Ze First Page in Ze Section.md

@@ -1 +0,0 @@
-The title of this should be "Ze First Page in Ze Section"

data/test/site1/A Slight Change of Heart/2 Another Page in the Section.md

@@ -1 +0,0 @@
-The title of this page should be "Another Page in the Section".

data/test/site1/A Slight Change of Heart/3_more_crap.haml

@@ -1,17 +0,0 @@
-title  : Additional Helpful Information
-author : Gavin Kistner
-date   : 2010-1-4
-toc    : frist-post moar
-+++
-%h2#frist-post Title Verification
-%p The title of this page should be "Additional Helpful Information", not "More Crap".
-
-%h2#moar TOC Verification
-:markdown
-	The TOC for this page should have sub-entries for the referenced headings.
-	
-	* The links should be named for the headings.
-	* The links should link to the headings.
-
-%h2#dumb Exclusivity
-%p The TOC should not, however, have this last heading.

data/test/site1/appendices/gkheadftw.html

@@ -1,2 +0,0 @@
-<p>Yo ho ho! It's <strong>GK Head</strong> time!</p>
-<p><img src="http://phrogz.net/tmp/gkhead.jpg"></p>

data/test/site1/appendices/index.md

@@ -1,2 +0,0 @@
-title: "Appendices: The final frontier?"
-+++

data/test/site1/headers.md

@@ -1,10 +0,0 @@
-# I like Chicken, I like Liver
-MeowMix MeowMix, please deliver.
-
-## Delivery Options
-You could just put it in my bowl. Or you could:
-
-* Put it on a fancy plate.
-* Let me eat it out of your hand.
-* Just dump it all over the floor and let me lick up dust
-  at the same time as I scarf the food.

data/test/site1/preamble.haml

@@ -1,4 +0,0 @@
-%p This page was generated by Haml!
-%ul
-	- (1..5).each do |i|
-		%li Generated Item ##{i}

data/test/site1/raw.textile

@@ -1,10 +0,0 @@
-This is a simple two paragraph page.
-
-This is the second paragraph. Click on the $$foinkle$$ to start the fun.
-
-IMPORTANT: READ THE FOLLOWING TERMS AND CONDITIONS BEFORE USING THE ACCOMPANYING NVIDIA PHYSX SDK.
-BY CLICKING ON THE "ACCEPT” BUTTON, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT AND AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, NVIDIA IS NOT WILLING TO LICENSE THE PHYSX SDK TO YOU. IF YOU DO NOT AGREE TO THESE TERMS, YOU MAY, WITHIN 15 DAYS, DESTROY THIS ENTIRE PRODUCT AND PROVIDE WRITTEN VERIFICATION OF DELETION OF ALL COPIES OF THE ENTIRE PRODUCT.
-
-RedCloth's parser is said to "sexify" English apostrophes and quotation marks...what does it do for the '80s--which should curl to the _left_--I wonder?
-
-A 2x4 is actually 1.5" x 3.5".

data/test/site1_html/A Slight Change of Heart/1 Ze First Page in Ze Section.html

@@ -1,30 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
-<link href='../common.css' media='all' rel='stylesheet' type='text/css'>
-<title>Ze First Page in Ze Section</title>
-</head>
-<body>
-<div id='content'>
-<div id='pagetop'>
-<div id='breadcrumb'>
-Table of Contents
-<span class='sep'>&gt;</span>
-<a href='../A Slight Change of Heart/index.html'>A Slight Change of Heart</a>
-<span class='sep'>&gt;</span>
-Ze First Page in Ze Section
-</div>
-<h1 id='title'>Ze First Page in Ze Section</h1>
-</div>
-<div id='pagebody'>
-<div id='mainbody'><p>The title of this should be "Ze First Page in Ze Section"</p>
-</div>
-<div id='pagefooter'>
-Copyright ©2010.
-All Rights Reserved.
-</div>
-</div>
-</div>
-</body>
-</html>

data/test/site1_html/A Slight Change of Heart/2 Another Page in the Section.html

@@ -1,30 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
-<link href='../common.css' media='all' rel='stylesheet' type='text/css'>
-<title>Another Page in the Section</title>
-</head>
-<body>
-<div id='content'>
-<div id='pagetop'>
-<div id='breadcrumb'>
-Table of Contents
-<span class='sep'>&gt;</span>
-<a href='../A Slight Change of Heart/index.html'>A Slight Change of Heart</a>
-<span class='sep'>&gt;</span>
-Another Page in the Section
-</div>
-<h1 id='title'>Another Page in the Section</h1>
-</div>
-<div id='pagebody'>
-<div id='mainbody'><p>The title of this page should be "Another Page in the Section".</p>
-</div>
-<div id='pagefooter'>
-Copyright ©2010.
-All Rights Reserved.
-</div>
-</div>
-</div>
-</body>
-</html>