th-bbcode 0.4.3 → 0.5.0

data/README.md

@@ -26,15 +26,18 @@ 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"
+require 'rubygems'
+require 'bundler/setup'
+require 'bbcode'
 
 Bbcode::Base.register_handler :html, Bbcode::HtmlHandler.new(
-	:b => :strong,
-	:i => :em,
-	:url => [ :a, { :href => "%{0}" } ],
-	:txt => ->(element){ "#{element.content.source}" },
-	:img => ->(element){ %(<img src="#{CGI.escapeHTML(element.content.source)}">) },
-	:color => [ :span, { :style => "color: %{0};" } ]
+  :b => :strong,
+  :i => :em,
+  :url => [ :a, { :href => "%{0}" } ],
+  :txt => ->(element){ "#{element.content.source}" },
+  :img => ->(element){ %(<img src="#{CGI.escapeHTML(element.content.source)}">) },
+  :admin => ->(element, locals){ locals[:is_admin] ? element.content : "" },
+  :color => [ :span, { :style => "color: %{0};" } ]
 )
 ```
 
@@ -44,6 +47,10 @@ the `:html`-handler like this:
 ```ruby
 "[b]Hello, bold world![/]".as_bbcode.to :html
 # => <strong>Hello, bold world!</strong>
+"[admin]Hello, admin![/]".as_bbcode.to :html, :is_admin => true
+# => Hello, admin!
+"[admin]Hello, admin![/]".as_bbcode.to :html, :is_admin => false
+# => 
 ```
 
 If you're using this gem in a rails project, I would recommend registering your
@@ -62,6 +69,8 @@ Features:
 * Parsing incorrectly nested bbcode elements like `[b]bold[i]and italic[/b]only
   italic[/]`, which might result to `<b>bold<i>and italic</i></b><i>only
   italic</i>`.
+* Passing variables to the handler and accessing them to the element handler
+  callbacks.
 
 Using WillScanString:
 ---------------------

data/lib/bbcode/base.rb

@@ -1,21 +1,24 @@
 module Bbcode
 	class Base
-		@@handlers = {}.with_indifferent_access
+		@@handlers = HashWithIndifferentAccess.new
 
-		def initialize( string )
+		attr_reader :locals
+
+		def initialize(string, locals = {})
 			@string = string
 		end
 
-		def to( handler )
+		def to(handler, locals = {})
 			handler = @@handlers[handler]
 			raise "Handler #{handler} isn't registered" if handler.blank?
+			handler.locals = locals.with_indifferent_access
 			Parser.new(Tokenizer.new).parse @string, handler
 			result = handler.get_document.content.to_s
 			handler.clear
 			result
 		end
 
-		def self.register_handler( name, handler )
+		def self.register_handler(name, handler)
 			@@handlers[name] = handler
 		end
 	end

data/lib/bbcode/element.rb

@@ -31,7 +31,7 @@ module Bbcode
 		end
 
 		def to_s
-			@handler_element.handler.get_element_handler(tagname).call(self)
+			@handler_element.handler.apply_element_handler_for_element self
 		end
 	end
 end

data/lib/bbcode/handler.rb

@@ -2,7 +2,7 @@ require "bbcode/handler_element"
 
 module Bbcode
 	class Handler
-		attr_accessor :element_handlers
+		attr_accessor :element_handlers, :locals
 
 		def initialize( element_handlers = nil )
 			@element_handlers = {}.with_indifferent_access
@@ -10,6 +10,7 @@ module Bbcode
 			self.clear
 			register_element_handlers element_handlers unless element_handlers.blank?
 			@interruption_stack = []
+			self.locals = {}
 		end
 
 		def register_element_handlers( element_handlers )
@@ -63,6 +64,15 @@ module Bbcode
 			@element_handlers[name] || ->(element){ element.is_a?(String) ? element : element.source_wraps_content }
 		end
 
+		def locals=(locals)
+			@locals = locals.with_indifferent_access
+		end
+
+		def apply_element_handler_for_element(element)
+			callable = get_element_handler(element.is_a?(String) ? :"#text" : element.tagname)
+			callable.arity == 2 ? callable.call(element, locals) : callable.call(element)
+		end
+
 		protected
 		def current_handler_element
 			@handler_element_stack.last

data/lib/bbcode/node_list.rb

@@ -11,9 +11,7 @@ module Bbcode
 		end
 
 		def to_s
-			self.map{ |element|
-				@handler.get_element_handler(element.is_a?(String) ? :"#text" : element.tagname).call(element)
-			}.join
+			self.map{ |element| @handler.apply_element_handler_for_element element }.join
 		end
 
 		def with_handler( handler )

data/lib/bbcode/version.rb

@@ -1,3 +1,3 @@
 module Bbcode
-	VERSION = "0.4.3"
+	VERSION = "0.5.0"
 end

data/spec/lib/bbcode/helpers_spec.rb

@@ -10,6 +10,7 @@ handler = Bbcode::Handler.new({
 	:img => ->(element){ %(<img src="#{element.content.source}">) },
 	:quote => ->(element){ %(<blockquote>#{element.content.with_handler(quote_handler)}</blockquote>) },
 	:color => ->(element){ %(<span style="color: #{CGI.escapeHTML(element[0])};">#{element.content}</span>) },
+	:admin => ->(element, locals){ locals[:is_admin] ? element.content : "" },
 	:"#text" => ->(text){ CGI.escapeHTML(text) }
 })
 
@@ -37,4 +38,9 @@ describe Bbcode::Helpers do
 	it "should be able to process non-ascii characters" do
 		# load UTF-8 content from a file and parse it
 	end
+
+	it "should be able to pass locals" do
+		"[admin]Only admins can see this![/]".as_bbcode.to(:html, :is_admin => true).should eql("Only admins can see this!")
+		"[admin]Only admins can see this![/]".as_bbcode.to(:html, :is_admin => false).should eql("")
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: th-bbcode
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70342804090620 !ruby/object:Gem::Requirement
+  requirement: &70094233269240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70342804090620
+  version_requirements: *70094233269240
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70342804090200 !ruby/object:Gem::Requirement
+  requirement: &70094233268820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70342804090200
+  version_requirements: *70094233268820
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70342804089780 !ruby/object:Gem::Requirement
+  requirement: &70094233268400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70342804089780
+  version_requirements: *70094233268400
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70342804089360 !ruby/object:Gem::Requirement
+  requirement: &70094233267980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70342804089360
+  version_requirements: *70094233267980
 description: Gem for parsing bbcode-formatted strings to HTML or any other formatting
   you like (or don't like).
 email: