tagtreescanner 0.8.0 → 0.8.1

data/HISTORY

@@ -1,3 +1,7 @@
+== 0.8.1 / 2007-November-25
+
+* Fixed test_simplemarkup.rb to actually, you know, test something.
+
 == 0.8.0 / 2007-November-25
 
 * First release as a gem. Breaks backwards compatibility with older versions.

data/Manifest.txt

@@ -1,6 +1,6 @@
 HISTORY
 Manifest.txt
-README
+README.txt
 Rakefile
 TODO
 lib/tagtreescanner.rb

data/{README → README.txt}

@@ -1,18 +1,16 @@
-<b>TagTreeScanner</b>
-
+= TagTreeScanner
 Author::     Gavin Kistner  (mailto:phrogz@mac.com)
 Copyright::  Copyright (c)2005-2007 Gavin Kistner
 License::    MIT License
-Version::    0.8.0 (2007-November-24)
-
-= Overview
+Version::    0.8.1 (2007-November-25)
 
+== Overview
 The TagTreeScanner class provides a generic framework for creating a
 nested hierarchy of tags and text (like XML or HTML) by parsing text. An
 example use (and the reason it was written) is to convert a wiki markup
 syntax into HTML.
 
-= Example Usage
+== Example Usage
   require 'tagtreescanner'
 
   class SimpleMarkup < TagTreeScanner
@@ -90,10 +88,10 @@ syntax into HTML.
   #=> end</preformatted>
   #=> <paragraph><italic>That, as they say, is that.</italic></paragraph>
 
-= Details
+== Details
 
-== TagFactories at 10,000 feet
-  Each possible output tag is described by a TagFactory, which specifies
+=== TagFactories at 10,000 feet
+Each possible output tag is described by a TagFactory, which specifies
 some or all of the following:
 * The name of the tags it creates <i>(required)</i>
 * The regular expression to look for to start the tag
@@ -105,7 +103,7 @@ some or all of the following:
 
 See the TagFactory class for more information on specifying factories.
 
-== Genres as a State Machine
+=== Genres as a State Machine
 As a new tag is opened, the scanner uses the Tag#allowed_genre property
 of that tag (set by the +allowed_genre+ property on the TagFactory) to
 determine which tags to be looking for. A genre is specified by adding
@@ -122,7 +120,7 @@ for</b>. For example:
 Note that the +close_match+ regular expression of the current tag is
 always checked before looking to open/create any new tags.
 
-== Consuming Text
+=== Consuming Text
 As the text is being parsed, there will (probably) be many cases where
 you have raw text that doesn't close or open any new tags. Whenever the
 scanner reaches this state, it runs the <tt>@text_match</tt> regexp
@@ -150,7 +148,7 @@ a tag factory set to look for "Hvv2vvO" to indicate a subscripted '2',
 the entire string would be eaten as text and the subscript tag would
 never start.
 
-== Using the Scanner
+=== Using the Scanner
 As shown in the example above, consumers of your class initialize it by
 passing in the string to be parsed, and then calling #to_xml or #to_html
 on it.
@@ -161,11 +159,11 @@ replacing special command tags with other input, or performing database
 lookups on special wiki-page-link tags and replacing with HTML
 anchors.)</i>
 
-= Requirements
+== Requirements
 TagTreeScanner is built on top of the StringScanner library that is part
 of the standard Ruby installation.
 
-= License
+== License
 
 (The MIT License)
 

data/Rakefile

@@ -10,7 +10,7 @@ Hoe.new('tagtreescanner', TagTreeScanner::VERSION) do |p|
   p.email  = 'phrogz@mac.com'
   p.url         = ''
   p.summary = 'Meta library for creating classes that turn custom text markup into XML-like tag hierarchies.'
-  p.description = IO.read( 'README' )[ /= Overview\n(.+?)^=/m, 1 ].rstrip
+  p.description = IO.read( 'README.txt' )[ /= Overview\n(.+?)^=/m, 1 ].rstrip
   p.changes     = IO.read( 'HISTORY' )[ /^=[^\n]+\n+(.+?)^=/m, 1 ].rstrip
   p.remote_rdoc_dir = ''
 end

data/lib/tagtreescanner.rb

@@ -5,7 +5,7 @@
 # Author::     Gavin Kistner  (mailto:phrogz@mac.com)
 # Copyright::  Copyright (c)2005-2007 Gavin Kistner
 # License::    MIT License
-# Version::    0.8.0 (2007-November-24)
+# Version::    0.8.1 (2007-November-25)
 
 require 'strscan'
 
@@ -15,157 +15,9 @@ require 'strscan'
 # example use (and the reason it was written) is to convert a wiki markup
 # syntax into HTML.
 #
-# = Example Usage
-#   require 'TagTreeScanner'
-#
-#   class SimpleMarkup < TagTreeScanner
-#      @root_factory.allows_text = false
-#
-#      @tag_genres[ :root ] = [ ]
-#
-#      @tag_genres[ :root ] << TagFactory.new( :paragraph,
-#         # A line that doesn't have whitespace at the start
-#         :open_match => /(?=\S)/, :open_requires_bol => true,
-#
-#         # Close when you see a double return
-#         :close_match => /\n[ \t]*\n/,
-#         :allows_text => true,
-#         :allowed_genre => :inline
-#      )
-#
-#      @tag_genres[ :root ] << TagFactory.new( :preformatted,
-#         # Grab all lines that are indented up until a line that isn't
-#         :open_match => /((\s+).+?)\n+(?=\S)/m, :open_requires_bol => true,
-#         :setup => lambda{ |tag, scanner, tagtree|
-#            # Throw the contents I found into the tag
-#            # but remove leading whitespace
-#            tag << scanner[1].gsub( /^#{scanner[2]}/, '' )
-#         },
-#         :autoclose => :true
-#      )
-#
-#      @tag_genres[ :inline ] = [ ]
-#
-#      @tag_genres[ :inline ] << TagFactory.new( :bold,
-#         # An asterisk followed by a letter or number
-#         :open_match => /\*(?=[a-z0-9])/i,
-#
-#         # Close when I see an asterisk OR a newline coming up
-#         :close_match => /\*|(?=\n)/,
-#         :allows_text => true,
-#         :allowed_genre => :inline
-#      )
-#
-#      @tag_genres[ :inline ] << TagFactory.new( :italic,
-#         # An underscore followed by a letter or number
-#         :open_match => /_(?=[a-z0-9])/i,
-#
-#         # Close when I see an underscore OR a newline coming up
-#         :close_match => /_|(?=\n)/,
-#         :allows_text => true,
-#         :allowed_genre => :inline
-#      )
-#   end
-#
-#   raw_text = <<ENDINPUT
-#   Hello World! You're _soaking in_ my test.
-#   This is a *subset* of markup that I allow.
-#
-#   Hi paragraph two. Yo! A code sample:
-#
-#     def foo
-#       puts "Whee!"
-#     end
-#
-#   _That, as they say, is that._
-#
-#   ENDINPUT
-#
-#   markup = SimpleMarkup.new( raw_text ).to_xml
-#   puts markup
-#
-#
-#   #=> <paragraph>Hello World! You're <italic>soaking in</italic> my test.
-#   #=> This is a <bold>subset</bold> of markup that I allow.</paragraph>
-#   #=> <paragraph>Hi paragraph two. Yo! A code sample:</paragraph>
-#   #=> <preformatted>def foo
-#   #=>   puts "Whee!"
-#   #=> end</preformatted>
-#   #=> <paragraph><italic>That, as they say, is that.</italic></paragraph>
-#
-#
-# = Details
-#
-# == TagFactories at 10,000 feet
-# Each possible output tag is described by a TagFactory, which specifies
-# some or all of the following:
-# * The name of the tags it creates <i>(required)</i>
-# * The regular expression to look for to start the tag
-# * The regular expression to look for to close the tag, or
-# * Whether the tag is automatically closed after creation
-# * What genre of tags are allowed within the tag
-# * Whether the tag supports raw text inside it
-# * Code to run when creating a tag
-#
-# See the TagFactory class for more information on specifying factories.
-#
-# == Genres as a State Machine
-# As a new tag is opened, the scanner uses the Tag#allowed_genre property
-# of that tag (set by the +allowed_genre+ property on the TagFactory) to
-# determine which tags to be looking for. A genre is specified by adding
-# an array in the <tt>@tag_genres</tt> hash, whose key is the genre name.
-# For example:
-#   @tag_genres[ :inline ] = [ ]
-# adds a new genre named 'inline', with no tags in it. TagFactory instances
-# should be pushed onto this array <b>in the order that they should be looked
-# for</b>. For example:
-#   @tag_genres[ :inline ] << TagFactory.new( :italic,
-#     # see the TagFactory#initialize for options
-#   )
-#
-# Note that the +close_match+ regular expression of the current tag is
-# always checked before looking to open/create any new tags.
-#
-# == Consuming Text
-# As the text is being parsed, there will (probably) be many cases where
-# you have raw text that doesn't close or open any new tags. Whenever the
-# scanner reaches this state, it runs the <tt>@text_match</tt> regexp
-# against the text to move the pointer ahead. If the current tag has
-# <tt>Tag#allows_text?</tt> set to +true+ (through
-# <tt>TagFactory#allows_text</tt>), then this text is added as contents of
-# the tag. If not, the text is thrown away.
-#
-# The safest regular expression consumes only one character at a time:
-#   @text_match = /./m
-#
-# <b><i>It is vital that your regexp match newlines</i></b> (the 'm')
-# <b><i>unless every single one of your tags is set to close upon seeing
-# a newline.</i></b>
-#
-# Unfortunately, the safest regular expression is also the slowest. If
-# speed is an issue, your regexp should strive to eat as many characters as
-# possible at once...while ensuring that it doesn't eat characters that
-# would signify the start of a new tag.
-#
-# For example, setting a regexp like:
-#   @text_match = /\w+|./m
-# allows the scanner to match a whole word at a time. However, if you have
-# a tag factory set to look for "Hvv2vvO" to indicate a subscripted '2',
-# the entire string would be eaten as text and the subscript tag would
-# never start.
-#
-# == Using the Scanner
-# As shown in the example above, consumers of your class initialize it by
-# passing in the string to be parsed, and then calling #to_xml or #to_html
-# on it.
-#
-# <i>(This two-step process allows the consumer to run other code after
-# the tag parsing, before final conversion. Examples might include
-# replacing special command tags with other input, or performing database
-# lookups on special wiki-page-link tags and replacing with HTML
-# anchors.)</i>
+# See the link:README.txt.html file for examples and more information.
 class TagTreeScanner
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 
   # A TagFactory holds the information about a specific kind of tag:
   # * the name of the tag
@@ -536,8 +388,8 @@ class TagTreeScanner
       end
     end
     
-    # Set the text content of this element to _new_contents_
-    # Removes any child tags (and their text)
+    # Set the text content of this element to _new_contents_.
+    # Removes any child tags (and their text).
     def text=( new_contents )
       @child_tags.clear
       append_child( TextNode.new( new_contents ) )

data/test/test_simplemarkup.rb

@@ -55,30 +55,21 @@ class Tag_Test < Test::Unit::TestCase
   end
 
   def test_conversion
-    raw_text = <<-ENDINPUT
-    Hello World! You're _soaking in_ my test.
-    This is a *subset* of markup that I allow.
+    raw_text = <<ENDINPUT
+Hello World! You're _soaking in_ my test.
+This is a *subset* of markup that I allow.
 
-    Hi paragraph two. Yo! A code sample:
+Hi paragraph two. Yo! A code sample:
 
-      def foo
-        puts "Whee!"
-      end
-
-    _That, as they say, is that._
+  def foo
+    puts "Whee!"
+  end
 
-    ENDINPUT
+_That, as they say, is that._
+ENDINPUT
 
     markup = SimpleMarkup.new( raw_text ).to_xml
-    p '',markup
+    expected = "<paragraph>Hello World! You're <italic>soaking in</italic> my test.\nThis is a <bold>subset</bold> of markup that I allow.</paragraph>\n<paragraph>Hi paragraph two. Yo! A code sample:</paragraph>\n<preformatted>\ndef foo\n  puts \"Whee!\"\nend</preformatted>\n<paragraph><italic>That, as they say, is that.</italic>\n</paragraph>\n"
+    assert_equal( expected, markup )
   end
 end
-
-
-#=> <paragraph>Hello World! You're <italic>soaking in</italic> my test.
-#=> This is a <bold>subset</bold> of markup that I allow.</paragraph>
-#=> <paragraph>Hi paragraph two. Yo! A code sample:</paragraph>
-#=> <preformatted>def foo
-#=>   puts "Whee!"
-#=> end</preformatted>
-#=> <paragraph><italic>That, as they say, is that.</italic></paragraph>

data/test/test_tagtreescanner.rb

@@ -1,5 +1,5 @@
 require "test/unit"
-require "../lib/tagtreescanner"
+require "../lib/tagtreescanner.rb"
 
 class Tag_Test < Test::Unit::TestCase
   def setup

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: tagtreescanner
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.1
 date: 2007-11-25 00:00:00 -07:00
 summary: Meta library for creating classes that turn custom text markup into XML-like tag hierarchies.
 require_paths: 
@@ -31,7 +31,7 @@ authors:
 files: 
 - HISTORY
 - Manifest.txt
-- README
+- README.txt
 - Rakefile
 - TODO
 - lib/tagtreescanner.rb
@@ -45,6 +45,7 @@ rdoc_options:
 - README.txt
 extra_rdoc_files: 
 - Manifest.txt
+- README.txt
 executables: []
 
 extensions: []