rack-insight 0.5.14 → 0.5.15

data/CHANGELOG

@@ -1,12 +1,13 @@
-== HEAD
+== 0.5.14 / 2012-09-11
 
   * New Features
 
     * Panel level configurations for :probes are now supported by default on all panels
     * Auto-magical panel names
-    * Auto-magical table creation (skipped with self.tableless = false in a Panel class definition)
+    * Auto-magical panel probe detection and storage
+    * Auto-magical panel content
+    * Auto-magical table creation (skipped with self.has_table = false in a Panel class definition)
     * Under construction, or blank, panels have more scaffolding
-    *
 
 == 0.5.13 / 2012-09-10
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-insight (0.5.13)
+    rack-insight (0.5.14)
       rack
       sqlite3 (>= 1.3.3)
       uuidtools (>= 2.1.2)

data/README.md

@@ -114,15 +114,17 @@ Options:
       Currently this is implemented in the log_panel, and configured as:
 
         Rack::Insight::Config.configure do |config|
-          config[:panel_configs][:log_panel] = {:watch => {'Logger' => :add}}
+          # The following two lines have the same result
+          config[:panel_configs][:log] = {:probes => {'Logger' => [:instance, :add]}}
+          config[:panel_configs][:log] = {:probes => ['Logger', :instance, :add]}
         end
 
       Example:  If you want all of your log statements in Rails to be traced twice by Rack::Insight,
                 this will do that because ActiveSupport::BufferedLogger utilizes Logger under the hood:
 
-        config[:panel_configs][:log_panel] = {:watch => {
-                "ActiveSupport::BufferedLogger" => :add,
-                "Logger" => :add
+        config[:panel_configs][:log_panel] = {:probes => {
+                "ActiveSupport::BufferedLogger" => [:instance, :add],
+                "Logger" => [:instance, :add]
         }}
 
 
@@ -208,6 +210,35 @@ location (i.e. Heroku), you can pass a custom file path.
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
       :database_path => "tmp/my_insight_db.sqlite"
 
+Magic Panels
+------------
+
+You can now create a fully functional new panel with a simple class definition:
+
+    module Rack::Insight
+      class FooBarPanel < Panel
+        self.is_magic = true
+      end
+    end
+
+Setup the probes for the magic panel in a `before_initialize` block in your application.rb as follows:
+
+    # Assuming there is a FooBra class with instance methods: foo, bar, cheese, and ducks
+    Rack::Insight::Config.configure do |config|
+      # Not :foo_bar_panel or 'FooBarPanel'... :foo_bar
+      config[:panel_configs][:foo_bar] = {:probes => {'FooBra' => [:instance, :foo, :bar, :cheese, :ducks]}}
+    end
+
+Custom Panels
+-------------
+
+See Magic Panels above, remove teh is_magic declaration, and add your own methods.
+Look at the panels bundled with this gem for pointers.  Here are some important methods to watch for:
+
+* initialize
+* after_detect
+* content_for_request(number)
+
 Authors
 -------
 

data/lib/rack/insight/filtered_backtrace.rb

@@ -10,7 +10,7 @@ module Rack::Insight
     end
 
     def filtered_backtrace
-      @filtered_backtrace ||= @backtrace.grep(FilteredBacktrace.backtrace_regexp)
+      @filtered_backtrace ||= @backtrace.respond_to?(:grep) ? @backtrace.grep(FilteredBacktrace.backtrace_regexp) : []
     end
 
     def self.backtrace_regexp

data/lib/rack/insight/panel.rb

@@ -132,7 +132,7 @@ module Rack::Insight
             end
           end
         else
-          raise "Expected Rack::Insight::Config.config[:panel_configs][#{self.as_sym.inspect}][:probes] to be a kind of Hash or an Array with length >= 3, but is a #{Rack::Insight::Config.config[:panel_configs][self.as_sym][:probes].class}"
+          raise "Expected Rack::Insight::Config.config[:panel_configs][#{panel_name}][:probes] to be a kind of Hash or an Array with length >= 3, but is a #{Rack::Insight::Config.config[:panel_configs][self.as_sym][:probes].class}"
         end
       end
 
@@ -240,28 +240,14 @@ module Rack::Insight
         logger.info("#{self.class} is being used without a table") if verbose(:med)
         content
       elsif self.is_probed?
-        html = "<h3>#{self.camelized_name}</h3>"
         invocations = retrieve(number)
         if invocations.length > 0 && invocations.first.is_a?(Rack::Insight::Panel::DefaultInvocation)
-          html += '<table><thead><tr>'
-          logger.info("Rack::Insight is using magic content for #{self.class}, which is probed") if verbose(:med)
-          members = invocations.first.members # is a struct, so we have members, not keys
-          members.each do |member|
-            html += '<td>' << member.to_s << '</td>'
-          end
-          html += '</tr></thead><tbody>'
-          invocations.each do |invocation|
-            html += '<tr>'
-            members.each do |member|
-              html += '<td>' << invocation.send(member).inspect << '</td>'
-            end
-            html += '</tr>'
-          end
-          html += '</tbody></table>'
+          logger.info("Rack::Insight is using magic content for #{self.class}, which is probed")# if verbose(:med)
+          render_template 'default_invocation', :invocations => invocations, :name => self.camelized_name
         else
-          html += '<p>No Data Available</p>'
+          logger.info("Rack::Insight has no data for magic content for #{self.class}, which is probed")# if verbose(:med)
+          render_template 'no_data', :name => self.camelized_name
         end
-        html
       else
         content
       end
@@ -284,7 +270,7 @@ module Rack::Insight
     def after_detect(method_call, timing, args, result)
       #puts "Default After Detect for #{self.underscored_name}: 1. #{self.is_magic?} && 2. #{self.has_table?} && 3. #{self.is_probed?}"
       if self.is_magic? && self.has_table? && self.is_probed?
-        store(@env, DefaultInvocation.new(method_call.to_s, timing.duration, args, result))
+        store(@env, DefaultInvocation.new(method_call.method.to_s, timing, args, result, method_call.backtrace[2..-1]))
       end
     end
 
@@ -297,14 +283,24 @@ module Rack::Insight
     def render(template)
     end
 
-    # For Magic Panels (not fully implemented)
-    class DefaultInvocation < Struct.new :method, :time, :args, :result
+    # For Magic Panels
+    class DefaultInvocation < Struct.new :method, :time, :arguments, :result, :backtrace
+      attr_accessor :method, :time, :arguments, :result, :backtrace
+
+      include Rack::Insight::FilteredBacktrace
+
       def initialize(*args)
-        @time = human_time(args[1])
+        @method = args[0]
+        @time = [args[1].duration, args[1].delta_t]
+        @arguments = args[2]
+        @result = args[3]
+        @backtrace = args[4]
       end
-      def human_time(t)
-        "%.2fms" % (t * 1_000)
+
+      def human_time
+        "%.2fms" % (self.time * 1_000)
       end
+
     end
 
   end

data/lib/rack/insight/version.rb

@@ -1,7 +1,7 @@
 module Rack
   module Insight
 
-  VERSION = '0.5.14'
+  VERSION = '0.5.15'
 
   end
 end

data/lib/rack/insight/views/default_invocation.html.erb

@@ -0,0 +1,30 @@
+<h3><%= name %></h3>
+<table>
+  <thead>
+    <tr>
+      <%- members = invocations.last.members # is a struct, so we have members, not keys %>
+      <%- members.each do |member| %>
+        <td><%= member  %></td>
+      <%- end %>
+    </tr>
+  </thead>
+  <tbody>
+  <%- invocations.each do |invocation| %>
+    <tr>
+      <%- members.each do |member| %>
+        <td>
+          <%- if member == :backtrace %>
+            <%- invocation.filtered_backtrace.each do |line| %>
+              <%= line %><br/>
+            <%- end %>
+          <%- elsif member == :time %>
+            <%= invocation.human_time %>
+          <%- else %>
+            <%= invocation.send(member).inspect %>
+          <%- end %>
+        </td>
+      <%- end %>
+    </tr>
+  <%- end %>
+  </tbody>
+</table>

data/lib/rack/insight/views/no_data.html.erb

@@ -0,0 +1,2 @@
+<h3><%= name %></h3>
+<p>No Data Available</p>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-insight
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 0.5.15
   prerelease: 
 platform: ruby
 authors:
@@ -280,9 +280,11 @@ files:
 - lib/rack/insight/rspec_matchers.rb
 - lib/rack/insight/toolbar.rb
 - lib/rack/insight/version.rb
+- lib/rack/insight/views/default_invocation.html.erb
 - lib/rack/insight/views/enable-button.html.erb
 - lib/rack/insight/views/error.html.erb
 - lib/rack/insight/views/headers_fragment.html.erb
+- lib/rack/insight/views/no_data.html.erb
 - lib/rack/insight/views/panels/active_record.html.erb
 - lib/rack/insight/views/panels/active_resource.html.erb
 - lib/rack/insight/views/panels/cache.html.erb