cpjolicoeur-bb-ruby 0.6.1

data/README.markdown

@@ -0,0 +1,73 @@
+# bb-ruby
+
+bb-ruby is a [BBCode](http://www.bbcode.org) implementation for Ruby
+
+## Installation
+
+To install as a plugin:
+
+`./script/plugin install git://github.com/cpjolicoeur/bb-ruby.git`
+
+To install as a gem:
+
+`sudo gem install bb-ruby --source=http://gems.github.com/`
+
+## 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](http://github.com/cpjolicoeur)
+
+## 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](http://code.google.com/p/ruby-bbcode/)
+* [Nazgum's Blog](http://www.nazgum.com/2008/01/08/bbcode-with-ruby-on-rails-part-1/)
+
+## TODO
+
+* add support for [email] tag
+* add support for [code] tag

data/bb-ruby.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = "bb-ruby"
+  s.version = "0.6.1"
+  s.date = "2008-06-27"
+  s.summary = "BBCode conversion library for Ruby"
+  s.email = "cpjolicoeur@gmail.com"
+  s.homepage = "http://github.com/cpjolicoeur/bb-ruby"
+  s.description = "bb-ruby is a Ruby library to convert BBCode markup to HTML"
+  s.has_rdoc = false
+  s.authors = ["Craig P Jolicoeur"]
+  s.files = ["bb-ruby.gemspec", "init.rb", "README.markdown", "lib/bb-ruby.rb", "test/test-bb-ruby.rb"]
+  s.test_files = ["test/test-bb-ruby.rb"]
+end

data/init.rb

@@ -0,0 +1 @@
+require 'bb-ruby'

data/lib/bb-ruby.rb

@@ -0,0 +1,215 @@
+module BBRuby
+  @@imageformats = 'png|bmp|jpg|gif'
+  @@tags = {
+    # tag name => [regex, replace, description, example, enable/disable symbol]
+    'Bold' => [
+      /\[b\](.*?)\[\/b\]/,
+      '<strong>\1</strong>',
+      'Embolden text',
+      'Look [b]here[/b]',
+      :bold],
+    'Italics' => [
+      /\[i\](.*?)\[\/i\]/,
+      '<em>\1</em>',
+      'Italicize or emphasize text',
+      'Even my [i]cat[/i] was chasing the mailman!',
+      :italics],
+    'Underline' => [
+      /\[u\](.*?)\[\/u\]/,
+      '<u>\1</u>',
+      'Underline',
+      'Use it for [u]important[/u] things or something',
+      :underline],
+    'Strikeout' => [
+      /\[s\](.*?)\[\/s\]/,
+      '<del>\1</del>',
+      'Strikeout',
+      '[s]nevermind[/s]',
+      :strikeout],
+    'Delete' => [
+      /\[del\](.*?)\[\/del\]/,
+      '<del>\1</del>',
+      'Deleted text',
+      '[del]deleted text[/del]',
+      :delete],
+    'Insert' => [
+      /\[ins\](.*?)\[\/ins\]/,
+      '<ins>\1</ins>',
+      'Inserted Text',
+      '[ins]inserted text[/del]',
+      :insert],
+
+    'Size' => [
+      /\[size=['"]?(.*?)['"]?\](.*?)\[\/size\]/im,
+      '<span style="font-size: \1px;">\2</span>',
+      'Change text size',
+      '[size=20]Here is some larger text[/size]',
+      :size],
+    'Color' => [
+      /\[color=['"]?(.*?)['"]?\](.*?)\[\/color\]/im,
+      '<span style="color: \1;">\2</span>',
+      'Change text color',
+      '[color=red]This is red text[/color]',
+      :color],
+  
+    'Ordered List' => [
+      /\[ol\](.*?)\[\/ol\]/m,
+      '<ol>\1</ol>',
+      'Ordered list',
+      'My favorite people (alphabetical order): [ol][li]Jenny[/li][li]Alex[/li][li]Beth[/li][/ol]',
+      :orderedlist],
+    'Unordered List' => [
+      /\[ul\](.*?)\[\/ul\]/m,
+      '<ul>\1</ul>',
+      'Unordered list',
+      'My favorite people (order of importance): [ul][li]Jenny[/li][li]Alex[/li][li]Beth[/li][/ul]',
+      :unorderedlist],
+    'List Item' => [
+      /\[li\](.*?)\[\/li\]/,
+      '<li>\1</li>',
+      'List item',
+      'See ol or ul',
+      :listitem],
+    'List Item (alternative)' => [
+      /\[\*\](.*?)$/,
+      '<li>\1</li>',
+      'List item (alternative)',
+      nil, nil,
+      :listitem],
+  
+    'Definition List' => [
+      /\[dl\](.*?)\[\/dl\]/m,
+      '<dl>\1</dl>',
+      'List of terms/items and their definitions',
+      '[dl][dt]Fusion Reactor[/dt][dd]Chamber that provides power to your... nerd stuff[/dd][dt]Mass Cannon[/dt][dd]A gun of some sort[/dd][/dl]',
+      :definelist],
+    'Definition Term' => [
+      /\[dt\](.*?)\[\/dt\]/,
+      '<dt>\1</dt>',
+      'List of definition terms',
+      nil, nil,
+      :defineterm],
+    'Definition Definition' => [
+      /\[dd\](.*?)\[\/dd\]/,
+      '<dd>\1</dd>',
+      'Definition definitions',
+      nil, nil,
+      :definition],
+  
+    'Quote' => [
+      /\[quote=(.*?)\](.*?)\[\/quote\]/m,
+      '<fieldset><legend>\1</legend><blockquote>\2</blockquote></fieldset>',
+      'Quote with citation',
+      nil, nil,
+      :quote],
+    'Quote (Sourceless)' => [
+      /\[quote\](.*?)\[\/quote\]/m,
+      '<fieldset><blockquote>\1</blockquote></fieldset>',
+      'Quote (sourceclass)',
+      nil, nil,
+      :quote],
+  
+    'Link' => [
+      /\[url=(.*?)\](.*?)\[\/url\]/,
+      '<a href="\1">\2</a>',
+      'Hyperlink to somewhere else',
+      'Maybe try looking on [url=http://google.com]Google[/url]?',
+      nil, nil,
+      :link],
+    'Link (Implied)' => [
+      /\[url\](.*?)\[\/url\]/,
+      '<a href="\1">\1</a>',
+      'Hyperlink (implied)',
+      nil, nil,
+      :link],
+    # 
+    # TODO: fix automatic links
+    #
+    # 'Link (Automatic)' => [
+    #   /http:\/\/(.*?)[^<\/a>]/,
+    #   '<a href="\1">\1</a>',
+    #   'Hyperlink (automatic)',
+    #   nil, nil,
+    #   :link],
+  
+    'Image' => [
+      /\[img\]([^\[\]].*?)\.(#{@@imageformats})\[\/img\]/i,
+      '<img src="\1.\2" alt="" />',
+      'Display an image',
+      'Check out this crazy cat: [img]http://catsweekly.com/crazycat.jpg[/img]',
+      :image],
+    'Image (Alternative)' => [
+      /\[img=([^\[\]].*?)\.(#{@@imageformats})\]/i,
+      '<img src="\1.\2" alt="" />',
+      'Display an image (alternative format)', 
+      '[img=http://myimage.com/logo.gif]',
+      :image],
+    'Image (Resized)' => [
+      /\[img size=['"]?(\d+)x(\d+)['"]?\](.*?)\[\/img\]/i,
+      '<img src="\3" style="width: \1px; height: \2px;" />',
+      'Display an image with a set width and height', 
+      '[img size=96x96]http://www.google.com/intl/en_ALL/images/logo.gif[/img]',
+      :image],
+      
+    'YouTube' => [
+      /\[youtube\](.*?)\?v=([\w\d\-]+).*\[\/youtube\]/i,
+      '<object width="400" height="330"><param name="movie" value="http://www.youtube.com/v/\2"></param><param name="wmode" value="transparent"></param><embed src="http://www.youtube.com/v/\2" type="application/x-shockwave-flash" wmode="transparent" width="400" height="330"></embed></object>',
+      'Display a video from YouTube.com', 
+      '[youtube]http://youtube.com/watch?v=E4Fbk52Mk1w[/youtube]',
+      :video],
+    'YouTube (Alternative)' => [
+      /\[youtube\](.*?)\/v\/([\w\d\-]+)\[\/youtube\]/i,
+      '<object width="400" height="330"><param name="movie" value="http://www.youtube.com/v/\2"></param><param name="wmode" value="transparent"></param><embed src="http://www.youtube.com/v/\2" type="application/x-shockwave-flash" wmode="transparent" width="400" height="330"></embed></object>',
+      'Display a video from YouTube.com (alternative format)', 
+      '[youtube]http://youtube.com/watch/v/E4Fbk52Mk1w[/youtube]',
+      :video],
+    'Google Video' => [
+      /\[gvideo\](.*?)\?docid=([-]{0,1}\d+).*\[\/gvideo\]/i,
+      '<embed style="width:400px; height:326px;" id="VideoPlayback" type="application/x-shockwave-flash" src="http://video.google.com/googleplayer.swf?docId=\2" flashvars=""> </embed>',
+      'Display a video from Google Video', 
+      '[gvideo]http://video.google.com/videoplay?docid=-2200109535941088987[/gvideo]',
+      :video]
+  }
+  def self.to_html(text, method = :disable, *tags)
+    text = text.clone
+    # escape < and > to remove any html
+    text.gsub!( '<', '&lt;' )
+    text.gsub!( '>', '&gt;' )
+    
+    # parse bbcode tags
+    case method
+      when :enable
+        @@tags.each_value { |t|
+          text.gsub!(t[0], t[1]) if tags.include?(t[4])
+        }
+      when :disable
+        # this works nicely because the default is disable and the default set of tags is [] (so none disabled) :)
+        @@tags.each_value { |t|
+          text.gsub!(t[0], t[1]) unless tags.include?(t[4])
+        }
+    end
+    
+    # parse spacing
+    text.gsub!( /\r\n?/, "\n" )
+    text.gsub!( /\n/, "<br />" )
+    
+    # return markup
+    text
+  end
+  
+  def self.tags
+    @@tags.each { |tn, ti|
+      # yields the tag name, a description of it and example
+      yield tn, ti[2], ti[3] if ti[2]
+    }
+  end
+end
+
+class String
+  def bbcode_to_html(method = :disable, *tags)
+          BBRuby.to_html(self, method, tags)
+  end
+  def bbcode_to_html!(method = :disable, *tags)
+          self.replace(BBRuby.to_html(self, method, tags))
+  end
+end

data/test/test-bb-ruby.rb

@@ -0,0 +1,48 @@
+#! /usr/bin/env ruby
+load 'lib/bb-ruby.rb'
+
+text = <<eot
+[b]Here is some bold text[/b]
+[i]Here is some italicized text[/i]
+[u]Underlined text[/u]
+[b]Bold, [u]underlined, and [i]italicized[/i][/u][/b]
+
+a [del]mistake[/del] [ins]corrected[/ins]
+
+List of stuff:
+[ul]
+        [*]Lions
+        [*]Tigers
+        [li]Bears[/li]
+[/ul]
+
+[size=32]12px Text[/size]
+[color=red]Red Text[/color]
+[color=#ff0023]Hex Color Text[/color]
+
+
+
+
+
+Link: [url=http://google.com]Google[/url]
+Link (implied): [url]http://google.com[/url]
+Link (automatic): http://google.com
+Image: [img]http://zoople/hochzeit.png[/img]
+Image: [img=http://zoople/hochzeit.png]
+Image (resized 1): [img size=96x96]http://zoople/hochzeit.png[/img]
+Image (resized 2): [img size="96x96"]http://zoople/hochzeit.png[/img]
+Image (resized 3): [img size='96x96']http://zoople/hochzeit.png[/img]
+Image (invalid): [img]http://google.com/google.img[/img]
+
+[quote=Bush]Go kill them terrists[/quote]
+[quote]Something wise.[/quote]
+
+[youtube]http://youtube.com/watch?v=E4Fbk52Mk1w[/youtube]
+[gvideo]http://video.google.com/videoplay?docid=-2200109535941088987[/gvideo]
+eot
+
+output = text.bbcode_to_html
+puts output
+
+# text.bbcode_to_html! #(:enable, :unorderedlist, :quote)
+# puts text

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: cpjolicoeur-bb-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.6.1
+platform: ruby
+authors: 
+- Craig P Jolicoeur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: bb-ruby is a Ruby library to convert BBCode markup to HTML
+email: cpjolicoeur@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bb-ruby.gemspec
+- init.rb
+- README.markdown
+- lib/bb-ruby.rb
+- test/test-bb-ruby.rb
+has_rdoc: false
+homepage: http://github.com/cpjolicoeur/bb-ruby
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: BBCode conversion library for Ruby
+test_files: 
+- test/test-bb-ruby.rb