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

data/CHANGELOG

@@ -1,3 +1,8 @@
+== Footnotes v4.0.0.pre.4 (April 2, 2011)
+  * fix event[:duration] to event.duration in query note
+  * fix layout note to work again
+  * rename views note to render note since it lists renders
+
 == Footnotes v4.0.0.pre.3 (March 30, 2011)
   * Merge in contributions from irjudson and jackkinsella
   * fixes for partials note

data/lib/rails-footnotes.rb

@@ -5,11 +5,15 @@ module Footnotes
       if ::Rails.env.development?
         require 'rails-footnotes/footnotes'
         require 'rails-footnotes/backtracer'
+        require 'rails-footnotes/view_subscriber'
 
         # Require each individual note
         notes_glob = File.expand_path("../rails-footnotes/notes/*.rb", __FILE__)
         Dir[notes_glob].each{|note| require note }
 
+        # Subscribe to view events so we can use them later
+        ActiveSupport::LogSubscriber.attach_to(:action_view, Footnotes.view_subscriber)
+
         # The footnotes are applied by default to all actions. To remove the
         # footnotes from an action, use skip_filter in your controller.
         ActionController::Base.prepend_before_filter Footnotes::BeforeFilter

data/lib/rails-footnotes/footnotes.rb

@@ -25,9 +25,9 @@ module Footnotes
     @@prefix = 'txmt://open?url=file://%s&line=%d&column=%d'.html_safe
 
     # Edit notes
-    @@notes = [ :controller, :view, :layout, :partials, :stylesheets, :javascripts ]
+    @@notes = [ :controller, :layout, :partials, :stylesheets, :javascripts ]
     # Show notes
-    @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log ]
+    @@notes += [ :render, :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log ]
 
     # Change queries for rpm note when available
     # if defined?(NewRelic)

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

@@ -3,9 +3,6 @@ require "#{File.dirname(__FILE__)}/abstract_note"
 module Footnotes
   module Notes
     class LayoutNote < AbstractNote
-      def initialize(controller)
-        @controller = controller
-      end
 
       def row
         :edit
@@ -16,13 +13,14 @@ module Footnotes
       end
 
       def valid?
-        prefix? && nil#@controller.active_layout TODO doesn't work with Rails 3
+        prefix? && filename
+      end
+
+    protected
+      def filename
+        Dir[Footnotes.view_subscriber.layout.to_s+".html*"].first
       end
 
-      protected
-        def filename
-          File.join(File.expand_path(Rails.root), 'app', 'layouts', "#{@controller.active_layout.to_s.underscore}").sub('/layouts/layouts/', '/views/layouts/')
-        end
     end
   end
 end

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

@@ -3,19 +3,12 @@ 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
@@ -27,8 +20,8 @@ module Footnotes
       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]]
+          name = filename.gsub(Rails.root.join("app/views/"),"")
+          [%{<a href="#{href}">#{name}</a>},"#{@partial_times[filename].sum}ms", @partial_counts[filename]]
         end
         mount_table(rows.unshift(%w(Partial Time Count)), :summary => "Partials for #{title}")
       end
@@ -37,7 +30,7 @@ module Footnotes
         self.loaded = true unless loaded
       end
 
-      protected
+    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
@@ -45,7 +38,7 @@ module Footnotes
           partials = []
           @partial_counts = {}
           @partial_times = {}
-          @@partial_subscriber.events.each do |event|
+          Footnotes.view_subscriber.partials.each do |event|
             partial = event.payload[:identifier]
             @partial_times[partial] ||= []
             @partial_times[partial] << event.duration
@@ -56,17 +49,7 @@ module Footnotes
           partials.reverse
         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

@@ -31,7 +31,7 @@ module Footnotes
 
       def title
         queries = @@query_subscriber.events.length
-        total_time = @@query_subscriber.events.inject(0){|sum, item| sum += item.payload[:duration]} / 1000.0
+        total_time = @@query_subscriber.events.map{|e| e.duration }.sum / 1000.0
         query_color = generate_red_color(@@query_subscriber.events.length, alert_sql_number)
         db_color    = generate_red_color(total_time, alert_db_time)
 
@@ -55,7 +55,7 @@ module Footnotes
 
         @@query_subscriber.events.each_with_index do |item, i|
           html << <<-HTML
-          #{print_name_and_time(item.payload[:name], item.payload[:duration] / 1000.0)}&nbsp;
+          #{print_name_and_time(item.payload[:name], item.duration / 1000.0)}&nbsp;
           <span id="explain_#{i}">#{print_query(item.payload[:sql])}</span><br />
           HTML
         end

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

@@ -0,0 +1,40 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+require "#{File.dirname(__FILE__)}/../view_subscriber"
+
+module Footnotes
+  module Notes
+    class RenderNote < AbstractNote
+
+      def initialize(controller)
+        super
+        @controller = controller
+        @page = Footnotes.view_subscriber.page
+      end
+
+      def title
+        "<span style=\"background-color:#{color(@page.duration)}\">Rendered (#{"%.3f" % @page.duration}ms)</span>"
+      end
+
+      def content
+        html = ''
+
+        if @page
+          view = Footnotes.view_subscriber.view_name
+          layout = Footnotes.view_subscriber.layout_name
+          partial_time = Footnotes.view_subscriber.partial_time
+
+          rows = [["View", "Layout", "View Render", "Partial Render", "Total Render"],
+                  [escape(view), escape(layout), "#{'%.3f' % (@page.duration - partial_time)}ms",
+                   "<a href=\"#\" onclick=\"Footnotes.hideAllAndToggle('partials_debug_info');return false;\">#{'%.3f' % partial_time}ms</a>",
+                   "#{'%.3f' % @page.duration}ms"]]
+          mount_table(rows)
+        end
+      end
+
+      def color(value)
+        value > 500.0 ? "#f00" : "#aaa"
+      end
+
+    end
+  end
+end

data/lib/rails-footnotes/version.rb

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

data/lib/rails-footnotes/view_subscriber.rb

@@ -0,0 +1,48 @@
+# Class that can subscribe to and log any view events
+module Footnotes
+  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
+
+    def partials
+      events.select{ |e| e.name =~ /render_partial/ }
+    end
+
+    def partial_time
+      partials.map{|p| p.duration }.sum
+    end
+
+    def page
+      events.find{ |e| e.name =~ /render_template/ }
+    end
+
+    def view
+      page && page.payload[:identifier]
+    end
+
+    def view_name
+      view && view.gsub(Rails.root.join("app/views/"),'')
+    end
+
+    def layout
+      page && Rails.root.join("app/views", page.payload[:layout])
+    end
+
+    def layout_name
+      page && page.payload[:layout]
+    end
+  end
+
+  def self.view_subscriber
+    @view_subscriber ||= ViewSubscriber.new
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rails3-footnotes
 version: !ruby/object:Gem::Version 
-  hash: 1923831855
+  hash: 1923831841
   prerelease: true
   segments: 
   - 4
   - 0
   - 0
   - pre
-  - 3
-  version: 4.0.0.pre.3
+  - 4
+  version: 4.0.0.pre.4
 platform: ruby
 authors: 
 - "Andr\xC3\xA9 Arko"
@@ -78,12 +78,13 @@ files:
 - 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/render_note.rb
 - lib/rails-footnotes/notes/routes_note.rb
 - lib/rails-footnotes/notes/rpm_note.rb
 - lib/rails-footnotes/notes/session_note.rb
 - lib/rails-footnotes/notes/stylesheets_note.rb
-- lib/rails-footnotes/notes/view_note.rb
 - lib/rails-footnotes/version.rb
+- lib/rails-footnotes/view_subscriber.rb
 - lib/rails-footnotes.rb
 - lib/rails3-footnotes.rb
 - test/footnotes_test.rb

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

@@ -1,75 +0,0 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
-module Footnotes
-  module Notes
-    class ViewNote < AbstractNote
-        @@alert_time = 500.0
-        @@loaded = false
-        @@view_subscriber = nil
-
-        def initialize(controller)
-          super
-          @controller = controller
-        end
-
-        def self.start!(controller)
-          @@view_subscriber = Footnotes::Notes::ViewSubscriber.new
-          ActiveSupport::LogSubscriber.attach_to(:action_view, @@view_subscriber)
-        end
-
-        def self.to_sym
-          :views
-        end
-
-        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 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/"),"")
-
-          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