ruby-bbcode 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.

data/README.textile

@@ -0,0 +1,29 @@
+h1. Ruby-BBcode
+
+This plugin adds support for "BBCode":http:/www.bbcode.org/ to Ruby. The BBCode is parsed by a parser before converted to HTML, allowing to convert nested BBCode tags in strings to their correct HTML equivalent. The parser also checks whether the BBCode is valid and gives errors for incorrect BBCode texts.
+
+The parser recognizes all "official tags":http://www.bbcode.org/reference.php and allows to easily extend this set with custom tags.
+
+h2. Example
+
+<pre><code>'This is [b]bold[/b] and this is [i]italic[/i].'.bbcode_to_html
+ => 'This is <strong>bold</strong> and this is <em>italic</em>.'</code></pre>
+
+h2. Installing
+
+Add the folling line to the Gemfile in your Rails application:
+<pre><code>gem 'ruby-bbcode', :git => 'git://github.com/veger/ruby-bbcode.git'</code></pre>
+Run
+<pre><code>bundle install</code></pre>
+
+And the gem is available in you application
+
+_Note_: Do not forget to restart your server!
+
+h2. Acknowledgements
+
+Some of the ideas and the tests came from "bb-ruby":http://github.com/cpjolicoeur/bb-ruby of Craig P Jolicoeur
+
+h2. License
+
+MIT License. See the included MIT-LICENCE file.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RubyBbcode'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+task :default => :test

data/lib/ruby-bbcode.rb

@@ -0,0 +1,214 @@
+require 'tags/tags'
+
+module RubyBBCode
+  include BBCode::Tags
+
+  @@to_sentence_bbcode_tags = {:words_connector => "], [", 
+    :two_words_connector => "] and [", 
+    :last_word_connector => "] and ["}
+
+  def self.to_html(text, escape_html = true, additional_tags = {}, method = :disable, *tags)
+    # We cannot convert to HTML if the BBCode is not valid!
+    text = text.clone
+    use_tags = @@tags.merge(additional_tags)
+
+    if method == :disable then
+      tags.each { |t| use_tags.delete(t) }
+    else
+      new_use_tags = {}
+      tags.each { |t| new_use_tags[t] = use_tags[t] if use_tags.key?(t) }
+      use_tags = new_use_tags
+    end
+
+    if escape_html
+      text.gsub!('<', '&lt;')
+      text.gsub!('>', '&gt;')
+    end
+    text.gsub!("\r\n", "\n")
+    text.gsub!("\n", "<br />\n")
+
+    valid = parse(text, use_tags)
+    raise valid.join(', ') if valid != true
+
+    bbtree_to_html(@bbtree[:nodes], use_tags)
+  end
+
+  def self.is_valid?(text, additional_tags = {})
+    parse(text, @@tags.merge(additional_tags));
+  end
+
+  def self.tag_list
+    @@tags
+  end
+
+  protected
+  def self.parse(text, tags = {})
+    tags = @@tags if tags == {}
+    tags_list = []
+    @bbtree = {:nodes => []}
+    bbtree_depth = 0
+    bbtree_current_node = @bbtree
+    text.scan(/((\[ (\/)? (\w+) ((=[^\[\]]+) | (\s\w+=\w+)* | ([^\]]*))? \]) | ([^\[]+))/ix) do |tag_info|
+      ti = find_tag_info(tag_info)
+
+      if ti[:is_tag] and !tags.include?(ti[:tag].to_sym)
+        # Handle as text from now on!
+        ti[:is_tag] = false
+        ti[:text] = ti[:complete_match]
+      end
+     
+      if !ti[:is_tag] or !ti[:closing_tag]
+        if ti[:is_tag]
+          tag = tags[ti[:tag].to_sym]
+          unless tag[:only_in].nil? or (tags_list.length > 0 and tag[:only_in].include?(tags_list.last.to_sym))
+            # Tag does to be put in the last opened tag
+            err = "[#{ti[:tag]}] can only be used in [#{tag[:only_in].to_sentence(@@to_sentence_bbcode_tags)}]"
+            err += ", so using it in a [#{tags_list.last}] tag is not allowed" if tags_list.length > 0
+            return [err]
+          end
+
+          if tag[:allow_tag_param] and ti[:params][:tag_param] != nil
+            # Test if matches
+            return [tag[:tag_param_description].gsub('%param%', ti[:params][:tag_param])] if ti[:params][:tag_param].match(tag[:tag_param]).nil?
+          end
+        end
+
+        if tags_list.length > 0 and  tags[tags_list.last.to_sym][:only_allow] != nil
+          # Check if the found tag is allowed
+          last_tag = tags[tags_list.last.to_sym]
+          allowed_tags = last_tag[:only_allow]
+          if (!ti[:is_tag] and last_tag[:require_between] != true) or (ti[:is_tag] and (allowed_tags.include?(ti[:tag].to_sym) == false))
+            # Last opened tag does not allow tag
+            err = "[#{tags_list.last}] can only contain [#{allowed_tags.to_sentence(@@to_sentence_bbcode_tags)}] tags, so "
+            err += "[#{ti[:tag]}]" if ti[:is_tag]
+            err += "\"#{ti[:text]}\"" unless ti[:is_tag]
+            err += ' is not allowed'
+            return [err]
+          end
+        end
+
+        # Validation of tag succeeded, add to tags_list and/or bbtree
+        if ti[:is_tag]
+          tag = tags[ti[:tag].to_sym]
+          tags_list.push ti[:tag]
+          element = {:is_tag => true, :tag => ti[:tag].to_sym, :nodes => [] }
+          element[:params] = {:tag_param => ti[:params][:tag_param]} if tag[:allow_tag_param] and ti[:params][:tag_param] != nil
+        else
+          element = {:is_tag => false, :text => ti[:text] }
+          if bbtree_depth > 0
+            tag = tags[bbtree_current_node[:tag]]
+            if tag[:require_between] == true
+              bbtree_current_node[:between] = ti[:text]
+              if tag[:allow_tag_param] and tag[:allow_tag_param_between] and (bbtree_current_node[:params] == nil or bbtree_current_node[:params][:tag_param] == nil)
+                # Did not specify tag_param, so use between.
+                # Check if valid
+                return [tag[:tag_param_description].gsub('%param%', ti[:text])] if ti[:text].match(tag[:tag_param]).nil?
+                # Store as tag_param
+                bbtree_current_node[:params] = {:tag_param => ti[:text]} 
+              end
+              element = nil
+            end
+          end
+        end
+        bbtree_current_node[:nodes] << element unless element == nil
+        if ti[:is_tag]
+          # Advance to next level (the node we just added)
+          bbtree_current_node = element
+          bbtree_depth += 1
+        end
+      end
+
+      if  ti[:is_tag] and ti[:closing_tag]
+        if ti[:is_tag]
+          tag = tags[ti[:tag].to_sym]
+          return ["Closing tag [/#{ti[:tag]}] does match [#{tags_list.last}]"] if tags_list.last != ti[:tag]
+          return ["No text between [#{ti[:tag]}] and [/#{ti[:tag]}] tags."] if tag[:require_between] == true and bbtree_current_node[:between].blank?
+          tags_list.pop
+
+          # Find parent node (kinda hard since no link to parent node is available...)
+          bbtree_depth -= 1
+          bbtree_current_node = @bbtree
+          bbtree_depth.times { bbtree_current_node = bbtree_current_node[:nodes].last }
+        end
+      end
+    end
+    return ["[#{tags_list.to_sentence((@@to_sentence_bbcode_tags))}] not closed"] if tags_list.length > 0
+
+    true
+  end
+
+  def self.find_tag_info(tag_info)
+    ti = {}
+    ti[:complete_match] = tag_info[0]
+    ti[:is_tag] = (tag_info[0].start_with? '[')
+    if ti[:is_tag]
+      ti[:closing_tag] = (tag_info[2] == '/')
+      ti[:tag] = tag_info[3]
+      ti[:params] = {}
+      if tag_info[4][0] == ?=
+        ti[:params][:tag_param] = tag_info[4][1..-1]
+      elsif tag_info[4][0] == ?\s
+        #TODO: Find params
+      end
+    else
+      # Plain text
+      ti[:text] = tag_info[8]
+    end
+    ti
+  end
+
+  def self.bbtree_to_html(node_list, tags = {})
+    tags = @@tags if tags == {}
+    text = ""
+    node_list.each do |node|
+      if node[:is_tag]
+        tag = tags[node[:tag]]
+        t = tag[:html_open].dup
+        t.gsub!('%between%', node[:between]) if tag[:require_between]
+        if tag[:allow_tag_param]
+          if node[:params] and !node[:params][:tag_param].blank?
+            match_array = node[:params][:tag_param].scan(tag[:tag_param])[0]
+            index = 0
+            match_array.each do |match|
+              if index < tag[:tag_param_tokens].length
+                t.gsub!("%#{tag[:tag_param_tokens][index][:token].to_s}%", tag[:tag_param_tokens][index][:prefix].to_s+match+tag[:tag_param_tokens][index][:postfix].to_s)
+                index += 1
+              end
+            end
+          else
+            # Remove unused tokens
+            tag[:tag_param_tokens].each do |token|
+              t.gsub!("%#{token[:token]}%", '')
+            end
+          end
+        end
+
+        text += t
+        text += bbtree_to_html(node[:nodes], tags) if node[:nodes].length > 0
+        t = tag[:html_close]
+        t.gsub!('%between%', node[:between]) if tag[:require_between]
+        text += t
+      else
+        text += node[:text] unless node[:text].nil?
+      end
+    end
+    text
+  end
+end
+
+String.class_eval do
+  # Convert a string with BBCode markup into its corresponding HTML markup
+  def bbcode_to_html(escape_html = true, additional_tags = {}, method = :disable, *tags)
+    RubyBBCode.to_html(self, escape_html, additional_tags, method, *tags)
+  end
+  
+  # Replace the BBCode content of a string with its corresponding HTML markup
+  def bbcode_to_html!(escape_html = true, additional_tags = {}, method = :disable, *tags)
+    self.replace(RubyBBCode.to_html(self, escape_html, additional_tags, method, *tags))
+  end
+
+  # Check if string contains valid BBCode. Returns true when valid, else returns array with error(s)
+  def is_valid_bbcode?
+    RubyBBCode.is_valid?(self)
+  end
+end

data/lib/ruby-bbcode/version.rb

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

data/lib/tags/tags.rb

@@ -0,0 +1,95 @@
+module BBCode
+  module Tags
+    # tagname => tag, HTML open tag, HTML close tag, description, example
+    @@tags = {
+      :b => {
+        :html_open => '<strong>', :html_close => '</strong>',
+        :description => 'Make text bold',
+        :example => 'This is [b]bold[/b].'},
+      :i => {
+        :html_open => '<em>', :html_close => '</em>',
+        :description => 'Make text italic',
+        :example => 'This is [i]italic[/i].'},
+      :u => {
+        :html_open => '<u>', :html_close => '</u>',
+        :description => 'Underline text',
+        :example => 'This is [u]underlined[/u].'},
+      :s => {
+        :html_open => '<span style="text-decoration:line-through;">', :html_close => '</span>',
+        :description => 'Strike-through text',
+        :example => 'This is [s]wrong[/s] good.'},
+      :center => {
+        :html_open => '<div style="text-align:center;">', :html_close => '</div>',
+        :description => 'Center a text',
+        :example => '[center]This is centered[/center].'},
+      :ul => {
+        :html_open => '<ul>', :html_close => '</ul>',
+        :description => 'Unordered list',
+        :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
+        :only_allow => [ :li ]},
+      :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 ]},
+      :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 ]},
+      :img => {
+        :html_open => '<img src="%between%" %width%%height%alt="" />', :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 => '<a href="%url%">%between%', :html_close => '</a>',
+        :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 => {
+        :html_open => '<div class="quote">%author%', :html_close => '</div>',
+        :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 => '<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_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_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 => [],
+        :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]',
+        :only_allow => [],
+        :require_between => true},
+    }
+  end
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "ruby-bbcode"
+
+module Dummy
+  class Application < Rails::Application
+   # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/ruby_bbcode_test.rb

@@ -0,0 +1,197 @@
+require 'test_helper'
+
+class RubyBbcodeTest < Test::Unit::TestCase
+
+  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_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
+  end
+
+  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
+
+  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_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_illegal_items
+    assert_raise RuntimeError do
+      '[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?
+    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?
+  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_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?
+  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_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?
+  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
+    assert_equal '<div class="quote"><strong>Kitten wrote:</strong><div class="quote"><strong>creatiu wrote:</strong>f1</div>f2</div>',
+                  '[quote=Kitten][quote=creatiu]f1[/quote]f2[/quote]'.bbcode_to_html
+  end
+
+  def test_link
+    assert_equal '<a href="http://www.google.com">http://www.google.com</a>', '[url]http://www.google.com[/url]'.bbcode_to_html
+    assert_equal '<a href="http://google.com">Google</a>', '[url=http://google.com]Google[/url]'.bbcode_to_html
+    assert_equal '<a href="/index.html">Home</a>', '[url=/index.html]Home[/url]'.bbcode_to_html
+  end
+
+  def test_illegal_link
+    assert_raise RuntimeError do
+      # Link within same domain must start with a /
+      '[url=index.html]Home[/url]'.bbcode_to_html
+    end
+    assert_raise RuntimeError do
+      # 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
+  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="" />', 
+                   '[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_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
+  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)
+    assert_equal '1 is &lt; 2', '1 is < 2'.bbcode_to_html
+    assert_equal '1 is < 2', '1 is < 2'.bbcode_to_html(false)
+    assert_equal '2 is &gt; 1', '2 is > 1'.bbcode_to_html
+    assert_equal '2 is > 1', '2 is > 1'.bbcode_to_html(false)
+  end
+
+  def test_disable_tags
+    assert_equal "[b]foobar[/b]", "[b]foobar[/b]".bbcode_to_html(true, {}, :disable, :b)
+    assert_equal "[b]<em>foobar</em>[/b]", "[b][i]foobar[/i][/b]".bbcode_to_html(true, {}, :disable, :b)
+    assert_equal "[b][i]foobar[/i][/b]", "[b][i]foobar[/i][/b]".bbcode_to_html(true, {}, :disable, :b, :i)
+  end
+
+  def test_enable_tags
+    assert_equal "<strong>foobar</strong>" , "[b]foobar[/b]".bbcode_to_html(true, {}, :enable, :b)
+    assert_equal "<strong>[i]foobar[/i]</strong>", "[b][i]foobar[/i][/b]".bbcode_to_html(true, {}, :enable, :b)
+    assert_equal "<strong><em>foobar</em></strong>", "[b][i]foobar[/i][/b]".bbcode_to_html(true, {}, :enable, :b, :i)
+  end
+
+  def test_to_html_bang_method
+    foo = "[b]foobar[/b]"
+    assert_equal "<strong>foobar</strong>", foo.bbcode_to_html!
+    assert_equal "<strong>foobar</strong>", foo
+  end
+
+  def test_self_tag_list
+    assert_equal 15, RubyBBCode.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_html(true, mydef)
+    assert_equal 'pre <strong><test>Test here</test></strong> post', 'pre [b][test]Test here[/test][/b] post'.bbcode_to_html(true, mydef)
+  end
+
+  def test_multiple_tag_test
+    assert_equal "<strong>bold</strong><em>italic</em><u>underline</u><div class=\"quote\">quote</div><a href=\"https://test.com\">link</a>",
+                   "[b]bold[/b][i]italic[/i][u]underline[/u][quote]quote[/quote][url=https://test.com]link[/url]".bbcode_to_html
+  end
+
+  def test_no_ending_tag
+    assert_raise RuntimeError do
+      "this [b]should not be bold".bbcode_to_html 
+    end
+  end
+
+  def test_no_start_tag
+    assert_raise RuntimeError do
+      "this should not be bold[/b]".bbcode_to_html
+    end
+  end
+
+  def test_different_start_and_ending_tags
+    assert_raise RuntimeError do
+      "this [b]should not do formatting[/i]".bbcode_to_html
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-bbcode
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Maarten Bezemer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-19 00:00:00 Z
+dependencies: []
+
+description: Convert BBCode to HTML and check whether the BBCode is valid.
+email: 
+- maarten.bezemer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/tags/tags.rb
+- lib/ruby-bbcode/version.rb
+- lib/ruby-bbcode.rb
+- MIT-LICENSE
+- Rakefile
+- README.textile
+- test/ruby_bbcode_test.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/test_helper.rb
+homepage: http://github.com/veger/ruby-bbcode
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: ruby-bbcode-0.0.2
+test_files: 
+- test/ruby_bbcode_test.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/test_helper.rb