firephruby 0.2.0 → 0.2.1

data/Changelog

@@ -1,2 +1,5 @@
 0.2 -- changed headers to comply to FirePHP 0.2, added labels, added support
 for Rails, added version check, added 'DUMP'
+
+0.2.1 -- added type masking with support for arrays, hashes and other types as
+hash keys and options for renderer scripts

data/lib/firephruby.rb

@@ -1,7 +1,7 @@
 #!/usr/local/bin/ruby
 # -*- coding: utf-8 -*-
 
-# Version 0.2.0
+# Version 0.2.1
 
 require 'json'
 
@@ -10,24 +10,27 @@ module FirePHRuby
 	FPHR_FUNCTION_NAMES = %w(LOG INFO WARN ERROR)
 	module Common
 		FPHR_INIT_HEADERS = { 'X-Wf-Protocol-1' => 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2',
+											#	'X-FirePHP-RendererURL' => 'http://banza.net/firephruby/Renderer.js', 
+											#	'X-FirePHP-ProcessorURL' => 'http://banza.net/firephruby/RequestProcessor.js',
 												'X-Wf-1-Plugin-1' =>'http://meta.firephp.org/Wildfire/Plugin/FirePHP/Library-FirePHPCore/0.2.0'}
 		FPHR_INIT_HEADERS_LOG = { 'X-Wf-1-Structure-1' => 'http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1' }
 		FPHR_INIT_HEADERS_DUMP = { 'X-Wf-1-Structure-2' => 'http://meta.firephp.org/Wildfire/Structure/FirePHP/Dump/0.1' }
 		FPHR_KINDS = %w(LOG INFO WARN ERROR DUMP TRACE EXCEPTION TABLE)
 		FPHR_LEGACY_WARNING = { 'X-FirePHP-Data-100000000001' => '{' ,
 						'X-FirePHP-Data-300000000001' => '"FirePHP.Firebug.Console":[',
-						'X-FirePHP-Data-300000000002' => '[ "INFO", "This version of FirePHP is no longer supported by FirePHRuby. Please update to 0.2 or higher." ],',
+						'X-FirePHP-Data-300000000002' => '[ "INFO", "This version of FirePHP is no longer supported by FirePHRuby. Please update to 0.2.1 or higher." ],',
 						'X-FirePHP-Data-399999999999' => '["__SKIP__"]],',
 						'X-FirePHP-Data-999999999999' => '"__SKIP__":"__SKIP__"}' }
 		MAX_LENGTH = 4000
 		
-		def build_headers msg,kind='LOG',label=nil
+		def _firephruby_build_headers msg,kind='LOG',label=nil
 			headers = []
 			t_pref,g_kind = kind == 'DUMP' ? [ 2, 'DUMP' ] : [ 1, 'LOG' ]
 			file, line, function = caller[2].split ':'
 			msg_meta = { 'Type' => kind, 'File' => file, 'Line' => line }
 			msg_meta['Label'] = label if label
 			@fire_msg_index = 0 unless instance_variables.member? '@fire_msg_index'
+			msg = _firephruby_mask_ruby_types msg if ( @firephruby_options.has_key? :mask_ruby_types && :mask_ruby_types )
 			msg = kind == 'DUMP' ? "{#{label.to_json}:#{msg.to_json}}" : "[#{msg_meta.to_json},#{msg.to_json}]"
 			#puts msg.to_json
 			(msg.gsub /.{#{MAX_LENGTH}}/ do |m| "#{m}\n" end).split( "\n" ).each_with_index do |msg_part,ind|
@@ -41,26 +44,76 @@ module FirePHRuby
 			end
 			return headers
 		end
-		def initialize_request ua
+		def _firephruby_set_options opts
+			@firephruby_options = {} unless instance_variables.member? '@firephruby_options'
+			@firephruby_options.merge! opts
+		end
+		def _firephruby_initialize_request ua
 			@firephp_version = ua.match( /FirePHP\/(\d+)\.(\d+)\.([\db.]+)/)
 			@firephp_version = @firephp_version[1,3].map {|i| i.to_i} if @firephp_version
 			firephp_01_version = ( @firephp_version || [0,2] )[0,2].join('.').to_f<0.2 
 			@firephpruby_skip = @firephp_version == nil || firephp_01_version
-			firephp_01_version ? FPHR_LEGACY_WARNING : FPHR_INIT_HEADERS 
+			headers = firephp_01_version ? FPHR_LEGACY_WARNING : FPHR_INIT_HEADERS
+			headers['X-FirePHP-RendererURL'] = @firephruby_options[:renderer_url] if @firephruby_options.has_key? :renderer_url
+			headers['X-FirePHP-ProcessorURL'] = @firephruby_options[:processor_url] if @firephruby_options.has_key? :processor_url
+			return headers
+		end
+		def firephruby_internal_log msg
+			@fire_msg_index = 0 unless instance_variables.member? '@fire_msg_index'
+			@fire_msg_index += 1
+			msg = "[#{{:Type=>'LOG',:Label=>'____________________________ internal message'}.to_json},#{msg.to_json}]"
+			puts "X-Wf-1-1-1-#{@fire_msg_index}: #{msg.size}|#{msg}|"
+		end
+		def _firephruby_mask_ruby_types data, skip=true # skip masking if not hash key
+			#firephruby_internal_log data.class.to_s
+			if data.is_a? String
+				return data
+			elsif data.is_a? Integer
+				return "__INT__#{data.to_s}__INT__"
+			elsif data.is_a? Numeric
+				return skip ? data : "__NUM__#{data.to_s}__NUM__"
+			elsif data.is_a? TrueClass or data.is_a? FalseClass
+				return skip ? data : "__BOOL__#{data.to_s}__BOOL__"
+			elsif data.nil?
+				return skip ? data : '__NIL__nil__NIL__'
+			elsif data.is_a? Symbol
+				return "__SYM__:#{data.to_s}__SYM__"
+			elsif data.is_a? Array
+				#firephruby_internal_log 'wird'
+				return data.map { |v| _firephruby_mask_ruby_types v }
+			elsif data.is_a? Hash
+				k_types = [ Symbol, Fixnum, Bignum, Float, Range, TrueClass, FalseClass, NilClass ]
+				j_types = [ Array, Hash ]
+				data.each { |k,v| data[k] = _firephruby_mask_ruby_types v }
+				keys_to_mask = data.keys.select { |k| k_types.include? k.class }
+				keys_to_mask.each { |k| nk = _firephruby_mask_ruby_types k,false; data[nk] = data[k]; data.delete k }
+				keys_to_jsonize = data.keys.select { |k| j_types.include? k.class }
+				keys_to_jsonize.each do |k| 
+					nk = _firephruby_mask_ruby_types( k,false ).to_json 
+					data["__JSON__#{nk}__JSON__"] = data[k]
+					data.delete k
+				end
+				return data
+			elsif data.is_a? Range
+				return "__RNG__#{data.to_s}__RNG__"
+			end
+			firephruby_internal_log 'shit happens - class: ' + data.class.to_s
+			return data
 		end
 	end
 	
 	class CGI
 		include Common
-		def initialize
+		def initialize options={}
+			_firephruby_set_options options
 			ENV['HTTP_USER_AGENT'] = 'FirePHP/0.2.b.7' unless ENV['HTTP_USER_AGENT'] # for being callable from shell
-			headers = initialize_request ENV['HTTP_USER_AGENT'] 
+			headers = _firephruby_initialize_request ENV['HTTP_USER_AGENT'] 
 			return if @firephpruby_skip
 			headers.each_pair { |k,v| puts "#{k}: #{v}" }
 		end
 		def firelog msg,kind='LOG', label=nil
 			return if @firephpruby_skip
-			headers = build_headers msg,kind,label
+			headers = _firephruby_build_headers msg,kind,label
 			headers.each { |h| puts "#{h[0]}: #{h[1]}" }
 		end
 		FPHR_FUNCTION_NAMES.each { |x| self.class_eval "def #{x.downcase} msg, label=nil; firelog msg,'#{x}',label; end" }
@@ -76,24 +129,27 @@ module FirePHRuby
 	  include Common
 		def fire_clog msg,kind='LOG', label=nil
 			return if defined?( @firephpruby_skip ) && @firephpruby_skip
-			headers = build_headers msg,kind,label
+			headers = _firephruby_build_headers msg,kind,label
 			headers.each { |h| @header[h[0]] = h[1] }
 			return if defined? @firephruby_inited
-			initialize_request( @firephruby_user_agent ).each_pair { |k,v| @header[k] = v }
+			_firephruby_initialize_request( @firephruby_user_agent ).each_pair { |k,v| @header[k] = v }
 			@firephruby_inited = true
 		end
+		def fire_options options={}
+			_firephruby_set_options options
+		end
 		FPHR_FUNCTION_NAMES.each { |x| self.module_eval "def fire_#{x.downcase} msg, label=nil; fire_clog msg,'#{x}',label; end" }
-			def fire_dump obj, label=''
+		def fire_dump obj, label=''
 			fire_clog obj,'DUMP', label
 		end
-		def fire_set_user_agent ua
+		def _firephruby_set_user_agent ua
 			@firephruby_user_agent = ua
 		end
 	end
 
 	module Rails
 		include HTTPResponse
-		def set_header_var		# the @header-hash from WEBrick/Mongrel-response-classes 
+		def _firephruby_set_header_var		# the @header-hash from WEBrick/Mongrel-response-classes 
 			@header = @headers	# is called @headers in the Rails-response-class
 		end
 		module Interface
@@ -101,6 +157,9 @@ module FirePHRuby
 			def fire_dump obj, label=''
 				response.fire_clog obj,'DUMP', label
 			end
+			def fire_options opts={}
+				response.fire_options opts
+			end
 		end
 	end
 end
@@ -109,13 +168,14 @@ if defined? ActionController # guessing Rails should be a little bit more detail
 	module ActionController
 		class Base
 			include FirePHRuby::Rails::Interface
-			unless defined? the_original_process_method
-				puts "alias the_original_process_method process"
-				alias the_original_process_method process
+			unless defined? _firephruby_the_original_process_method
+				puts "alias _firephruby_the_original_process_method process"
+				alias _firephruby_the_original_process_method process
 				def process(request, response, method = :perform_action, *arguments)
-					response.fire_set_user_agent request.env['HTTP_USER_AGENT']
-					response.set_header_var
-					the_original_process_method(request, response, method, *arguments)
+					response._firephruby_set_user_agent request.env['HTTP_USER_AGENT']
+					response._firephruby_set_header_var
+					response._firephruby_set_options( {} )
+					_firephruby_the_original_process_method(request, response, method, *arguments)
 				end
 			end
 		end
@@ -134,10 +194,11 @@ elsif defined? WEBrick
 			include FirePHRuby::HTTPResponse
 		end
 		class HTTPServer
-			alias the_original_service_method service # 'duck punching' the service method
+			alias _firephruby_the_original_service_method service # 'duck punching' the service method
 			def service(req,res)				# to get req.properties to the response object
-				res.fire_set_user_agent( req.meta_vars['HTTP_USER_AGENT'] )
-				the_original_service_method(req,res)
+				res._firephruby_set_user_agent( req.meta_vars['HTTP_USER_AGENT'] )
+				res._firephruby_set_options( {} )
+				_firephruby_the_original_service_method(req,res)
 			end
 		end
 	end
@@ -145,8 +206,9 @@ elsif defined? Mongrel
 	module Mongrel
 		class HttpResponse
 			include FirePHRuby::HTTPResponse
-			def fire_init req
-				fire_set_user_agent req.params['HTTP_USER_AGENT']
+			def fire_init req, options={}
+				_firephruby_set_user_agent req.params['HTTP_USER_AGENT']
+				_firephruby_set_options options
 			end
 		end
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: firephruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: []
 
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-21 00:00:00 +02:00
+date: 2008-12-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency