logical-insight 0.4.2 → 0.4.3

data/README.md

@@ -1,7 +1,9 @@
 Insight
 =========
 
-Insight began life as an LRDesign fork of Insight.  We started a fork because the main project wasn't making progress on Rails 3 support.  Having made really significant archetectural changes, we'll be keeping Insight a separate project for the forseeable future.
+Insight began life as an LRDesign fork of Rack::Bug by brynary.  We started a fork because, at the time, the main project wasn't making progress on Rails 3 support.  Since then we've rewritten a lot of the code to make it more modular, easier to extend, and to store information about multiple requests so you can use it to inspect your AJAX requests (or any past request), not just previous page loads.
+
+Having made really significant architectural changes, we'll be keeping Insight a separate project for the forseeable future.
 
 * Forked From: [http://github.com/brynary/rack-bug](http://github.com/brynary/rack-bug)
 
@@ -9,7 +11,8 @@ Description
 -----------
 
 Insight adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
-allowing exploration of logging, database queries, template rendering times, etc.
+allowing exploration of logging, database queries, template rendering times, etc.   Insight
+stores debugging info over many requests, incuding AJAX requests.
 
 Features
 --------
@@ -47,10 +50,10 @@ Add this to your Gemfile
 
 In config/environments/development.rb, add:
 
-    config.middleware.use "Insight",
+    config.middleware.use "Insight::App",
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
 
-Any environment with Insight loaded will have a link to "Insight" in the upper left.  Clicking that link will load the toolbar.
+Any environment with Insight loaded will have a link to "Insight" added to as the last child of BODY to normal responses.  Clicking that link will load the toolbar.  It's set with an id of "logical-insight-enabler", so it can be styled to go somewhere more noticeable.  E.g. "position: absolute; top: 0; left: 0"
 
 Using with non-Rails Rack apps
 ------------------------------
@@ -64,9 +67,9 @@ Configuring custom panels
 
 Specify the set of panels you want, in the order you want them to appear:
 
-    require "rack/bug"
+    require "logical-insight"
 
-    ActionController::Dispatcher.middleware.use Insight,
+    ActionController::Dispatcher.middleware.use "Insight::App",
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
       :panel_files => %w[
         timer_panel
@@ -94,26 +97,34 @@ Restrict access to particular IP addresses:
 
     require "ipaddr"
 
-    ActionController::Dispatcher.middleware.use "Insight"
+    ActionController::Dispatcher.middleware.use "Insight::App"
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
       :ip_masks   => [IPAddr.new("2.2.2.2/0")]
 
 Restrict access using a password:
 
-    ActionController::Dispatcher.middleware.use "Insight",
+    ActionController::Dispatcher.middleware.use "Insight::App",
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
       :password   => "yourpassword"
 
+#### custom file path for the logging database ####
+
+Logical Insight uses SQLite to store data from requests, and outputs a database file in the root directory. If you need the file to be created at another location (i.e. Heroku), you can pass a custom file path.
+
+    ActionController::Dispatcher.middleware.use "Insight::App"
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :database_path => "tmp/my_insight_db.sqlite"
 
 Authors
 -------
 
 - Maintained by [Judson Lester](mailto:judson@lrdesign.com)
 - Contributions from Luke Melia, Joey Aghion, Tim Connor, and more
+- Based on Rack::Bug by Bryan Helmkamp
 
 Thanks
 ------
-Insight owes a lot to Rack::Bug, as the basis project.  There's a lot of smart in there.
+Insight owes a lot to Rack::Bug, as the basis project.  There's a lot of smart in there.  Many thanks to Bryan for building it.
 
 Inspiration for Rack::Bug is primarily from the Django debug toolbar. Additional ideas from Rails footnotes, Rack's ShowException middleware, Oink, and Rack::Cache
 

data/Rakefile

@@ -1,3 +1,4 @@
+require 'yaml'
 require 'corundum'
 require 'corundum/tasklibs'
 

data/lib/insight/database.rb

@@ -39,6 +39,15 @@ module Insight
 
     class << self
       include Logging
+
+      def database_path=(value)
+        @database_path = value
+      end
+
+      def database_path
+        @database_path
+      end
+
       def db
         @db ||= open_database
       end
@@ -48,7 +57,7 @@ module Insight
       end
 
       def open_database
-        @db = SQLite3::Database.new("insight.sqlite")
+        @db = SQLite3::Database.new(database_path)
         @db.execute("pragma foreign_keys = on")
         @db
       rescue Object => ex

data/lib/insight/options.rb

@@ -1,4 +1,5 @@
 require 'ipaddr'
+
 module Insight
   module Options
     class << self
@@ -15,6 +16,7 @@ module Insight
     option_accessor :password
     option_accessor :panel_classes
     option_accessor :intercept_redirects
+    option_accessor :database_path
 
     # The underlying options Hash. During initialization (or outside of a
     # request), this is a default values Hash. During a request, this is the
@@ -70,6 +72,8 @@ module Insight
         end
         write_option('insight.panel_classes', class_list)
       end
+
+      Insight::Database.database_path = read_option('insight.database_path')
     end
 
     def initialize_options(options=nil)
@@ -82,6 +86,7 @@ module Insight
         'insight.panels'               =>  [],
         'insight.log_level'            =>  Logger::INFO,
         'insight.log_path'             =>  "log/insight.log",
+        'insight.database_path'        =>  "insight.sqlite",
         'insight.panel_files'          =>  %w{
           rails_info_panel
           timer_panel

data/lib/insight/panels/speedtracer_panel/tracer.rb

@@ -19,7 +19,8 @@ module Insight
       def before_detect(method_call, arguments)
         @event_id += 1
 
-        arguments_string = make_string_of(arguments)
+        #arguments_string = make_string_of(arguments)
+        arguments_string = ""
         #XXX ServerEvent use method call...
         event = ServerEvent.new(method_call, arguments_string)
         @pstack.push event

data/spec/insight_spec.rb

@@ -138,4 +138,20 @@ describe Insight do
       get_via_rack "/"
     end
   end
+
+  context "configured with a SQLite database file path" do
+    before do
+      # We need to pass the SQLite database file path to the gem
+      reset_insight :database_path => 'my_custom_db_path.sqlite'
+    end
+
+    it "should create a database at the path specified in the options" do
+      File.exist?('my_custom_db_path.sqlite').should be_true
+    end
+
+    after do
+      File.delete("my_custom_db_path.sqlite")
+    end
+
+  end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: logical-insight
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 2
-  version: 0.4.2
+  prerelease: 
+  version: 0.4.3
 platform: ruby
 authors: 
 - Bryan Helmkamp
@@ -16,13 +12,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 -08:00
-default_executable: 
+date: 2011-12-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: uuid
-  prerelease: false
+  name: corundum
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.13
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -32,11 +38,12 @@ dependencies:
         - 1
         version: 2.3.1
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: sqlite3
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -46,7 +53,8 @@ dependencies:
         - 3
         version: 1.3.3
   type: :runtime
-  version_requirements: *id002
+  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.  "
 email: evan@lrdesign.com judson@lrdesign.com
 executables: []
@@ -156,7 +164,6 @@ files:
 - README.md
 - Rakefile
 - Thorfile
-has_rdoc: true
 homepage: https://github.com/LRDesign/logical-insight
 licenses: []
 
@@ -166,23 +173,24 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -756212099
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Debugging toolbar for Rack applications implemented as middleware.  Rails 3 compatible version maintained by Logical Reality Design.