josevalim-rails-footnotes 3.5.0 → 3.6.0

data/CHANGELOG

@@ -1,6 +1,14 @@
+== Footnotes v3.6
+  * Cookies, sessions and params notes now use table;
+  * Old components note removed;
+  * Added assigns notes (thanks to scorpio);
+  * Improve query note, count query time and display it with several configurable
+    options (:alert_db_time and :alert_sql_number) (thanks to scorpio);
+  * Fixed bugs of layout link and route note related (thanks to scorpio).
+
 == Footnotes v3.5
-  * Added NewRelic RPM footnote (cortesy of kbrock)
-  * Several bug fixes (cortesy of kbrock, ivanoats and kristopher)
+  * Added NewRelic RPM footnote (thanks to kbrock);
+  * Several bug fixes (thanks to kbrock, ivanoats and kristopher).
 
 == Footnotes v3.4
   * Rails 2.3 compatible.

data/README

@@ -1,6 +1,6 @@
 Rails Footnotes
 License: MIT
-Version: 3.5
+Version: 3.6
 
 You can also read this README in pretty html at the GitHub project Wiki page
 
@@ -131,9 +131,10 @@ Then put in your environment:
 Colaborators
 ------------
 
-* http://github.com/kbrock
-* http://github.com/ivanoats
-* http://github.com/kristopher
+* Leon Li       - http://github.com/scorpio
+* Keenan Brock  - http://github.com/kbrock
+* Ivan Storck   - http://github.com/ivanoats
+* Kris Chamber  - http://github.com/kristopher
 
 
 Bugs and Feedback
@@ -149,7 +150,7 @@ http://josevalim.blogspot.com/
 Version 2.0
 -----------
 
-Until version 2.0, this plugin was created and maintained by Duane Johnson:
+This plugin was created and maintained until version 2.0 by Duane Johnson:
 
 Copyright (c) 2006 InquiryLabs, Inc.
 http://blog.inquirylabs.com/

data/lib/rails-footnotes/footnotes.rb

@@ -10,11 +10,12 @@ module Footnotes
     # Edit notes
     @@notes = [ :controller, :view, :layout, :stylesheets, :javascripts ]
     # Show notes
-    @@notes += [ :session, :cookies, :params, :filters, :routes, :env, :log, :general ]
+    @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general ]
+
+    # Change queries for rpm note when available
     if defined?(NewRelic)
+      @@notes.delete(:queries)
       @@notes << :rpm
-    else
-      @@notes << :queries
     end
 
     # :no_style       => If you don't want the style to be appended to your pages
@@ -168,6 +169,7 @@ module Footnotes
           #footnotes_debug table {text-align: center;}
           #footnotes_debug table td {padding: 0 5px;}
           #footnotes_debug tbody {text-align: left;}
+          #footnotes_debug .name_values td {vertical-align: top;}
           #footnotes_debug legend {background-color: #FFF;}
           #footnotes_debug fieldset {text-align: left; border: 1px dashed #aaa; padding: 0.5em 1em 1em 1em; margin: 1em 2em; color: #444; background-color: #FFF;}
           /* Aditional Stylesheets */
@@ -232,11 +234,10 @@ module Footnotes
         <!-- End Footnotes -->
         HTML
 
-        if @body =~ %r{<div[^>]+id=['"]footnotes_holder['"][^>]*>}
-          # Insert inside the "footnotes_holder" div if it exists
-          insert_text :after, %r{<div[^>]+id=['"]footnotes_holder['"][^>]*>}, footnotes_html
+        placeholder = /<div[^>]+id=['"]footnotes_holder['"][^>]*>/i
+        if @body =~ placeholder
+          insert_text :after, placeholder, footnotes_html
         else
-          # Otherwise, try to insert as the last part of the html body
           insert_text :before, /<\/body>/i, footnotes_html
         end
       end

data/lib/rails-footnotes/notes/abstract_note.rb

@@ -155,9 +155,20 @@ module Footnotes
           TABLE
         end
 
+        # Mount table for hash, using name and value and adding a name_value class
+        # to the generated table.
+        #
+        def mount_table_for_hash(hash)
+          rows = []
+          hash.each do |key, value|
+            rows << [ key.to_sym.inspect, escape(value.inspect) ]
+          end
+          mount_table(rows.unshift(['Name', 'Value']), :class => 'name_value')
+        end
+
         def hash_to_xml_attributes(hash)
           return hash.collect{ |key, value| "#{key.to_s}=\"#{value.gsub('"','\"')}\"" }.join(' ')
         end
     end
   end
-end
+end

data/lib/rails-footnotes/notes/assigns_note.rb

@@ -0,0 +1,44 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class AssignsNote < AbstractNote
+      @@ignored_assigns = %w( @template @_request @db_rt_before_render @db_rt_after_render @view_runtime )
+      cattr_accessor :ignored_assigns, :instance_writter => false
+
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def title
+        "Assigns (#{assigns.size})"
+      end
+
+      def valid?
+        assigns
+      end
+
+      def content
+        rows = []
+        assigns.each do |key|
+          rows << [ key, assigned_value(key) ]
+        end
+        mount_table(rows.unshift(['Name', 'Value']), :class => 'name_values')
+      end
+
+      protected
+
+        def assigns
+          return @assigns if @assigns
+
+          @assigns = @controller.instance_variables
+          @assigns -= @controller.protected_instance_variables
+          @assigns -= ignored_assigns
+        end
+
+        def assigned_value(key)
+          escape(@controller.instance_variable_get(key).inspect)
+        end
+    end
+  end
+end

data/lib/rails-footnotes/notes/cookies_note.rb

@@ -12,8 +12,8 @@ module Footnotes
       end
 
       def content
-        escape(@cookies.inspect)
+        mount_table_for_hash(@cookies)
       end
     end
   end
-end
+end

data/lib/rails-footnotes/notes/layout_note.rb

@@ -21,7 +21,7 @@ module Footnotes
 
       protected
         def filename
-          File.join(File.expand_path(RAILS_ROOT), 'app', 'layouts', "#{@controller.active_layout.to_s.underscore}.html.erb").sub('/layouts/layouts/', '/views/layouts/')
+          File.join(File.expand_path(RAILS_ROOT), 'app', 'layouts', "#{@controller.active_layout.to_s.underscore}").sub('/layouts/layouts/', '/views/layouts/')
         end
     end
   end

data/lib/rails-footnotes/notes/params_note.rb

@@ -12,8 +12,8 @@ module Footnotes
       end
 
       def content
-        escape(@params.inspect)
+        mount_table_for_hash(@params)
       end
     end
   end
-end
+end

data/lib/rails-footnotes/notes/queries_note.rb

@@ -3,8 +3,10 @@ require "#{File.dirname(__FILE__)}/abstract_note"
 module Footnotes
   module Notes
     class QueriesNote < AbstractNote
+      @@alert_db_time = 0.16
+      @@alert_sql_number = 8
       @@sql = []
-      cattr_accessor :sql
+      cattr_accessor :sql, :alert_db_time, :alert_sql_number, :alert_explain, :instance_writter => false
 
       def self.start!(controller)
         @@sql = []
@@ -15,16 +17,23 @@ module Footnotes
       end
 
       def title
-        "Queries (#{@@sql.length})"
+        db_time = @@sql.inject(0){|sum, item| sum += item.time }
+        query_color = generate_red_color(@@sql.length, alert_sql_number)
+        db_color    = generate_red_color(db_time, alert_db_time)
+
+        <<-TITLE
+  <span style="background-color:#{query_color}">Queries (#{@@sql.length})</span> 
+  <span style="background-color:#{db_color}">DB (#{"%.6f" % db_time}s)</span>
+        TITLE
       end
 
       def stylesheet
-<<-STYLESHEET
+        <<-STYLESHEET
   #queries_debug_info table td, #queries_debug_info table th{border:1px solid #A00; padding:0 3px; text-align:center;}
   #queries_debug_info table thead, #queries_debug_info table tbody {color:#A00;}
   #queries_debug_info p {background-color:#F3F3FF; border:1px solid #CCC; margin:12px; padding:4px 6px;}
   #queries_debug_info a:hover {text-decoration:underline;}
-STYLESHEET
+        STYLESHEET
       end
 
       def content
@@ -32,16 +41,16 @@ STYLESHEET
 
         @@sql.each_with_index do |item, i|
           sql_links = []
-          sql_links << "<a href=\"#\" style=\"color:#A00;\" onclick=\"Footnotes.toggle('qtable_#{i}');return false\">explain</a>" if item.explain
-          sql_links << "<a href=\"#\" style=\"color:#00A;\" onclick=\"Footnotes.toggle('qtrace_#{i}');return false\">trace</a>" if item.trace
+          sql_links << "<a href=\"javascript:Footnotes.toggle('qtable_#{i}')\" style=\"color:#A00;\">explain</a>" if item.explain
+          sql_links << "<a href=\"javascript:Footnotes.toggle('qtrace_#{i}')\" style=\"color:#00A;\">trace</a>" if item.trace
 
-html << <<-HTML
+          html << <<-HTML
   <b id="qtitle_#{i}">#{escape(item.type.to_s.upcase)}</b> (#{sql_links.join(' | ')})<br />
   #{print_name_and_time(item.name, item.time)}<br />
-  #{print_query(item.query)}<br />
+  <span id="explain_#{i}">#{print_query(item.query)}</span><br />
   #{print_explain(i, item.explain) if item.explain}
   <p id="qtrace_#{i}" style="display:none;">#{parse_trace(item.trace) if item.trace}</p><br />
-HTML
+          HTML
         end
 
         return html
@@ -51,7 +60,9 @@ HTML
         def parse_explain(results)
           table = []
           table << results.fetch_fields.map(&:name)
-          results.each{|row| table << row}
+          results.each do |row|
+            table << row
+          end
           table
         end
 
@@ -63,7 +74,7 @@ HTML
         end
 
         def print_name_and_time(name, time)
-          "#{escape(name || 'SQL')} (#{sprintf('%f', time)}s)"
+          "<span style='background-color:#{generate_red_color(time, alert_ratio)}'>#{escape(name || 'SQL')} (#{sprintf('%f', time)}s)</span>"
         end
 
         def print_query(query)
@@ -73,6 +84,20 @@ HTML
         def print_explain(i, explain)
           mount_table(parse_explain(explain), :id => "qtable_#{i}", :style => 'margin:10px;display:none;')
         end
+
+        def generate_red_color(value, alert)
+          c = ((value.to_f/alert).to_i - 1) * 16
+          c = 0  if c < 0
+          c = 15 if c > 15
+
+          c = (15-c).to_s(16)
+          "#ff#{c*4}"
+        end
+
+        def alert_ratio
+          alert_db_time / alert_sql_number
+        end
+
     end
   end
 
@@ -87,7 +112,8 @@ HTML
         @query = query
         @explain = explain
 
-        # Strip, select those ones from app and reject first two, because they are from the plugin
+        # Strip, select those ones from app and reject first two, because they
+        # are from the plugin
         @trace = Kernel.caller.collect(&:strip).select{|i| i.gsub!(/^#{RAILS_ROOT}\//im, '') }[2..-1]
       end
     end
@@ -125,7 +151,7 @@ HTML
         if @logger
           @logger.silence do
             result = yield
-          end        
+          end
         else
           result = yield
         end

data/lib/rails-footnotes/notes/routes_note.rb

@@ -20,7 +20,7 @@ module Footnotes
         def parse_routes
           routes_with_name = ActionController::Routing::Routes.named_routes.to_a.flatten
 
-          return ActionController::Routing::Routes.filtered_routes(:controller => @controller.controller_name).collect do |route|
+          return ActionController::Routing::Routes.filtered_routes(:controller => @controller.controller_path).collect do |route|
             # Catch routes name if exists
             i = routes_with_name.index(route)
             name = i ? routes_with_name[i-1].to_s : ''
@@ -56,4 +56,4 @@ end
 
 if Footnotes::Notes::RoutesNote.included?
   ActionController::Routing::RouteSet.send :include, Footnotes::Extensions::Routes
-end
+end

data/lib/rails-footnotes/notes/session_note.rb

@@ -7,8 +7,12 @@ module Footnotes
         @session = (controller.session || {}).symbolize_keys
       end
 
+      def title
+        "Session (#{@session.length})"
+      end
+
       def content
-        escape(@session.inspect)
+        mount_table_for_hash(@session)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-rails-footnotes
 version: !ruby/object:Gem::Version 
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 -07:00
+date: 2009-05-12 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,7 @@ files:
 - lib/rails-footnotes/backtracer.rb
 - lib/rails-footnotes/footnotes.rb
 - lib/rails-footnotes/notes/abstract_note.rb
-- lib/rails-footnotes/notes/components_note.rb
+- lib/rails-footnotes/notes/assigns_note.rb
 - lib/rails-footnotes/notes/controller_note.rb
 - lib/rails-footnotes/notes/cookies_note.rb
 - lib/rails-footnotes/notes/env_note.rb

data/lib/rails-footnotes/notes/components_note.rb

@@ -1,79 +0,0 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-require "#{File.dirname(__FILE__)}/controller_note"
-require "#{File.dirname(__FILE__)}/view_note"
-require "#{File.dirname(__FILE__)}/params_note"
-
-module Footnotes
-  module Notes
-    module ComponentsNote
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        def to_sym
-          @note_sym ||= "#{self.title.underscore}_component_#{(rand*1000).to_i}".to_sym
-        end
-
-        def title
-          @note_title ||= self.name.match(/^Footnotes::Notes::(\w+)ComponentNote$/)[1]
-        end
-      end
-
-      def initialize(controller)
-        super
-        @controller = controller
-      end
-
-      def row
-        "#{@controller.controller_name.camelize}##{@controller.action_name.camelize} Component"
-      end
-     
-      def legend
-        "#{super} for #{row}"
-      end
-    end
-
-    class ControllerComponentNote < ControllerNote; include ComponentsNote; end
-    class ViewComponentNote < ViewNote; include ComponentsNote; end
-    class ParamsComponentNote < ParamsNote; include ComponentsNote; end
-  end
-
-  module Components
-
-    def self.included(base)
-      base.class_eval do
-        alias_method_chain :add_footnotes!, :component
-        Footnotes::Filter.notes.delete(:components)
-        @@component_notes = [ :controller, :view, :params ]
-      end
-    end
-
-    def add_footnotes_with_component!
-      if component_request?
-        initialize_component_notes!
-        Footnotes::Filter.notes.unshift(*@notes)
-      else
-        add_footnotes_without_component!
-        Footnotes::Filter.notes.delete_if {|note| note.class.to_s =~ /(ComponentNote)$/}
-      end
-    end
-
-    protected
-      def initialize_component_notes!
-        @@component_notes.flatten.each do |note|
-          begin
-            note = eval("Footnotes::Notes::#{note.to_s.camelize}ComponentNote").new(@controller) if note.is_a?(Symbol) || note.is_a?(String)
-            @notes << note if note.respond_to?(:valid?) && note.valid?
-          rescue Exception => e
-            # Discard note if it has a problem
-            self.class.log_error("Footnotes #{note.to_s.camelize}ComponentNote Exception", e)
-            next
-          end
-        end
-      end
-
-  end
-end
-
-Footnotes::Filter.__send__ :include, Footnotes::Components if Footnotes::Filter.notes.include?(:components)