th-bbcode 0.5.0 → 0.6.0

data/README.md

@@ -104,6 +104,17 @@ 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.
 
+Using another parser or tokenizer:
+----------------------------------
+Although this bbcode parser gem was primary designed for converting bbcode to
+HTML, it is possible to use another parser or tokenizer while still using the
+same handlers.
+
+Using another tokenizer allows you to parse anything as if it were to be
+bbcode. This feature is still in development, but a nice example is my own
+ycode gem. This gem can be found here:
+`https://github.com/tobyhinloopen/y-code`
+
 Todo:
 -----
 * An easier way to handle text around bbcode tags to, for example, add smileys

data/lib/bbcode.rb

@@ -4,6 +4,7 @@ require 'action_view/helpers/tag_helper'
 require 'cgi'
 require "bbcode/version"
 require "bbcode/tokenizer"
+require "bbcode/abstract_handler"
 require "bbcode/parser"
 require "bbcode/handler"
 require "bbcode/html_handler"
@@ -14,4 +15,31 @@ include ActionView::Helpers::TagHelper
 
 module Bbcode
 	String.send :include, Bbcode::Helpers
+
+	def self.handlers
+		@@handlers ||= {}
+	end
+
+	def self.handler(name)
+		handlers[name]
+	end
+
+	def self.register_handler(name, handler)
+		handlers[name] = handler
+	end
+
+	def self.parsers
+		@@parsers ||= {}
+	end
+
+	def self.parser(name)
+		parser = parsers[name]
+		parser.respond_to?(:call) ? parser.call : parser
+	end
+
+	def self.register_parser(name, parser = nil, &parser_factory)
+		parsers[name] = (parser || parser_factory)
+	end
+
+	register_parser(:bbcode){ Parser.new(Tokenizer.new) }
 end

data/lib/bbcode/abstract_handler.rb

@@ -0,0 +1,19 @@
+module Bbcode
+	class AbstractHandler
+		def start_element(tagname, attributes = {}, source = nil); end
+		def end_element(tagname, source = nil); end
+		def text(text); end
+		def interrupt_element(tagname); end
+		def continue_element(tagname); end
+
+		def restart_element(tagname, attributes = {}, source = nil)
+			end_element tagname
+			start_element tagname, attributes, source
+		end
+
+		def void_element(tagname, attributes = {}, source = nil)
+			start_element tagname, attributes, source
+			end_element tagname
+		end
+	end
+end

data/lib/bbcode/base.rb

@@ -4,22 +4,24 @@ module Bbcode
 
 		attr_reader :locals
 
-		def initialize(string, locals = {})
+		def initialize(parser, string)
+			@parser = parser
 			@string = string
 		end
 
-		def to(handler, locals = {})
-			handler = @@handlers[handler]
-			raise "Handler #{handler} isn't registered" if handler.blank?
+		def to(handler_name, locals = {})
+			handler = Bbcode.handler handler_name
+			raise "Handler #{handler} isn't registered." if handler.nil?
 			handler.locals = locals.with_indifferent_access
-			Parser.new(Tokenizer.new).parse @string, handler
+			@parser.parse @string, handler
 			result = handler.get_document.content.to_s
 			handler.clear
 			result
 		end
 
 		def self.register_handler(name, handler)
-			@@handlers[name] = handler
+			puts "WARNING: Bbcode::Base.register_handler is deprecated. Use Bbcode.register_handler instead."
+			Bbcode.register_handler(name, handler)
 		end
 	end
 end

data/lib/bbcode/handler.rb

@@ -1,7 +1,7 @@
 require "bbcode/handler_element"
 
 module Bbcode
-	class Handler
+	class Handler < AbstractHandler
 		attr_accessor :element_handlers, :locals
 
 		def initialize( element_handlers = nil )

data/lib/bbcode/helpers.rb

@@ -1,7 +1,15 @@
 module Bbcode
 	module Helpers
+		def parse_with(parser)
+			Base.new parser, self.to_s
+		end
+
+		def as(parser_name)
+			parse_with Bbcode.parser parser_name
+		end
+
 		def as_bbcode
-			Base.new self.to_s
+			as :bbcode
 		end
 	end
 end

data/lib/bbcode/parser.rb

@@ -1,6 +1,6 @@
 module Bbcode
 	# Attempts to pair a stream of tokens created by a tokenizer
-	class Parser
+	class Parser < AbstractHandler
 		attr_accessor :tokenizer
 
 		def initialize( tokenizer = nil )
@@ -14,12 +14,12 @@ module Bbcode
 		end
 
 		def text( text )
-			@handler.send :text, text
+			@handler.text text
 		end
 
 		def start_element( tagname, attributes, source )
 			@tags_stack << tagname
-			@handler.send :start_element, tagname, attributes, source
+			@handler.start_element tagname, attributes, source
 		end
 
 		def end_element( tagname, source )
@@ -29,22 +29,20 @@ module Bbcode
 			@interruption_stack = []
 			while @tags_stack.last != tagname do
 				@interruption_stack << @tags_stack.last
-				@handler.send :interrupt_element, @tags_stack.pop
+				@handler.interrupt_element @tags_stack.pop
 			end
 
-			@handler.send :end_element, @tags_stack.pop, source
+			@handler.end_element @tags_stack.pop, source
 
 			while !@interruption_stack.empty? do
 				@tags_stack << @interruption_stack.last
-				@handler.send :continue_element, @interruption_stack.pop
+				@handler.continue_element @interruption_stack.pop
 			end
 		end
 
 		def parse( document, handler )
 			@handler = handler
-			@tokenizer.tokenize document do |*args|
-				self.send *args if [:start_element, :end_element, :text].include?(args.first)
-			end
+			@tokenizer.tokenize document, self
 		end
 	end
 end

data/lib/bbcode/tokenizer.rb

@@ -25,14 +25,14 @@ module Bbcode
 		# Parses the document as BBCode-formatted text and calls block with bbcode
 		# events.
 		#
-		# The block is called with the following events:
-		# - :text, text
+		# The handler will have the following methods called:
+		# - .text text
 		#   A text-event with an additional parameter containing the actual text.
-		# - :start_element, element_name, element_arguments
+		# - .start_element element_name, element_arguments
 		#   An element-event with 2 additional parameters: The element name as a
 		#   symbol and the element attributes as a hash. This events indicate the
 		#   start of the element.
-		# - :end_element, element_name
+		# - .end_element element_name
 		#   An element-event indicating the end of an element. Optionally, the
 		#   element_name is added as a parameter. If no parameter is present, it is
 		#   assumed to be the last started element.
@@ -44,12 +44,12 @@ module Bbcode
 		# Also note that :text events are not guaranteed to match the whole text.
 		# In some cases, the text might be separated to multiple :text events, even
 		# though there are no nodes in between.
-		def tokenize( document, &handler )
+		def tokenize(document, handler)
 			while !(match = BBCODE_TAG_PATTERN.match(document)).nil?
 				offset = match.begin(0)
 				elem_source = match[0]
 
-				handler.call :text, document[0...offset] unless offset == 0
+				handler.text document[0...offset] unless offset == 0
 
 				elem_is_closing_tag = match[1]=='/'
 				elem_name = (match[2].length > 0 && match[2].to_sym) || nil
@@ -57,18 +57,18 @@ module Bbcode
 
 				if (elem_is_closing_tag && !elem_attr_string) || (!elem_is_closing_tag && elem_name)
 					if !elem_is_closing_tag
-						handler.call :start_element, elem_name, parse_attributes_string(elem_attr_string), elem_source
+						handler.start_element elem_name, parse_attributes_string(elem_attr_string), elem_source
 					else
-						handler.call :end_element, elem_name, elem_source
+						handler.end_element elem_name, elem_source
 					end
 				else
-					handler.call :text, elem_source
+					handler.text elem_source
 				end
 
 				document = document[(offset+elem_source.length)..-1]
 			end
 
-			handler.call :text, document unless document.length == 0
+			handler.text document unless document.length == 0
 		end
 	end
 end

data/lib/bbcode/version.rb

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

data/spec/lib/bbcode/base_spec.rb

@@ -1,8 +1,4 @@
 require 'spec_helper.rb'
 
 describe Bbcode::Base do
-	it "should enable a handler to be registered and used" do
-		Bbcode::Base.register_handler :test, Bbcode::Handler.new
-		Bbcode::Base.new("test").to(:test).should eql("test")
-	end
 end

data/spec/lib/bbcode/helpers_spec.rb

@@ -19,8 +19,8 @@ quote_handler.register_element_handlers handler.element_handlers.merge({
 	:quote => ->(element){ "[...]" }
 })
 
-Bbcode::Base.register_handler :html, handler
-Bbcode::Base.register_handler :text, Bbcode::Handler.new()
+Bbcode.register_handler :html, handler
+Bbcode.register_handler :text, Bbcode::Handler.new
 
 describe Bbcode::Helpers do
 	it "should enable a string to use a registered helper" do

data/spec/lib/bbcode/tokenizer_spec.rb

@@ -2,12 +2,9 @@ require 'spec_helper.rb'
 
 def get_tokenizer_results(string, strip_source = true)
 	tokenizer = Bbcode::Tokenizer.new
-	results = []
-	tokenizer.tokenize string do |*args|
-		args.pop if strip_source && [:end_element, :start_element].include?(args.first) # pop the source
-		results.push args
-	end
-	results
+	handler = DummyHandler.new strip_source
+	tokenizer.tokenize string, handler
+	handler.stack
 end
 
 describe Bbcode::Tokenizer do

data/spec/spec_helper.rb

@@ -3,6 +3,18 @@ require 'bundler/setup'
 
 require 'bbcode'
 
+class DummyHandler
+	attr_accessor :stack
+
+	def initialize(strip_source)
+		@strip_source = strip_source
+	end
+
+	def method_missing(*args)
+		(@stack ||= []) << args.tap{ |args| args.pop if @strip_source && args.first.to_s.end_with?("element") }
+	end
+end
+
 RSpec.configure do |config|
   # some (optional) config here
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: th-bbcode
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000Z
+date: 2012-03-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70094233269240 !ruby/object:Gem::Requirement
+  requirement: &70359577113220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094233269240
+  version_requirements: *70359577113220
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70094233268820 !ruby/object:Gem::Requirement
+  requirement: &70359577112800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094233268820
+  version_requirements: *70359577112800
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70094233268400 !ruby/object:Gem::Requirement
+  requirement: &70359577112380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094233268400
+  version_requirements: *70359577112380
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70094233267980 !ruby/object:Gem::Requirement
+  requirement: &70359577111960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094233267980
+  version_requirements: *70359577111960
 description: Gem for parsing bbcode-formatted strings to HTML or any other formatting
   you like (or don't like).
 email:
@@ -69,6 +69,7 @@ files:
 - Rakefile
 - bbcode.gemspec
 - lib/bbcode.rb
+- lib/bbcode/abstract_handler.rb
 - lib/bbcode/base.rb
 - lib/bbcode/element.rb
 - lib/bbcode/handler.rb