ruby-bbcode 0.0.3 → 1.0.0

data/lib/ruby-bbcode/version.rb

@@ -1,3 +1,6 @@
-module RubyBbcode
-  VERSION = "0.0.3"
+module RubyBBCode
+  # Version of RubyBBCode
+  #
+  # Follows semantic versioning: http://semver.org/
+  VERSION = "1.0.0"
 end

data/lib/tags/tags.rb

@@ -1,6 +1,9 @@
-module BBCode
+module RubyBBCode
+  # Provides the official/default BBCode tags as stated by http://www.bbcode.org/reference.php
   module Tags
     # tagname => tag, HTML open tag, HTML close tag, description, example
+    # All of these entrys are represented as @dictionary in the classes (or as the variable tags)
+    # A single item from this file (eg the :b entry) is refered to as a @definition
     @@tags = {
       :b => {
         :html_open => '<strong>', :html_close => '</strong>',
@@ -26,17 +29,32 @@ module BBCode
         :html_open => '<ul>', :html_close => '</ul>',
         :description => 'Unordered list',
         :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
-        :only_allow => [ :li ]},
+        :only_allow => [ :li, "*".to_sym ]},
+      :code => {
+        :html_open => '<pre>', :html_close => '</pre>',
+        :description => 'Code block with mono-spaced text',
+        :example => 'This is [code]mono-spaced code[/code].'},
       :ol => {
         :html_open => '<ol>', :html_close => '</ol>',
         :description => 'Ordered list',
         :example => '[ol][li]List item[/li][li]Another list item[/li][/ol].',
-        :only_allow => [ :li ]},
+        :only_allow => [ :li, "*".to_sym ]},
       :li => {
         :html_open => '<li>', :html_close => '</li>',
         :description => 'List item',
         :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
         :only_in => [ :ul, :ol ]},
+      :list => {
+        :html_open => '<ul>', :html_close => '</ul>',
+        :description => 'Unordered list',
+        :example => '[list][*]List item[*]Another list item[/list].',
+        :only_allow => [ "*".to_sym ]},
+      "*".to_sym => {
+        :html_open => '<li>', :html_close => '</li>',
+        :description => 'List item',
+        :example => '[list][*]List item[*]Another list item[/list].',
+        :self_closable => true,
+        :only_in => [ :list, :ul, :ol ]},
       :img => {
         :html_open => '<img src="%between%" %width%%height%alt="" />', :html_close => '',
         :description => 'Image',
@@ -44,8 +62,8 @@ module BBCode
         :only_allow => [],
         :require_between => true,
         :allow_tag_param => true, :allow_tag_param_between => false,
-        :tag_param => /^(\d*)x(\d*)$/, 
-        :tag_param_tokens => [{:token => :width, :prefix => 'width="', :postfix => '" ' }, 
+        :tag_param => /^(\d*)x(\d*)$/,
+        :tag_param_tokens => [{:token => :width, :prefix => 'width="', :postfix => '" ' },
                               { :token => :height,  :prefix => 'height="', :postfix => '" ' } ],
         :tag_param_description => 'The image parameters \'%param%\' are incorrect, <width>x<height> excepted'},
       :url => {
@@ -62,34 +80,49 @@ module BBCode
         :description => 'Quote another person',
         :example => '[quote]BBCode is great[/quote]',
         :allow_tag_param => true, :allow_tag_param_between => false,
-        :tag_param => /(.*)/, 
+        :tag_param => /(.*)/,
         :tag_param_tokens => [{:token => :author, :prefix => '<strong>', :postfix => ' wrote:</strong>'}]},
       :size => {
         :html_open => '<span style="font-size: %size%px;">', :html_close => '</span>',
         :description => 'Change the size of the text',
         :example => '[size=32]This is 32px[/size]',
         :allow_tag_param => true, :allow_tag_param_between => false,
-        :tag_param => /(\d*)/, 
+        :tag_param => /(\d*)/,
         :tag_param_tokens => [{:token => :size}]},
       :color => {
         :html_open => '<span style="color: %color%;">', :html_close => '</span>',
         :description => 'Change the color of the text',
         :example => '[color=red]This is red[/color]',
         :allow_tag_param => true, :allow_tag_param_between => false,
-        :tag_param => /(([a-z]+)|(#[0-9a-f]{6}))/i, 
+        :tag_param => /(([a-z]+)|(#[0-9a-f]{6}))/i,
         :tag_param_tokens => [{:token => :color}]},
       :youtube => {
         :html_open => '<object width="400" height="325"><param name="movie" value="http://www.youtube.com/v/%between%"></param><embed src="http://www.youtube.com/v/%between%" type="application/x-shockwave-flash" width="400" height="325"></embed></object>', :html_close => '',
         :description => 'Youtube video',
         :example => '[youtube]E4Fbk52Mk1w[/youtube]',
         :only_allow => [],
+        :url_varients => ["youtube.com", "youtu.be", "y2u.be"], # NOT USED
+        :url_matches => [/youtube\.com.*[v]=([^&]*)/, /youtu\.be\/([^&]*)/, /y2u\.be\/([^&]*)/],
         :require_between => true},
-      :gvideo => {
-        :html_open => '<embed id="VideoPlayback" src="http://video.google.com/googleplayer.swf?docid=%between%&hl=en" style="width:400px; height:325px;" type="application/x-shockwave-flash"></embed>', :html_close => '',
-        :description => 'Google video',
-        :example => '[gvideo]397259729324681206[/gvideo]',
+      :vimeo => {
+        :html_open => '<iframe src="http://player.vimeo.com/video/%between%?badge=0" width="500" height="281" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>', 
+        :html_close => '',
+        :description => 'Vimeo video',
+        :example => '[vimeo]http://vimeo.com/46141955[/vimeo]',
         :only_allow => [],
+        :url_matches => [/vimeo\.com\/([^&]*)/],
         :require_between => true},
+      :media => {
+        :multi_tag => true,
+        :supported_tags => [
+          :youtube,
+          :vimeo
+        ]
+      }
     }
+
+    def self.tag_list
+      @@tags
+    end
   end
 end

data/test/current_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+require 'benchmark'
+
+
+
+class RubyBbcodeTest < Test::Unit::TestCase
+  
+end

data/test/debugging.rb

@@ -0,0 +1,93 @@
+module RubyBBCode
+  def self.log(string, clear_file = true)
+    clear_log_file_at_beginning_of_execution clear_file
+
+    File.open('/tmp/ruby-bbcode.log', 'a') do |f|
+      f.puts string
+    end
+  end
+
+  def self.clear_log_file_at_beginning_of_execution(clear_file)
+    return if !clear_file
+    if defined?(@@cleared_file).nil?
+      @@cleared_file = true
+      File.open('/tmp/ruby-bbcode.log', 'w+') do |f|
+        puts ''
+      end
+    end
+  end
+
+
+  # This module can be included in the BBTree and TagNode to give them debugging features
+  module DebugBBTree
+    # For Debugging/ visualization purposes.
+    # This can be used to render the #nodes array in a pretty manor, showing the hirarchy.
+    def to_v
+      tree = self
+      visual_string = ''
+
+      walk_tree(tree) do |node, depth|
+        indentation = '  ' * depth
+        case node[:is_tag]
+        when true
+          visual_string += "#{indentation}" + node[:tag].to_s + "\n"
+        when false
+          visual_string += "#{indentation}\"#{node[:text]}\"\n"
+        end
+      end
+
+      visual_string
+    end
+
+
+    # this blocky method counts how many children are
+    # in the TagNode.children, recursively walking the tree
+    def count_child_nodes(hash = self)
+      count = 0
+      walk_tree(hash) do
+        count += 1
+      end
+      count
+    end
+
+    # For BBTree, teh to_s method shows the count of the children plus a graphical
+    # depiction of the tree, and the relation of the nodes.
+    # For TagNodes, the root-most tag is displayed, and the children are counted.
+    def to_s
+      object_identifier = "#<#{self.class.to_s}:0x#{'%x' % (self.object_id << 1)}\n"
+      close_object = ">\n"
+
+      case self
+      when RubyBBCode::BBTree
+        object_identifier + "Children: #{count_child_nodes}\n" + self.to_v + close_object
+      when RubyBBCode::TagNode   # when inspecting TagNodes, it's better not to show the tree display
+        if self[:is_tag]
+          object_identifier + "Tag:  #{self[:tag].to_s}, Children: #{count_child_nodes}\n" + close_object
+        else
+          object_identifier + '"' + self[:text].to_s + "\"\n" + close_object
+        end
+      end
+    end
+
+    private
+
+    # This function is used by to_v and anything else that needs to iterate through the
+    # @bbtree
+    def walk_tree(tree, depth = -1, &blk)
+      return enum_for(:walk_tree) unless blk  # ignore me for now, I'm a convention for being versatile
+
+      # Perform the block action specified at top level!!!
+      yield tree, depth unless depth == -1
+
+      # next if we're a text node
+      return if tree.type == :text
+
+      # Enter into recursion (including block action) for each child node in this node
+      tree.children.each do |node|
+        walk_tree(node, depth + 1, &blk)
+      end
+    end
+
+  end
+
+end

data/test/ruby_bbcode_test.rb

@@ -6,31 +6,36 @@ class RubyBbcodeTest < Test::Unit::TestCase
     assert_equal "line1<br />\nline2", "line1\nline2".bbcode_to_html
     assert_equal "line1<br />\nline2", "line1\r\nline2".bbcode_to_html
   end
-  
+
   def test_strong
     assert_equal '<strong>simple</strong>', '[b]simple[/b]'.bbcode_to_html
     assert_equal "<strong>line 1<br />\nline 2</strong>", "[b]line 1\nline 2[/b]".bbcode_to_html
   end
-  
+
   def test_em
     assert_equal '<em>simple</em>', '[i]simple[/i]'.bbcode_to_html
     assert_equal "<em>line 1<br />\nline 2</em>", "[i]line 1\nline 2[/i]".bbcode_to_html
   end
-  
+
   def test_u
     assert_equal '<u>simple</u>', '[u]simple[/u]'.bbcode_to_html
     assert_equal "<u>line 1<br />\nline 2</u>", "[u]line 1\nline 2[/u]".bbcode_to_html
   end
 
+  def test_code
+    assert_equal '<pre>simple</pre>', '[code]simple[/code]'.bbcode_to_html
+    assert_equal "<pre>line 1<br />\nline 2</pre>", "[code]line 1\nline 2[/code]".bbcode_to_html
+  end
+
   def test_strikethrough
     assert_equal '<span style="text-decoration:line-through;">simple</span>', '[s]simple[/s]'.bbcode_to_html
     assert_equal "<span style=\"text-decoration:line-through;\">line 1<br />\nline 2</span>", "[s]line 1\nline 2[/s]".bbcode_to_html
   end
-  
+
   def test_size
     assert_equal '<span style="font-size: 32px;">32px Text</span>', '[size=32]32px Text[/size]'.bbcode_to_html
   end
-  
+
   def test_color
     assert_equal '<span style="color: red;">Red Text</span>', '[color=red]Red Text[/color]'.bbcode_to_html
     assert_equal '<span style="color: #ff0023;">Hex Color Text</span>', '[color=#ff0023]Hex Color Text[/color]'.bbcode_to_html
@@ -39,7 +44,7 @@ class RubyBbcodeTest < Test::Unit::TestCase
   def test_center
     assert_equal '<div style="text-align:center;">centered</div>', '[center]centered[/center]'.bbcode_to_html
   end
-  
+
   def test_ordered_list
     assert_equal '<ol><li>item 1</li><li>item 2</li></ol>', '[ol][li]item 1[/li][li]item 2[/li][/ol]'.bbcode_to_html
   end
@@ -47,16 +52,30 @@ class RubyBbcodeTest < Test::Unit::TestCase
   def test_unordered_list
     assert_equal '<ul><li>item 1</li><li>item 2</li></ul>', '[ul][li]item 1[/li][li]item 2[/li][/ul]'.bbcode_to_html
   end
- 
+
+  def test_unordered_list_omit_closing
+    assert_raise RuntimeError do
+      assert_equal '<ul><li>item 1</li><li>item 2</li></ul>', '[ul][li]item 1[li]item 2[/ul]'.bbcode_to_html
+    end
+  end
+
+  def test_list_common_syntax
+    assert_equal '<ul><li>item 1</li><li>item 2</li></ul>', '[list][*]item 1[*]item 2[/list]'.bbcode_to_html
+  end
+
+  def test_list_common_syntax_explicit_closing
+    assert_equal '<ul><li>item 1</li><li>item 2</li></ul>', '[list][*]item 1[/*][*]item 2[/*][/list]'.bbcode_to_html
+  end
+
   def test_two_lists
     assert_equal '<ul><li>item1</li><li>item2</li></ul><ul><li>item1</li><li>item2</li></ul>',
                    '[ul][li]item1[/li][li]item2[/li][/ul][ul][li]item1[/li][li]item2[/li][/ul]'.bbcode_to_html
   end
 
   def test_whitespace_in_only_allowed_tags
-    assert_equal "<ol><br />\n<li>item 1</li><br />\n<li>item 2</li><br />\n</ol>", 
+    assert_equal "<ol><br />\n<li>item 1</li><br />\n<li>item 2</li><br />\n</ol>",
                    "[ol]\n[li]item 1[/li]\n[li]item 2[/li]\n[/ol]".bbcode_to_html
-        assert_equal "<ol> <li>item 1</li>  <li>item 2</li>	</ol>", 
+        assert_equal "<ol> <li>item 1</li>  <li>item 2</li>	</ol>",
                    "[ol] [li]item 1[/li]  [li]item 2[/li]	[/ol]".bbcode_to_html
 
   end
@@ -66,41 +85,41 @@ class RubyBbcodeTest < Test::Unit::TestCase
       '[li]Illegal item[/li]'.bbcode_to_html
     end
     assert_equal ['[li] can only be used in [ul] and [ol]'],
-                   '[li]Illegal item[/li]'.is_valid_bbcode?
+                   '[li]Illegal item[/li]'.bbcode_check_validity
     assert_raise RuntimeError do
       '[b][li]Illegal item[/li][/b]'.bbcode_to_html
     end
-    
+
     assert_equal ['[li] can only be used in [ul] and [ol], so using it in a [b] tag is not allowed'],
-                   '[b][li]Illegal item[/li][/b]'.is_valid_bbcode?
+                   '[b][li]Illegal item[/li][/b]'.bbcode_check_validity
   end
 
   def test_illegal_list_contents
     assert_raise RuntimeError do
       '[ul]Illegal list[/ul]'.bbcode_to_html
     end
-    assert_equal ['[ul] can only contain [li] tags, so "Illegal list" is not allowed'],
-                   '[ul]Illegal list[/ul]'.is_valid_bbcode?
+    assert_equal ['[ul] can only contain [li] and [*] tags, so "Illegal list" is not allowed'],
+                   '[ul]Illegal list[/ul]'.bbcode_check_validity
     assert_raise RuntimeError do
       '[ul][b]Illegal list[/b][/ul]'.bbcode_to_html
     end
-    assert_equal ['[ul] can only contain [li] tags, so [b] is not allowed'],
-                   '[ul][b]Illegal list[/b][/ul][/b]'.is_valid_bbcode?
+    assert_equal ['[ul] can only contain [li] and [*] tags, so [b] is not allowed'],
+                   '[ul][b]Illegal list[/b][/ul][/b]'.bbcode_check_validity
   end
 
   def test_illegal_list_contents_text_between_list_items
     assert_raise RuntimeError do
       '[ul][li]item[/li]Illegal list[/ul]'.bbcode_to_html
     end
-    assert_equal ['[ul] can only contain [li] tags, so "Illegal text" is not allowed'],
-                   '[ul][li]item[/li]Illegal text[/ul]'.is_valid_bbcode?
+    assert_equal ['[ul] can only contain [li] and [*] tags, so "Illegal text" is not allowed'],
+                   '[ul][li]item[/li]Illegal text[/ul]'.bbcode_check_validity
     assert_raise RuntimeError do
       '[ul][li]item[/li]Illegal list[li]item[/li][/ul]'.bbcode_to_html
     end
-    assert_equal ['[ul] can only contain [li] tags, so "Illegal text" is not allowed'],
-                   '[ul][li]item[/li]Illegal text[li]item[/li][/ul]'.is_valid_bbcode?
+    assert_equal ['[ul] can only contain [li] and [*] tags, so "Illegal text" is not allowed'],
+                   '[ul][li]item[/li]Illegal text[li]item[/li][/ul]'.bbcode_check_validity
   end
-  
+
   def test_quote
     assert_equal '<div class="quote">quoting</div>',  '[quote]quoting[/quote]'.bbcode_to_html
     assert_equal '<div class="quote"><strong>someone wrote:</strong>quoting</div>', '[quote=someone]quoting[/quote]'.bbcode_to_html
@@ -123,25 +142,36 @@ class RubyBbcodeTest < Test::Unit::TestCase
       # Link within same domain must start with a / and a link to another domain with http://, https:// or ftp://
       '[url=www.google.com]Google[/url]'.bbcode_to_html
     end
+    assert_raise RuntimeError do
+      '[url]htfp://www.google.com[/url]'.bbcode_to_html
+    end
   end
-  
+
   def test_image
     assert_equal '<img src="http://www.ruby-lang.org/images/logo.gif" alt="" />',
                    '[img]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_to_html
-    assert_equal '<img src="http://www.ruby-lang.org/images/logo.gif" width="95" height="96" alt="" />', 
+    assert_equal '<img src="http://www.ruby-lang.org/images/logo.gif" width="95" height="96" alt="" />',
                    '[img=95x96]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_to_html
   end
-  
+
   def test_youtube
     assert_equal '<object width="400" height="325"><param name="movie" value="http://www.youtube.com/v/E4Fbk52Mk1w"></param><embed src="http://www.youtube.com/v/E4Fbk52Mk1w" type="application/x-shockwave-flash" width="400" height="325"></embed></object>' ,
                    '[youtube]E4Fbk52Mk1w[/youtube]'.bbcode_to_html
   end
+
+  def test_youtube_with_full_url
+    full_url = "http://www.youtube.com/watch?feature=player_embedded&v=E4Fbk52Mk1w"
+    assert_equal '<object width="400" height="325"><param name="movie" value="http://www.youtube.com/v/E4Fbk52Mk1w"></param><embed src="http://www.youtube.com/v/E4Fbk52Mk1w" type="application/x-shockwave-flash" width="400" height="325"></embed></object>' ,
+                   "[youtube]#{full_url}[/youtube]".bbcode_to_html
+  end
   
-  def test_google_video
-    assert_equal '<embed id="VideoPlayback" src="http://video.google.com/googleplayer.swf?docid=397259729324681206&hl=en" style="width:400px; height:325px;" type="application/x-shockwave-flash"></embed>',
-                   '[gvideo]397259729324681206[/gvideo]'.bbcode_to_html
+  def test_youtube_with_url_shortener
+    full_url = "http://www.youtu.be/cSohjlYQI2A"
+    assert_equal '<object width="400" height="325"><param name="movie" value="http://www.youtube.com/v/cSohjlYQI2A"></param><embed src="http://www.youtube.com/v/cSohjlYQI2A" type="application/x-shockwave-flash" width="400" height="325"></embed></object>' ,
+                   "[youtube]#{full_url}[/youtube]".bbcode_to_html
   end
 
+
   def test_html_escaping
     assert_equal '<strong>&lt;i&gt;foobar&lt;/i&gt;</strong>', '[b]<i>foobar</i>[/b]'.bbcode_to_html
     assert_equal '<strong><i>foobar</i></strong>', '[b]<i>foobar</i>[/b]'.bbcode_to_html(false)
@@ -169,10 +199,11 @@ class RubyBbcodeTest < Test::Unit::TestCase
     assert_equal "<strong>foobar</strong>", foo
   end
 
-  def test_self_tag_list
-    assert_equal 15, RubyBBCode.tag_list.size
-  end
-  
+  # commented this out, it kinda just gets in the way of development atm
+  #def test_self_tag_list
+  #  assert_equal 16, RubyBBCode::Tags.tag_list.size
+  #end
+
   def test_addition_of_tags
     mydef = {
       :test => {
@@ -191,7 +222,7 @@ class RubyBbcodeTest < Test::Unit::TestCase
 
   def test_no_ending_tag
     assert_raise RuntimeError do
-      "this [b]should not be bold".bbcode_to_html 
+      "this [b]should not be bold".bbcode_to_html
     end
   end
 
@@ -206,5 +237,49 @@ class RubyBbcodeTest < Test::Unit::TestCase
       "this [b]should not do formatting[/i]".bbcode_to_html
     end
   end
+  
+  def test_no_xss_hax
+    expected = "<a href=\"http://www.google.com&quot; onclick=\&quot;javascript:alert\">google</a>"
+    assert_equal expected, '[url=http://www.google.com" onclick="javascript:alert]google[/url]'.bbcode_to_html
+  end
+  
+    # TODO:  This stack level problem should be validated during the validations
+  #def test_stack_level_too_deep
+  #  num = 2300  # increase this number if the test starts failing.  It's very near the tipping point
+  #  openers = "[s]hi i'm" * num
+  #  closers = "[/s]" * num
+  #  assert_raise( SystemStackError ) do
+  #    (openers+closers).bbcode_to_html
+  #  end
+  #end
+  
+  def test_mulit_tag
+    input1 = "[media]http://www.youtube.com/watch?v=cSohjlYQI2A[/media]"
+    input2 = "[media]http://vimeo.com/46141955[/media]"
+    
+    output1 = "<object width=\"400\" height=\"325\"><param name=\"movie\" value=\"http://www.youtube.com/v/cSohjlYQI2A\"></param><embed src=\"http://www.youtube.com/v/cSohjlYQI2A\" type=\"application/x-shockwave-flash\" width=\"400\" height=\"325\"></embed></object>"
+    output2 = '<iframe src="http://player.vimeo.com/video/46141955?badge=0" width="500" height="281" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>'
+    
+    
+    assert_equal output1, input1.bbcode_to_html
+    assert_equal output2, input2.bbcode_to_html
+  end
+  
+  def test_vimeo_tag
+    input = "[vimeo]http://vimeo.com/46141955[/vimeo]"
+    input2 = "[vimeo]46141955[/vimeo]"
+    output = '<iframe src="http://player.vimeo.com/video/46141955?badge=0" width="500" height="281" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>'
+    
+    assert_equal output, input.bbcode_to_html
+    assert_equal output, input2.bbcode_to_html
+  end
+  
+  def test_failing_multi_tag
+    input1 = "[media]http://www.youtoob.com/watch?v=cSohjlYQI2A[/media]"
+    
+    assert_equal input1, input1.bbcode_to_html
+  end
+  
+  
 
 end