rails-footnotes 3.6.5 → 3.6.6

data/CHANGELOG

@@ -1,3 +1,12 @@
+== Footnotes v3.6.6
+  * fix for ruby 1.9 compat (thanks to ivanoats)
+  * fix for log note (thanks to tobias)
+  * pre rails 2.3 support fixes (thanks to tobias)
+  * better disabling of query notes (thanks to tobias)
+  * fixed variable assignment escaping (thanks to gdelvino)
+  * fixed cookie value escaping (thanks to indirect) 
+  * Turn off footnotes with a parameter footnotes=false (thanks to indirect)
+
 == Footnotes v3.6
   * Cookies, sessions and params notes now use table;
   * Old components note removed;

data/README

@@ -62,6 +62,10 @@ Finally, you can control which notes you want to show. The default are:
 
   Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]
 
+The queries note by default will not load if it detects New Relic loaded in the app. If you want to load it
+in this case, add the following to an initializer:
+
+Footnotes::Notes::QueriesNote.include_when_new_relic_installed = true if defined?(Footnotes)
 
 Creating your own notes
 -----------------------

data/Rakefile

@@ -6,7 +6,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "rails-footnotes"
-    s.version = "3.6.5"
+    s.version = "3.6.6"
     s.rubyforge_project = "rails-footnotes"
     s.summary = "Every Rails page has footnotes that gives information about your application and links back to your editor."
     s.email = "jose@plataformatec.com.br"
@@ -36,3 +36,14 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('MIT-LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+begin
+  require 'metric_fu'
+  MetricFu::Configuration.run do |config|
+      #skipping: churn, :stats
+      config.metrics  = [:saikuro, :flog, :flay, :reek, :roodi, :rcov]
+      # config.graphs   = [:flog, :flay, :reek, :roodi, :rcov]
+      config.rcov[:rcov_opts] << "-Itest"
+  end
+rescue LoadError
+end

data/lib/rails-footnotes.rb

@@ -6,7 +6,7 @@ if RAILS_ENV == 'development'
   # Load all notes
   #
   Dir[File.join(dir, 'rails-footnotes', 'notes', '*.rb')].each do |note|
-    require note  unless note =~ /queries/ && !defined?(ActiveRecord)
+    require note
   end
 
   # The footnotes are applied by default to all actions. You can change this

data/lib/rails-footnotes/footnotes.rb

@@ -8,7 +8,7 @@ module Footnotes
     @@prefix = 'txmt://open?url=file://%s&line=%d&column=%d'
 
     # Edit notes
-    @@notes = [ :controller, :view, :layout, :stylesheets, :javascripts ]
+    @@notes = [ :controller, :view, :layout, :partials, :stylesheets, :javascripts ]
     # Show notes
     @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general ]
 
@@ -119,7 +119,9 @@ module Footnotes
 
     protected
       def valid?
-        performed_render? && valid_format? && valid_content_type? && @body.is_a?(String) && !component_request? && !xhr?
+        performed_render? && valid_format? && valid_content_type? &&
+          @body.is_a?(String) && !component_request? && !xhr? &&
+          !footnotes_disabled?
       end
 
       def add_footnotes_without_validation!
@@ -156,6 +158,10 @@ module Footnotes
         @controller.request.xhr?
       end
 
+      def footnotes_disabled?
+        @controller.params[:footnotes] == "false"
+      end
+
       #
       # Insertion methods
       #
@@ -165,6 +171,7 @@ module Footnotes
         <!-- Footnotes Style -->
         <style type="text/css">
           #footnotes_debug {margin: 2em 0 1em 0; text-align: center; color: #444; line-height: 16px;}
+          #footnotes_debug th, #footnotes_debug td {color: #444; line-height: 18px;}
           #footnotes_debug a {text-decoration: none; color: #444; line-height: 18px;}
           #footnotes_debug table {text-align: center;}
           #footnotes_debug table td {padding: 0 5px;}

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

@@ -145,6 +145,7 @@ module Footnotes
           return '' if array.empty?
 
           header = header.collect{|i| escape(i.to_s.humanize) }
+          array = array.collect { |a| a.collect { |b| c = b.to_s; escape(c) unless c == ""}}
           rows = array.collect{|i| "<tr><td>#{i.join('</td><td>')}</td></tr>" }
 
           <<-TABLE
@@ -158,12 +159,12 @@ module Footnotes
         # Mount table for hash, using name and value and adding a name_value class
         # to the generated table.
         #
-        def mount_table_for_hash(hash)
+        def mount_table_for_hash(hash, options={})
           rows = []
           hash.each do |key, value|
             rows << [ key.to_sym.inspect, escape(value.inspect) ]
           end
-          mount_table(rows.unshift(['Name', 'Value']), :class => 'name_value')
+          mount_table(rows.unshift(['Name', 'Value']), {:class => 'name_value'}.merge(options))
         end
 
         def hash_to_xml_attributes(hash)

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

@@ -23,7 +23,7 @@ module Footnotes
         assigns.each do |key|
           rows << [ key, assigned_value(key) ]
         end
-        mount_table(rows.unshift(['Name', 'Value']), :class => 'name_values')
+        mount_table(rows.unshift(['Name', 'Value']), :class => 'name_values', :summary => "Debug information for #{title}")
       end
 
       protected
@@ -32,12 +32,12 @@ module Footnotes
           return @assigns if @assigns
 
           @assigns = @controller.instance_variables
-          @assigns -= @controller.protected_instance_variables
+          @assigns -= @controller.protected_instance_variables if @controller.respond_to? :protected_instance_variables
           @assigns -= ignored_assigns
         end
 
         def assigned_value(key)
-          escape(@controller.instance_variable_get(key).inspect)
+          @controller.instance_variable_get(key).inspect
         end
     end
   end

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

@@ -51,7 +51,7 @@ module Footnotes
         def lines_from_index(string, index)
           return nil if string.blank? || index.blank?
 
-          lines = string.to_a
+          lines = string.respond_to?(:to_a) ? string.to_a : string.lines.to_a
           running_length = 0
           lines.each_with_index do |line, i|
             running_length += line.length

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

@@ -12,7 +12,7 @@ module Footnotes
       end
 
       def content
-        mount_table_for_hash(@cookies)
+        mount_table_for_hash(@cookies, :summary => "Debug information for #{title}")
       end
     end
   end

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

@@ -8,11 +8,18 @@ module Footnotes
       end
 
       def content
-        # Replace HTTP_COOKIE for a link
-        @env['HTTP_COOKIE'] = '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>'
+        env_data = @env.to_a.sort.unshift([:key, :value]).map do |k,v|
+          case k
+          when 'HTTP_COOKIE'
+            # Replace HTTP_COOKIE for a link
+            [k, '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>']
+          else
+            [k, escape(v.to_s)]
+          end
+        end
 
         # Create the env table
-        mount_table(@env.to_a.sort.unshift([:key, :value]))
+        mount_table(env_data)
       end
     end
   end

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

@@ -13,7 +13,7 @@ module Footnotes
       end
 
       def content
-        mount_table(@parsed_filters.unshift([:name, :type, :actions]))
+        mount_table(@parsed_filters.unshift([:name, :type, :actions]), :summary => "Debug information for #{title}")
       end
 
       protected

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

@@ -12,7 +12,7 @@ module Footnotes
       end
 
       def content
-        mount_table_for_hash(@params)
+        mount_table_for_hash(@params, :summary => "Debug information for #{title}")
       end
     end
   end

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

@@ -0,0 +1,50 @@
+module Footnotes
+  module Notes
+    class PartialsNote < LogNote
+      def initialize(controller)
+        super
+        @controller = controller
+      end
+      def row
+        :edit
+      end
+      def title
+        "Partials (#{partials.size})"
+      end
+      def content
+        links = partials.map do |file|
+          href = Footnotes::Filter.prefix(file,1,1)
+          "<tr><td><a href=\"#{href}\">#{file.gsub(File.join(Rails.root,"app/views/"),"")}</td><td>#{@partial_times[file].sum}ms</a></td><td>#{@partial_counts[file]}</td></tr>"
+        end
+        "<table><thead><tr><th>Partial</th><th>Time</th><th>Count</th></tr></thead><tbody>#{links.join}</tbody></table>"
+      end
+
+      protected
+        #Generate a list of partials that were rendered, also build up render times and counts.
+        #This is memoized so we can use its information in the title easily.
+        def partials
+          @partials ||= begin
+            partials = []
+            @partial_counts = {}
+            @partial_times = {}
+            log_lines = log
+            log_lines.split("\n").each do |line|
+              if line =~ /Rendered (\S*) \(([\d\.]+)\S*?\)/
+                partial = $1
+                files = Dir.glob("#{Rails.root}/app/views/#{partial}*")
+                for file in files
+                  #TODO figure out what format got rendered if theres multiple
+                  @partial_times[file] ||= []
+                  @partial_times[file] << $2.to_f
+                  @partial_counts[file] ||= 0
+                  @partial_counts[file] += 1
+                  partials << file unless partials.include?(file)
+                end
+              end
+            end
+            partials.reverse
+          end
+        end
+    end    
+  end
+end

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

@@ -6,8 +6,17 @@ module Footnotes
       @@alert_db_time = 0.16
       @@alert_sql_number = 8
       @@sql = []
-      cattr_accessor :sql, :alert_db_time, :alert_sql_number, :alert_explain, :instance_writter => false
-
+      @@include_when_new_relic_installed = false
+      @@loaded = false
+      
+      cattr_accessor :sql, :alert_db_time, :alert_sql_number, :alert_explain, :loaded, :instance_writter => false
+      cattr_reader :include_when_new_relic_installed
+      
+      def self.include_when_new_relic_installed=(include_me)
+        @@include_when_new_relic_installed = include_me
+        load if include_me
+      end
+      
       def self.start!(controller)
         @@sql = []
       end
@@ -55,7 +64,24 @@ module Footnotes
 
         return html
       end
-
+      
+      def self.load
+        #only include when NewRelic is installed if configured to do so
+        if !loaded and
+            included? and
+            defined?(ActiveRecord) and
+            (!defined?(NewRelic) or
+             include_when_new_relic_installed)
+          ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Footnotes::Extensions::AbstractAdapter
+          ActiveRecord::ConnectionAdapters.local_constants.each do |adapter|
+            next unless adapter =~ /.*[^Abstract]Adapter$/
+            next if adapter =~ /SQLiteAdapter$/
+            eval("ActiveRecord::ConnectionAdapters::#{adapter}").send :include, Footnotes::Extensions::QueryAnalyzer
+            self.loaded = true
+          end
+        end
+      end
+      
       protected
         def parse_explain(results)
           table = []
@@ -82,7 +108,7 @@ module Footnotes
         end
 
         def print_explain(i, explain)
-          mount_table(parse_explain(explain), :id => "qtable_#{i}", :style => 'margin:10px;display:none;')
+          mount_table(parse_explain(explain), :id => "qtable_#{i}", :style => 'margin:10px;display:none;', :summary => "Debug information for #{title}")
         end
 
         def generate_red_color(value, alert)
@@ -162,11 +188,4 @@ module Footnotes
   end
 end
 
-if Footnotes::Notes::QueriesNote.included?
-  ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Footnotes::Extensions::AbstractAdapter
-  ActiveRecord::ConnectionAdapters.local_constants.each do |adapter|
-    next unless adapter =~ /.*[^Abstract]Adapter$/
-    next if adapter =~ /SQLiteAdapter$/
-    eval("ActiveRecord::ConnectionAdapters::#{adapter}").send :include, Footnotes::Extensions::QueryAnalyzer
-  end
-end
+Footnotes::Notes::QueriesNote.load

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

@@ -13,7 +13,7 @@ module Footnotes
       end
 
       def content
-        mount_table(@parsed_routes.unshift([:path, :name, :options, :requirements]))
+        mount_table(@parsed_routes.unshift([:path, :name, :options, :requirements]), :summary => "Debug information for #{title}")
       end
 
       protected

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

@@ -1,5 +1,6 @@
 require "#{File.dirname(__FILE__)}/abstract_note"
 
+if defined?(NewRelic)
 module Footnotes
   module Notes
     class RpmNote < AbstractNote
@@ -13,12 +14,17 @@ module Footnotes
 
       def link
          #{:controller => 'newrelic', :action => 'show_sample_detail', :id => @rpm_id}
-         "/newrelic/show_sample_detail/#{@rpm_id}"
+         "/newrelic/show_sample_detail/#{@rpm_id}" if @rpm_id
       end
       
       def valid?
-        !NewRelic::Config.instance['skip_developer_route']
+        if defined?(NewRelic::Control)
+          !NewRelic::Control.instance['skip_developer_route']
+        else
+          !NewRelic::Config.instance['skip_developer_route']
+        end
       end
     end
   end
 end
+end

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

@@ -4,7 +4,17 @@ module Footnotes
   module Notes
     class SessionNote < AbstractNote
       def initialize(controller)
-        @session = (controller.session.data || {}).symbolize_keys
+        session = controller.session
+        if session
+          if session.respond_to? :to_hash
+            # rails >= 2.3
+            session = session.to_hash
+          else
+            #rails < 2.3
+            session = session.data
+          end
+        end
+        @session = (session || {}).symbolize_keys
       end
 
       def title
@@ -12,7 +22,7 @@ module Footnotes
       end
 
       def content
-        mount_table_for_hash(@session)
+        mount_table_for_hash(@session, :summary => "Debug information for #{title}")
       end
     end
   end

data/test/footnotes_test.rb

@@ -159,12 +159,12 @@ class FootnotesTest < Test::Unit::TestCase
 
   def test_insert_text
     @footnotes.send(:insert_text, :after, /<head>/, "Graffiti")
-    after = "    <head>Graffiti\n"
-    assert_equal after, @controller.response.body.to_a[2]
+    after = "    <head>Graffiti"
+    assert_equal after, @controller.response.body.split("\n")[2]
 
     @footnotes.send(:insert_text, :before, /<\/body>/, "Notes")
-    after = "    Notes</body>\n"
-    assert_equal after, @controller.response.body.to_a[12]
+    after = "    Notes</body>"
+    assert_equal after, @controller.response.body.split("\n")[12]
   end
   
   protected
@@ -172,7 +172,6 @@ class FootnotesTest < Test::Unit::TestCase
     # Then we call add_footnotes!
     #
     def footnotes_perform!
-      @controller.template.expects(:instance_variable_get).returns(true)
       @controller.template.expects(:template_format).returns('html')
       @controller.performed_render = true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails-footnotes
 version: !ruby/object:Gem::Version 
-  version: 3.6.5
+  version: 3.6.6
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-22 00:00:00 +01:00
+date: 2010-01-31 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +41,7 @@ files:
 - lib/rails-footnotes/notes/layout_note.rb
 - lib/rails-footnotes/notes/log_note.rb
 - lib/rails-footnotes/notes/params_note.rb
+- lib/rails-footnotes/notes/partials_note.rb
 - lib/rails-footnotes/notes/queries_note.rb
 - lib/rails-footnotes/notes/routes_note.rb
 - lib/rails-footnotes/notes/rpm_note.rb