hoe-manualgen 0.1.1 → 0.2.0

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

@@ -1,11 +1,11 @@
 #!/usr/bin/ruby 
-# 
+#
 # A manual filter to generate links from the Darkfish API.
-# 
+#
 # Authors:
 # * Michael Granger <ged@FaerieMUD.org>
 # * Mahlon E. Smith <mahlon@martini.nu>
-# 
+#
 
 
 ### A filter for generating links from the generated API documentation. This allows you to refer
@@ -14,8 +14,14 @@
 ### Links are XML processing instructions. Pages can be referenced as such:
 ###
 ###   <?api Class::Name ?>
+###   <?api Class::Name#instance_method ?>
+###   <?api Class::Name.class_method ?>
+###
+### Link text can be overridden, too:
+###
 ###   <?api "click here":Class::Name ?>
-### 
+###   <?api "click here":Class::Name#instance_method ?>
+###
 class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 
 	# PI	   ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
@@ -27,6 +33,7 @@ class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 				(.*?)   # Optional link text [$1]
 			":)?
 			(.*?)	    # Class name [$2]
+			([\.#].*?)? # Method anchor [$3]
 			\s+
 		\?>
 	  }x
@@ -44,26 +51,27 @@ class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 
 		return source.gsub( ApiPI ) do |match|
 			# Grab the tag values
-			link_text = $1
-			classname = $2
+			link_text  = $1
+			classname  = $2
+			methodname = $3
 
-			self.generate_link( page, apipath, classname, link_text )
+			self.generate_link( page, apipath, classname, methodname, link_text )
 		end
 	end
 
 
 	### Create an HTML link fragment from the parsed ApiPI.
-	###
-	def generate_link( current_page, apipath, classname, link_text=nil )
+	def generate_link( current_page, apipath, classname, methodname=nil, link_text=nil )
 
 		classpath = "%s.html" % [ classname.gsub('::', '/') ]
 		classfile = apipath + classpath
-		classuri = current_page.basepath + 'api' + classpath
+		classuri  = current_page.basepath + 'api' + classpath
 
 		if classfile.exist?
-			return %{<a href="%s">%s</a>} % [
+			return %{<a href="%s%s">%s</a>} % [
 				classuri,
-				link_text || classname
+				make_anchor( methodname ),
+				link_text || (classname + methodname || '')
 			]
 		else
 			link_text ||= classname
@@ -72,5 +80,17 @@ class Hoe::ManualGen::APIFilter < Hoe::ManualGen::PageFilter
 			return %{<a href="#" title="#{error_message}" class="broken-link">#{link_text}</a>}
 		end
 	end
+
+
+	### Attach a method anchor.
+	def make_anchor( methodname )
+		return '' unless methodname
+
+		method_type = methodname[ 0, 1 ]
+		return "#method-%s-%s" % [
+			( method_type == '#' ? 'i' : 'c' ),
+			methodname[ 1..-1 ]
+		]
+	end
 end
 

data/lib/hoe/manualgen.rb

@@ -31,10 +31,10 @@ module Hoe::ManualGen
 	include FileUtils::DryRun if Rake.application.options.dryrun
 
 	# Library version constant
-	VERSION = '0.1.1'
+	VERSION = '0.2.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 7b431d0b1024 $
+	REVISION = %q$Revision: b775fc3856f5 $
 
 	# Configuration defaults
 	DEFAULT_BASE_DIR     = Pathname( 'manual' )

metadata

@@ -1,184 +1,162 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hoe-manualgen
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Michael Granger
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
+cert_chain:
+- ! '-----BEGIN CERTIFICATE-----
+
   MIIDLDCCAhSgAwIBAgIBADANBgkqhkiG9w0BAQUFADA8MQwwCgYDVQQDDANnZWQx
+
   FzAVBgoJkiaJk/IsZAEZFgdfYWVyaWVfMRMwEQYKCZImiZPyLGQBGRYDb3JnMB4X
+
   DTEwMDkxNjE0NDg1MVoXDTExMDkxNjE0NDg1MVowPDEMMAoGA1UEAwwDZ2VkMRcw
+
   FQYKCZImiZPyLGQBGRYHX2FlcmllXzETMBEGCgmSJomT8ixkARkWA29yZzCCASIw
+
   DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALy//BFxC1f/cPSnwtJBWoFiFrir
+
   h7RicI+joq/ocVXQqI4TDWPyF/8tqkvt+rD99X9qs2YeR8CU/YiIpLWrQOYST70J
+
   vDn7Uvhb2muFVqq6+vobeTkILBEO6pionWDG8jSbo3qKm1RjKJDwg9p4wNKhPuu8
+
   KGue/BFb67KflqyApPmPeb3Vdd9clspzqeFqp7cUBMEpFS6LWxy4Gk+qvFFJBJLB
+
   BUHE/LZVJMVzfpC5Uq+QmY7B+FH/QqNndn3tOHgsPadLTNimuB1sCuL1a4z3Pepd
+
   TeLBEFmEao5Dk3K/Q8o8vlbIB/jBDTUx6Djbgxw77909x6gI9doU4LD5XMcCAwEA
+
   AaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJeoGkOr9l4B
+
   +saMkW/ZXT4UeSvVMA0GCSqGSIb3DQEBBQUAA4IBAQBG2KObvYI2eHyyBUJSJ3jN
+
   vEnU3d60znAXbrSd2qb3r1lY1EPDD3bcy0MggCfGdg3Xu54z21oqyIdk8uGtWBPL
+
   HIa9EgfFGSUEgvcIvaYqiN4jTUtidfEFw+Ltjs8AP9gWgSIYS6Gr38V0WGFFNzIH
+
   aOD2wmu9oo/RffW4hS/8GuvfMzcw7CQ355wFR4KB/nyze+EsZ1Y5DerCAagMVuDQ
+
   U0BLmWDFzPGGWlPeQCrYHCr+AcJz+NRnaHCKLZdSKj/RHuTOt+gblRex8FAh8NeA
+
   cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
+
   -----END CERTIFICATE-----
 
-date: 2011-06-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+'
+date: 2011-08-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: hoe
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70213889262460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 2
-        - 9
-        version: "2.9"
+      - !ruby/object:Gem::Version
+        version: '2.10'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889262460
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: &70213889261920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 4
-        - 2
-        version: "4.2"
+      - !ruby/object:Gem::Version
+        version: '4.2'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rcodetools
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889261920
+- !ruby/object:Gem::Dependency
+  name: rcodetools
+  requirement: &70213889261500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: hoe-mercurial
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889261500
+- !ruby/object:Gem::Dependency
+  name: hoe-mercurial
+  requirement: &70213889260960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.2.1
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: hoe-highline
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889260960
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: &70213889260380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 0
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: tidy-ext
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889260380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70213889259920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 0
-        - 1
-        version: "0.1"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889259920
+- !ruby/object:Gem::Dependency
+  name: tidy-ext
+  requirement: &70213889259400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 4
-        version: "2.4"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *70213889259400
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70213889258840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 2
-        - 9
-        - 4
-        version: 2.9.4
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
   type: :development
-  version_requirements: *id008
-description: |-
-  A manual-generation plugin for Hoe.
-  
+  prerelease: false
+  version_requirements: *70213889258840
+description: ! 'A manual-generation plugin for Hoe.
+
+
   This is a plugin for [Hoe][hoe] that adds tasks and resources for
+
   generating a manual or cookbook.
-  
-  It's self-documenting, so for more, see [the latest manual for hoe-manualgen itself][hoe-manualgen-manual].
-email: 
+
+
+  It''s self-documenting, so for more, see [the latest manual for hoe-manualgen itself][hoe-manualgen-manual].'
+email:
 - ged@FaerieMUD.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - data/hoe-manualgen/lib/api-filter.rb
 - data/hoe-manualgen/lib/editorial-filter.rb
 - data/hoe-manualgen/lib/examples-filter.rb
 - data/hoe-manualgen/lib/links-filter.rb
-files: 
+files:
 - .autotest
 - History.md
 - README.md
@@ -218,40 +196,30 @@ files:
 - data/hoe-manualgen/src/index.page.erb
 - lib/hoe/manualgen.rb
 homepage: http://deveiate.org/hoe-manualgen.html
-licenses: 
+licenses:
 - BSD
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: hoe-manualgen
-rubygems_version: 1.8.4
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A manual-generation plugin for Hoe
 test_files: []
-