logical-insight 0.4.4 → 0.4.5

data/lib/insight/app.rb

@@ -11,6 +11,7 @@ require "insight/redirect_interceptor"
 require "insight/render"
 require "insight/toolbar"
 require "insight/enable-button"
+require "insight/path-filter"
 require 'insight/logger'
 require 'insight/request-recorder'
 require 'insight/instrumentation/setup'
@@ -46,17 +47,17 @@ module Insight
     attr_accessor :panels
 
     def call(env)
-      env.replace @default_options.merge(env)
-      @env = env
-      @original_request = Rack::Request.new(@env)
-      env['insight.logger'] = @logger
-      Thread.current['insight.logger'] = @logger
-
+      @original_request = Rack::Request.new(env)
       if insight_active?
+        @env = env
+        self.options = @default_options
+
+        env['insight.logger'] = @logger
+        Thread.current['insight.logger'] = @logger
+
         Insight.enable
         env["insight.panels"] = []
-        result = @debug_stack.call(env)
-        result
+        @debug_stack.call(env)
       else
         @normal_stack.call(env)
       end
@@ -64,6 +65,7 @@ module Insight
 
 
     def reset(new_options=nil)
+      @env = nil
       initialize_options(new_options)
 
       Insight::Instrumentation::ClassProbe::all_probes.each do |probe|
@@ -94,7 +96,8 @@ module Insight
       @panels.clear
       builder = Rack::Builder.new
       builder.use Toolbar, self
-      builder.run Rack::Cascade.new([panel_mappings, collection_stack(@base_app)])
+      builder.run Rack::Cascade.new([panel_mappings, shortcut_stack(@base_app), collection_stack(@base_app)])
+
       @debug_stack = builder.to_app
     end
 
@@ -120,24 +123,30 @@ module Insight
       return asset_mapped(builder)
     end
 
+    def shortcut_stack(app)
+      Rack::Builder.app do
+        use PathFilter
+        run app
+      end
+    end
 
     def collection_stack(app)
       classes = read_option(:panel_classes)
       insight_id = self.object_id
       panels = self.panels
-      Rack::Builder.app do
-        use RequestRecorder
-        classes.each do |panel_class|
-          run(lambda do |app|
-            panel = panel_class.new(app)
-            panels << panel
-            panel
-          end)
-        end
-        use RedirectInterceptor
-        use Instrumentation::Setup
-        run app
+
+      #Builder makes it impossible to access the panels
+
+      app = Instrumentation::Setup.new(app)
+      app = RedirectInterceptor.new(app)
+      #Reversed?  Does it matter?
+      app = classes.inject(app) do |app, panel_class|
+        panel = panel_class.new(app)
+        panels << panel
+        panel
       end
+      app = RequestRecorder.new(app)
+      return app
     end
 
     def asset_mapped(builder)

data/lib/insight/database.rb

@@ -62,7 +62,7 @@ module Insight
         @db
       rescue Object => ex
         msg = "Issue while loading SQLite DB:" + [ex.class, ex.message, ex.backtrace[0..4]].inspect
-        logger.debug{ msg }
+        logger.error{ msg }
 
         return {}
       end
@@ -90,7 +90,7 @@ module Insight
       end
 
       def execute(*args)
-        logger.debug{ ins_args = args.inspect; "(#{[ins_args.length,120].min}/#{ins_args.length})" + ins_args[0..120] }
+        logger.info{ ins_args = args.inspect; "(#{[ins_args.length,120].min}/#{ins_args.length})" + ins_args[0..120] }
         db.execute(*args)
       end
 
@@ -98,9 +98,8 @@ module Insight
         @table_name = table_name
         @keys = keys
         if(execute("select * from sqlite_master where name = ?", table_name).empty?)
+          logger.warn{ "Initializing a table called #{table_name}" }
           execute(create_sql)
-
-          logger.debug{ "Initializing a table called #{table_name}" }
         end
       end
 

data/lib/insight/enable-button.rb

@@ -31,7 +31,7 @@ module Insight
       full_body = response.body.join
       full_body.sub! /<\/body>/, render + "</body>"
 
-      response["Content-Length"] = full_body.size.to_s
+      response["Content-Length"] = full_body.bytesize.to_s
 
       response.body = [full_body]
     end

data/lib/insight/instrumentation/probe.rb

@@ -20,8 +20,6 @@ module Insight
           result = nil
           if instrument.nil?
             backstage do
-              # Rails.logger.debug{"No instrument in thread - #{context} /
-              # #{called_at}"}
               result = yield
             end
           else
@@ -68,7 +66,7 @@ module Insight
             begin
               h[k] = self.new(const_from_name(k))
             rescue NameError
-              logger.info{ "Cannot find constant: #{k}" }
+              logger.warn{ "Cannot find constant: #{k}" }
             end
           end
         end
@@ -130,7 +128,6 @@ module Insight
       include Logging
       def log &block
         logger.debug &block
-        #$stderr.puts block.call.inspect
       end
 
       def fulfill_probe_orders

data/lib/insight/logger.rb

@@ -19,9 +19,7 @@ module Insight
       message = message.inspect unless String === message
       return unless severity >= @level
 
-      if defined? Rails and
-        Rails.respond_to? :logger
-        not Rails.logger.nil?
+      if defined? Rails and Rails.respond_to?(:logger) and not Rails.logger.nil?
         Rails.logger.add(severity, "[Insight]: " + message)
       end
 

data/lib/insight/options.rb

@@ -49,11 +49,19 @@ module Insight
     private
 
     def read_option(key)
-      options[option_name(key)]
+      key = option_name(key)
+      if @env and @env.has_key?(key)
+        @env[key]
+      else
+        @default_options[key]
+      end
     end
 
     def write_option(key, value)
-      options[option_name(key)] = value
+      @default_options[option_name(key)] = value
+      if @env.respond_to? :[]
+        @env[option_name(key)] = value
+      end
     end
 
     def option_name(key)
@@ -84,6 +92,7 @@ module Insight
         'insight.secret_key'           =>  nil,
         'insight.intercept_redirects'  =>  false,
         'insight.panels'               =>  [],
+        'insight.path_filters'         =>  %w{/assets/},
         'insight.log_level'            =>  Logger::INFO,
         'insight.log_path'             =>  "log/insight.log",
         'insight.database_path'        =>  "insight.sqlite",

data/lib/insight/panel.rb

@@ -73,9 +73,11 @@ module Insight
 
     def call(env)
       @env = env
+      logger.debug{ "Before call: #{self.name}" }
       before(env)
       status, headers, body = @app.call(env)
       @request = Rack::Request.new(env)
+      logger.debug{ "After call: #{self.name}" }
       after(env, status, headers, body)
       env["insight.panels"] << self
       return [status, headers, body]
@@ -94,7 +96,7 @@ module Insight
     end
 
     def name
-      "Unnamed panel: #{__FILE__}" #for shame
+      "Unnamed panel: #{self.class.name}" #for shame
     end
 
     def heading_for_request(number)

data/lib/insight/panels/log_panel.rb

@@ -15,7 +15,6 @@ module Insight
       end
     end
 
-
     def after_detect(method_call, timing, args, message)
       message = args[1] || args[2] unless message.is_a?(String)
       log_level = args[0]

data/lib/insight/panels/memory_panel.rb

@@ -27,6 +27,10 @@ module Insight
       false
     end
 
+    def name
+      "Memory"
+    end
+
   end
 
 end

data/lib/insight/path-filter.rb

@@ -0,0 +1,23 @@
+require 'insight/logger'
+
+module Insight
+  class PathFilter
+    include Logging
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      filters = env['insight.path_filters'].map do |string|
+        %r{^#{string}}
+      end
+
+      unless filter = filters.find{|regex| regex =~ env['PATH_INFO']}
+        return [404, {}, []]
+      end
+
+      logger.debug{ "Shortcutting collection stack: #{filter} =~ #{env['PATH_INFO']}"}
+      return @app.call(env)
+    end
+  end
+end

data/lib/insight/toolbar.rb

@@ -1,6 +1,7 @@
 module Insight
   class Toolbar
     include Render
+    include Logging
 
     MIME_TYPES = ["text/html", "application/xhtml+xml"]
 
@@ -16,7 +17,9 @@ module Insight
 
       response = Rack::Response.new(body, status, headers)
 
-      inject_toolbar(response) if okay_to_modify?(env, response)
+      if okay_to_modify?(env, response)
+        inject_toolbar(response)
+      end
 
       return response.to_a
     end
@@ -46,6 +49,9 @@ module Insight
       requests = @request_table.to_a.map do |row|
         { :id => row[0], :method => row[1], :path => row[2] }
       end
+
+      logger.info{ "Injecting toolbar: active panels: #{@insight.panels.map{|pnl| pnl.class.name}.inspect}" }
+
       headers_fragment = render_template("headers_fragment",
                                          :panels => @insight.panels,
                                          :request_id => req_id)

data/lib/insight/views/enable-button.html.erb

@@ -1 +1,21 @@
-<a id='logical-insight-enabler' href="javascript: (function(){var script=document.createElement('script'); script.src='/__insight__/bookmarklet.js'; document.getElementsByTagName('head')[0].appendChild(script); document.insightEnable()})()">Insight</a>
+<script type="text/javascript" src='/__insight__/bookmarklet.js'></script>
+<style>
+  #logical-insight-enabler {
+    position: absolute;
+    z-index: 100000;
+    overflow: hidden;
+    width: 4px;
+    height: 4px;
+    top: 0;
+    left: 0;
+    background: #326342;
+    color: #92EF3F;
+  }
+
+  #logical-insight-enabler:hover {
+    width: 50px;
+    height: 24px;
+  }
+</style>
+
+<a id='logical-insight-enabler' href="#" onclick="document.insightEnable()" style="">Insight</a>

data/lib/insight/views/headers_fragment.html.erb

@@ -1,7 +1,5 @@
-
-      <li id="insight_disable_button">[X]</li>
-      <li id="insight_debug_button">Insight (req# <span id="request_id"><%= request_id %></span>)</li>
-
+<li id="insight_disable_button">[X]</li>
+<li id="insight_debug_button">Insight (req# <span id="request_id"><%= request_id %></span>)</li>
 <% panels.each do |panel| %>
   <li>
   <% begin %>

data/spec/insight/panels/active_record_panel_spec.rb

@@ -3,7 +3,7 @@ module Insight
   describe "ActiveRecordPanel" do
     before do
       mock_constant("ActiveRecord::Base")
-      reset_insight :panel_classes => [ActiveRecordPanel]
+      reset_insight :panel_files => %w{active_record_panel}
     end
 
     def mock_model(name)

data/spec/insight/panels/cache_panel_spec.rb

@@ -112,7 +112,7 @@ module Insight
 
     describe "cache operations" do
       before do
-        rack_env "insight.secret_key", 'abc'
+        app.insight_app.secret_key = 'abc'
         response = get_via_rack "/"
       end
 

data/spec/insight/panels/mongo_panel_spec_pending.rb

@@ -3,7 +3,7 @@ if defined? Mongo
     describe "MongoPanel" do
       before do
         MongoPanel.reset
-        rack_env "insight.panel_classes", [MongoPanel]
+        reset_insight :panel_files => %w{mongo_panel}
       end
 
       describe "heading" do

data/spec/insight/panels/sql_panel_spec.rb

@@ -61,7 +61,7 @@ module Insight
 
     describe "sql/execute" do
       it "displays the query results" do
-        rack_env "insight.secret_key", "abc"
+        app.insight_app.secret_key = "abc"
         expect_query "SELECT username FROM users",
           [["username"],
             ["bryan"]]
@@ -73,7 +73,7 @@ module Insight
       end
 
       it "is forbidden when the hash is missing or wrong" do
-        rack_env "insight.secret_key", 'abc'
+        app.insight_app.secret_key='abc'
 
         lambda {
           get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
@@ -82,7 +82,7 @@ module Insight
       end
 
       it "is not available when the insight.secret_key is nil" do
-        rack_env "insight.secret_key", nil
+        app.insight_app.secret_key = nil
 
         lambda {
           get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
@@ -91,7 +91,7 @@ module Insight
       end
 
       it "is not available when the insight.secret_key is an empty string" do
-        rack_env "insight.secret_key", ""
+        app.insight_app.secret_key = ""
 
         lambda {
           get_via_rack "/__insight__/sql/execute", {:query => "SELECT username FROM users",
@@ -102,7 +102,7 @@ module Insight
 
     describe "sql/explain" do
       it "displays the query explain plan" do
-        rack_env "insight.secret_key", "abc"
+        app.insight_app.secret_key = "abc"
         expect_query "EXPLAIN SELECT username FROM users",
           [["table"],
             ["users"]]
@@ -115,7 +115,7 @@ module Insight
       end
 
       it "is forbidden when the hash is missing or wrong" do
-        rack_env "insight.secret_key", 'abc'
+        app.insight_app.secret_key='abc'
 
         lambda {
           get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
@@ -124,7 +124,7 @@ module Insight
       end
 
       it "is not available when the insight.secret_key is nil" do
-        rack_env "insight.secret_key", nil
+        app.insight_app.secret_key=nil
 
         lambda {
           get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",
@@ -133,7 +133,7 @@ module Insight
       end
 
       it "is not available when the insight.secret_key is an empty string" do
-        rack_env "insight.secret_key", ""
+        app.insight_app.secret_key=""
 
         lambda {
           get_via_rack "/__insight__/sql/explain", :query => "SELECT username FROM users",

data/spec/insight_spec.rb

@@ -72,31 +72,35 @@ describe Insight do
   end
 
   context "redirected when configured to intercept redirects" do
+    before :each do
+      app.insight_app.intercept_redirects = true
+    end
+
     it "shows the interception page" do
-      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response = get "/redirect"
       response.should have_selector("div#insight")
     end
 
     it "should provide a link to the target URL" do
-      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response = get "/redirect"
       response.should have_selector("a[href='http://example.org/']")
     end
 
     it "inserts the toolbar if requested" do
-      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response = get "/redirect"
       response.should have_selector("div#insight")
     end
 
     it "does not inserts the toolbar if not requested" do
       header 'cookie', ""
-      response = get "/redirect", {}, "insight.intercept_redirects" => true
+      response = get "/redirect"
       response.should_not have_selector("div#insight")
     end
   end
 
   context "configured with an IP address restriction" do
     before do
-      rack_env "insight.ip_masks", [IPAddr.new("127.0.0.1/255.255.255.0")]
+      app.insight_app.ip_masks = [IPAddr.new("127.0.0.1/255.255.255.0")]
     end
 
     it "inserts the Insight toolbar when the IP matches" do
@@ -111,14 +115,14 @@ describe Insight do
 
     it "doesn't use any panels" do
       DummyPanel.should_not_receive(:new)
-      rack_env "insight.panel_classes", [DummyPanel]
+      app.insight_app.panel_classes = [DummyPanel]
       get_via_rack "/", {}, "REMOTE_ADDR" => "128.0.0.1"
     end
   end
 
   context "configured with a password" do
     before do
-      rack_env "insight.password", "secret"
+      app.insight_app.password = "secret"
     end
 
     it "should insert the Insight toolbar when the password matches" do
@@ -134,7 +138,7 @@ describe Insight do
     end
     it "doesn't use any panels" do
       DummyPanel.should_not_receive(:new)
-      rack_env "insight.panel_classes", [DummyPanel]
+      app.insight_app.panel_classes = [DummyPanel]
       get_via_rack "/"
     end
   end

metadata

@@ -1,70 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: logical-insight
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.5
   prerelease: 
-  version: 0.4.4
 platform: ruby
-authors: 
+authors:
 - Bryan Helmkamp
 - Evan Dorn
 - Judson Lester
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-13 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: corundum
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &71737750 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.0.13
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *71737750
+- !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &71736830 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+        segments:
         - 2
         - 3
         - 1
-        version: 2.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *71736830
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70113490 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+        segments:
         - 1
         - 3
         - 3
-        version: 1.3.3
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-description: "Debugging toolbar for Rack applications implemented as\n    middleware.  Rails 3 compatible version maintained by Logical Reality\n    Design.  "
+  version_requirements: *70113490
+description: ! "Debugging toolbar for Rack applications implemented as\n    middleware.
+  \ Rails 3 compatible version maintained by Logical Reality\n    Design.  "
 email: evan@lrdesign.com judson@lrdesign.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - MIT-LICENSE.txt
-files: 
+files:
 - lib/logical-insight.rb
 - lib/insight.rb
 - lib/insight/rack_static_bug_avoider.rb
@@ -101,6 +99,7 @@ files:
 - lib/insight/enable-button.rb
 - lib/insight/instrumentation.rb
 - lib/insight/app.rb
+- lib/insight/path-filter.rb
 - lib/insight/panels/request_variables_panel.rb
 - lib/insight/panels/redis_panel.rb
 - lib/insight/panels/rails_info_panel.rb
@@ -166,33 +165,30 @@ files:
 - Thorfile
 homepage: https://github.com/LRDesign/logical-insight
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 910188977
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -406706161
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Debugging toolbar for Rack applications implemented as middleware.  Rails 3 compatible version maintained by Logical Reality Design.
+summary: Debugging toolbar for Rack applications implemented as middleware.  Rails
+  3 compatible version maintained by Logical Reality Design.
 test_files: []
-