@@ -1,13 +1,20 @@ -== Textmate Footnotes v3.1 - * Added MySQL Query Analyzer - * Code refactoring (using modules, except backtracer) - * Ability to cherry pick notes - * Working on Rails 2.1 - -== Textmate Footnotes v3.0 +TODO: + * Use YAML files to load configuration files + * Create a profiler tab + +== Footnotes v3.2 Author: José Valim (jose.valim@gmail.com) Site: http://www.pagestacker.com/ -Description: + * Added numbers to tabs; + * Added Queries note; + * Added MySQL Query Analyzer. + +== Footnotes v3.1 + * Code refactoring (using modules, except backtracer); + * Ability to cherry pick notes; + * Working on Rails 2.1. + +== Footnotes v3.0 * Some code refactoring; * Stylesheets bug fixed: was showing not only css in Stylesheets div; * Logtail fix: working with Rails 2.0 logger and in all OS, since it's Regexp based; @@ -17,8 +24,8 @@ Description: == Textmate Footnotes v2.0 Copyright (c) 2006 InquiryLabs, Inc. -Site: http://inquirylabs.com/ Author: Duane Johnson (duane.johnson@gmail.com) +Site: http://inquirylabs.com/ Description: Creates clickable footnotes on each rendered page, as well as clickable links in the backtrace should an error occur in your Rails app. Links take CHANGELOG @@ -33,7 +33,7 @@ # In Footnotes 3.1, you also have the ability to cherry pick which notes do you # want to use, simply doing: # -# Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :log, :general] +# Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :queries, :log, :general] # if (ENV['RAILS_ENV'] == 'development') # Windows doesn't have 'uname', so rescue false init.rb @@ -1,49 +1,56 @@ module Footnotes module QueryAnalyzer - def self.columnized_row(fields, sized) - row = [] - fields.each_with_index do |f, i| - row << sprintf("%0-#{sized[i]}s", f.to_s) - end - row.join(' | ') - end - - def self.columnized(array) - sized = {} - array.each do |row| - row.values.each_with_index do |value, i| - sized[i] = [sized[i].to_i, row.keys[i].length, value.to_s.length].max - end - end - + def self.parse_explain(results) table = [] - table << columnized_row(array.first.keys, sized) - table << '-' * table.first.length - array.each { |row| table << columnized_row(row.values, sized) } - table.join("\n ") # Spaces added to work with format_log_entry + table << results.fetch_fields.map(&:name) + results.each{|row| table << row} + table end - + def self.included(base) base.class_eval do - alias_method :select_without_analyzer, :select - alias_method :select, :select_with_analyzer + alias_method_chain :execute, :analyzer end end - private - def select_with_analyzer(sql, name = nil) - query_results = select_without_analyzer(sql, name) + def execute_with_analyzer(sql, name = nil) + query_results = nil + time = Benchmark.realtime { query_results = execute_without_analyzer(sql, name) } + + if sql =~ /^(select)|(create)|(update)|(delete)\b/i + operation = $&.downcase.to_sym + explain = nil - if @logger && @logger.level <= Logger::INFO - @logger.debug( - @logger.silence do - "\nAnalyzing #{name}\n #{Footnotes::QueryAnalyzer.columnized(select_without_analyzer("explain #{sql}", name))}\n\n" + if adapter_name == 'MySQL' && operation == :select + log_silence do + explain = execute_without_analyzer("explain #{sql}", name) end - ) if sql =~ /^select/i - end + explain = Footnotes::QueryAnalyzer.parse_explain(explain) + end + Footnotes::Filter.sql << [operation, name, time, sql, explain] + end + query_results end end + + module AbstractAdapter + def log_silence + result = nil + if @logger + @logger.silence do + result = yield + end + else + result = yield + end + result + end + end end -ActiveRecord::ConnectionAdapters::MysqlAdapter.send :include, Footnotes::QueryAnalyzer \ No newline at end of file +ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Footnotes::AbstractAdapter +ActiveRecord::ConnectionAdapters.local_constants.each do |adapter| + next unless adapter =~ /.*[^Abstract]Adapter$/ + eval("ActiveRecord::ConnectionAdapters::#{adapter}").send :include, Footnotes::QueryAnalyzer +end \ No newline at end of file lib/textmate_analyzer.rb @@ -2,17 +2,19 @@ require 'ostruct' module Footnotes class Filter - cattr_accessor :no_style, :notes + cattr_accessor :no_style, :notes, :sql self.no_style = false - self.notes = [:session, :cookies, :params, :filters, :routes, :log, :general] + self.notes = [:session, :cookies, :params, :filters, :routes, :queries, :log, :general] + self.sql = [] # # Controller methods # def self.filter(controller) filter = Footnotes::Filter.new(controller) - filter.add_footnotes! + filter.add_footnotes! + filter.reset! end def initialize(controller) @@ -20,6 +22,7 @@ module Footnotes @template = controller.instance_variable_get('@template') @body = controller.response.body @extra_html = '' + @script = '' end def add_footnotes! @@ -45,28 +48,48 @@ module Footnotes def content_type @controller.response.headers['Content-Type'] end + + def reset! + self.sql = [] + end # # Fieldset methods # def session_debug_info - escape(@controller.session.instance_variable_get("@data").inspect) + sessions = @controller.session.instance_variable_get("@data").symbolize_keys + [escape(sessions.inspect), sessions.length] end def cookies_debug_info - escape(@controller.send(:cookies).inspect) + cookies = @controller.send(:cookies).symbolize_keys + [escape(cookies.inspect), cookies.length] end def params_debug_info - escape(@controller.params.inspect) + params = @controller.params.symbolize_keys + [escape(params.inspect), params.length] end def filters_debug_info - "<pre>#{mount_table(parsed_filters, :name, :type, :actions)}</pre>" + filters = parsed_filters.unshift([:name, :type, :actions]) + ["<pre>#{mount_table(filters)}</pre>", filters.length] end def routes_debug_info - "<pre>#{mount_table(parsed_routes, :path, :name, :options, :requirements)}</pre>" + routes = parsed_routes.unshift([:path, :name, :options, :requirements]) + ["<pre>#{mount_table(routes)}</pre>", routes.length] + end + + def queries_debug_info + html = '' + self.sql.collect do |item| + html << "<b>#{item[0].to_s.upcase}</b>\n" + html << "#{item[1] || 'SQL'} (#{sprintf('%f',item[2])}s)\n" + html << "#{item[3].gsub(/(\s)+/,' ').gsub('`','')}\n" + html << mount_table(item[4]) + end + ["<pre>#{html}</pre>", self.sql.length] end def log_debug_info @@ -97,17 +120,15 @@ module Footnotes # Gets a bidimensional array with the labels of the "second" array (columns) # - def mount_table(array, *args) - return '' if args.empty? - header = '<tr><th>' + args.collect{|i| escape(i.to_s.titlecase) }.join('</th><th>') + '</th></tr>' + def mount_table(array) + return '' if array.empty? + header = '<tr><th>' + array.shift.collect{|i| escape(i.to_s.humanize) }.join('</th><th>') + '</th></tr>' lines = array.collect{|i| "<tr><td>#{i.join('</td><td>')}</td></tr>" }.join <<-TABLE <table> <thead>#{header}</thead> - <tbody style="text-align:left;"> - #{lines} - </tbody> + <tbody>#{lines}</tbody> </table> TABLE end @@ -158,9 +179,9 @@ module Footnotes <div id="tm_footnotes_debug"> #{textmate_links if Footnotes::Filter.textmate_prefix} Show: - #{footnotes_links} + #{footnotes_content} #{@extra_html} - #{footnotes_fieldsets} + <script type="text/javascript">function untoogle(){#{@script}}</script> </div> <!-- End Footnotes --> HTML @@ -173,59 +194,76 @@ module Footnotes end end - # Defines the title for each fieldset + # Generates footnotes script, links and content # - def footnotes_titles - return { - :session => "Session", - :cookies => "Cookies", - :params => "Parameters", - :filters => "Filter chain for #{@controller.class.to_s}", - :routes => "Routes for #{@controller.class.to_s}", - :log => "Log", - :general => "General (id=\"tm_debug\")" + def footnotes_content + links = [] + content = '' + + self.notes.each{ |section| + next unless footnotes_info.key?(section) + + # Call the method with the results + result, total = eval("#{section.to_s}_debug_info") + links << footnote_link(section, total) + content << footnote_fieldset(section, result) } + + "#{links.join(" | \n")}#{content}" end - # Generates links based on specified tabs + # Defines the title and link names for each note # - def footnotes_links - self.notes.collect{ |section| - next unless footnotes_titles.key?(section) - section_name = section.to_s - "<a href=\"#\" onclick=\"#{footnotes_toggle(section_name+'_debug_info')};return false\">#{section_name.titleize}</a>" - }.join(" | \n") + def footnotes_info + return { + :session => { :title => "Session", :link => "Session" }, + :cookies => { :title => "Cookies", :link => "Cookies (%d)" }, + :params => { :title => "Parameters", :link => "Params (%d)" }, + :filters => { :title => "Filter chain for #{@controller.class.to_s}", :link => "Filters" }, + :routes => { :title => "Routes for #{@controller.class.to_s}", :link => "Routes" }, + :queries => { :title => "Queries", :link => "Queries (%d)" }, + :log => { :title => "Log", :link => "Log" }, + :general => { :title => "General (id=\"tm_debug\")", :link => "General Debug" }, + :javascripts => { :title => "Javascripts", :link => "Javascripts (%d)" }, + :stylesheets => { :title => "Stylesheets", :link => "Stylesheets (%d)" } + } end - # Generates fieldsets based on specified tabs + # Generate script that close notes when another is select # - def footnotes_fieldsets - self.notes.collect{ |section| - next unless footnotes_titles.key?(section) - section_name = section.to_s - <<-HTML - <fieldset id="#{section_name}_debug_info" class="tm_footnotes_debug_info" style="display: none"> - <legend>#{footnotes_titles[section]}</legend> - <code>#{eval(section_name+'_debug_info')}</code> - </fieldset> - HTML - } + def footnote_script(section) + @script << "document.getElementById('#{section.to_s}_debug_info').style.display = 'none'\n" end - def footnotes_toggle(id) - "s = document.getElementById('#{id}').style; if(s.display == 'none') { s.display = '' } else { s.display = 'none' }" + def footnote_link(section, value = 0) + footnote_script(section) + name = section.to_s + "<a href=\"#\" onclick=\"untoogle();document.getElementById('#{name}_debug_info').style.display = 'block';location.href ='##{name}_debug_info';return false;\">#{(footnotes_info[section][:link] % value).humanize}</a>" + end + + def footnote_fieldset(section, value) + name = section.to_s + <<-HTML + <fieldset id="#{name}_debug_info" class="tm_footnotes_debug_info" style="display: none"> + <legend>#{footnotes_info[section][:title]}</legend> + <code>#{value}</code> + </fieldset> + HTML end def insert_styles insert_text :before, /<\/head>/i, <<-HTML <!-- Footnotes Style --> <style type="text/css"> - #tm_footnotes_debug {margin: 2em 0 1em 0; text-align: center; color: #777;} - #tm_footnotes_debug a {text-decoration: none; color: #777;} + #tm_footnotes_debug {margin: 2em 0 1em 0; text-align: center; color: #444; line-height: 16px;} + #tm_footnotes_debug a {text-decoration: none; color: #444;} #tm_footnotes_debug pre {overflow: scroll; margin: 0;} - #tm_footnotes_debug table td {padding: 0 4px;} + #tm_footnotes_debug thead {text-align: center;} + #tm_footnotes_debug table td {padding: 0 5px;} + #tm_footnotes_debug tbody {text-align: left;} #tm_footnotes_debug legend, #tm_footnotes_debug fieldset {background-color: #FFF;} - fieldset.tm_footnotes_debug_info {text-align: left; border: 1px dashed #aaa; padding: 0.5em 1em 1em 1em; margin: 1em 2em 1em 2em; color: #777;} + #queries_debug_info thead, #queries_debug_info tbody {text-align: center; color:#FF0000;} + fieldset.tm_footnotes_debug_info {text-align: left; border: 1px dashed #aaa; padding: 0.5em 1em 1em 1em; margin: 1em 2em 1em 2em; color: #444;} </style> <!-- End Footnotes Style --> HTML lib/textmate_footnotes.rb @@ -75,13 +75,13 @@ module Footnotes <a href="#{view_url}">View</a> | <a href="#{layout_url}">Layout</a> HTML - html += asset_file_links('Stylesheets', stylesheet_files) unless stylesheet_files.blank? - html += asset_file_links('Javascripts', javascript_files) unless javascript_files.blank? + html += asset_file_links(:stylesheets, stylesheet_files) unless stylesheet_files.blank? + html += asset_file_links(:javascripts, javascript_files) unless javascript_files.blank? html += '<br/>' return html end - def asset_file_links(link_text, files) + def asset_file_links(link_sym, files) return '' if files.size == 0 links = files.map do |filename| if filename =~ %r{^/} @@ -91,14 +91,10 @@ module Footnotes %{<a href="#{filename}">#{filename}</a>} end end - @extra_html << <<-HTML - <fieldset id="tm_footnotes_#{link_text.underscore.gsub(' ', '_')}" class="tm_footnotes_debug_info" style="display: none"> - <legend>#{link_text}</legend> - <ul><li>#{links.join("</li><li>")}</li></ul> - </fieldset> - HTML + @extra_html << footnote_fieldset(link_sym, "<ul><li>#{links.join("</li><li>")}</li></ul>") + # Return the link that will open the 'extra html' div - %{ | <a href="#" onclick="#{footnotes_toggle('tm_footnotes_' + link_text.underscore.gsub(' ', '_') )}; return false">#{link_text}</a>} + " | #{footnote_link(link_sym, links.length)}" end def lines_from_index(string, index) lib/textmate_links.rb 014b1736b8572ec313c3135a68f49b31b2324a84 josevalim jose.valim@gmail.com http://github.com/josevalim/rails-footnotes/commit/14dc5d1b2433fed070e6c10fdd652fa2f8df84ee 14dc5d1b2433fed070e6c10fdd652fa2f8df84ee 2008-06-04T11:47:23-07:00 2008-06-04T11:47:23-07:00 Added Queries notes, numbers and click in one note automatically close the others d046158e47c039c1dd8dadbad451ce5c6d07b99b josevalim jose.valim@gmail.com