bbcodeizer 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in bbcodeizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Jonathan Dance / Agora Games
+Copyright (c) 2011 Luke Curley
+
+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

@@ -0,0 +1,128 @@
+== BBCodeizer
+
+BBCodeizer is a gem used to translate BBCode to HTML. The main interface
+is provided through the helper method "bbcodeize." Use of it is as simple as
+passing a string to bbcodeize:
+
+  <%= bbcodeize post.body %>
+
+You can also invoke the BBCodeizer directly without the helper:
+
+  render :text => BBCodeizer.bbcodeize(post.body)
+
+All settings are centralized so you can very quickly deactivate any tag or
+modify the HTML that is generated. You can modify these settings by adding
+lines to the end of your environment.rb. For example:
+
+  # deactivate [color], [size], and [code] tags
+  BBCodeizer.deactivate(:color, :size, :code)
+
+  # use <b> instead of <strong>
+  BBCodeizer.replace_using(:bold, '<b>\1</b>')
+
+These changes should be considered one-time configuration, e.g. tags
+cannot be deactivated then activated again.
+
+== Warning
+
+While BBCodeizer does some validation (see below), you should be aware it is
+possible to create unsafe HTML in the wrong hands (for example, invoking
+Javascript using the [url] tag). It is highly recommended you run the
+resulting HTML through a sanity checker such as WhiteList:
+
+  http://svn.techno-weenie.net/projects/plugins/white_list/
+
+Once installed, the following is a helper method that will produce nicely
+formatted, safe HTML:
+
+  def format_text(text)
+    white_list(simple_format(auto_link(bbcodeize(h(text)))))
+  end
+
+== Supported Tags
+
+BBCodeizer currently supports the following tags. The default HTML expansion
+is documented here.
+
+  [u]text[/u]
+
+    <u>text</u>
+
+  [b]text[/b]
+
+    <strong>text</strong>
+
+  [i]text[/i]
+
+    <em>text</em>
+
+  [img]http://example.com/image.gif[/img]
+
+    <img src="http://example.com/image.gif" />
+
+  [email=joe@example.com]Joe Example[/email]
+
+    <a href="mailto:joe@example.com">Joe Example</a>
+
+  [email]joe@example.com[/email]
+
+   <a href="mailto:joe@example.com">joe@example.com</a>
+
+  [code]bbcodeize(string)[/code]
+
+    <pre>bbcodeize(string)</pre>
+
+  [url=http://www.google.com]Google[/url]
+
+    <a href="http://www.google.com">Google</a>
+
+  [url]http://www.google.com[/url]
+
+    <a href="http://www.google.com">http://www.google.com</a>
+
+  [quote="Shakespeare"]To be or not to be[/quote]
+
+    <blockquote><cite>Shakespeare wrote:</cite><br />To be or not to
+  be</blockquote>
+
+  [quote]That is the question[/quote]
+
+    <blockquote>That is the question</blockquote>
+
+  [size=32]Big Text[/size]
+
+    <span style="font-size: 32px">Big Text</span>
+
+  [color=red]Red Text[/color] [color=#ABCDEF]Alphabet-colored Text[/color]
+
+    <span style="color: red">Red Text</span>
+    <span style="color: #ABCDEF">Alphabet Colored Text</span>
+
+== Validation
+
+BBCodeizer aims to produce HTML that will not break your site - all opening
+tags must have a closing tag or they will not be replaced (unmatched tags are
+left as-is). All [code] and [quote] tags are left entirely untouched if there
+is any mismatch with either of these. All other tags will replace as many as
+possible and leave the remaining unmatched tags as-is.
+
+BBCodeizer attempts to produce XHTML-compliant markup, however, misuse of
+nesting tags is not validated or corrected. For example:
+
+ [b]bold [u]bold + underline[/b] underline[/u]
+
+Will produce the following HTML:
+
+ <strong>bold <u>bold + underline</strong> underline</u>
+
+Colors in the [color] tag are not validated - any string can be used. Strings
+containing semicolons are not allowed to prevent users from adding additional
+style rules.
+
+Sizes used in the [size] tag are validated - only 1 or 2 digit numbers are
+accepted.
+
+-----------------
+Copyright (c) 2006 Jonathan Dance / Agora Games
+Copyright (c) 2011 Luke Curley
+Distributed under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the BBCodeizer plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the BBCodeizer plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BBCodeizer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bbcodeizer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bbcodeizer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bbcodeizer"
+  s.version     = Bbcodeizer::VERSION
+  s.authors     = ["Jonathan Dance", "Luke Curley"]
+  s.email       = ["jd+bbcodeizer@wuputah.com", "luke@box.net"]
+  s.homepage    = "https://github.com/qpingu/bbcodeizer"
+  s.summary     = %q{BBCodeizer is a simple gem that translates BBCode to HTML}
+
+  s.rubyforge_project = "bbcodeizer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rdoc"
+end

data/init.rb

@@ -0,0 +1,4 @@
+require 'bbcodeizer'
+require 'bbcodeize_helper'
+
+ActionView::Base.send :include, BBCodeizeHelper

data/lib/bbcodeize_helper.rb

@@ -0,0 +1,8 @@
+require 'bbcodeizer'
+
+module BBCodeizeHelper
+  # Parses all bbcode in +text+ and returns a new HTML-formatted string.
+  def bbcodeize(text)
+    BBCodeizer.bbcodeize(text)
+  end
+end

data/lib/bbcodeizer/version.rb

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

data/lib/bbcodeizer.rb

@@ -0,0 +1,77 @@
+module BBCodeizer
+  class << self
+
+    #:nodoc:
+    Tags = {
+      :start_code            => [ /\[code\]/i,                           '<pre>' ],
+      :end_code              => [ /\[\/code\]/i,                         '</pre>' ],
+      :start_quote           => [ /\[quote(?:=".*?")?\]/i,               nil ],
+      :start_quote_with_cite => [ /\[quote="(.*?)"\]/i,                  '<blockquote><cite>\1 wrote:</cite><br />' ],
+      :start_quote_sans_cite => [ /\[quote\]/i,                          '<blockquote>' ],
+      :end_quote             => [ /\[\/quote\]/i,                        '</blockquote>' ],
+      :bold                  => [ /\[b\](.+?)\[\/b\]/i,                  '<strong>\1</strong>' ],
+      :italic                => [ /\[i\](.+?)\[\/i\]/i,                  '<em>\1</em>' ],
+      :underline             => [ /\[u\](.+?)\[\/u\]/i,                  '<u>\1</u>' ],
+      :email_with_name       => [ /\[email=(.+?)\](.+?)\[\/email\]/i,    '<a href="mailto:\1">\2</a>' ],
+      :email_sans_name       => [ /\[email\](.+?)\[\/email\]/i,          '<a href="mailto:\1">\1</a>' ],
+      :url_with_title        => [ /\[url=(.+?)\](.+?)\[\/url\]/i,        '<a href="\1">\2</a>' ],
+      :url_sans_title        => [ /\[url\](.+?)\[\/url\]/i,              '<a href="\1">\1</a>' ],
+      :image                 => [ /\[img\](.+?)\[\/img\]/i,              '<img src="\1" />' ],
+      :size                  => [ /\[size=(\d{1,2})\](.+?)\[\/size\]/i,  '<span style="font-size: \1px">\2</span>' ],
+      :color                 => [ /\[color=([^;]+?)\](.+?)\[\/color\]/i, '<span style="color: \1">\2</span>' ]
+    }
+
+    # Tags in this list are invoked. To deactivate a particular tag, call BBCodeizer.deactivate.
+    # These names correspond to either names above or methods in this module.
+    TagList = [ :bold, :italic, :underline, :email_with_name, :email_sans_name,
+                :url_with_title, :url_sans_title, :image, :size, :color,
+                :code, :quote ]
+
+    # Parses all bbcode in +text+ and returns a new HTML-formatted string.
+    def bbcodeize(text)
+      text = text.dup
+      TagList.each do |tag|
+        if Tags.has_key?(tag)
+          apply_tag(text, tag)
+        else
+          self.send(tag, text)
+        end
+      end
+      text
+    end
+
+    # Configuration option to deactivate particular +tags+.
+    def deactivate(*tags)
+      tags.each { |t| TagList.delete(t) }
+    end
+
+    # Configuration option to change the replacement string used for a particular +tag+. The source
+    # code should be referenced to determine what an appropriate replacement +string+ would be.
+    def replace_using(tag, string)
+      Tags[tag][1] = string
+    end
+
+  private
+
+    def code(string)
+      # code tags must match, else don't do any replacing.
+      if string.scan(Tags[:start_code].first).size == string.scan(Tags[:end_code].first).size
+        apply_tags(string, :start_code, :end_code)
+      end
+    end
+
+    def quote(string)
+      # quotes must match, else don't do any replacing
+      if string.scan(Tags[:start_quote].first).size == string.scan(Tags[:end_quote].first).size
+        apply_tags(string, :start_quote_with_cite, :start_quote_sans_cite, :end_quote)
+      end
+    end
+
+    def apply_tags(string, *tags)
+      tags.each do |tag|
+        string.gsub!(*Tags[tag])
+      end
+    end
+    alias_method :apply_tag, :apply_tags
+  end
+end

data/rdoc/BBCodeizeHelper.html

@@ -0,0 +1,182 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: BBCodeizeHelper</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/bbcodeize_helper_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/bbcodeize_helper.rb">lib/bbcodeize_helper.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+
+      
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          
+          <li><a href="#method-i-bbcodeize">#bbcodeize</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./README.html">README</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./BBCodeizeHelper.html">BBCodeizeHelper</a></li>
+        
+          <li><a href="./Bbcodeizer.html">Bbcodeizer</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">BBCodeizeHelper</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+      <div id="public-instance-method-details" class="method-section section">
+        <h3 class="section-header">Public Instance Methods</h3>
+
+      
+        <div id="bbcodeize-method" class="method-detail ">
+          <a name="method-i-bbcodeize"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">bbcodeize</span><span
+              class="method-args">(text)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            <p>Parses all bbcode in <tt>text</tt> and returns a new HTML-formatted string.</p>
+            
+
+            
+            <div class="method-source-code" id="bbcodeize-source">
+<pre>
+<span class="ruby-comment"># File lib/bbcodeize_helper.rb, line 5</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">bbcodeize</span>(<span class="ruby-identifier">text</span>)
+  <span class="ruby-constant">BBCodeizer</span>.<span class="ruby-identifier">bbcodeize</span>(<span class="ruby-identifier">text</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- bbcodeize-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- bbcodeize-method -->
+
+      
+      </div><!-- public-instance-method-details -->
+    
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+

data/rdoc/Bbcodeizer.html

@@ -0,0 +1,146 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: Bbcodeizer</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/bbcodeizer/version_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/bbcodeizer/version.rb">lib/bbcodeizer/version.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./README.html">README</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./BBCodeizeHelper.html">BBCodeizeHelper</a></li>
+        
+          <li><a href="./Bbcodeizer.html">Bbcodeizer</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">Bbcodeizer</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+      <!-- Constants -->
+      <div id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        
+          <dt><a name="VERSION">VERSION</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+        </dl>
+      </div>
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+