firephruby 0.1.2 → 0.2.0

data/Changelog

@@ -0,0 +1,2 @@
+0.2 -- changed headers to comply to FirePHP 0.2, added labels, added support
+for Rails, added version check, added 'DUMP'

data/LICENSE

@@ -1 +1,165 @@
-LGPL
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,10 @@
+FirePHRuby currently supports only the log/info/warn/error and the dump-command. 
+The syntax is 
+
+  fire_log message, label=nil
+
+where message can be any jsonizable data. 
+
+I now hacked FirePHRuby into Rails. It's only tested with 2.1.2. I'm quite new 
+to Ruby and Rails and so FirePHRuby is probably highly 'optimizable' to say the 
+least. If you have any comments, suggestions or critics email me: tnt@banza.net

data/lib/firephruby.rb

@@ -1,81 +1,153 @@
 #!/usr/local/bin/ruby
 # -*- coding: utf-8 -*-
 
+# Version 0.2.0
+
 require 'json'
 
 module FirePHRuby
-
+	
+	FPHR_FUNCTION_NAMES = %w(LOG INFO WARN ERROR)
 	module Common
-		FPHR_INIT_HEADERS = { 'X-FirePHP-Data-100000000001' => '{',
-						'X-FirePHP-Data-999999999999' => '"__SKIP__":"__SKIP__"}' }
-		FPHR_INIT_HEADERS_LOG = { 'X-FirePHP-Data-300000000001' => '"FirePHP.Firebug.Console":[',
-						'X-FirePHP-Data-399999999999' => '["__SKIP__"]],' }
-		FPHR_INIT_HEADERS_DUMP = { 'X-FirePHP-Data-200000000001' => '"FirePHP.Dump":{',
-						'X-FirePHP-Data-299999999999' => '"__SKIP__":"__SKIP__"},' }
+		FPHR_INIT_HEADERS = { 'X-Wf-Protocol-1' => 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2',
+												'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)
-
-		def build_headers msg,kind='LOG'
+		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-399999999999' => '["__SKIP__"]],',
+						'X-FirePHP-Data-999999999999' => '"__SKIP__":"__SKIP__"}' }
+		MAX_LENGTH = 4000
+		
+		def build_headers msg,kind='LOG',label=nil
 			headers = []
-			t_pref,g_kind = kind == 'DUMP' ? [ 2, 'DUMP' ] : [ 3, 'LOG' ]
-			c_time = Time.new
-			digits = "#{c_time.tv_sec.to_s[-5,5]}#{c_time.usec}"
-			headers << [ "X-FirePHP-Data-#{t_pref}#{digits}", "[ \"#{kind}\", #{msg.to_json} ]," ]
+			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 = 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|
+				@fire_msg_index += 1
+				headers << [ "X-Wf-1-#{t_pref}-1-#{@fire_msg_index}", "#{msg.size if ind == 0}|#{msg_part}|#{'\\' if ind < msg.size/MAX_LENGTH}" ] # int/int = int
+				#puts "   msg_part: #{msg.size if ind == 0}|#{msg_part}|"
+			end
 			unless instance_variables.member? "@firephruby_inited_#{g_kind.downcase}"
 				FirePHRuby::Common::const_get( "FPHR_INIT_HEADERS_#{g_kind}" ).each_pair { |k,v| headers << [ k, v ] }
 				instance_variable_set( "@firephruby_inited_#{g_kind.downcase}", true )
 			end
 			return headers
 		end
+		def 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 
+		end
 	end
 	
 	class CGI
 		include Common
 		def initialize
-			FPHR_INIT_HEADERS.each_pair { |k,v| puts "#{k}: #{v}" }
-			#FPHR_INIT_HEADERS_LOG.each_pair { |k,v| puts "#{k}: #{v}" }
+			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'] 
+			return if @firephpruby_skip
+			headers.each_pair { |k,v| puts "#{k}: #{v}" }
 		end
-		def firelog msg,kind='LOG'
-			headers = build_headers msg,kind
+		def firelog msg,kind='LOG', label=nil
+			return if @firephpruby_skip
+			headers = build_headers msg,kind,label
 			headers.each { |h| puts "#{h[0]}: #{h[1]}" }
 		end
-		def log msg
-			firelog msg,'LOG'
+		FPHR_FUNCTION_NAMES.each { |x| self.class_eval "def #{x.downcase} msg, label=nil; firelog msg,'#{x}',label; end" }
+		def dump obj, label=''
+			firelog obj,'DUMP', label
 		end
-		def info msg
-			firelog msg,'INFO'
-		end
-		def warn msg
-			firelog msg,'WARN'
-		end
-		def error msg
-			firelog msg,'ERROR'
+		def send_index_header # not needed since 0.2.b.4 or something like
+			puts "X-Wf-1-Index: #{@fire_msg_index.to_s}"
 		end
 	end
 
-	module WEBrick
+	module HTTPResponse
 	  include Common
-		def fire_log msg,kind='LOG'
-			headers = build_headers msg,kind
+		def fire_clog msg,kind='LOG', label=nil
+			return if defined?( @firephpruby_skip ) && @firephpruby_skip
+			headers = build_headers msg,kind,label
 			headers.each { |h| @header[h[0]] = h[1] }
-			unless defined? @firephruby_inited
-				FPHR_INIT_HEADERS.each_pair { |k,v| @header[k] = v }
-				@firephruby_inited = true
-			end
+			return if defined? @firephruby_inited
+			initialize_request( @firephruby_user_agent ).each_pair { |k,v| @header[k] = v }
+			@firephruby_inited = true
 		end
-		def fire_info msg
-			fire_log msg,'INFO'
+		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=''
+			fire_clog obj,'DUMP', label
 		end
-		def fire_warn msg
-			fire_log msg,'WARN'
+		def fire_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 
+			@header = @headers	# is called @headers in the Rails-response-class
 		end
-		def fire_error msg
-			fire_log msg,'ERROR'
+		module Interface
+			FPHR_FUNCTION_NAMES.each { |x| self.module_eval "def fire_#{x.downcase} msg, label=nil; response.fire_clog msg,'#{x}',label; end" }
+			def fire_dump obj, label=''
+				response.fire_clog obj,'DUMP', label
+			end
 		end
-  end
+	end
 end
 
-module WEBrick
-  class HTTPResponse
-	  include FirePHRuby::WEBrick
-  end
+if defined? ActionController # guessing Rails should be a little bit more detailed.
+	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
+				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)
+				end
+			end
+		end
+	  class AbstractResponse
+		  include FirePHRuby::Rails
+	  end
+	end
+	module ActionView
+		class Base
+			include FirePHRuby::Rails::Interface
+		end
+	end
+elsif defined? WEBrick
+	module WEBrick
+		class HTTPResponse
+			include FirePHRuby::HTTPResponse
+		end
+		class HTTPServer
+			alias 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)
+			end
+		end
+	end
+elsif defined? Mongrel
+	module Mongrel
+		class HttpResponse
+			include FirePHRuby::HTTPResponse
+			def fire_init req
+				fire_set_user_agent req.params['HTTP_USER_AGENT']
+			end
+		end
+	end
 end

data/{cgi_sample.rb → samples/cgi_sample.rb}

@@ -1,6 +1,7 @@
 #!/usr/local/bin/ruby
 # -*- coding: utf-8 -*-
 
+require 'rubygems'
 require 'firephruby'
 
 console = Fireruby::CGI.new
@@ -9,6 +10,8 @@ console.log 'HMMMmmm...'
 console.info 'Übrigens...'
 console.warn "Achtunk!"
 console.error "Scheiße!"
+console.log %w(eins zwei drei), 'Label 1'
+console.dump [].public_methods.sort, 'array methods'
 
 puts "Content-Type: text/plain; charset=utf-8\n\n"
 puts 'so far it worked'

data/samples/mongrel_sample.rb

@@ -0,0 +1,30 @@
+#! /usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'mongrel'
+require 'firephruby'
+
+class SimpleHandler < Mongrel::HttpHandler
+	def process(request, response)
+		response.fire_init request # required in mongrel
+		response.fire_log 'HMMMmmm...'
+		response.fire_info 'Übrigens...', 'label'
+		response.fire_info :bla=>'blahhh', :blubb=>'bluhhbb'
+		response.fire_warn "Achtunk!"
+		response.fire_error "Schiet!"
+		response.fire_dump [].public_methods.sort, 'array methods'
+
+		response.start(200) do |head,out|
+		  head["Content-Type"] = "text/plain"
+		  out.write("hello!\n")
+		end
+	end
+end
+
+h = Mongrel::HttpServer.new("0.0.0.0", "3000")
+h.register("/firetest", SimpleHandler.new)
+h.run.join
+
+
+

data/samples/rails/app/controllers/fphrdemo_controller.rb

@@ -0,0 +1,15 @@
+class FphrdemoController < ApplicationController
+  def index
+  end
+  
+  def fphr_ajax
+		fire_log 'Hello'
+		fire_info 'Hello'
+		fire_warn 'Hello'
+		fire_error 'Hello'
+		fire_log %w(eins zwei drei), 'Label 1'
+		fire_dump [].public_methods.sort, 'array methods'
+		render :json => [ 'sweet', 'sweet', "AJAX World" ]
+  end
+  
+end

data/samples/rails/app/views/fphrdemo/index.html.erb

@@ -0,0 +1,12 @@
+<%= javascript_include_tag :defaults %>
+
+Hello
+<div id="ajax">response goes here</div>
+
+<%= link_to_remote("klick me", { 
+      :update => :ajax, 
+      :url => { :action => :fphr_ajax } }) %>
+
+<p><% fire_dump self.public_methods.sort, '"self.public_methods" of a view' 
+  		fire_log 'hiho','from the view' %>
+

data/{webrick_sample.rb → samples/webrick_sample.rb}

@@ -1,17 +1,19 @@
 #! /usr/bin/env ruby
 # -*- coding: utf-8 -*-
 
+require 'rubygems'
 require 'webrick'
-include WEBrick
 require 'firephruby'
 
-server = HTTPServer.new(:Port => 8085)
+server = WEBrick::HTTPServer.new(:Port => 8085)
 
 server.mount_proc('/firetest') do |request, response|
 	response.fire_log 'HMMMmmm...'
 	response.fire_info 'Übrigens...'
 	response.fire_warn "Achtunk!"
-	response.fire_error "Scheiße!"
+	response.fire_error "Schiet!"
+	response.fire_log %w(eins zwei drei), 'Label 1'
+	response.fire_dump [].public_methods.sort, 'array methods'
 	response.body = "so far it worked"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: firephruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: []
 
@@ -34,8 +34,11 @@ files:
 - README
 - Changelog
 - LICENSE
-- webrick_sample.rb
-- cgi_sample.rb
+- samples/mongrel_sample.rb
+- samples/rails/app/controllers/fphrdemo_controller.rb
+- samples/rails/app/views/fphrdemo/index.html.erb
+- samples/webrick_sample.rb
+- samples/cgi_sample.rb
 - lib/firephruby.rb
 has_rdoc: false
 homepage: http://firephruby.rubyforge.org/