WikiCreole 0.1.2 → 0.1.3

data/Changelog

@@ -1,3 +1,12 @@
+2009-02-05 (0.1.3)
+  * nono on github made the Ruby more idiomatic and fixed a section
+    which had eluded Gordon earlier.  He also added profiling, which
+    can be run using "rake profiling" then opening profiling.html
+    in a browser.
+  * Raphael Knaus found an infinite loop error while parsing a nested
+    list.  He provided a quick fix, but both he and I are dissatisfied
+    by the current workaround.
+    
 2008-12-12 (0.1.2)
   * Made the usage more clear by adding the "require 'rubygems'" before
     the require 'wiki_creole' command

data/Rakefile

@@ -14,4 +14,10 @@ Rake::TestTask.new(:test_all) do |t|
   t.libs << 'lib'
   t.warning = true
   t.test_files = FileList['test/test_all.rb']
+end
+
+Rake::TestTask.new(:profiling) do |t|
+  t.libs << 'lib'
+  t.warning = true
+  t.test_files = FileList['test/profiling.rb']
 end

data/lib/wiki_creole.rb

@@ -1,12 +1,12 @@
-# WikiCreole implements the Wiki Creole markup language, 
+# WikiCreole implements the Wiki Creole markup language,
 # version 1.0, as described at http://www.wikicreole.org.  It
 # reads Creole 1.0 markup and returns XHTML.
 #
 # Author::    Gordon McCreight  (mailto:wikicreole.to.gordon@mccreight.com)
 # Copyright:: Copyright (c) 2008 Gordon McCreight
 # License::   Distributes under the same terms as Ruby (see the LICENSE file)
-# Version:: 0.1.2
-# Date:: 2008-12-12
+# Version:: 0.1.3
+# Date:: 2009-02-05
 #
 # == Synopsis
 # Most likely you'll just want to do:
@@ -18,7 +18,7 @@
 #
 # == Official Markup
 #
-#  Here is a summary of the official Creole 1.0 markup 
+#  Here is a summary of the official Creole 1.0 markup
 #  elements.  See http://www.wikicreole.org for the full
 #  details.
 #
@@ -62,7 +62,7 @@
 #  ~** not bold **    ->    ** not bold **
 #  tilde: ~~          ->    tilde: ~
 #
-#  Paragraphs are separated by other blocks and blank lines.  
+#  Paragraphs are separated by other blocks and blank lines.
 #  Inline markup can usually be combined, overlapped, etc.  List
 #  items and plugin text can span lines.
 #
@@ -104,7 +104,7 @@
 # converter which can be found here:
 # http://search.cpan.org/~jburnett/Text-WikiCreole/
 # He, in turn, acknowledges the Document::Parser perl module.
-# 
+#
 # Also, some of the tests are taken from Lars Christensen's implementation of
 # the Creole parser.  You can find his code at:
 # http://github.com/larsch/creole/tree/master
@@ -113,83 +113,67 @@
 # http://www.wikicreole.org/
 
 class WikiCreole
-  
+
   # Reads Creole 1.0 markup and return XHTML.
   #
   # xhtml = WikiCreole.creole_parse(wiki_creole_markup)
   def self.creole_parse(s)
-    return "" if s.class.to_s != "String"
-    return "" if s.length < 1
+    return "" unless String === s
+    return "" if s.empty?
 
     init
-    return parse(s, :top)
+    parse(s, :top)
   end
-  
+
   # Creole 1.0 supports two plugin syntaxes: << plugin content >> and
   # <<< plugin content >>>
-  # 
-  # Write a function that receives the text between the <<>> 
-  # delimiters (not including the delimiters) and 
-  # returns the text to be displayed.  For example, here is a 
+  #
+  # Write a function that receives the text between the <<>>
+  # delimiters (not including the delimiters) and
+  # returns the text to be displayed.  For example, here is a
   # simple plugin that converts plugin text to uppercase:
   #
-  #  uppercase = Proc.new {|s| 
-  #    s.upcase!
-  #    s
-  #  }
-  #  WikiCreole.creole_plugin(uppercase)
+  #  WikiCreole.creole_plugin {|s| s.upcase }
   #
   # If you do not register a plugin function, plugin markup will be left
   # as is, including the surrounding << >>.
-  def self.creole_plugin(func)
-    @plugin_function = func
+  def self.creole_plugin(&blk)
+    @plugin_function = blk
   end
 
   # You may wish to customize [[ links ]], such as to prefix a hostname,
   # port, etc.
   #
   # Write a function, similar to the plugin function, which receives the
-  # URL part of the link (with leading and trailing whitespace stripped) 
-  # and returns the customized link.  For example, to prepend 
+  # URL part of the link (with leading and trailing whitespace stripped)
+  # and returns the customized link.  For example, to prepend
   #  http://my.domain/
   # to pagename:
   #
-  #  mylink = Proc.new {|s| 
-  #    s = "http://my.domain/" + s
-  #    s
-  #  }
-  #  WikiCreole.creole_link(mylink)
-  def self.creole_link(func)
-    @link_function = func
+  #  WikiCreole.creole_link {|s| "http://my.domain/#{s}" }
+  def self.creole_link(&blk)
+    @link_function = blk
   end
-  
+
   # Same purpose as creole_link, but for "bare" link markup.  Bare links are
   # the links which are in the text but not surrounded by brackets.
   #
-  #  mybarelink = Proc.new {|s| 
-  #    s = s + ".html"
-  #    s
-  #  }
-  #  WikiCreole.creole_barelink(mybarelink)
-  def self.creole_barelink(func)
-    @barelink_function = func
+  #  WikiCreole.creole_barelink {|s| "#{s}.html" }
+  def self.creole_barelink(&blk)
+    @barelink_function = blk
   end
 
   # Same purpose as creole_link, but for image URLs.
   #
-  #  myimg = Proc.new {|s| 
-  #    s = "http://my.domain/" + s
-  #    s
-  #  }
-  #  WikiCreole.creole_img(myimg)
-  def self.creole_img(func)
-    @img_function = func
+  #  WikiCreole.creole_img {|s| "http://my.domain/#{s}" }
+  def self.creole_img(&blk)
+    @img_function = blk
   end
-  
+
   # If you want complete control over links, rather than just modifying
   # the URL, register your link markup function with WikiCreole.creole_link()
   # as above and then call creole_customlinks().  Now your function will receive
-  # the entire link markup chunk, such as <tt>[[ some_wiki_page | page description ]]</tt> 
+  # the entire link markup chunk, such as <tt>[[ some_wiki_page | page description ]]</tt>
   # and must return HTML.
   #
   # This has no effect on "bare" link markup, such as
@@ -200,10 +184,8 @@ class WikiCreole
     @@chunks_hash[:link][:open] = ""
     @@chunks_hash[:link][:close] = ""
     @@chunks_hash[:link].delete(:contains)
-    @@chunks_hash[:link][:filter] = Proc.new {|s| 
-      if @link_function
-        s = @link_function.call(s)
-      end
+    @@chunks_hash[:link][:filter] = Proc.new {|s|
+      s = @link_function.call(s) if @link_function
       s
     }
   end
@@ -212,10 +194,8 @@ class WikiCreole
   def self.creole_custombarelinks
     @@chunks_hash[:ilink][:open] = ""
     @@chunks_hash[:ilink][:close] = ""
-    @@chunks_hash[:ilink][:filter] = Proc.new {|s| 
-      if @barelink_function
-        s = @barelink_function.call(s)
-      end
+    @@chunks_hash[:ilink][:filter] = Proc.new {|s|
+      s = @barelink_function.call(s) if @barelink_function
       s
     }
   end
@@ -225,28 +205,23 @@ class WikiCreole
     @@chunks_hash[:img][:open] = ""
     @@chunks_hash[:img][:close] = ""
     @@chunks_hash[:img].delete(:contains)
-    @@chunks_hash[:img][:filter] = Proc.new {|s| 
-      if @img_function
-        s = @img_function.call(s)
-      end
+    @@chunks_hash[:img][:filter] = Proc.new {|s|
+      s = @img_function.call(s) if @img_function
       s
     }
   end
-  
+
   # You may wish to customize the opening and/or closing tags
   # for the various bits of Creole markup.  For example, to
   # assign a CSS class to list items:
   #  WikiCreole.creole_tag(:li, :open, "<li class=myclass>")
   #
-  # Or to see all current tags:
-  #  puts WikiCreole.creole_tag()
-  #
   # The tags that may be of interest are:
   #
   #  br          dd          dl
   #  dt          em          h1
   #  h2          h3          h4
-  #  h5          h6          hr 
+  #  h5          h6          hr
   #  ilink       img         inowiki
   #  ip          li          link
   #  mono        nowiki      ol
@@ -258,71 +233,68 @@ class WikiCreole
   # Those should be self-explanatory, except for inowiki (inline nowiki),
   # ilink (bare links, e.g.
   #  http://www.cpan.org
-  # and ip (indented paragraph).
-  def self.creole_tag(*args)
-    
-    # I bet a good Ruby hacker would know a way around this little chunk...
-    tag = args.length > 0 ? args[0] : nil
-    type = args.length > 1 ? args[1] : nil
-    text = args.length > 2 ? args[2] : nil
-    
-    if tag.nil?
-      tags = ""
-      for key in @@chunks_hash.keys.collect{|x| x.to_s}.sort
-        key = key.to_sym
-        o = @@chunks_hash[key][:open]
-        c = @@chunks_hash[key][:close]
-        next if o.nil? || !o.index(/</m)
-        o = o.gsub(/\n/m,"\\n")
-        c = c.gsub(/\n/m,"\\n") if c
-        c = "" if c.nil?
-        this_tag = "#{key}: open(#{o}) close(#{c})\n"
-        tags += this_tag
-      end
-      return tags
-    else
-      return if ! type
-      type = type.to_sym
-      return if type != :open && type != :close
-      return if !@@chunks_hash.has_key?(tag)
-      @@chunks_hash[tag][type] = text ? text : ""
+  # ) and ip (indented paragraph).
+  def self.creole_tag(tag, type, text="")
+    type = type.to_sym
+    return unless [:open, :close].include?(type)
+    return unless @@chunks_hash.has_key?(tag)
+    @@chunks_hash[tag][type] = text
+  end
+
+  # See all current tags:
+  #  puts WikiCreole.creole_tags()
+  #
+  def self.creole_tags
+    tags = []
+    keys = @@chunks_hash.keys.collect{|x| x.to_s}.sort
+    keys.each do |key|
+      key = key.to_sym
+      o = @@chunks_hash[key][:open]  || ""
+      c = @@chunks_hash[key][:close] || ""
+      next if o !~ /</m
+      o, c = [o, c].map {|x| x.gsub(/\n/m,"\\n") }
+      this_tag = "#{key}: open(#{o}) close(#{c})\n"
+      tags << this_tag
     end
+    tags.join
   end
-  
-  private
-  
+
+private
+
   # characters that may indicate inline wiki markup
-  @@specialchars = ['^', '\\', '*', '/', '_', ',', '{', '[', 
-                    '<', '~', '|', "\n", '#', ':', ';', '(', '-', '.']
-                  
-  # plain characters - auto-generated below (ascii printable minus @specialchars)
-  @@plainchars = []
+  SPECIALCHARS = ['^', '\\', '*', '/', '_', ',', '{', '[',
+                  '<', '~', '|', "\n", '#', ':', ';', '(', '-', '.']
+
+  # plain characters
+  # build an array of "plain content" characters by subtracting SPECIALCHARS
+  # from ascii printable (ascii 32 to 126)
+  PLAINCHARS   = (32..126).map{|c| c.chr}.reject{|c| SPECIALCHARS.index(c)}
 
   # non-plain text inline widgets
-  @@inline = %w{strong em br esc img link ilink inowiki
-                sub sup mono u plug plug2 tm reg copy ndash ellipsis amp}
-            
-  @@all_inline = [@@inline, 'plain', 'any'].flatten # including plain text
+  INLINE       = %w{strong em br esc img link ilink inowiki
+                    sub sup mono u plug plug2 tm reg copy ndash ellipsis amp}
+
+  ALL_INLINE   = [INLINE, 'plain', 'any'].flatten # including plain text
+
+  BLOCKS       = %w{h1 h2 h3 hr nowiki h4 h5 h6 ul ol table p ip dl plug plug2 blank}
 
-  @@blocks = %w{h1 h2 h3 hr nowiki h4 h5 h6 ul ol table p ip dl plug plug2 blank}
-  
   # handy - used several times in %chunks
-  @@eol = '(?:\n|$)'; # end of line (or string)
-  
+  EOL = '(?:\n|$)'.freeze # end of line (or string)
+
   @plugin_function = nil
   @barelink_function = nil
   @link_function = nil
   @img_function = nil
-  
+
   @is_initialized = false
 
   @@chunks_hash = {
     :top => {
-       :contains => @@blocks,
+       :contains => BLOCKS,
     },
     :blank => {
-      :curpat => "(?= *#{@@eol})",
-      :fwpat => "(?=(?:^|\n) *#{@@eol})",
+      :curpat => "(?= *#{EOL})",
+      :fwpat => "(?=(?:^|\n) *#{EOL})",
       :stops => '(?=\S)',
       :hint => ["\n"],
       :filter => Proc.new { "" }, # whitespace into the bit bucket
@@ -331,8 +303,8 @@ class WikiCreole
     :p => {
       :curpat => '(?=.)',
       :stops => ['blank', 'ip', 'h', 'hr', 'nowiki', 'ul', 'ol', 'dl', 'table'],
-      :hint => @@plainchars,
-      :contains => @@all_inline,
+      :hint => PLAINCHARS,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s| s.chomp },
       :open => "<p>", :close => "</p>\n\n",
     },
@@ -362,7 +334,7 @@ class WikiCreole
       :fwpat => '\n(?=;)',
       :stops => '(?=:|\n)',
       :hint => [';'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s.sub!(/^;\s*/, '')
         s
@@ -372,9 +344,9 @@ class WikiCreole
     :dd => {
       :curpat => '(?=\n|:)',
       :fwpat => '(?:\n|:)',
-      :stops => '(?=:)|\n(?=;)',
+      :stops => '.(?=:)|\n(?=;)',
       :hint => [':', "\n"],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s.sub!(/(?:\n|:)\s*/m, '')
         s.sub!(/\s*$/m, '')
@@ -406,7 +378,7 @@ class WikiCreole
       :curpat => '(?=\|[^=])',
       # this gnarly regex fixes ambiguous '|' for links/imgs/nowiki in tables
       :stops => '[^~](?=\|(?!(?:[^\[]*\]\])|(?:[^\{]*\}\})))',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :hint => ['|'],
       :filter => Proc.new {|s|
         s.sub!(/^ *\| */, '')
@@ -419,7 +391,7 @@ class WikiCreole
       :curpat => '(?=\|=)',
       # this gnarly regex fixes ambiguous '|' for links/imgs/nowiki in tables
       :stops => '[^~](?=\|(?!(?:[^\[]*\]\])|(?:[^\{]*\}\})))',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :hint => ['|'],
       :filter => Proc.new {|s|
         s.sub!(/^ *\|= */, '')
@@ -462,13 +434,13 @@ class WikiCreole
         s.chomp!
         s
       },
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "    <li>", :close => "</li>\n",
     },
     :nowiki => {
       :curpat => '(?=\{\{\{ *\n)',
       :fwpat => '\n(?=\{\{\{ *\n)',
-      :stops => "\n\\}\\}\\} *#{@@eol}",
+      :stops => "\n\\}\\}\\} *#{EOL}",
       :hint => ['{'],
       :filter => Proc.new {|s|
         s[0,3] = ''
@@ -481,19 +453,19 @@ class WikiCreole
       :open => "<pre>", :close => "</pre>\n\n",
     },
     :hr => {
-      :curpat => "(?= *-{4,} *#{@@eol})",
-      :fwpat => "\n(?= *-{4,} *#{@@eol})",
+      :curpat => "(?= *-{4,} *#{EOL})",
+      :fwpat => "\n(?= *-{4,} *#{EOL})",
       :hint => ['-', ' '],
-      :stops => @@eol,
+      :stops => EOL,
       :open => "<hr />\n\n", :close => "",
       :filter => Proc.new { "" } # ----- into the bit bucket
     },
     :h => { :curpat => '(?=(?:^|\n) *=)' }, # matches any heading
     :h1 => {
       :curpat => '(?= *=[^=])',
-      :hint => ['=', ' '], 
+      :hint => ['=', ' '],
       :stops => '\n',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "<h1>", :close => "</h1>\n\n",
       :filter => Proc.new {|s|
         s = strip_leading_and_trailing_eq_and_whitespace(s)
@@ -502,9 +474,9 @@ class WikiCreole
     },
     :h2 => {
       :curpat => '(?= *={2}[^=])',
-      :hint => ['=', ' '], 
+      :hint => ['=', ' '],
       :stops => '\n',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "<h2>", :close => "</h2>\n\n",
       :filter => Proc.new {|s|
         s = strip_leading_and_trailing_eq_and_whitespace(s)
@@ -513,9 +485,9 @@ class WikiCreole
     },
     :h3 => {
       :curpat => '(?= *={3}[^=])',
-      :hint => ['=', ' '], 
+      :hint => ['=', ' '],
       :stops => '\n',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "<h3>", :close => "</h3>\n\n",
       :filter => Proc.new {|s|
         s = strip_leading_and_trailing_eq_and_whitespace(s)
@@ -524,9 +496,9 @@ class WikiCreole
     },
     :h4 => {
       :curpat => '(?= *={4}[^=])',
-      :hint => ['=', ' '], 
+      :hint => ['=', ' '],
       :stops => '\n',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "<h4>", :close => "</h4>\n\n",
       :filter => Proc.new {|s|
         s = strip_leading_and_trailing_eq_and_whitespace(s)
@@ -535,9 +507,9 @@ class WikiCreole
     },
     :h5 => {
       :curpat => '(?= *={5}[^=])',
-      :hint => ['=', ' '], 
+      :hint => ['=', ' '],
       :stops => '\n',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "<h5>", :close => "</h5>\n\n",
       :filter => Proc.new {|s|
         s = strip_leading_and_trailing_eq_and_whitespace(s)
@@ -546,9 +518,9 @@ class WikiCreole
     },
     :h6 => {
       :curpat => '(?= *={6,})',
-      :hint => ['=', ' '], 
+      :hint => ['=', ' '],
       :stops => '\n',
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :open => "<h6>", :close => "</h6>\n\n",
       :filter => Proc.new {|s|
         s = strip_leading_and_trailing_eq_and_whitespace(s)
@@ -557,13 +529,13 @@ class WikiCreole
     },
     :plain => {
       :curpat => '(?=[^\*\/_\,\^\\\\{\[\<\|])',
-      :stops => @@inline,
-      :hint => @@plainchars,
+      :stops => INLINE,
+      :hint => PLAINCHARS,
       :open => '', :close => ''
     },
     :any => { # catch-all
       :curpat => '(?=.)',
-      :stops => @@inline,
+      :stops => INLINE,
       :open => '', :close => ''
     },
     :br => {
@@ -604,7 +576,7 @@ class WikiCreole
       :filter => Proc.new {|s|
         s[0,3] = ''
         s.sub!(/\>{3}$/, '')
-        if !@plugin_function.nil?
+        if @plugin_function
           s = @plugin_function.call(s)
         else
           s = "<<<#{s}>>>"
@@ -620,7 +592,7 @@ class WikiCreole
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/\>{2}$/, '')
-        if !@plugin_function.nil?
+        if @plugin_function
           s = @plugin_function.call(s)
         else
           s = "<<#{s}>>"
@@ -640,9 +612,9 @@ class WikiCreole
       :filter => Proc.new {|s|
         s.sub!(/^\s*/, '')
         s.sub!(/\s*$/, '')
-        if !@barelink_function.nil?
+        if @barelink_function
           s = @barelink_function.call(s)
-        end  
+        end
         s = "href=\"#{s}\">#{s}"
         s
       },
@@ -657,7 +629,7 @@ class WikiCreole
         s[0,2] = ''
         s[-2,2] = ''
         s += "|#{s}" if ! s.index(/\|/) # text = url unless given
-        s      
+        s
       },
       :open => "<a ", :close => "</a>",
     },
@@ -667,7 +639,7 @@ class WikiCreole
       :filter => Proc.new {|s|
         s.sub!(/^\s*/, '')
         s.sub!(/\s*$/, '')
-        if !@link_function.nil?
+        if @link_function
           s = @link_function.call(s)
         end
         s
@@ -678,7 +650,7 @@ class WikiCreole
       :curpat => '(?=\|)',
       :stops => '\n',
       :hint => ['|'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s.sub!(/^\|\s*/, '')
         s.sub!(/\s*$/, '')
@@ -715,7 +687,7 @@ class WikiCreole
       :filter => Proc.new {|s|
         s.sub!(/^\|\s*/, '')
         s.sub!(/\s*$/, '')
-        if !@img_function.nil?
+        if @img_function
           s = @img_function.call(s)
         end
         s
@@ -726,7 +698,7 @@ class WikiCreole
       :curpat => '(?=\*\*)',
       :stops => '\*\*.*?\*\*',
       :hint => ['*'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/\*\*$/, '')
@@ -737,7 +709,7 @@ class WikiCreole
     :em => {
       # This could use a negative lookback assertion to let you know whether
       # it's part of a URL or not.  That would be helpful if the URL had been
-      # escaped.  Currently, it will just become italic after the // since 
+      # escaped.  Currently, it will just become italic after the // since
       # it didn't process the URL.
       :curpat => '(?=\/\/)',
       # Removed a negative lookback assertion (?<!:) from the Perl version
@@ -746,7 +718,7 @@ class WikiCreole
       # I had to do it.
       :stops => '\/\/.*?[^:]\/\/',
       :hint => ['/'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/\/\/$/, '')
@@ -758,7 +730,7 @@ class WikiCreole
       :curpat => '(?=\#\#)',
       :stops => '\#\#.*?\#\#',
       :hint => ['#'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/\#\#$/, '')
@@ -770,7 +742,7 @@ class WikiCreole
       :curpat => '(?=,,)',
       :stops => ',,.*?,,',
       :hint => [','],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/\,\,$/, '')
@@ -782,7 +754,7 @@ class WikiCreole
       :curpat => '(?=\^\^)',
       :stops => '\^\^.*?\^\^',
       :hint => ['^'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/\^\^$/, '')
@@ -794,7 +766,7 @@ class WikiCreole
       :curpat => '(?=__)',
       :stops => '__.*?__',
       :hint => ['_'],
-      :contains => @@all_inline,
+      :contains => ALL_INLINE,
       :filter => Proc.new {|s|
         s[0,2] = ''
         s.sub!(/__$/, '')
@@ -845,93 +817,77 @@ class WikiCreole
       :open => "", :close => "",
     },
   }
-  
+
   def self.strip_leading_and_trailing_eq_and_whitespace(s)
     s.sub!(/^\s*=*\s*/, '')
     s.sub!(/\s*=*\s*$/, '')
-    return s
+    s
   end
 
   def self.strip_list(s)
     s.sub!(/(?:`*| *)[\*\#]/, '`')
     s.gsub!(/\n(?:`*| *)[\*\#]/m, "\n`")
-    return s
+    s
   end
-  
+
   def self.filter_string_x_with_chunk_filter_y(str, chunk)
-    return @@chunks_hash[chunk][:filter].call(str)
+    @@chunks_hash[chunk][:filter].call(str)
   end
-  
+
   def self.parse(tref, chunk)
-  
+
     sub_chunk = nil
     pos = 0
     last_pos = 0
-    html = ""
+    html = []
+    first_try = true
 
     loop do
 
       if sub_chunk # we've determined what type of sub_chunk this is
-        
-        if sub_chunk == :dd
-          # Yuck... I don't exactly understand why I need this section, but
-          # without it the parser will go into an infinite loop on the :dd's in
-          # the test suite.  Please, if you're a most excellent Ruby hacker,
-          # find the issue, clean this up, and remove the comment here, m'kay?
-          
-          while tref.index(Regexp.compile('\G.*' + @@chunks_hash[sub_chunk][:delim], Regexp::MULTILINE), pos)
-            end_of_match = Regexp.last_match.end(0)
-            if end_of_match == pos
-              break
-            else
-              pos = end_of_match
-            end
-          end
 
-          if pos == last_pos
-            pos = tref.length
-          end
+        # This is a little slower than it could be.  The delim should be
+        # pre-compiled, but see the issue in the comment above.
+        if tref.index(@@chunks_hash[sub_chunk][:delim], pos)
+          pos = Regexp.last_match.end(0)
         else
-          # This is a little slower than it could be.  The delim should be
-          # pre-compiled, but see the issue in the comment above.
-          if tref.index(Regexp.compile(@@chunks_hash[sub_chunk][:delim], Regexp::MULTILINE), pos)
-            pos = Regexp.last_match.end(0)
-          else 
-            pos = tref.length
-          end
+          pos = tref.length
         end
 
-        html += @@chunks_hash[sub_chunk][:open]
+        html << @@chunks_hash[sub_chunk][:open]
 
         t = tref[last_pos, pos - last_pos] # grab the chunk
 
         if @@chunks_hash[sub_chunk].has_key?(:filter)   # filter it, if applicable
           t = @@chunks_hash[sub_chunk][:filter].call(t)
         end
-        
+
         last_pos = pos  # remember where this chunk ends (where next begins)
-        
+
         if t && @@chunks_hash[sub_chunk].has_key?(:contains)  # if it contains other chunks...
-          html += parse(t, sub_chunk)         #    recurse.
+          html << parse(t, sub_chunk)         #    recurse.
         else
-          html += t                    # otherwise, print it
+          html << t                    # otherwise, print it
         end
+
+        html << @@chunks_hash[sub_chunk][:close]       # print the close tag
         
-        html += @@chunks_hash[sub_chunk][:close]       # print the close tag
-        
+      else
+       if !first_try
+         $stderr.puts "ERROR: endless loop detected"
+         break
+       end
+       first_try = false
       end
 
-      if pos && pos == tref.length # we've eaten the whole string
-        break
-      else ## more string to come
-        sub_chunk = get_sub_chunk_for(tref, chunk, pos)
-      end
-      
+      break if pos && pos == tref.length # we've eaten the whole string
+      sub_chunk = get_sub_chunk_for(tref, chunk, pos) # more string to come
+
     end
-    
-    return html
+
+    html.join
   end
-  
+
   def self.get_sub_chunk_for(tref, chunk, pos)
 
     first_char = tref[pos, 1] # get a hint about the next chunk
@@ -949,17 +905,17 @@ class WikiCreole
         return contained_chunk.to_sym
       end
     end
-    
-    return nil
+
+    nil
   end
-  
+
   # compile a regex that matches any of the patterns that interrupt the
   # current chunk.
   def self.delim(chunk)
     chunk = @@chunks_hash[chunk]
-    if chunk[:stops].class.to_s == "Array"
+    if Array === chunk[:stops]
       regex = ''
-      for stop in chunk[:stops]
+      chunk[:stops].each do |stop|
         stop = stop.to_sym
         if @@chunks_hash[stop].has_key?(:fwpat)
           regex += @@chunks_hash[stop][:fwpat] + "|"
@@ -968,59 +924,42 @@ class WikiCreole
         end
       end
       regex.chop!
-      return regex
+      regex
     else
-      return chunk[:stops]
+      chunk[:stops]
     end
   end
-  
+
   # one-time optimization of the grammar - speeds the parser up a ton
-  def self.init 
+  def self.init
     return if @is_initialized
 
     @is_initialized = true
 
-    # build an array of "plain content" characters by subtracting @specialchars
-    # from ascii printable (ascii 32 to 126)
-    for charnum in 32..126 do
-      char = charnum.chr
-      if @@specialchars.index(char).nil?
-        @@plainchars << char
-      end
-    end
-
-    # precompile a bunch of regexes 
-    for k in @@chunks_hash.keys do
+    # precompile a bunch of regexes
+    @@chunks_hash.keys.each do |k|
       c = @@chunks_hash[k]
       if c.has_key?(:curpat)
         c[:curpatcmp] = Regexp.compile('\G' + c[:curpat], Regexp::MULTILINE)
       end
-      
+
       if c.has_key?(:stops)
-        c[:delim] = delim(k)
+        c[:delim] = Regexp.compile(delim(k), Regexp::MULTILINE)
       end
-      
+
       if c.has_key?(:contains) # store hints about each chunk to speed id
         c[:calculated_hint_array_for] = {}
-        
-        for ct in c[:contains]
+
+        c[:contains].each do |ct|
           ct = ct.to_sym
-          
-          if @@chunks_hash[ct].has_key?(:hint)
-            for hint in @@chunks_hash[ct][:hint]
-              if !c[:calculated_hint_array_for].has_key?(hint)
-                c[:calculated_hint_array_for][hint] = []
-              end
-              c[:calculated_hint_array_for][hint] << ct
-            end
+
+          (@@chunks_hash[ct][:hint] || []).each do |hint|
+            (c[:calculated_hint_array_for][hint] ||= []) << ct
           end
 
         end
       end
     end
-    
   end
-  
-  
 
-end
+end

data/test/profiling.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'wiki_creole'
+require 'ruby-prof'
+
+WikiCreole.init
+
+result = RubyProf.profile do
+  10.times do
+    %w(amp block escape inline specialchars jsp_wiki).each do |name|
+      markup = File.read("./test/test_#{name}.markup")
+      parsed = WikiCreole.parse(markup, :top)
+    end
+  end
+end
+
+printer = RubyProf::GraphHtmlPrinter.new(result)
+File.open("profiling.html", "w") do |file|
+  printer.print(file)
+end
+

data/test/test_all.rb

@@ -119,11 +119,7 @@ class TC_WikiCreole < Test::Unit::TestCase
   
   def test_user_supplied_creole_link_function
     
-    uppercase = Proc.new {|s| 
-      s.upcase!
-      s
-    }
-    WikiCreole.creole_link(uppercase)
+    WikiCreole.creole_link {|s| s.upcase }
     
     markup = "This is a paragraph with an uppercased [[ link ]].\nCheck it out."
     goodhtml = %Q{<p>This is a paragraph with an uppercased <a href="LINK">link</a>.\nCheck it out.</p>\n\n}
@@ -132,12 +128,12 @@ class TC_WikiCreole < Test::Unit::TestCase
     
     # set the link function back to being nil so that the rest of the tests
     # are not affected by the custom link function
-    WikiCreole.creole_link(nil)
+    WikiCreole.creole_link
 
   end
   
   def test_puts_existing_creole_tags
-    tags = WikiCreole.creole_tag()
+    tags = WikiCreole.creole_tags
     assert tags.index(/u: open\(<u>\) close\(<\/u>\)/)
   end
   
@@ -152,11 +148,7 @@ class TC_WikiCreole < Test::Unit::TestCase
   end
   
   def test_user_supplied_plugin_function
-    uppercase = Proc.new {|s| 
-      s.upcase!
-      s
-    }
-    WikiCreole.creole_plugin(uppercase)
+    WikiCreole.creole_plugin {|s| s.upcase }
     
     markup = "This is a paragraph with an uppercasing << plugin >>.\nCheck it out."
     goodhtml = %Q{<p>This is a paragraph with an uppercasing  PLUGIN .\nCheck it out.</p>\n\n}
@@ -165,7 +157,7 @@ class TC_WikiCreole < Test::Unit::TestCase
     
     # set the link function back to being nil so that the rest of the tests
     # are not affected by the custom link function
-    WikiCreole.creole_plugin(nil)
+    WikiCreole.creole_plugin
   end
 
   #-----------------------------------------------------------------------------
@@ -198,6 +190,10 @@ class TC_WikiCreole < Test::Unit::TestCase
     # are the same as they were in the original test.
     run_testfile("jsp_wiki")    
   end
+
+  def test_nested_lists
+    run_testfile("nested_lists")
+  end
   
   def run_testfile(name)
     name = "test_" + name

data/test/test_nested_lists.html

@@ -0,0 +1,10 @@
+<ul>
+    <li>correctly start with first level</li>
+<ul>
+    <li>correctly continue with second level</li>
+<ul>
+    <li>correctly enter third level</li>
+</ul>
+</ul>
+    <li>bug: jump back to first level</li>
+</ul>

data/test/test_nested_lists.markup

@@ -0,0 +1,4 @@
+* correctly start with first level
+** correctly continue with second level
+*** correctly enter third level
+* bug: jump back to first level

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: WikiCreole
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Gordon McCreight
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-12 00:00:00 -08:00
+date: 2009-02-05 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -28,19 +28,22 @@ files:
 - LICENSE
 - Rakefile
 - lib/wiki_creole.rb
+- test/profiling.rb
 - test/test_all.rb
-- test/test_escape.html
-- test/test_jsp_wiki.markup
-- test/test_amp.html
-- test/test_escape.markup
-- test/test_specialchars.html
 - test/test_amp.markup
-- test/test_inline.html
-- test/test_specialchars.markup
+- test/test_amp.html
+- test/test_block.markup
 - test/test_block.html
+- test/test_escape.markup
+- test/test_escape.html
 - test/test_inline.markup
-- test/test_block.markup
+- test/test_inline.html
+- test/test_jsp_wiki.markup
 - test/test_jsp_wiki.html
+- test/test_nested_lists.markup
+- test/test_nested_lists.html
+- test/test_specialchars.markup
+- test/test_specialchars.html
 has_rdoc: true
 homepage: http://github.com/gmccreight/wikicreole/tree/master
 post_install_message: 
@@ -62,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.2.0
+rubyforge_project: wikicreole
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A Creole-to-XHTML converter written in pure Ruby