hoe-manualgen 0.2.0 → 0.3.0

data/Rakefile

@@ -1,14 +1,16 @@
 #!/usr/bin/env rake
 
+require 'pathname'
+
 begin
 	require 'hoe'
 rescue LoadError
-	$stderr.puts "This Rakefile requires Hoe (gem install hoe)"
+	abort "This Rakefile requires Hoe (gem install hoe)"
 end
 
 require 'rake/clean'
 
-Hoe.add_include_dirs 'lib'
+Hoe.add_include_dirs 'lib', 'data/hoe-manualgen'
 
 Hoe.plugin :mercurial
 Hoe.plugin :signing
@@ -17,71 +19,26 @@ Hoe.plugin :manualgen
 Hoe.plugins.delete :rubyforge
 
 hoespec = Hoe.spec 'hoe-manualgen' do
-	self.readme_file = 'README.md'
-	self.history_file = 'History.md'
+	self.readme_file = 'README.rdoc'
+	self.history_file = 'History.rdoc'
+	self.extra_rdoc_files = FileList[ '*.rdoc', 'data/hoe-manualgen/lib/*.rb' ]
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.extra_deps.push *{
-		'hoe'        => "~> #{Hoe::VERSION[/^\d+\.\d+/]}",
-		'RedCloth'   => '~> 4.2',
-		'rcodetools' => '~> 0.8',
-	}
-	self.extra_dev_deps.push *{
-		'rspec'    => '~> 2.4',
-		'tidy-ext' => '~> 0.1',
-	}
+	self.dependency 'hoe', "~> #{Hoe::VERSION[/^\d+\.\d+/]}"
+	self.dependency 'RedCloth', '~> 4.2'
+	self.dependency 'rcodetools', '~> 0.8'
 
-	self.spec_extras[:licenses] = ["BSD"]
-	self.spec_extras[:signing_key] = '/Volumes/Keys/ged-private_gem_key.pem'
+	self.dependency 'tidy-ext', '~> 0.1', :developer
 
+	self.manual_lib_dir = Pathname.pwd + 'data/hoe-manualgen/lib'
+
+	self.spec_extras[:licenses] = ["BSD"]
 	self.require_ruby_version( '>=1.8.7' )
 
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
-
-	self.extra_rdoc_files += Dir.glob( 'data/hoe-manualgen/lib/*.rb' )
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
 
 ENV['VERSION'] ||= hoespec.spec.version.to_s
 
-begin
-	include Hoe::MercurialHelpers
-
-	### Task: prerelease
-	desc "Append the package build number to package versions"
-	task :pre do
-		rev = get_numeric_rev()
-		trace "Current rev is: %p" % [ rev ]
-		hoespec.spec.version.version << "pre#{rev}"
-		Rake::Task[:gem].clear
-
-		Gem::PackageTask.new( hoespec.spec ) do |pkg|
-			pkg.need_zip = true
-			pkg.need_tar = true
-		end
-	end
-
-	### Make the ChangeLog update if the repo has changed since it was last built
-	file '.hg/branch'
-	file 'ChangeLog' => '.hg/branch' do |task|
-		$stderr.puts "Updating the changelog..."
-		content = make_changelog()
-		File.open( task.name, 'w', 0644 ) do |fh|
-			fh.print( content )
-		end
-	end
-
-	# Rebuild the ChangeLog immediately before release
-	task :prerelease => 'ChangeLog'
-
-rescue NameError => err
-	task :no_hg_helpers do
-		fail "Couldn't define the :pre task: %s: %s" % [ err.class.name, err.message ]
-	end
-
-	task :pre => :no_hg_helpers
-	task 'ChangeLog' => :no_hg_helpers
-
-end
-

data/data/hoe-manualgen/lib/api-filter.rb

@@ -29,7 +29,7 @@ class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 		<\?
 			api			# Instruction Target
 			\s+
-			(?:"					
+			(?:"
 				(.*?)   # Optional link text [$1]
 			":)?
 			(.*?)	    # Class name [$2]
@@ -71,7 +71,7 @@ class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 			return %{<a href="%s%s">%s</a>} % [
 				classuri,
 				make_anchor( methodname ),
-				link_text || (classname + methodname || '')
+				link_text || (classname + (methodname || ''))
 			]
 		else
 			link_text ||= classname

data/data/hoe-manualgen/lib/editorial-filter.rb

@@ -1,24 +1,24 @@
-#!/usr/bin/ruby 
-# 
+#!/usr/bin/ruby
+#
 # A manual filter to highlight content that needs editorial help.
-# 
+#
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
-# 
-# 
+#
+#
 
 
 
 ### A filter for making editorial marks in manual content.
-### 
+###
 ### Editorial marks are XML processing instructions. There are several available types of
 ### marks:
 ###
 ###   <?ed "This is an editor's note." ?>
 ###   <?ed verify:"this content needs checking or verification" ?>
-### 
+###
 class Hoe::ManualGen::EditorialFilter < Hoe::ManualGen::PageFilter
-	
+
 	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 	LinkPI = %r{
 		<\?
@@ -26,14 +26,14 @@ class Hoe::ManualGen::EditorialFilter < Hoe::ManualGen::PageFilter
 			\s+
 			(\w+?)				# type of editorial mark [$1]
 			:?					# optional colon
-			"					
+			"
 				(.*?)           # content that should be edited [$2]
 			"
 			\s*
 		\?>
 	  }x
-	
-	
+
+
 	######
 	public
 	######
@@ -44,16 +44,16 @@ class Hoe::ManualGen::EditorialFilter < Hoe::ManualGen::PageFilter
 			# Grab the tag values
 			mark_type = $1
 			content   = $2
-			
+
 			self.generate_mark( page, mark_type, content )
 		end
 	end
-	
-	
+
+
 	### Create an HTML fragment from the parsed LinkPI.
 	def generate_mark( current_page, mark_type, content )
 		return "%%(editorial %s-mark)%s%%" % [ mark_type, content ]
 	end
-	
-	
+
+
 end

data/data/hoe-manualgen/lib/examples-filter.rb

@@ -1,11 +1,12 @@
-#!/usr/bin/ruby 
-# 
+#!/usr/bin/ruby
+#encoding: utf-8
+#
 # A collection of standard filters for the manual generation tasklib.
-# 
+#
 # Authors:
 #   Michael Granger <ged@FaerieMUD.org>
-# 
-# 
+#
+#
 
 # Dependencies deferred until #initialize
 
@@ -13,7 +14,7 @@
 
 ### A filter for inline example code or command-line sessions -- does
 ### syntax-checking for some languages and captioning.
-### 
+###
 ### Examples are enclosed in XML processing instructions like so:
 ###
 ###   <?example {language: ruby, testable: true, caption: "A fine example"} ?>
@@ -24,7 +25,7 @@
 ### This will be pulled out into a preformatted section in the HTML,
 ### highlighted as Ruby source, checked for valid syntax, and annotated with
 ### the specified caption. Valid keys in the example PI are:
-### 
+###
 ### language::
 ###   Specifies which (machine) language the example is in.
 ### testable::
@@ -33,7 +34,7 @@
 ### caption::
 ###   A small blurb to put below the pulled-out example in the HTML.
 class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
-	
+
 	DEFAULTS = {
 		:language     => :ruby,
 		:line_numbers => :inline,
@@ -56,31 +57,22 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 			)?
 		\?>
 	  }x
-	
+
 	EndPI = %r{ <\? end (?: \s+ example )? \s* \?> }x
 
 
 	### Defer loading of dependenies until the filter is loaded
 	def initialize( *args )
-		begin
-			require 'pathname'
-			require 'strscan'
-			require 'yaml'
-			require 'rcodetools/xmpfilter'
-			require 'digest/md5'
-			require 'tmpdir'
-			require 'erb'
-		rescue LoadError => err
-			unless Object.const_defined?( :Gem )
-				require 'rubygems'
-				retry
-			end
-
-			raise
-		end
+		require 'pathname'
+		require 'strscan'
+		require 'yaml'
+		require 'rcodetools/xmpfilter'
+		require 'digest/md5'
+		require 'tmpdir'
+		require 'erb'
 	end
-	
-	
+
+
 	######
 	public
 	######
@@ -88,15 +80,15 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 	### Process the given +source+ for <?example ... ?> processing-instructions, calling out
 	def process( source, page, metadata )
 		scanner = StringScanner.new( source )
-		
+
 		buffer = ''
 		until scanner.eos?
 			startpos = scanner.pos
-			
+
 			# If we find an example
 			if scanner.skip_until( ExamplePI )
 				contents = ''
-				
+
 				# Append the interstitial content to the buffer
 				if ( scanner.pos - startpos > scanner.matched.length )
 					offset = scanner.pos - scanner.matched.length - 1
@@ -106,13 +98,13 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 				# Append everything up to it to the buffer and save the contents of
 				# the tag
 				params = scanner[1]
-				
+
 				# Now find the end of the example or complain
 				contentpos = scanner.pos
 				scanner.skip_until( EndPI ) or
-					raise "Unterminated example at line %d" % 
+					raise "Unterminated example at line %d" %
 						[ scanner.string[0..scanner.pos].count("\n") ]
-				
+
 				# Now build the example and append to the buffer
 				if ( scanner.pos - contentpos > scanner.matched.length )
 					offset = scanner.pos - scanner.matched.length - 1
@@ -128,11 +120,11 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 		end
 		buffer << scanner.rest
 		scanner.terminate
-		
+
 		return buffer
 	end
-	
-	
+
+
 	### Filter out 'example' macros, doing syntax highlighting, and running
 	### 'testable' examples through a validation process appropriate to the
 	### language the example is in.
@@ -141,7 +133,7 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 		caption = options.delete( :caption )
 		content = ''
 		lang = options.delete( :language ).to_s
-		
+
 		# Test it if it's testable
 		if options[:testable]
 			content = test_content( body, lang, page )
@@ -154,12 +146,12 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 		caption = %{<div class="caption">} + caption.to_s + %{</div>} if caption
 
 		return %{<notextile><div class="example #{lang}-example">%s%s</div></notextile>} %
-		 	[content, caption || '']
+			[content, caption || '']
 	end
 
 
-	### Parse an options hash for filtering from the given +args+, which can either 
-	### be a plain String, in which case it is assumed to be the name of the language the example 
+	### Parse an options hash for filtering from the given +args+, which can either
+	### be a plain String, in which case it is assumed to be the name of the language the example
 	### is in, or a Hash of configuration options.
 	def parse_options( args )
 		args = "{ #{args} }" unless args.strip[0] == ?{
@@ -173,7 +165,7 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 		end
 		return DEFAULTS.merge( args )
 	end
-	
+
 
 	### Test the given +content+ with a rule specific to the given +language+.
 	def test_content( body, language, page )
@@ -188,8 +180,8 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 			return body
 		end
 	end
-	
-		
+
+
 	### Test the specified Ruby content for valid syntax
 	def test_ruby_content( source, page )
 		# $stderr.puts "Testing ruby content..."
@@ -216,8 +208,8 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 		return "%s while testing: %s\n  %s" %
 			[ err.class.name, err.message, err.backtrace.join("\n  ") ]
 	end
-	
-	
+
+
 	### Test the specified YAML content for valid syntax
 	def test_yaml_content( source, metadata )
 		YAML.load( source )
@@ -226,13 +218,13 @@ class Hoe::ManualGen::ExamplesFilter < Hoe::ManualGen::PageFilter
 	else
 		return source
 	end
-	
-	
+
+
 	### Highlights the given +content+ in language +lang+.
 	def highlight( content, options, lang )
 		source = ERB::Util.html_escape( content )
 		return %Q{\n\n<pre class="brush:#{lang}">#{source}</pre>\n\n}
 	end
-	
+
 end
 

data/data/hoe-manualgen/lib/links-filter.rb

@@ -1,25 +1,25 @@
-#!/usr/bin/ruby 
-# 
+#!/usr/bin/ruby
+#
 # A manual filter to generate links from the page catalog.
-# 
+#
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
 # * Mahlon E. Smith <mahlon@martini.nu>
-# 
-# 
+#
+#
 
 
 ### A filter for generating links from the page catalog. This allows you to refer to other pages
 ### in the source and have them automatically updated as the structure of the manual changes.
-### 
+###
 ### Links are XML processing instructions. Pages can be referenced in one of several ways:
 ###
 ###   <?link Page Title ?>
 ###   <?link "click here":Page Title ?>
 ###   <?link Page Title #section_id ?>
 ###   <?link "click here":Page Title#section_id ?>
-### 
-### This first form links to a page by title. Link text defaults to the page title unless an 
+###
+### This first form links to a page by title. Link text defaults to the page title unless an
 ### optional quoted string is prepended. If you want to link to an anchor inside the page, include
 ### its ID with a hash mark after the title.
 ###
@@ -32,13 +32,13 @@
 ### Again, the link text defaults to the page title, or can be overriden via a prepended string,
 ### and you can link into a page with an appended ID.
 class Hoe::ManualGen::LinksFilter < Hoe::ManualGen::PageFilter
-	
+
 	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 	LinkPI = %r{
 		<\?
 			link				# Instruction Target
 			\s+
-			(?:"					
+			(?:"
 				(.*?)           # Optional link text [$1]
 			":)?
 			(.*?)				# Title or path [$2]
@@ -47,8 +47,8 @@ class Hoe::ManualGen::LinksFilter < Hoe::ManualGen::PageFilter
 			\s+
 		\?>
 	  }x
-	
-	
+
+
 	######
 	public
 	######
@@ -60,19 +60,19 @@ class Hoe::ManualGen::LinksFilter < Hoe::ManualGen::PageFilter
 			link_text = $1
 			reference = $2
 			fragment  = $3
-			
+
 			self.generate_link( page, reference, link_text, fragment )
 		end
 	end
-	
-	
+
+
 	### Create an HTML link fragment from the parsed LinkPI.
 	def generate_link( current_page, reference, link_text=nil, fragment=nil )
 
 		if other_page = self.find_linked_page( current_page, reference )
 			href_path = other_page.sourcefile.relative_path_from( current_page.sourcefile.dirname )
 			href = href_path.to_s.gsub( '.page', '.html' )
-		
+
 			if link_text
 				return %{<a href="#{href}#{fragment}">#{link_text}</a>}
 			else
@@ -85,19 +85,19 @@ class Hoe::ManualGen::LinksFilter < Hoe::ManualGen::PageFilter
 			return %{<a href="#" title="#{error_message}" class="broken-link">#{link_text}</a>}
 		end
 	end
-	
-	
+
+
 	### Lookup a page +reference+ in the catalog.  +reference+ can be either a
 	### path to the .page file, relative to the manual root path, or a page title.
 	### Returns a matching Page object, or nil if no match is found.
 	def find_linked_page( current_page, reference )
-		
+
 		catalog = current_page.catalog
-		
+
 		# Lookup by page path
 		if reference =~ /\.page$/
 			return catalog.uri_index[ reference ]
-			
+
 		# Lookup by page title
 		else
 			return catalog.title_index[ reference ]