Adding very basic logging, sql, templates panels

Author: brynary

.gitignore

@@ -1 +1,2 @@
 coverage
+pkg

History.txt

@@ -1,4 +1,6 @@
 require "rubygems"
+require "rake/gempackagetask"
+require "rake/clean"
 require "spec/rake/spectask"
 require File.expand_path("./lib/rack/bug")
 
@@ -18,3 +20,27 @@ Spec::Rake::SpecTask.new(:rcov) do |t|
   end
 end
 
+spec = Gem::Specification.new do |s|
+  s.name         = "rack-bug"
+  s.version      = Rack::Bug::VERSION
+  s.author       = "Bryan Helmkamp"
+  s.email        = "bryan" + "@" + "brynary.com"
+  s.homepage     = "http://github.com/brynary/rack-bug"
+  s.summary      = "Debugging toolbar for Rack applications implemented as middleware"
+  s.description  = s.summary
+  s.files        = %w[History.txt Rakefile README.rdoc] + Dir["lib/**/*"]
+  
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+  package.gem_spec = spec
+end
+
+desc 'Install the package as a gem.'
+task :install => [:clean, :package] do
+  gem = Dir['pkg/*.gem'].first
+  sh "sudo gem install --no-rdoc --no-ri --local #{gem}"
+end

MIT-LICENSE.txt

@@ -7,10 +7,15 @@
 require "rack/bug/toolbar"
 require "rack/bug/panels/timer_panel"
 require "rack/bug/panels/env_panel"
+require "rack/bug/panels/sql_panel"
+require "rack/bug/panels/log_panel"
+require "rack/bug/panels/templates_panel"
 
 module Rack
   module Bug
 
+    VERSION = "0.1.0"
+    
     class Middleware
 
       def initialize(app)

README README.rdoc

@@ -19,6 +19,10 @@ def call(env)
         return [status, headers, body]
       end
 
+      def has_content?
+        true
+      end
+      
       def before(env)
       end
 

Rakefile

@@ -0,0 +1,51 @@
+if defined?(Rails) && Rails.logger
+  module LoggingExtensions
+    def add(*args, &block)
+      logged_message = super
+      Rack::Bug::LogPanel.record(logged_message)
+      return logged_message
+    end
+  end
+
+  Rails.logger.extend LoggingExtensions
+end
+
+module Rack
+  module Bug
+    
+    class LogPanel < Panel
+      
+      def self.record(message)
+        return unless message
+        Thread.current["rack.bug.logs"] ||= []
+        Thread.current["rack.bug.logs"] << message
+      end
+      
+      def self.reset
+        Thread.current["rack.bug.logs"] = []
+      end
+      
+      def self.logs
+        Thread.current["rack.bug.logs"] || []
+      end
+      
+      def name
+        "log"
+      end
+      
+      def heading
+        "Log"
+      end
+
+      def content
+        @logs = self.class.logs
+        @template = ERB.new ::File.read(::File.dirname(__FILE__) + "/../views/panels/log.html.erb")
+        result = @template.result(binding)
+        self.class.reset
+        return result
+      end
+      
+    end
+    
+  end
+end

lib/rack/bug.rb

@@ -0,0 +1,64 @@
+if defined?(ActiveRecord)
+  ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+    def log_with_rack_bug(sql, name, &block)
+      start_time = Time.now
+      result = log_without_rack_bug(sql, name, &block)
+      Rack::Bug::SQLPanel.record_query(sql, Time.now - start_time)
+      return result
+    end
+    
+    alias_method_chain :log, :rack_bug
+  end
+end
+
+module Rack
+  module Bug
+    
+    class SQLPanel < Panel
+      
+      class Query
+        attr_reader :sql
+        
+        def initialize(sql, time)
+          @sql = sql
+          @time = time
+        end
+        
+        def time
+          "%.1fms" % (@time * 1_000)
+        end
+      end
+      
+      def self.record_query(sql, time)
+        Thread.current["queries"] ||= []
+        Thread.current["queries"] << Query.new(sql, time)
+      end
+      
+      def self.reset_queries
+        Thread.current["queries"] = []
+      end
+      
+      def self.queries
+        Thread.current["queries"] || []
+      end
+      
+      def name
+        "sql"
+      end
+      
+      def heading
+        "SQL"
+      end
+
+      def content
+        @queries = self.class.queries
+        @template = ERB.new ::File.read(::File.dirname(__FILE__) + "/../views/panels/sql.html.erb")
+        result = @template.result(binding)
+        self.class.reset_queries
+        return result
+      end
+      
+    end
+    
+  end
+end

lib/rack/bug/panel.rb

@@ -0,0 +1,51 @@
+if defined?(ActionView) && defined?(ActionView::Template)
+  ActionView::Template.class_eval do
+
+    def render_template_with_rack_test(*args, &block)
+      result = render_template_without_rack_test(*args, &block)
+      Rack::Bug::TemplatesPanel.record(path_without_format_and_extension)
+      return result
+    end
+
+    alias_method_chain :render_template, :rack_test
+  end
+end
+
+module Rack
+  module Bug
+    
+    class TemplatesPanel < Panel
+      
+      def self.record(template)
+        Thread.current["rack.bug.templates"] ||= []
+        Thread.current["rack.bug.templates"] << template
+      end
+      
+      def self.reset
+        Thread.current["rack.bug.templates"] = []
+      end
+      
+      def self.templates
+        Thread.current["rack.bug.templates"] || []
+      end
+      
+      def name
+        "templates"
+      end
+      
+      def heading
+        "Templates"
+      end
+
+      def content
+        @templates = self.class.templates
+        @template = ERB.new ::File.read(::File.dirname(__FILE__) + "/../views/panels/templates.html.erb")
+        result = @template.result(binding)
+        self.class.reset
+        return result
+      end
+      
+    end
+    
+  end
+end

lib/rack/bug/panels/log_panel.rb

@@ -1,15 +1,71 @@
-jQuery(function() {
-  jQuery("#rack_bug ul.panels li a").click(function () {
-    current = $('#rack_bug #' + this.className);
-    
-    if (current.is(':visible')) {
-      $('.panelContent').hide();
-      current.hide();
-    } else {
-      $('.panelContent').hide();
-      current.show();
+// jQuery(function() {
+//   jQuery("#rack_bug ul.panels li a").click(function () {
+//     current = $('#rack_bug #' + this.className);
+//     
+//     if (current.is(':visible')) {
+//       $('.panelContent').hide();
+//       current.hide();
+//     } else {
+//       $('.panelContent').hide();
+//       current.show();
+//     }
+//     
+//     return false;
+//   });
+// });
+
+var _$ = window.$;
+jQuery.noConflict();
+jQuery(function($) {
+  $.rackBug = function(data, klass) {
+    $.rackBug.init();
+  }
+  $.extend($.rackBug, {
+    init: function() {
+      var current = null;
+      $('#rack_bug ul.panels li a').click(function() {
+        current = $('#rack_bug #' + this.className);
+        
+        if (current.is(':visible')) {
+          $(document).trigger('close.rackBug');
+        } else {
+          $('#rack_bug .panel_content').hide();
+          current.show();
+          $.rackBug.open();
+        }
+        return false;
+      });
+      $('#rack_bug a.close').click(function() {
+        $(document).trigger('close.rackBug');
+        return false;
+      });
+    },
+    open: function() {
+      $(document).bind('keydown.rackBug', function(e) {
+        if (e.keyCode == 27) {
+          $.rackBug.close();
+        }
+      });
+    },
+    toggle_content: function(elem) {
+      if (elem.is(':visible')) {
+        elem.hide();
+      } else {
+        elem.show();
+      }
+    },
+    close: function() {
+      $(document).trigger('close.rackBug');
+      return false;
     }
-    
-    return false;
   });
-});
+  $(document).bind('close.rackBug', function() {
+    $(document).unbind('keydown.rackBug');
+    $('.panel_content').hide();
+  });
+});
+
+jQuery(function() {
+  jQuery.rackBug();
+});
+$ = _$;

lib/rack/bug/panels/sql_panel.rb

@@ -28,7 +28,7 @@ def builder
       end
 
       def panel_classes
-        [TimerPanel, EnvPanel]
+        [TimerPanel, EnvPanel, SQLPanel, LogPanel, TemplatesPanel]
       end
 
       def inject_into(response)

lib/rack/bug/panels/templates_panel.rb

@@ -16,17 +16,24 @@
 
       <% @panels.each do |panel| %>
         <li>
-          <a href="#" class="<%= panel.name %>">
+          <% if panel.has_content? %>
+            <a href="#" class="<%= panel.name %>">
+              <%= panel.heading %>
+            </a>
+          <% else %>
             <%= panel.heading %>
-          </a>
+          <% end %>
         </li>
       <% end %>
     </ul>
   </div>
 
   <% @panels.each do |panel| %>
-    <div class="panel_content" id="<%= panel.name %>">
-      <%= panel.content %>
-    </div>
+    <% if panel.has_content? %>
+      <div class="panel_content" id="<%= panel.name %>">
+        <a href="" class="close">Close</a>
+        <%= panel.content %>
+      </div>
+    <% end %>
   <% end %>
 </div>

lib/rack/bug/public/__rack_bug__/bug.js

@@ -0,0 +1,23 @@
+<h3>Log Messages</h3>
+<table>
+  <thead>
+    <tr>
+      <th>Level</th>
+      <th>Time</th>
+      <th>Message</th>
+      <th>Location</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% i = 1 %>
+    <% @logs.each do |log| %>
+      <tr class="<%= i % 2 == 0 ? "even" : "odd" %>">
+        <td></td>
+        <td></td>
+        <td><%= log.gsub(/\e\[[;\d]+m/, "") %></td>
+        <td></td>
+      </tr>
+      <% i += 1 %>
+    <% end %>
+  </tbody>
+</table>