rails-footnotes 3.6.6 → 3.6.7

data/CHANGELOG

@@ -1,3 +1,13 @@
+== Footnotes v3.6.7
+  * fixed log_note error - long overdue (thanks to many including Moritz Heidkamp)
+  * 1.9: ignore more assigns (thanks to justin case)
+  * 1.9 fixed test mocking (thanks to lsylvester)
+  * sort notes includes (thanks Alexey Smolianiov)
+  * handle controller paths in gems / others (thanks ubilabs)
+  * more graceful fallback when controller not found
+  * fixes for table entries being double encoded
+  * moved rpm exclude sql explain logic to config option
+
 == Footnotes v3.6.6
   * fix for ruby 1.9 compat (thanks to ivanoats)
   * fix for log note (thanks to tobias)

data/README

@@ -1,6 +1,6 @@
 Rails Footnotes
 License: MIT
-Version: 3.6.4
+Version: 3.6.7
 
 You can also read this README in pretty html at the GitHub project Wiki page
 
@@ -58,14 +58,20 @@ Another option is to allow multiple notes to be opened at the same time:
 
   Footnotes::Filter.multiple_notes = true
 
+If you have New Relic RPM installed, you may want to turn off query explains
+(explains can slows things down)
+
+  Footnotes::Notes::QueriesNote.sql_explain = false
+
+If you want to add alternate logic to enable or disable footnotes,
+add something like this to environment.rb:
+
+  ENABLE_RAILS_FOOTNOTES=(Rails.env.production? == false)
+
 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
 -----------------------
@@ -128,13 +134,18 @@ Colaborators
 Bugs and Feedback
 -----------------
 
-If you discover any bugs, please send an e-mail to jose@plataformatec.com.br
+If you discover any bugs, please send an e-mail to keenan@thebrocks.net
 If you just want to give some positive feedback or drop a line, that's fine too!
 
+
+Version 3.x
+-----------
+
+This plugin was maintained until version 3.6 by José Valim
+
 Copyright (c) 2009 José Valim (jose@plataformatec.com.br)
 http://blog.plataformatec.com.br/
 
-
 Version 2.0
 -----------
 

data/Rakefile

@@ -6,19 +6,19 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "rails-footnotes"
-    s.version = "3.6.6"
+    s.version = "3.6.7"
     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"
+    s.email = "keenan@thebrocks.net"
     s.homepage = "http://github.com/josevalim/rails-footnotes"
     s.description = "Every Rails page has footnotes that gives information about your application and links back to your editor."
-    s.authors = ['José Valim']
+    s.authors = ['Keenan Brock']
     s.files =  FileList["[A-Z]*", "{lib}/**/*"]
   end
 
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
 end
 
 desc 'Run tests for Footnotes.'

data/lib/rails-footnotes.rb

@@ -1,11 +1,14 @@
-if RAILS_ENV == 'development'
+unless defined?(ENABLE_RAILS_FOOTNOTES)
+  ENABLE_RAILS_FOOTNOTES=(RAILS_ENV == 'development')
+end
+if ENABLE_RAILS_FOOTNOTES
   dir = File.dirname(__FILE__)
   require File.join(dir, 'rails-footnotes', 'footnotes')
   require File.join(dir, 'rails-footnotes', 'backtracer')
 
   # Load all notes
   #
-  Dir[File.join(dir, 'rails-footnotes', 'notes', '*.rb')].each do |note|
+  Dir[File.join(dir, 'rails-footnotes', 'notes', '*.rb')].sort.each do |note|
     require note
   end
 
@@ -17,4 +20,4 @@ if RAILS_ENV == 'development'
     prepend_before_filter Footnotes::Filter
     after_filter Footnotes::Filter
   end
-end
+end

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

@@ -145,7 +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 == ""}}
+#          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

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

@@ -3,7 +3,20 @@ 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 )
+      @@ignored_assigns = [
+                            :@real_format,
+                            :@before_filter_chain_aborted,
+                            :@performed_redirect,
+                            :@performed_render,
+                            :@_params,
+                            :@_response,
+                            :@url,
+                            :@template,
+                            :@_request,
+                            :@db_rt_before_render,
+                            :@db_rt_after_render,
+                            :@view_runtime
+                          ]
       cattr_accessor :ignored_assigns, :instance_writter => false
 
       def initialize(controller)
@@ -21,7 +34,7 @@ module Footnotes
       def content
         rows = []
         assigns.each do |key|
-          rows << [ key, assigned_value(key) ]
+          rows << [ key, escape(assigned_value(key)) ]
         end
         mount_table(rows.unshift(['Name', 'Value']), :class => 'name_values', :summary => "Debug information for #{title}")
       end
@@ -29,11 +42,14 @@ module Footnotes
       protected
 
         def assigns
-          return @assigns if @assigns
-
-          @assigns = @controller.instance_variables
-          @assigns -= @controller.protected_instance_variables if @controller.respond_to? :protected_instance_variables
-          @assigns -= ignored_assigns
+          assign = []
+          ignored = @@ignored_assigns
+          
+          @controller.instance_variables.each {|x| assign << x.intern }
+          @controller.protected_instance_variables.each {|x| ignored << x.intern } if @controller.respond_to? :protected_instance_variables
+           
+          assign -= ignored            
+          return assign
         end
 
         def assigned_value(key)

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

@@ -12,7 +12,9 @@ module Footnotes
       end
 
       def link
-        escape(Footnotes::Filter.prefix(controller_filename, controller_line_number + 1, 3))
+        if controller_filename && controller_line_number
+          escape(Footnotes::Filter.prefix(controller_filename, controller_line_number + 1, 3))
+        end
       end
 
       def valid?
@@ -23,29 +25,34 @@ module Footnotes
         # Some controller classes come with the Controller:: module and some don't
         # (anyone know why? -- Duane)
         def controller_filename
+          return @controller_filename if defined?(@controller_filename)
           controller_name=@controller.class.to_s.underscore
           controller_name='application' if controller_name=='application_controller'
           if ActionController::Routing.respond_to? :controller_paths
+            @controller_filename=nil
             ActionController::Routing.controller_paths.each do |controller_path|
               full_controller_path = File.join(File.expand_path(controller_path), "#{controller_name}.rb")
-              return full_controller_path if File.exists?(full_controller_path)
+              @controller_filename=full_controller_path if File.exists?(full_controller_path)
             end
-            raise "File not found"
+            #raise "File not found"
           else
-            File.join(File.expand_path(RAILS_ROOT), 'app', 'controllers', "#{controller_name}.rb").sub('/controllers/controllers/', '/controllers/')
+            @controller_filename=File.join(File.expand_path(RAILS_ROOT), 'app', 'controllers', "#{controller_name}.rb").sub('/controllers/controllers/', '/controllers/')
           end
+          @controller_filename
         end
 
         def controller_text
-          @controller_text ||= IO.read(controller_filename)
+          if controller_filename
+            @controller_text ||= IO.read(controller_filename)
+          end
         end
 
         def action_index
-          (controller_text =~ /def\s+#{@controller.action_name}[\s\(]/)
+          (controller_text =~ /def\s+#{@controller.action_name}[\s\(]/) if controller_text
         end
 
         def controller_line_number
-          lines_from_index(controller_text, action_index) || 0
+          lines_from_index(controller_text, action_index) || 0 if controller_text
         end
 
         def lines_from_index(string, index)

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

@@ -1,3 +1,5 @@
+require "#{File.dirname(__FILE__)}/log_note"
+
 module Footnotes
   module Notes
     class PartialsNote < LogNote
@@ -12,11 +14,12 @@ module Footnotes
         "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>"
+        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]]
         end
-        "<table><thead><tr><th>Partial</th><th>Time</th><th>Count</th></tr></thead><tbody>#{links.join}</tbody></table>"
+        mount_table(rows.unshift(%w(Partial Time Count)), :summary => "Partials for #{title}")
       end
 
       protected
@@ -31,14 +34,17 @@ module Footnotes
             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)
+                @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

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

@@ -9,7 +9,7 @@ module Footnotes
       @@include_when_new_relic_installed = false
       @@loaded = false
       
-      cattr_accessor :sql, :alert_db_time, :alert_sql_number, :alert_explain, :loaded, :instance_writter => false
+      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)
@@ -67,11 +67,7 @@ module Footnotes
       
       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)
+        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$/
@@ -159,7 +155,7 @@ module Footnotes
           type = $&.downcase.to_sym
           explain = nil
 
-          if adapter_name == 'MySQL' && type == :select
+          if adapter_name == 'MySQL' && type == :select && Footnotes::Notes::QueriesNote.sql_explain
             log_silence do
               explain = execute_without_analyzer("EXPLAIN #{query}", name)
             end

data/test/footnotes_test.rb

@@ -16,6 +16,7 @@ end
 class FootnotesTest < Test::Unit::TestCase
   def setup
     @controller = FootnotesController.new
+    @controller.template = Object.new
     @controller.request = ActionController::TestRequest.new
     @controller.response = ActionController::TestResponse.new
     @controller.response.body = $html.dup

metadata

@@ -1,20 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: rails-footnotes
 version: !ruby/object:Gem::Version 
-  version: 3.6.6
+  hash: 17
+  prerelease: false
+  segments: 
+  - 3
+  - 6
+  - 7
+  version: 3.6.7
 platform: ruby
 authors: 
-- "Jos\xC3\xA9 Valim"
+- Keenan Brock
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-31 00:00:00 -05:00
+date: 2010-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: Every Rails page has footnotes that gives information about your application and links back to your editor.
-email: jose@plataformatec.com.br
+email: keenan@thebrocks.net
 executables: []
 
 extensions: []
@@ -48,6 +54,9 @@ files:
 - lib/rails-footnotes/notes/session_note.rb
 - lib/rails-footnotes/notes/stylesheets_note.rb
 - lib/rails-footnotes/notes/view_note.rb
+- test/footnotes_test.rb
+- test/notes/abstract_note_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/josevalim/rails-footnotes
 licenses: []
@@ -58,21 +67,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rails-footnotes
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Every Rails page has footnotes that gives information about your application and links back to your editor.