docubot 0.7.1 → 1.0.0

data/lib/docubot.rb

@@ -20,7 +20,7 @@ module FileUtils
 end
 
 module DocuBot
-	VERSION = '0.7.1'
+	VERSION = '1.0.0'
 	DIR     = File.expand_path( File.dirname( __FILE__ ) )
 	
 	TEMPLATE_DIR = DIR / 'docubot/templates'
@@ -32,12 +32,12 @@ module DocuBot
 	end
 end
 
-require 'docubot/link_tree'
-require 'docubot/metasection'
-require 'docubot/snippet'
-require 'docubot/converter'
-require 'docubot/writer'
-require 'docubot/page'
-require 'docubot/glossary'
-require 'docubot/index'
-require 'docubot/bundle'
+require_relative 'docubot/link_tree'
+require_relative 'docubot/metasection'
+require_relative 'docubot/snippet'
+require_relative 'docubot/converter'
+require_relative 'docubot/writer'
+require_relative 'docubot/page'
+require_relative 'docubot/glossary'
+require_relative 'docubot/index'
+require_relative 'docubot/bundle'

data/lib/docubot/bundle.rb

@@ -83,11 +83,25 @@ class DocuBot::Bundle
 					unless page.hide
 						@toc.add_to_link_hierarchy( page.title, page.html_path, page )
 						page.toc.as_list.each do |id_or_text|
-							id = id_or_text[0..0] == '#' ? id_or_text : DocuBot.id_from_text(id_or_text)
-							if ele = page.nokodoc.at_css(id)
-								@toc.add_to_link_hierarchy( ele.inner_text, page.html_path + id, page )
+							if id_or_text[0..0] == '#'
+								if ele = page.nokodoc.at_css(id_or_text)
+									@toc.add_to_link_hierarchy( ele.inner_text, page.html_path + id_or_text, page )
+								else
+									warn "Could not find requested toc anchor #{id_or_text.inspect} on #{page.html_path}"
+								end
 							else
-								warn "Could not find requested toc anchor #{id.inspect} based on #{id_or_text.inspect} on #{page.html_path}"
+								# TODO: Find an elegant way to handle quotes in XPath, for speed
+								# Kramdown 'helpfully' converts quotes in the body to be curly, breaking direct text matching
+								quotes = /['‘’"“”]+/
+								quoteless = id_or_text.gsub(quotes,'')
+								if t=page.nokodoc.xpath('text()|.//text()').find{ |t| t.content.gsub(quotes,'')==quoteless }
+									ele = t.parent
+									# FIXME: better unique ID generator
+									ele['id'] = "item-#{Time.now.to_i}-#{rand 999999}" unless ele['id']
+									@toc.add_to_link_hierarchy( id_or_text, page.html_path + '#' + ele['id'], page )
+								else
+									warn "Could not find requested toc anchor for #{id_or_text.inspect} on #{page.html_path}"
+								end
 							end
 						end
 					end

data/lib/docubot/converters/haml.rb

@@ -1,5 +1,4 @@
 # encoding: UTF-8
-require 'rubygems'
 require 'haml'
 options = { :format=>:html4, :ugly=>true }
 options.merge!( :encoding=>'utf-8' ) if Object.const_defined? "Encoding"

data/lib/docubot/converters/markdown.rb

@@ -1,5 +1,4 @@
 # encoding: UTF-8
-require 'rubygems'
 begin
 	require 'kramdown'
 	DocuBot::Converter.to_convert :md, :markdown do |page, source|
@@ -10,5 +9,6 @@ begin
 	end
 rescue LoadError
 	warn "Unable to load kramdown gem; *.markdown/*.md markup will not be recognized as a page."
+	warn "(Use   gem install kramdown  to fix this, if you need Markdown processing.)"
 end
 

data/lib/docubot/converters/textile.rb

@@ -1,5 +1,4 @@
 # encoding: UTF-8
-require 'rubygems'
 begin
 	require 'redcloth'
 	DocuBot::Converter.to_convert :textile, :rc do |page, source|
@@ -7,4 +6,5 @@ begin
 	end
 rescue LoadError
 	warn "Unable to load RedCloth gem; *.textile/*.rc markup will not be recognized as a page."
+	warn "(Use   gem install RedCloth  to fix this, if you need Textile processing.)"
 end

data/lib/docubot/metasection.rb

@@ -25,7 +25,7 @@ class DocuBot::MetaSection
 		@attrs = {}
 		attrs.each{ |key,value| self[key]=value }
 		if file_path && File.exists?( file_path )
-			parts = IO.read( file_path ).split( META_SEPARATOR, 2 )
+			parts = IO.read( file_path, encoding:'utf-8' ).split( META_SEPARATOR, 2 )
 			if parts.length > 1
 				parts.first.scan(/.+/) do |line|
 					next if line =~ /^\s*#/

data/lib/docubot/page.rb

@@ -155,7 +155,7 @@ class DocuBot::Page
 		tmpl = source_templates / "#{template}.haml"
 		tmpl = master_templates / "#{template}.haml" unless File.exists?( tmpl )
 		tmpl = master_templates / "page.haml"        unless File.exists?( tmpl )
-		tmpl = IO.read( tmpl )
+		tmpl = IO.read( tmpl, encoding:'utf-8' )
 		haml = Haml::Engine.new( tmpl, DocuBot::Writer::HAML_OPTIONS )
 		haml.render( Object.new, :contents=>content_html, :page=>self, :global=>@bundle.global, :root=>root )
 	end

data/lib/docubot/writers/chm.rb

@@ -72,12 +72,12 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 		lap = Time.now
 		
 		# Clean out the intermediary files
-		FileUtils.rm( [ @hhc, @hhp, @hhk ] ) unless ARGS[:logfile] 
+		FileUtils.rm( [ @hhc, @hhp, @hhk ] ) unless defined?(ARGS) && ARGS[:logfile] 
 		FileUtils.rm_r( @html_path )
 		puts "...%.2fs to clean up temporary files" % (Time.now-lap)
 		lap = Time.now
 		
-		unless ARGS[:nopreview]
+		unless defined?(ARGS) && ARGS[:nopreview]
 			# Spin a new thread so it doesn't hold up the Ruby process, but sleep long enough for it to get going.
 			Thread.new{ `hh.exe "#{FileUtils.win_path @chm_path}"` }
 			sleep 0.1 if Object.const_defined? "Encoding" # This sleep does not help on 1.8.6
@@ -88,19 +88,19 @@ class DocuBot::CHMWriter < DocuBot::HTMLWriter
 
 	def write_hhc
 		File.open( @hhc, 'w' ) do |f|
-			f << ERB.new( IO.read( SUPPORT / 'hhc.erb' ) ).result( binding )
+			f << ERB.new( IO.read( SUPPORT / 'hhc.erb', encoding:'utf-8' ) ).result( binding )
 		end
 	end
 
 	def write_hhp
 		File.open( @hhp, 'w' ) do |f|
-			f << ERB.new( IO.read( SUPPORT / 'hhp.erb' ) ).result( binding )
+			f << ERB.new( IO.read( SUPPORT / 'hhp.erb', encoding:'utf-8' ) ).result( binding )
 		end
 	end
 
 	def write_hhk
 		File.open( @hhk, 'w' ) do |f|
-			f << ERB.new( IO.read( SUPPORT / 'hhk.erb' ) ).result( binding )
+			f << ERB.new( IO.read( SUPPORT / 'hhk.erb', encoding:'utf-8' ) ).result( binding )
 		end
 	end
 end

data/lib/docubot/writers/html.rb

@@ -36,7 +36,7 @@ class DocuBot::HTMLWriter < DocuBot::Writer
 			
 			# Write out every page
 			top = File.exists?( source_templates/'top.haml' ) ? source_templates/'top.haml' : master_templates/'top.haml'
-			top = Haml::Engine.new( IO.read( top ), HAML_OPTIONS )
+			top = Haml::Engine.new( IO.read( top, encoding:'utf-8' ), HAML_OPTIONS )
 			@bundle.toc.descendants.each do |node|
 				next if node.anchor
 				

data/spec/_all.rb

@@ -1,13 +1,12 @@
 #encoding: UTF-8
-$: << '..'
-require 'spec/global'
-require 'spec/bundle'
-require 'spec/toc'
-require 'spec/converters'
-require 'spec/page'
-require 'spec/glossary'
-require 'spec/index'
-require 'spec/templates'
-require 'spec/command'
-require 'spec/writer/html'
-require 'spec/writer/chm'
+require_relative 'global'
+require_relative 'bundle'
+require_relative 'toc'
+require_relative 'converters'
+require_relative 'page'
+require_relative 'glossary'
+require_relative 'index'
+require_relative 'templates'
+require_relative 'command'
+require_relative 'writer/html'
+require_relative 'writer/chm'

data/spec/_helper.rb

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

data/spec/bundle.rb

@@ -1,5 +1,5 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_helper'
 
 describe "AbusedBundle" do
 	it 'requires a valid path' do

data/spec/chm.rb

@@ -1,5 +1,5 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_helper'
 
 describe "CHM Writer default topic" do
 	it "should pick the first valid page as the default if not specified" do

data/spec/command.rb

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

data/spec/converters.rb

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

data/spec/global.rb

@@ -1,5 +1,5 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_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

data/spec/glossary.rb

@@ -1,5 +1,5 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_helper'
 
 describe "Glossary Scanner" do
 	before do

data/spec/index.rb

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

data/spec/page.rb

@@ -1,5 +1,5 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_helper'
 
 describe "Validating page titles" do
 	before do

data/spec/samples/attributes/explicit2.haml

@@ -2,7 +2,7 @@ title: Combo the Other
 keywords: explicit, metasection, attributes/specifying
 no-index: headings
 auto-section:true
-toc: Heading 1, #h1-1, Giggity, #h0
+toc: Heading 1, #h1-1, Giggity, #h0, Oh No No No
 +++
 %h2#h1 Heading 1
 %p#p1-1 Paragraph Number 1.1

data/spec/samples/attributes/explicit3.md

@@ -0,0 +1,6 @@
+title: Combo Mr. Markdown
+toc: It's a Heading!
++++
+## It's a Heading!
+
+The above has mixed casing, punctuation, and inline apostrophes.

data/spec/samples/underscores/_static/Foo/_ignoremore.txt

@@ -0,0 +1 @@
+_Hello_, **World!**

data/spec/samples/underscores/_static/_Bar/_ignoreevenmore.txt

@@ -0,0 +1 @@
+_Hello_, **World!**

data/spec/templates.rb

@@ -1,5 +1,5 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_helper'
 
 describe "Variety Hour" do
 	before do

data/spec/toc.rb

@@ -1,6 +1,7 @@
 #encoding: UTF-8
-require File.join(File.dirname(__FILE__), "_helper")
+require_relative '_helper'
 
+# *************************************************************************************************
 describe "Simplest Table of Contents" do
 	before do
 		Dir.chdir SAMPLES/'simplest' do
@@ -43,12 +44,14 @@ describe "Simplest Table of Contents" do
 	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
@@ -75,37 +78,50 @@ describe "Sub-page Links in the Table of Contents" do
 	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"
+		@err.must_include "Oh No No No"
 	end
 	
 	it "should have sub-entries" do
 		e2 = @toc.find('explicit2.html')
 
-		e2.children.length.must_equal 3
+		e2.children.length.must_equal 4
 		
-		# 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"
+		# No assumptions are made about the generated id.
+		kid.page.must_equal e2.page
+
+		kid = e2.children[1]
 		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 = e2.children[2]
 		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 = e2.children[3]
 		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
+
+	it "should work for Markdown headers with mixed casing" do
+		e3 = @toc.find('explicit3.html')
+		e3.children.length.must_equal 1
+
+		kid = e3.children[0]
+		kid.title.must_equal "It's a Heading!"
+		kid.file.must_equal 'explicit3.html'
+		kid.page.must_equal e3.page
+	end
 end
 
+# *************************************************************************************************
 describe "ToC with Deep Hierarchy" do
 	before do
 		@bundle = DocuBot::Bundle.new SAMPLES/'hierarchy'

data/spec/writer/chm.rb

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

data/spec/writer/html.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docubot
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -169,6 +169,7 @@ files:
 - spec/samples/attributes/defaults.haml
 - spec/samples/attributes/explicit1.haml
 - spec/samples/attributes/explicit2.haml
+- spec/samples/attributes/explicit3.md
 - spec/samples/attributes/hidden.haml
 - spec/samples/attributes/index.md
 - spec/samples/collisions/page1.md
@@ -245,6 +246,8 @@ files:
 - spec/samples/underscores/Home.md
 - spec/samples/underscores/subsection/_andignoreme.md
 - spec/samples/underscores/_ignoreme.md
+- spec/samples/underscores/_static/Foo/_ignoremore.txt
+- spec/samples/underscores/_static/_Bar/_ignoreevenmore.txt
 - spec/templates.rb
 - spec/toc.rb
 - spec/writer/chm.rb
@@ -277,7 +280,7 @@ requirements:
 - RedCloth gem for Textile conversion.
 - MiniTest gem for running specifications.
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Create documentation from a hierarchy of text files.