th-bbcode 0.4.0 → 0.4.1

data/README.md

@@ -17,8 +17,8 @@ designed to convert bbcode elements to HTML more easily.
 
 Installation:
 -------------
-Add the gem to the gemfile of your project.
-(todo: add examples)
+Add the gem to the gemfile of your project:
+`gem "th-bbcode", "~> 0.4.0"`
 
 Usage:
 ------
@@ -26,6 +26,8 @@ Create and register a handler. In this example, I'm creating a HtmlHandler and
 I'm going to register it as `:html`.
 
 ```ruby
+require "bbcode"
+
 Bbcode::Base.register_handler :html, Bbcode::HtmlHandler.new(
 	:b => :strong,
 	:i => :em,
@@ -61,12 +63,44 @@ Features:
   italic[/]`, which might result to `<b>bold<i>and italic</i></b><i>only
   italic</i>`.
 
+Using WillScanString:
+---------------------
+You might want to convert URLs in the message to be converted to a hyperlink,
+or you might want smileys in your bbcode message. This can be done by
+defining a `:"#text"`-handler in your Handler or HtmlHandler.
+
+I personally used WillScanString's StringScanner class to achieve this:
+
+```ruby
+# Requires the will_scan_string gem
+require "will_scan_string"
+
+string_scanner = WillScanString::StringScanner.new
+string_scanner.register_replacement "<", "&lt;"
+string_scanner.register_replacement ">", "&gt;"
+string_scanner.register_replacement "&", "&amp;"
+string_scanner.register_replacement "\"", "&quot;"
+string_scanner.register_replacement /(?:\r\n|\r|\n)/, "<br>"
+string_scanner.register_replacement /[^\s@]+@[^\s@]/, ->(email){ %(<a href="mailto:#{CGI.escapeHTML(email)}">#{CGI.escapeHTML(email)}</a>) }
+
+# +handler+ is your Bbcode::HtmlHandler or Bbcode::Handler instance
+handler.register_element_handler :"#text", ->(text){ string_scanner.replace(text) }
+```
+
+The above example converts newlines to `<br>`-tags, escapes HTML entities
+and converts e-mail addresses to clickable mailto hyperlinks.
+
+Note: By overwriting the `:"#text"`-handler in the HtmlHandler, html entities
+are no longer replaced automatically: You need to escape them in your handler
+callback yourself. Failing to do so might expose your website to XSS
+vulnerabilities.
+
 Todo:
 -----
 * An easier way to handle text around bbcode tags to, for example, add smileys
   and wrap hyperlinks to URLs. Currently, the only way to achieve this is by
   adding a `:"#text"`-handler to your handler and adding the functionality
-  yourself.
+  yourself. (note: See the above note regarding WillScanString)
 * An easier way to include the content, source or content-source in the
   `HtmlHandler`-class.
 * Review handleability of element interrupts.

data/lib/bbcode/html_handler.rb

@@ -9,9 +9,7 @@ module Bbcode
 
 		def register_element_handler( name, handler )
 			unless handler.is_a?(Proc)
-				args = *handler
-				target_tagname = args.shift
-				attributes = args.first
+				target_tagname, attributes = handler.is_a?(Array) ? handler : [handler, {}]
 				handler = ->(element){
 					content_tag(target_tagname, element.content, !attributes ? {} : Hash[attributes.map{ |k, v|
 						[k, v.gsub(/%{[^}]+}/) { |m| CGI.escapeHTML element[m[3] == ":" ? m[3...-1].to_sym : m[2...-1].to_i] }]

data/lib/bbcode/version.rb

@@ -1,3 +1,3 @@
 module Bbcode
-	VERSION = "0.4.0"
+	VERSION = "0.4.1"
 end

data/lib/bbcode.rb

@@ -1,3 +1,5 @@
+include  ActionView::Helpers::TagHelper
+
 require "bbcode/version"
 require "bbcode/tokenizer"
 require "bbcode/parser"

data/spec/spec_helper.rb

@@ -4,8 +4,6 @@ require 'active_support/all'
 require 'action_view/helpers/capture_helper'
 require 'action_view/helpers/tag_helper'
 
-include  ActionView::Helpers::TagHelper
-
 require 'bbcode'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: th-bbcode
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000Z
+date: 2011-11-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70176012816200 !ruby/object:Gem::Requirement
+  requirement: &70135440360960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70176012816200
+  version_requirements: *70135440360960
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70176012815280 !ruby/object:Gem::Requirement
+  requirement: &70135440358260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *70176012815280
+  version_requirements: *70135440358260
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70176012814380 !ruby/object:Gem::Requirement
+  requirement: &70135440352380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *70176012814380
+  version_requirements: *70135440352380
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70176012813460 !ruby/object:Gem::Requirement
+  requirement: &70135440349240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70176012813460
+  version_requirements: *70135440349240
 description: Gem for parsing bbcode-formatted strings to HTML or any other formatting
   you like (or don't like).
 email: