ruby-bbcode-to-md 0.0.1

data/lib/ruby-bbcode/version.rb

@@ -0,0 +1,3 @@
+module RubyBbcode
+  VERSION = "0.0.1"
+end

data/lib/tags/tags.rb

@@ -0,0 +1,113 @@
+module RubyBBCode
+  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 => '**', :html_close => '**',
+        :description => 'Make text bold',
+        :example => 'This is [b]bold[/b].'},
+      :i => {
+        :html_open => '*', :html_close => '*',
+        :description => 'Make text italic',
+        :example => 'This is [i]italic[/i].'},
+      :u => {
+        :html_open => '', :html_close => '',
+        :description => 'Underline text',
+        :example => 'This is [u]underlined[/u].'},
+      :center => {
+        :html_open => '', :html_close => '',
+        :description => 'Center a text',
+        :example => '[center]This is centered[/center].'},
+      :ul => {
+        :html_open => '', :html_close => "\n",
+        :description => 'Unordered list',
+        :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
+        :only_allow => [ :li ]},
+      :ol => {
+        :html_open => '', :html_close => "\n",
+        :description => 'Ordered list',
+        :example => '[ol][li]List item[/li][li]Another list item[/li][/ol].',
+        :only_allow => [ :li ]},
+      :li => {
+        :html_open => {
+          :ul => '  - ',
+          :ol => '  1. '
+        },
+        :html_close => "\n",
+        :description => 'List item',
+        :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
+        :only_in => [ :ul, :ol ]},
+      :img => {
+        :html_open => '%between%', :html_close => '',
+        :description => 'Image',
+        :example => '[img]http://www.google.com/intl/en_ALL/images/logo.gif[/img].',
+        :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 => '" ' },
+                              { :token => :height,  :prefix => 'height="', :postfix => '" ' } ],
+        :tag_param_description => 'The image parameters \'%param%\' are incorrect, <width>x<height> excepted'},
+      :url => {
+        :html_open => '%url%', :html_close => '',
+        :description => 'Link to another page',
+        :example => '[url]http://www.google.com/[/url].',
+        :only_allow => [],
+        :require_between => true,
+        :allow_tag_param => true, :allow_tag_param_between => true,
+        :tag_param => /^((((http|https|ftp):\/\/)|\/).+)$/, :tag_param_tokens => [{ :token => :url }],
+        :tag_param_description => 'The URL should start with http:// https://, ftp:// or /, instead of \'%param%\'' },
+      :quote => {
+        :first_html_open => "\n", :last_html_close => "\n",
+        :html_open => "%author%>", :html_close => "\n",
+        :description => 'Quote another person',
+        :example => '[quote]BBCode is great[/quote]',
+        :allow_tag_param => true, :allow_tag_param_between => false,
+        :tag_param => /(.*)/,
+        :tag_param_tokens => [{:token => :author, :prefix => '>', :postfix => " said:\n"}]},
+      :size => {
+        :html_open => '[size=%size%]', :html_close => '[/size]',
+        :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_tokens => [{:token => :size}]},
+      :color => {
+        :html_open => '', :html_close => '',
+        :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_tokens => [{:token => :color}]},
+      :youtube => {
+        :html_open => 'http://www.youtube.com/v/%between%', :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},
+      :vimeo => {
+        :html_open => 'http://vimeo.com/%between%', 
+        :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/ruby_bbcode_test.rb

@@ -0,0 +1,208 @@
+require 'test_helper'
+
+class RubyBbcodeTest < Test::Unit::TestCase
+
+  def test_multiline
+    assert_equal "line1\nline2", "line1\nline2".bbcode_to_md
+    assert_equal "line1\nline2", "line1\r\nline2".bbcode_to_md
+  end
+
+  def test_strong
+    assert_equal '**simple**', '[b]simple[/b]'.bbcode_to_md
+    assert_equal "**line 1\nline 2**", "**line 1\nline 2**".bbcode_to_md
+  end
+
+  def test_em
+    assert_equal '*simple*', '[i]simple[/i]'.bbcode_to_md
+    assert_equal "*line 1\nline 2*", "[i]line 1\nline 2[/i]".bbcode_to_md
+  end
+
+  def test_u
+    assert_equal 'simple', '[u]simple[/u]'.bbcode_to_md
+    assert_equal "line 1\nline 2", "[u]line 1\nline 2[/u]".bbcode_to_md
+  end
+
+  def test_size
+    assert_equal '[size=32]32px Text[/size]', '[size=32]32px Text[/size]'.bbcode_to_md
+  end
+
+  def test_color
+    assert_equal 'Red Text', '[color=red]Red Text[/color]'.bbcode_to_md
+    assert_equal 'Hex Color Text', '[color=#ff0023]Hex Color Text[/color]'.bbcode_to_md
+  end
+
+  def test_center
+    assert_equal 'centered', '[center]centered[/center]'.bbcode_to_md
+  end
+
+  def test_ordered_list
+    assert_equal "  1. item 1\n  1. item 2\n\n", '[ol][li]item 1[/li][li]item 2[/li][/ol]'.bbcode_to_md
+  end
+
+  def test_unordered_list
+    assert_equal "  - item 1\n  - item 2\n\n", '[ul][li]item 1[/li][li]item 2[/li][/ul]'.bbcode_to_md
+  end
+
+  def test_two_lists
+    assert_equal "  - item1\n  - item2\n\n  - item1\n  - item2\n\n",
+                   "[ul][li]item1[/li][li]item2[/li][/ul][ul][li]item1[/li][li]item2[/li][/ul]".bbcode_to_md
+  end
+
+  def test_whitespace_in_only_allowed_tags
+    assert_equal "\n  1. item 1\n\n  1. item 2\n\n\n",
+                   "[ol]\n[li]item 1[/li]\n[li]item 2[/li]\n[/ol]".bbcode_to_md
+    assert_equal "   1. item 1\n    1. item 2\n\n",
+               "[ol] [li]item 1[/li]  [li]item 2[/li][/ol]".bbcode_to_md
+
+  end
+
+  def test_quote
+    assert_equal "\n>quoting\n\n",  '[quote]quoting[/quote]'.bbcode_to_md
+    assert_equal "\n>someone said:\n>quoting\n\n", '[quote=someone]quoting[/quote]'.bbcode_to_md
+  end
+
+  def test_nested_quotes
+    assert_equal "\n>Kitten said:\n>>creatiu said:\n>>f1\n>f2",
+                  '[quote=Kitten][quote=creatiu]f1[/quote]f2[/quote]'.bbcode_to_md
+  end
+
+  # TODO convert URLs with link text instead of just extracting the url.
+  def test_link
+    assert_equal 'http://www.google.com', '[url]http://www.google.com[/url]'.bbcode_to_md
+    assert_equal 'http://google.com', '[url=http://google.com]Google[/url]'.bbcode_to_md
+    assert_equal '/index.html', '[url=/index.html]Home[/url]'.bbcode_to_md
+    assert_equal "http://google.com and http://bing.com are both search engines.",
+                  '[url=http://google.com]Google[/url] and [url=http://bing.com]Bing[/url] are both search engines.'.bbcode_to_md
+  end
+
+  def test_image
+    assert_equal 'http://www.ruby-lang.org/images/logo.gif',
+                   '[img]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_to_md
+    assert_equal 'http://www.ruby-lang.org/images/logo.gif',
+                   '[img=95x96]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_to_md
+  end
+
+  def test_youtube
+    assert_equal 'http://www.youtube.com/v/E4Fbk52Mk1w' ,
+                   '[youtube]E4Fbk52Mk1w[/youtube]'.bbcode_to_md
+  end
+
+  def test_youtube_with_full_url
+    full_url = "http://www.youtube.com/watch?feature=player_embedded&v=E4Fbk52Mk1w"
+    assert_equal "http://www.youtube.com/v/E4Fbk52Mk1w" ,
+                   "[youtube]#{full_url}[/youtube]".bbcode_to_md
+  end
+  
+  def test_youtube_with_url_shortener
+    full_url = "http://www.youtu.be/cSohjlYQI2A"
+    assert_equal "http://www.youtube.com/v/cSohjlYQI2A" ,
+                   "[youtube]#{full_url}[/youtube]".bbcode_to_md
+  end
+
+
+  def test_html_escaping
+    assert_equal '**&lt;i&gt;foobar&lt;/i&gt;**', '[b]<i>foobar</i>[/b]'.bbcode_to_md
+    assert_equal '**<i>foobar</i>**', '[b]<i>foobar</i>[/b]'.bbcode_to_md(false)
+    assert_equal '1 is &lt; 2', '1 is < 2'.bbcode_to_md
+    assert_equal '1 is < 2', '1 is < 2'.bbcode_to_md(false)
+    assert_equal '2 is &gt; 1', '2 is > 1'.bbcode_to_md
+    assert_equal '2 is > 1', '2 is > 1'.bbcode_to_md(false)
+  end
+
+  def test_disable_tags
+    assert_equal "[b]foobar[/b]", "[b]foobar[/b]".bbcode_to_md(true, {}, :disable, :b)
+    assert_equal "[b]*foobar*[/b]", "[b][i]foobar[/i][/b]".bbcode_to_md(true, {}, :disable, :b)
+    assert_equal "[b][i]foobar[/i][/b]", "[b][i]foobar[/i][/b]".bbcode_to_md(true, {}, :disable, :b, :i)
+  end
+
+  def test_enable_tags
+    assert_equal "**foobar**" , "[b]foobar[/b]".bbcode_to_md(true, {}, :enable, :b)
+    assert_equal "**[i]foobar[/i]**", "[b][i]foobar[/i][/b]".bbcode_to_md(true, {}, :enable, :b)
+    assert_equal "***foobar***", "[b][i]foobar[/i][/b]".bbcode_to_md(true, {}, :enable, :b, :i)
+  end
+
+  def test_to_html_bang_method
+    foo = "[b]foobar[/b]"
+    assert_equal "**foobar**", foo.bbcode_to_md!
+    assert_equal "**foobar**", foo
+  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 => {
+        :html_open => '<test>', :html_close => '</test>',
+        :description => 'This is a test',
+        :example => '[test]Test here[/test]'}
+    }
+    assert_equal 'pre <test>Test here</test> post', 'pre [test]Test here[/test] post'.bbcode_to_md(true, mydef)
+    assert_equal 'pre **<test>Test here</test>** post', 'pre [b][test]Test here[/test][/b] post'.bbcode_to_md(true, mydef)
+  end
+
+  def test_multiple_tag_test
+    assert_equal "**bold***italic*underline\n>quote\n\nhttps://test.com",
+                   "[b]bold[/b][i]italic[/i][u]underline[/u][quote]quote[/quote][url=https://test.com]link[/url]".bbcode_to_md
+  end
+
+  def test_no_ending_tag
+    assert_raise RuntimeError do
+      "this [b]should not be bold".bbcode_to_md
+    end
+  end
+
+  def test_no_start_tag
+    assert_raise RuntimeError do
+      "this should not be bold[/b]".bbcode_to_md
+    end
+  end
+
+  def test_different_start_and_ending_tags
+    assert_raise RuntimeError do
+      "this [b]should not do formatting[/i]".bbcode_to_md
+    end
+  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( RuntimeError ) do
+      (openers+closers).bbcode_to_md
+    end
+    
+  end
+  
+  def test_mulit_tag
+    input1 = "[media]http://www.youtube.com/watch?v=cSohjlYQI2A[/media]"
+    input2 = "[media]http://vimeo.com/46141955[/media]"
+    
+    output1 = "http://www.youtube.com/v/cSohjlYQI2A"
+    output2 = "http://vimeo.com/46141955"    
+    
+    assert_equal output1, input1.bbcode_to_md
+    assert_equal output2, input2.bbcode_to_md
+  end
+  
+  def test_vimeo_tag
+    input = "[vimeo]http://vimeo.com/46141955[/vimeo]"
+    input2 = "[vimeo]46141955[/vimeo]"
+    output = 'http://vimeo.com/46141955'
+    
+    assert_equal output, input.bbcode_to_md
+    assert_equal output, input2.bbcode_to_md
+  end
+  
+  def test_failing_multi_tag
+    input1 = "[media]http://www.youtoob.com/watch?v=cSohjlYQI2A[/media]"
+    
+    assert_equal input1, input1.bbcode_to_md
+  end
+  
+  
+
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'ruby-bbcode'
+require "test/unit"
+
+# This hack allows us to make all the private methods of a class public.  
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    self.class_eval { public(*saved_private_instance_methods) }
+    yield
+    self.class_eval { private(*saved_private_instance_methods) }
+  end
+end
+
+
+# This is for measuring memory usage...
+def get_current_memory_usage
+  `ps -o rss= -p #{Process.pid}`.to_i
+end

data/test/unit/debugging_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class RubyBbcodeTest < Test::Unit::TestCase
+  include ::RubyBBCode::Tags
+  
+  def test_bbtree_to_v
+    text = "[i][b]a[/b][b]a[/b][b]a[/b][b]a[/b]item 1[/i][i]item 2[/i]"
+    visual = <<eos
+i
+  b
+    "a"
+  b
+    "a"
+  b
+    "a"
+  b
+    "a"
+  "item 1"
+i
+  "item 2"
+eos
+    
+    tags = @@tags
+    @tag_sifter = RubyBBCode::TagSifter.new(text, tags)
+    @tag_sifter.process_text
+    
+    # manually include the debugging methods if they've been disabled for cleanliness purposes
+    @tag_sifter.bbtree.extend(::RubyBBCode::DebugBBTree) unless @tag_sifter.bbtree.respond_to? :to_v
+    
+    assert_equal visual, @tag_sifter.bbtree.to_v
+  end
+  
+  def test_bbtree_counting_nodes
+    text = "[ol][li][b][/b][b][/b][b][/b][b][/b]item 1[/li][li]item 2[/li][/ol]"
+    tags = @@tags
+    
+    @tag_sifter = RubyBBCode::TagSifter.new(text, tags)
+    
+    @tag_sifter.process_text
+    
+    # manually include debugging methods if needed.  
+    @tag_sifter.bbtree.extend(::RubyBBCode::DebugBBTree) unless @tag_sifter.bbtree.respond_to? :count_child_nodes
+    
+    assert_equal 9, @tag_sifter.bbtree.count_child_nodes
+  end
+  
+end

data/test/unit/tag_sifter_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class TagSifterTest < Test::Unit::TestCase
+  def test_youtube_parser
+    url1 = "http://www.youtube.com/watch?v=E4Fbk52Mk1w"
+    just_an_id = 'E4Fbk52Mk1w'
+    url_without_http = "www.youtube.com/watch?v=E4Fbk52Mk1w"
+    url_without_www = "youtube.com/watch?v=E4Fbk52Mk1w"
+    url_with_feature = "http://www.youtube.com/watch?feature=player_embedded&v=E4Fbk52Mk1w"
+    mock_regex_matches = [/youtube.com.*[v]=([^&]*)/, /youtu.be\/([^&]*)/, /y2u.be\/([^&]*)/]
+    
+    expected_output = 'E4Fbk52Mk1w'
+    
+    RubyBBCode::TagSifter.publicize_methods do
+      ts = RubyBBCode::TagSifter.new "", ""
+      assert_equal expected_output, 
+                     ts.conduct_special_formatting(url1, mock_regex_matches)
+      
+      assert_equal expected_output, 
+                   ts.conduct_special_formatting(just_an_id, mock_regex_matches)
+                   
+      assert_equal expected_output, 
+                     ts.conduct_special_formatting(url_without_http, mock_regex_matches)
+                     
+      assert_equal expected_output, 
+                     ts.conduct_special_formatting(url_without_www, mock_regex_matches)
+                     
+      assert_equal expected_output, 
+                     ts.conduct_special_formatting(url_with_feature, mock_regex_matches)
+    end
+    
+  end
+
+	# I think the answer to this is creating a new tag named [youtube]
+	# but that captures specifically the .be or .com and treats them differently...
+	def test_youtubes_via_there_url_shortener
+		url_from_shortener = "http://youtu.be/E4Fbk52Mk1w"
+		directory_format = "http://youtube.googleapis.com/v/E4Fbk52Mk1w"
+    expected_output = 'E4Fbk52Mk1w'
+    mock_regex_matches = [/youtube.com.*[v]=([^&]*)/, /youtu.be\/([^&]*)/, /y2u.be\/([^&]*)/]
+
+    
+    RubyBBCode::TagSifter.publicize_methods do
+      ts = RubyBBCode::TagSifter.new "", ""
+      
+      
+			assert_equal expected_output, 
+				             ts.conduct_special_formatting(url_from_shortener, mock_regex_matches)   # this test is now hopelessly broken because generating an ID from a link requires that @bbtree.current_node.definition be properly populated with regex matches...
+		end
+	end
+end