BBRuby

What

BBRuby is a BBCode implementation for Ruby. It will convert strings with BBCode markup to their HTML equivalent.

Installing

To install as a gem:

sudo gem install bb-ruby

To install as a plugin:

script/plugin install git://github.com/cpjolicoeur/bb-ruby.git

Demonstration of usage

BBRuby has been included directly into the String class for use on any string object:

require 'bb-ruby' # (only needed if installed as a gem)

text = "[b]Here is some bold text[/b] followed by some [u]underlined text[/u]."
output = text.bbcode_to_html
text.bbcode_to_html! # (direct in-place conversion)

BBRuby will auto-escape HTML tags, which can be prevented by passing false as the second param. BBRuby can also enable or disable certain tags based on input

output = text.bbcode_to_html({}, false)

You can also choose to only allow certain BBCode tags to be processed. The following will only process image, bold and quote tags.

output = text.bbcode_to_html({}, true, :enable, :image, :bold, :quote)

You can also disable certain tags from being processed.

output = text.bbcode_to_html({}, true, :disable, :image, :bold, :quote)

Alternately you can access BBRuby directly and not via a string:

output = BBRuby.to_html(bbcode_markup)

BBRuby will also allow you to define your own custom BBCode markup translations or override the built-in translations to be more flexible with your application. The first parameter is a hash that accepts your custom markup translations:

custom_blockquote = {
  'Quote' => [
    /\[quote(:.*)?=(.*?)\](.*?)\[\/quote\1?\]/mi,
    '<div class="quote"><p><cite>\2</cite></p><blockquote>\3</blockquote></div>',
    'Quote with citation',
    '[quote=mike]please quote me[/quote]',
    :quote
  ],      
}

text.bbcode_to_html(custom_blockquote)

Tags Processed

The following is the list of BBCode tags processed by BBRuby and their associated symbol for enabling/disabling them

[b] :bold
[i] :italics
[u] :underline
[s] :strikeout
[del] :delete
[ins] :insert
[code] :code
[size] :size
[color] :color
[ol] :orderedlist
[ul] :unorderedlist
[li] :listitem
[*] :listitem
[list] :listitem
[list=1] :listitem
[list=a] :listitem
[dl] :definelist
[dt] :defineterm
[dd] :definition
[quote] :quote
[quote=source] :quote
[url=link] :link
[url] :link
[img size=] :image
[img=] :image
[img] :image
[youtube] :video
[gvideo] :video
[vimeo] :video
[email] :email

Forum

http://groups.google.com/group/bb-ruby

How to submit patches

First read the 8 steps for fixing other people’s code

Then fork your own copy of the repository on github, make your patch and then submit a pull request via github.

github: http://github.com/cpjolicoeur/bb-ruby/tree/master

git clone git://github.com/cpjolicoeur/bb-ruby.git

Build and test instructions

cd bb-ruby
rake test
rake install_gem

Documentation

http://bb-ruby.rubyforge.org/rdoc

License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Contact

Comments are welcome. Send an email to Craig P Jolicoeur or email via the Google Group

Craig P Jolicoeur, 20th November 2009
Theme extended from Paul Battley