bb-ruby 0.9.8 → 1.0

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bb-ruby.gemspec
 gemspec
+
+group :development do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    bb-ruby (0.9.8)
+    bb-ruby (0.9.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    rake (10.0.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bb-ruby!
+  rake

data/History.txt

@@ -1,3 +1,11 @@
+== 1.0 2013-05-9
+
+* Enable Procs to be used in custom defined replacements
+
+== 0.9.9 2013-02-2
+
+* Dont insert any extra html tags if just using .to_html method
+
 == 0.9.8 2012-10-03
 
 * replace deprecated html <u> tag
@@ -54,4 +62,4 @@
 
 * No major enhancements:
   * Small point release for moving gem from Github to RubyForge
-  * Gem is no longer served from github via cpjolicoeur-bbruby.  Gem is now served directly from Rubyforge via bb-ruby 
+  * Gem is no longer served from github via cpjolicoeur-bbruby.  Gem is now served directly from Rubyforge via bb-ruby

data/README.rdoc

@@ -55,6 +55,20 @@ Define your own translation, in order to be more flexible:
     }
  
     text.bbcode_to_html(my_blockquote)
+
+Define Proc as replacement:
+
+    module BBRuby
+      @@tags = @@tags.merge({
+          'File' => [
+            /\[file(:.*)?=(.*?)\](.*?)\[\/file\1?\]/mi,
+            lambda{ |e| "<div class="file"><p><cite>#{e[3]}</cite></p><blockquote>#{file_read_method(e[2])}</blockquote></div>"},
+            'File content with citation',
+            '[file=script.rb]Script Caption[/file]',
+            :file
+          ],
+        })
+    end
     
 You can also use the simple_format method of ActionPack by using the *_with_formatting methods:
 

data/Rakefile

@@ -9,3 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
+task :default => :test

data/lib/bb-ruby.rb

@@ -10,7 +10,7 @@ module BBRuby
     # tag name => [regex, replace, description, example, enable/disable symbol]
     'Bold' => [
       /\[b(:.*)?\](.*?)\[\/b\1?\]/mi,
-      '<strong>\2</strong>',
+      '<strong>\2</strong>', #Proc alternative for example: lambda{ |e| "<strong>#{e[2]}</strong>" }
       'Embolden text',
       'Look [b]here[/b]',
       :bold],
@@ -252,10 +252,10 @@ module BBRuby
 
       # parse spacing
       text.gsub!( /\r\n?/, "\n" )
-      text.gsub!( /\n/, "<br />\n" )
-			text.gsub!(/\[quote\]/, '<fieldset><legend>Quote:</legend><blockquote>')
-			text.gsub!(/\[quote(:.*)?="?(.*?)"?\]/, '<fieldset><legend>Quote: \2</legend><blockquote>')
-			text.gsub!(/\[\/quote\]/, '</blockquote></fieldset>')
+
+      text.gsub!(/\[quote\]/, '<fieldset><legend>Quote:</legend><blockquote>')
+      text.gsub!(/\[quote(:.*)?="?(.*?)"?\]/, '<fieldset><legend>Quote: \2</legend><blockquote>')
+      text.gsub!(/\[\/quote\]/, '</blockquote></fieldset>')
 
       # return markup
       text
@@ -298,10 +298,28 @@ module BBRuby
       # parse bbcode tags
       case method
       when :enable
-        tags_definition.each_value { |t| text.gsub!(t[0], t[1]) if tags.include?(t[4]) }
+        tags_definition.each_value do |t|
+          if tags.include?( t[4] )
+            if t[1].class == String
+              text.gsub!( t[0], t[1] ) # just replace if replacement is String
+            else
+              text.gsub!( t[0] ){ t[1].call($~) } # call replacement
+              # It may be Proc or lambda with one argument
+              # Argument is MatchData. See 'Bold' tag name for example.
+            end
+          end
+        end
       when :disable
         # this works nicely because the default is disable and the default set of tags is [] (so none disabled) :)
-        tags_definition.each_value { |t| text.gsub!(t[0], t[1]) unless tags.include?(t[4]) }
+        tags_definition.each_value do |t|
+          unless tags.include?( t[4] )
+            if t[1].class == String
+              text.gsub!( t[0], t[1] )
+            else
+              text.gsub!( t[0] ){ t[1].call($~) }
+            end
+          end
+        end
       end
 
       text

data/lib/bb-ruby/version.rb

@@ -1,3 +1,3 @@
 module BBRuby
-  VERSION = "0.9.8"
+  VERSION = "1.0"
 end

data/test/bb-ruby_test.rb

@@ -1,7 +1,7 @@
 #! /usr/bin/env ruby
 #coding: utf-8
 
-require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test_helper.rb'
 
 class TestBBRuby < Test::Unit::TestCase
 
@@ -9,20 +9,20 @@ class TestBBRuby < Test::Unit::TestCase
     assert_equal '<strong>simple</strong>', '[b]simple[/b]'.bbcode_to_html
     assert_equal '<strong>simple</strong>', '[b:7a9ca2c5c3]simple[/b:7a9ca2c5c3]'.bbcode_to_html
     assert_equal %Q(<strong>simple</strong>), BBRuby.to_html( %Q([b:7a9ca2c5c3]simple[/b:7a9ca2c5c3]) )
-    assert_equal "<strong>line 1<br />\nline 2</strong>", "[b:7a9ca2c5c3]line 1\nline 2[/b:7a9ca2c5c3]".bbcode_to_html
-    assert_equal "<strong>1. text 1:</strong> text 2<br />\n<strong>2. text 3</strong>", "[b:post_uid0]1. text 1:[/b:post_uid0] text 2\n[b:post_uid0]2. text 3[/b:post_uid0]".bbcode_to_html
+    assert_equal "<strong>line 1\nline 2</strong>", "[b:7a9ca2c5c3]line 1\nline 2[/b:7a9ca2c5c3]".bbcode_to_html
+    assert_equal "<strong>1. text 1:</strong> text 2\n<strong>2. text 3</strong>", "[b:post_uid0]1. text 1:[/b:post_uid0] text 2\n[b:post_uid0]2. text 3[/b:post_uid0]".bbcode_to_html
   end
 
   def test_em
     assert_equal '<em>simple</em>', '[i]simple[/i]'.bbcode_to_html
     assert_equal '<em>simple</em>', '[i:7a9ca2c5c3]simple[/i:7a9ca2c5c3]'.bbcode_to_html
-    assert_equal "<em>line 1<br />\nline 2</em>", "[i:7a9ca2c5c3]line 1\nline 2[/i:7a9ca2c5c3]".bbcode_to_html
+    assert_equal "<em>line 1\nline 2</em>", "[i:7a9ca2c5c3]line 1\nline 2[/i:7a9ca2c5c3]".bbcode_to_html
   end
 
   def test_u
     assert_equal '<span style="text-decoration:underline;">simple</span>', '[u]simple[/u]'.bbcode_to_html
     assert_equal '<span style="text-decoration:underline;">simple</span>', '[u:7a9ca2c5c3]simple[/u:7a9ca2c5c3]'.bbcode_to_html
-    assert_equal '<span style="text-decoration:underline;">line 1<br />\nline 2</span>', "[u:7a9ca2c5c3]line 1\nline 2[/u:7a9ca2c5c3]".bbcode_to_html
+    assert_equal %Q(<span style="text-decoration:underline;">line 1\nline 2</span>), "[u:7a9ca2c5c3]line 1\nline 2[/u:7a9ca2c5c3]".bbcode_to_html
   end
 
   def test_del
@@ -40,7 +40,7 @@ class TestBBRuby < Test::Unit::TestCase
   def test_code
     assert_equal '<code>simple</code>', '[code]simple[/code]'.bbcode_to_html
     assert_equal '<code>simple</code>', '[code:7a9ca2c5c3]simple[/code:7a9ca2c5c3]'.bbcode_to_html
-    assert_equal "<code>var bxi = 0;<br />\n//Holds current speed of scrolling menu</code>", "[code:1:91cbdd72b7]var bxi = 0;\n//Holds current speed of scrolling menu[/code:1:91cbdd72b7]".bbcode_to_html
+    assert_equal "<code>var bxi = 0;\n//Holds current speed of scrolling menu</code>", "[code:1:91cbdd72b7]var bxi = 0;\n//Holds current speed of scrolling menu[/code:1:91cbdd72b7]".bbcode_to_html
   end
 
   def test_size
@@ -113,7 +113,7 @@ class TestBBRuby < Test::Unit::TestCase
   end
 
   def test_double_quote
-   assert_equal '<fieldset><legend>Kitten</legend><blockquote><fieldset><legend>creatiu</legend><blockquote>f1</blockquote></fieldset>f2</blockquote></fieldset>',
+   assert_equal '<fieldset><legend>Kitten</legend><blockquote><fieldset><legend>Quote: &quot;creatiu&quot;</legend><blockquote>f1</blockquote></fieldset>f2</blockquote></fieldset>',
                 '[quote:26fe26a6a9="Kitten"][quote:26fe26a6a93="creatiu"]f1[/quote:26fe26a6a93]f2[/quote:26fe26a6a9]'.bbcode_to_html.bbcode_to_html({}, false, :disable)
   end
 
@@ -121,7 +121,7 @@ class TestBBRuby < Test::Unit::TestCase
     assert_equal '<a href="http://google.com">Google</a>', '[url=http://google.com]Google[/url]'.bbcode_to_html
     assert_equal '<a href="http://google.com">http://google.com</a>', '[url]http://google.com[/url]'.bbcode_to_html
     assert_equal '<a href="http://www.altctrlsupr.com/dmstk/kdd070803/00.html"> ABRIR ALBUM </a>','[URL=http://www.altctrlsupr.com/dmstk/kdd070803/00.html] ABRIR ALBUM [/URL]'.bbcode_to_html
-    assert_equal %Q(<a href="http://www.altctrlsupr.com/dmstk/kdd070803/00.html"> ABRIR<br />\nALBUM </a>),"[URL=http://www.altctrlsupr.com/dmstk/kdd070803/00.html] ABRIR\nALBUM [/URL]".bbcode_to_html
+    assert_equal %Q(<a href="http://www.altctrlsupr.com/dmstk/kdd070803/00.html"> ABRIR\nALBUM </a>),"[URL=http://www.altctrlsupr.com/dmstk/kdd070803/00.html] ABRIR\nALBUM [/URL]".bbcode_to_html
     assert_equal '<a href="http://www.urimalet.com/cadaverex.mp3">aha</a>', "[URL=http://www.urimalet.com/cadaverex.mp3]aha[/URL]".bbcode_to_html
     # allow quoted urls:
     assert_equal '<a href="http://www.apple.com">aha</a>', '[URL="http://www.apple.com"]aha[/URL]'.bbcode_to_html
@@ -195,7 +195,7 @@ class TestBBRuby < Test::Unit::TestCase
 
   def test_to_html_with_no_markup
     foo = "first paragraph\n\nsecond paragraph\nwith a linebreak"
-    assert_equal "first paragraph<br />\n<br />\nsecond paragraph<br />\nwith a linebreak", foo.bbcode_to_html
+    assert_equal foo, foo.bbcode_to_html
   end
 
   def test_to_html_with_formatting
@@ -204,7 +204,7 @@ class TestBBRuby < Test::Unit::TestCase
   end
 
   def test_self_tag_list
-    assert_equal 32, BBRuby.tag_list.size
+    assert_equal 33, BBRuby.tag_list.size
   end
 
   def test_redefinition_of_tag_html
@@ -256,4 +256,58 @@ class TestBBRuby < Test::Unit::TestCase
     assert_equal "this [b]should not do formatting[/i]", "this [b]should not do formatting[/i]".bbcode_to_html
   end
 
+## proc tests below
+  def test_redefinition_replacement_to_proc # contrived example
+    mydef = {
+      'Quote' => [
+        /\[quote(:.*)?=(?:&quot;)?(.*?)(?:&quot;)?\](.*?)\[\/quote\1?\]/mi,
+        lambda { |e| "<div class=\"quote\"><p><cite>#{e[2]}</cite></p><blockquote>#{e[3]}</blockquote></div>"},
+        'Quote with citation (lambda)',
+        nil, nil,
+        :quote]
+    }
+    assert_equal '<div class="quote"><p><cite>Who</cite></p><blockquote>said that</blockquote></div>', '[quote=Who]said that[/quote]'.bbcode_to_html(mydef)
+  end
+
+  def test_proc_modifer # sum as example
+    mydef = {
+      'Sum (lambda)' => [
+        /\[sum(:.*)?=(?:&quot;)?(.*?)(?:&quot;)?\](\d+?)\+(\d+?)\[\/sum\1?\]/mi,
+        lambda { |e| "<span class=\"#{e[2]}\">#{e[3].to_i + e[4].to_i}</span>"},
+        'Sum (lambda)',
+        nil, nil,
+        :sum]
+    }
+    assert_equal '<span class="sum">4</span>', '[sum=sum]2+2[/sum]'.bbcode_to_html(mydef)
+  end
+
+  # for next test
+  def sum a, b; a + b end
+
+  def test_proc_include_method # sum as example
+    mydef = {
+      'Sum (lambda)' => [
+        /\[sum(:.*)?=(?:&quot;)?(.*?)(?:&quot;)?\](\d+?)\+(\d+?)\[\/sum\1?\]/mi,
+        lambda { |e| "<span class=\"#{e[2]}\">#{sum(e[3].to_i, e[4].to_i)}</span>"},
+        'Sum (lambda)',
+        nil, nil,
+        :sum]
+    }
+    assert_equal '<span class="sum">4</span>', '[sum=sum]2+2[/sum]'.bbcode_to_html(mydef)
+  end
+
+  # Proc.new{} as opposed to lambda{} may have not params
+  def test_proc_instead_of_lambda # copyright
+    copyright = "2913-3013 The Company, Ltd."
+    mydef = {
+      'copy' => [
+        /\[copy\/\]/mi,
+        Proc.new{"<span class=\"copy\">&copy; #{copyright}</span>"},
+        'Copy (Proc)',
+        nil, nil,
+        :copy]
+    }
+    assert_equal '<span class="copy">&copy; 2913-3013 The Company, Ltd.</span>', '[copy/]'.bbcode_to_html(mydef)
+  end
+
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bb-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.8
   prerelease: 
+  version: '1.0'
 platform: ruby
 authors:
 - Craig P. Jolicoeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies: []
 description: BBCode for Ruby
 email:
@@ -36,20 +36,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: BBRuby is a BBCode implementation for Ruby. It will convert strings with