html_toc 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a29233f8816b3ee12494fea882d296d3541315f
-  data.tar.gz: 1ef8af28f0c1c7ffd80f07dd344abad4a63da1a9
+  metadata.gz: b307e27db1ddd1187a5b57fbbbb73f631d454c55
+  data.tar.gz: f633df32057c695f0746466703d94c8b5262d1f0
 SHA512:
-  metadata.gz: 9ce2bc271cc049d832a6ac0c5ce2104f4cd7703de9b5a71884f67272f81d2316746e69d0dfc4021c6e74d31cc9e9295cbff81f2c62d61c58fb6433655aac4717
-  data.tar.gz: 05aa67dec91573dab6b1ac296589f6ddb4bf838bdab2156a4c900d089c24d37d96f669956f5c6fab229d39a329bca1a0c0742db47c464b3f7dd87eb9a873f7ca
+  metadata.gz: a0d6218b679c46bc1e802116b44899a2df27331702d6d50e6d161fdc5b1f8edaf9f20b337e1a6e28ea2d3fb095a951b62fa1a90baa269629d38ee3d8303c23cb
+  data.tar.gz: 88b0c8acb1abc416f8091f74f7b0b648973f81802ed0126f14f28697e69bfc7aa101e05159e249e79f06718f26f22dfe38b20e301c37582c9c54c3f08c982a93

data/README.md

@@ -8,11 +8,11 @@ HtmlToc is a Ruby module that post-processes an HTML document to built a table o
 
 The gem consists of a single module, <span style="color:#009900;">HtmlToc</span>, which exposes a single public method, <span style="color:#009900;">process</span>. 
 
-<span style="color:#009900;">#process</span> starts by performing a case-insensitive search for a token, **\[\[toc\]\]**. If no token is found, the unmodified source text is return. 
+<span style="color:#009900;">#process</span> starts by performing a case-insensitive search for a pseudo-tag, **&lt;toc /&gt;**. If it is found, the unmodified source text is return. 
 
-If the token is found, <span style="color:#009900;">#process</span> scans for header tags falling within a provided range; if the header does not already have an id attribute, one is added. If no matching headers are found, the token is removed and the modified source text is returned.
+If the tag is found, <span style="color:#009900;">#process</span> scans for header tags falling within a provided range. If a matching header does not already have an id attribute, one is added. If no matching headers are found, the **&lt;toc /&gt;** pseudo-tag is removed and the modified source text is returned.
 
-If headers are found, a link is generated for each matching header. The link text is taken from the header text, and the link's href points to the header's id. Each link wrapped in a div tag; the div is given a class name that matches is level relative to the search range. The link divs are wrapped in a few more divs with unique ids to create the table of contents. Lastly, the table of contents replaces the token and the modified source is returned. The classes and id allow the page to be styled in accordance with the website's design context. The resulting table of contents might look like this:
+If headers are found, a link is generated for each matching header. The link text is taken from the header text, and the link's href points to the header's id. Each link wrapped in a div tag; the div is given a class name that matches is level relative to the search range. The link divs are wrapped in a few more divs with unique ids to create the table of contents. Lastly, the table of contents replaces the **&lt;toc /&gt;** pseudo-tag and the modified source is returned. The classes and id allow the page to be styled to match the website's design context. The resulting table of contents might look like this:
 
 <div style="border:solid 1px #000000;margin-left:1em;">
 
@@ -40,7 +40,7 @@ If headers are found, a link is generated for each matching header. The link tex
 
 >**source** is a string holding the HTML source.
 
->**h_tags** is a range of integers giving the indexes of the header tags that will be used to the table of contents. The method iterates through it to build the regular expression <span style="color:#800000;">/&lt;h#{x}(?: .\*?)?&gt;(.\*?)&lt;\/h#{x}&gt;/</span>. 
+>**h_tags** is a range of integers giving the indexes of the header tags that will be used to the table of contents. The method iterates through it to build the regular expression <span style="color:#800000;">/&lt;h#{x}(?: .\*?)?&gt;(.\*?)&lt;\/h#{x}&gt;/i</span>. 
 
 >**show_toggle** flags whether or not to include a toggle button in the table of contents header. The span is programmed to call a Javascript method, ShowHideToc(). The implementing script is *not* included: it must be supplied by the programmer.
 
@@ -68,6 +68,7 @@ See **sample/html_toc.js** for the Javascript to toggle visibility of the table
 
 ##Change log
 
+**1.2** - Fixed some issues where matches were not case insensitive, and change the table of contents indicator from a keyword token to a pseudo-tag.
 **1.1** - Added keyword arguments.
 **1.0** - Initial deployment.
 

data/lib/html_toc.rb

@@ -6,7 +6,7 @@ module HtmlToc
 	def self.process(source:, h_tags: Range.new(2, 6), show_toggle: false, use_numbers: false)
 
 		#Search regex for {{toc}}
-		token = /\[\[[tT][oO][cC]\]\]/
+    token = /<toc\s*\/>|\[\[toc\]\]/i #Allow for a token of either <toc/> or [[toc]]
 
  		#If there is no token, just return the source
 		if source !~ token then 
@@ -36,7 +36,7 @@ module HtmlToc
 			depth += 1
 
 			#Regex for indexed header tags
-			test = /<h#{x}(?: .*?)?>(.*?)<\/h#{x}>/
+			test = /<h#{x}(?: .*?)?>(.*?)<\/h#{x}>/i
 		
 			#Scan, and use the resulting MatchData objects 
 			#to populate the hash
@@ -134,7 +134,7 @@ private
 			@end_index = md.end(0)
 
 			#If the tag does not have an ID, give it one
-			tag_id = @text.match(/\bid(\s*?)=(\s*?)(["'])(.*?)\3/)
+			tag_id = @text.match(/\bid(\s*?)=(\s*?)(["'])(.*?)\3/i)
 			if tag_id == nil 
 				@@unique_id += 1
 				id = " id='_id__#{@@unique_id}'"
@@ -145,7 +145,7 @@ private
 
 		def id
 			#TODO Allow for undelimited attribute values, as in HTML5
-			tag_id = @text.match(/\bid(\s*?)=(\s*?)(["'])(.*?)\3/)
+			tag_id = @text.match(/\bid(\s*?)=(\s*?)(["'])(.*?)\3/i)
 
 			if tag_id == nil 
 				""

metadata

@@ -1,26 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: html_toc
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Gregory Gadow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-27 00:00:00.000000000 Z
 dependencies: []
 description: "This gem is intended to be used in Rails pre-processing, after the page
   has been generated but before it is delivered to the requestor. \n\nIt does a case-insensitive
-  search in the source text for [[toc]], which marks where the table of contents will
-  be placed. If the token is not found, the unmodified source is returned.\n\nIf the
-  token is found, it searches the text for header tags in a given range, and add an
-  id attribute if the header does not already have one. If no headers were found,
-  it will remove the token and return the modified source. \n\nIf there are headers,
+  search in the source text for the pseudo-tag <toc />, which marks where the table
+  of contents will be placed. If the tag is not found, the unmodified source is returned.\n\nIf
+  the tag is found, it searches the text for header tags in a given range, and add
+  an id attribute if the header does not already have one. If no headers were found,
+  it will remove the tag and return the modified source. \n\nIf there are headers,
   a link is generated for each one, using the header's text and id for the link's
   text and href. The links are wrapped in some divs, with classes and ids added so
-  the table of contents can be styled. The token is then replaced with the table of
-  contents, and the the modified source is returned.\n"
+  the table of contents can be styled. The <toc /> pseudo-tag is then replaced with
+  the table of contents, and the the modified source is returned.\n"
 email: gpg@gregory-gadow.net
 executables: []
 extensions: []