rails3-footnotes 4.0.0.pre.2 → 4.0.0.pre.3

data/CHANGELOG

@@ -1,3 +1,10 @@
+== Footnotes v4.0.0.pre.3 (March 30, 2011)
+  * Merge in contributions from irjudson and jackkinsella
+  * fixes for partials note
+  * fixes for views note
+  * fixes for queries note
+  * fix a warning on routes note
+
 == Footnotes v4.0.0.pre.2 (February 21, 2011)
   * add a Railtie so the plugin will load in Rails 3 apps
   * remove some internal rails3 ivars from the assigns note

data/README.md

@@ -56,7 +56,7 @@ If you have New Relic RPM installed, you may want to turn off query explains
 
 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]
+    Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log]
 
 
 ## Creating your own notes

data/Rakefile

@@ -2,6 +2,9 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 desc 'Run tests for Footnotes.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'

data/lib/rails-footnotes/footnotes.rb

@@ -27,7 +27,7 @@ module Footnotes
     # Edit notes
     @@notes = [ :controller, :view, :layout, :partials, :stylesheets, :javascripts ]
     # Show notes
-    @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general ]
+    @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log ]
 
     # Change queries for rpm note when available
     # if defined?(NewRelic)

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

@@ -38,7 +38,7 @@ module Footnotes
           else
             @controller_filename=File.join(File.expand_path(Rails.root), 'app', 'controllers', "#{controller_name}.rb").sub('/controllers/controllers/', '/controllers/')
           end
-          @controller_filename
+          @controller_filename if File.exist?(@controller_filename)
         end
 
         def controller_text

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

@@ -3,54 +3,70 @@ require "#{File.dirname(__FILE__)}/log_note"
 module Footnotes
   module Notes
     class PartialsNote < LogNote
+      @@partial_subscriber = nil
+      cattr_accessor :partial_subscriber
+
       def initialize(controller)
         super
         @controller = controller
       end
+
+      def self.start!(controller)
+        @@partial_subscriber = Footnotes::Notes::PartialSubscriber.new
+        ActiveSupport::LogSubscriber.attach_to(:action_view, @@partial_subscriber)
+      end
+
       def row
         :edit
       end
+
       def title
         "Partials (#{partials.size})"
       end
+
       def content
         rows = partials.map do |filename|
           href = Footnotes::Filter.prefix(filename,1,1)
           shortened_name=filename.gsub(File.join(Rails.root,"app/views/"),"")
-          [%{<a href="#{href}">#{shortened_name}</a>},"#{@partial_times[filename].sum}ms",@partial_counts[filename]]
+          [%{<a href="#{href}">#{shortened_name}</a>},"#{@partial_times[filename].sum}ms", @partial_counts[filename]]
         end
         mount_table(rows.unshift(%w(Partial Time Count)), :summary => "Partials for #{title}")
       end
 
+      def self.load
+        self.loaded = true unless loaded
+      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
-                @controller.view_paths.each do |view_path|
-                  path = File.join(view_path, "#{partial}*")
-                  files = Dir.glob(path)
-                  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
-            end
-            partials.reverse
+      #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 = {}
+          @@partial_subscriber.events.each do |event|
+            partial = event.payload[:identifier]
+            @partial_times[partial] ||= []
+            @partial_times[partial] << event.duration
+            @partial_counts[partial] ||= 0
+            @partial_counts[partial] += 1
+            partials << partial unless partials.include?(partial)
           end
+          partials.reverse
         end
-    end    
+      end
+    end
+    class PartialSubscriber < ActiveSupport::LogSubscriber
+      attr_accessor :events
+      def initialize
+        @events = Array.new
+        super
+      end
+
+      def render_partial(event)
+        @events << event.dup
+      end
+    end
   end
 end

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

@@ -3,22 +3,26 @@ require "#{File.dirname(__FILE__)}/abstract_note"
 module Footnotes
   module Notes
     class QueriesNote < AbstractNote
-      @@alert_db_time = 0.16
+      @@alert_db_time = 16.0
       @@alert_sql_number = 8
       @@sql = []
       @@include_when_new_relic_installed = false
       @@loaded = false
-      
+      @@query_subscriber = nil
       cattr_accessor :sql, :alert_db_time, :alert_sql_number, :alert_explain, :loaded, :sql_explain, :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 = []
+        @@query_subscriber = Footnotes::Notes::QuerySubscriber.new
+        # There appears to be nothing wrong with registering with a non-existant notifier, so we just attach to both :-).
+        ActiveSupport::LogSubscriber.attach_to(:data_mapper, @@query_subscriber)
+        ActiveSupport::LogSubscriber.attach_to(:active_record, @@query_subscriber)
       end
 
       def self.to_sym
@@ -26,161 +30,92 @@ module Footnotes
       end
 
       def title
-        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)
+        queries = @@query_subscriber.events.length
+        total_time = @@query_subscriber.events.inject(0){|sum, item| sum += item.payload[:duration]} / 1000.0
+        query_color = generate_red_color(@@query_subscriber.events.length, alert_sql_number)
+        db_color    = generate_red_color(total_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>
+        <span style="background-color:#{query_color}">Queries (#{queries})</span>
+        <span style="background-color:#{db_color}">DB (#{"%.3f" % total_time}ms)</span>
         TITLE
       end
 
       def 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;}
+        #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
       end
 
       def content
         html = ''
 
-        @@sql.each_with_index do |item, i|
-          sql_links = []
-          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
-
+        @@query_subscriber.events.each_with_index do |item, i|
           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 />
-  <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 />
+          #{print_name_and_time(item.payload[:name], item.payload[:duration] / 1000.0)}&nbsp;
+          <span id="explain_#{i}">#{print_query(item.payload[:sql])}</span><br />
           HTML
         end
 
         return html
       end
-      
+
       def self.load
-        #only include when NewRelic is installed if configured to do so
-        if !loaded and included? and defined?(ActiveRecord)
-          ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Footnotes::Extensions::AbstractAdapter
-          ActiveRecord::ConnectionAdapters.local_constants.each do |adapter|
-            next unless adapter =~ /.*[^Abstract]Adapter$/
-            next if adapter =~ /(SQLite|Salesforce)Adapter$/
-            eval("ActiveRecord::ConnectionAdapters::#{adapter}").send :include, Footnotes::Extensions::QueryAnalyzer
-            self.loaded = true
-          end
-        end
+        self.loaded = true unless loaded
       end
-      
-      protected
-        def parse_explain(results)
-          table = []
-          table << results.fetch_fields.map(&:name)
-          results.each do |row|
-            table << row
-          end
-          table
-        end
-
-        def parse_trace(trace)
-          trace.map do |t|
-            s = t.split(':')
-            %[<a href="#{escape(Footnotes::Filter.prefix("#{Rails.root.to_s}/#{s[0]}", s[1].to_i, 1))}">#{escape(t)}</a><br />]
-          end.join
-        end
-
-        def print_name_and_time(name, time)
-          "<span style='background-color:#{generate_red_color(time, alert_ratio)}'>#{escape(name || 'SQL')} (#{sprintf('%f', time)}s)</span>"
-        end
 
-        def print_query(query)
-          escape(query.to_s.gsub(/(\s)+/, ' ').gsub('`', ''))
-        end
+      protected
+      def print_name_and_time(name, time)
+        "<span style='background-color:#{generate_red_color(time, alert_ratio)}'>#{escape(name || 'SQL')} (#{'%.3fms' % time})</span>"
+      end
 
-        def print_explain(i, explain)
-          mount_table(parse_explain(explain), :id => "qtable_#{i}", :style => 'margin:10px;display:none;', :summary => "Debug information for #{title}")
-        end
+      def print_query(query)
+        escape(query.to_s.gsub(/(\s)+/, ' ').gsub('`', ''))
+      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
+      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
+        c = (15-c).to_s(16)
+        "#ff#{c*4}"
+      end
 
-        def alert_ratio
-          alert_db_time / alert_sql_number
-        end
+      def alert_ratio
+        alert_db_time / alert_sql_number
+      end
 
     end
-  end
-
-  module Extensions
-    class Sql
-      attr_accessor :type, :name, :time, :query, :explain, :trace
 
-      def initialize(type, name, time, query, explain)
-        @type = type
-        @name = name
-        @time = time
-        @query = query
-        @explain = explain
+    class QuerySubscriber < ActiveSupport::LogSubscriber
+      attr_accessor :events
 
-        # 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]
+      def self.runtime=(value)
+        Thread.current["orm_sql_runtime"] = value
       end
-    end
 
-    module QueryAnalyzer
-      def self.included(base)
-        base.class_eval do
-          alias_method_chain :execute, :analyzer
-        end
+      def self.runtime
+        Thread.current["orm_sql_runtime"] ||= 0
       end
 
-      def execute_with_analyzer(query, name = nil)
-        query_results = nil
-        time = Benchmark.realtime { query_results = execute_without_analyzer(query, name) }
-
-        if query =~ /^(select|create|update|delete)\b/i
-          type = $&.downcase.to_sym
-          explain = nil
-
-          if adapter_name == 'MySQL' && type == :select && Footnotes::Notes::QueriesNote.sql_explain
-            log_silence do
-              explain = execute_without_analyzer("EXPLAIN #{query}", name)
-            end
-          end
-          Footnotes::Notes::QueriesNote.sql << Footnotes::Extensions::Sql.new(type, name, time, query, explain)
-        end
+      def self.reset_runtime
+        rt, self.runtime = runtime, 0
+        rt
+      end
 
-        query_results
+      def initialize
+        @events = Array.new
+        super
       end
-    end
 
-    module AbstractAdapter
-      def log_silence
-        result = nil
-        if @logger
-          @logger.silence do
-            result = yield
-          end
-        else
-          result = yield
-        end
-        result
+      def sql(event)
+        @events << event.dup
       end
     end
-
   end
 end
 

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

@@ -48,7 +48,7 @@ module Footnotes
       #
       def filtered_routes(filter = {})
         return [] unless filter.is_a?(Hash)
-        return routes.reject do |r| 
+        return routes.reject do |r|
           filter_diff = filter.diff(r.requirements)
           route_diff  = r.requirements.diff(filter)
           (filter_diff == filter) || (filter_diff != route_diff)

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

@@ -3,33 +3,73 @@ require "#{File.dirname(__FILE__)}/abstract_note"
 module Footnotes
   module Notes
     class ViewNote < AbstractNote
-      def initialize(controller)
-        @controller = controller
-        @template = controller.instance_variable_get(:@template)
-      end
+        @@alert_time = 500.0
+        @@loaded = false
+        @@view_subscriber = nil
 
-      def row
-        :edit
-      end
+        def initialize(controller)
+          super
+          @controller = controller
+        end
 
-      def link
-        escape(Footnotes::Filter.prefix(filename, 1, 1))
-      end
+        def self.start!(controller)
+          @@view_subscriber = Footnotes::Notes::ViewSubscriber.new
+          ActiveSupport::LogSubscriber.attach_to(:action_view, @@view_subscriber)
+        end
 
-      def valid?
-        prefix? && first_render?
-      end
+        def self.to_sym
+          :views
+        end
 
-    protected
+        def title
+          total_time = @@view_subscriber.events.select{ |e| e.name =~ /render_template/ }[0].duration
+          "<span style=\"background-color:#{generate_red_color(total_time)}\">View Render (#{"%.3f" % total_time}ms)</span>"
+        end
 
-      def first_render?
-        @template.instance_variable_get(:@_first_render)
-      end
+        def content
+          html = ''
+          page = @@view_subscriber.events.select{ |e| e.name =~ /render_template/ }[0]
+          partials = @@view_subscriber.events.select{ |e| e.name =~ /render_partial/ }
+          partial_time = partials.inject(0) {|sum, item| sum += item.duration}
+
+          view = page.payload[:identifier].gsub(File.join(Rails.root,"app/views/"),"")
+          layout = page.payload[:layout].gsub(File.join(Rails.root,"app/views/"),"")
 
-      def filename
-        @filename ||= @template.instance_variable_get(:@_first_render).filename
+          rows = [["View", "Layout", "View Render (ms)", "Partial(s) Render (ms)", "Total Render (ms)"],
+                  [escape(view), escape(layout), "#{'%.3f' % (page.duration - partial_time)}",
+                   "<a href=\"#\" onclick=\"Footnotes.hideAllAndToggle('partials_debug_info');return false;\">#{'%.3f' % partial_time}</a>",
+                   "#{'%.3f' % page.duration}"]]
+
+          puts rows.inspect
+
+          mount_table(rows)
+        end
+
+        def self.load
+          self.loaded = true unless loaded
+        end
+
+        def generate_red_color(value)
+          if value > @@alert_time
+            "#f00"
+          else
+            "#aaa"
+          end
+        end
       end
 
+      class ViewSubscriber < ActiveSupport::LogSubscriber
+        attr_accessor :events
+        def initialize
+          @events = Array.new
+          super
+        end
+
+        def render_template(event)
+          @events << event.dup
+        end
+        alias :render_partial :render_template
+        alias :render_collection :render_template
     end
   end
 end

data/lib/rails-footnotes/version.rb

@@ -1,3 +1,3 @@
 module Footnotes
-  VERSION = "4.0.0.pre.2"
+  VERSION = "4.0.0.pre.3"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rails3-footnotes
 version: !ruby/object:Gem::Version 
-  hash: 1923831853
+  hash: 1923831855
   prerelease: true
   segments: 
   - 4
   - 0
   - 0
   - pre
-  - 2
-  version: 4.0.0.pre.2
+  - 3
+  version: 4.0.0.pre.3
 platform: ruby
 authors: 
 - "Andr\xC3\xA9 Arko"
@@ -35,6 +35,21 @@ dependencies:
         version: "3.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id002
 description: Adds footnotes to each page in your Rails app, containing useful development information as well as links to edit the controllers and views in your editor.
 email: andre@arko.net
 executables: []
@@ -57,7 +72,6 @@ files:
 - lib/rails-footnotes/notes/env_note.rb
 - lib/rails-footnotes/notes/files_note.rb
 - lib/rails-footnotes/notes/filters_note.rb
-- lib/rails-footnotes/notes/general_note.rb
 - lib/rails-footnotes/notes/javascripts_note.rb
 - lib/rails-footnotes/notes/layout_note.rb
 - lib/rails-footnotes/notes/log_note.rb

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

@@ -1,19 +0,0 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
-module Footnotes
-  module Notes
-    class GeneralNote < AbstractNote
-      def title
-        'General Debug'
-      end
-
-      def legend
-        'General (id="general_debug_info")'
-      end
-
-      def content
-        'You can use this tab to debug other parts of your application, for example Javascript.'
-      end
-    end
-  end
-end