bb-ruby

bb-ruby is a BBCode implementation for Ruby

Usage

require 'bb-ruby'

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

text = "[b]Here is some bold text[/b] followed by some [u]underlined text[/u]"

output = text.bbcode_to_html

text.bbcode_to_html!

Only allow certain tags:

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

Disable certain tags:

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

Alternative Direct usage:

output = BBRuby.to_html(bbcode_markup)

Developers

• Craig P Jolicoeur

License

Copyright (c) 2008 Craig P Jolicoeur

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.

Acknowledgements

• ruby-bbcode project
• Nazgum’s Blog

TODO

• add support for email tag
• add support for code tag