rack-insight 0.5.0

data/.gitignore

@@ -0,0 +1,13 @@
+*.sw?
+*.gem
+.bundle/
+.conductor/
+corundum/
+doc/
+rack-insight-test.log
+rack-insight.sqlite
+notions-and-tests/
+pkg/
+.sass-cache/
+.yardoc/
+gh-pages/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  coverage_dir "corundum/docs/coverage"
+  add_filter "./spec"
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/CHANGELOG

@@ -0,0 +1,58 @@
+== 0.5.0 / 2012-08-29 - transition to rack_insight
+
+  * Compatibility
+
+    * Restructure gem so Insight is inside a namespace, because I have classes named Insight that are obscured by
+      logical_insight gem when loaded.  Logical also seemed like it may be a class name somewhere, hence going back to
+      the Rack namespace a la rack-bug.  Keeping the (now nested) Insight namespace as well, because - genetics.
+
+  *Other
+
+    * Fix spelling of retreive => retrieve (Peter Boling)
+    * Remove redundant time method from cache_panel/stats.rb
+
+== 0.4.X - last of logical_insight
+
+  * New features
+
+    * Can use LoggerPanel on ruby stdlib Logger in non-rails app (Tim Connor)
+
+  * Bug fixes
+  
+    * Fix profile, explain and select in the queries tab, fixes issue #22 (ebertech)
+    
+  * Minor fixes
+  
+    * Explicitly require 'digest/sha1' (Jérémy Lecour)
+    * Eliminate unreachable code in params signature validation (Tim Connor)
+
+  * Compatibilty
+
+    * Make Redis panel compatible with latest redis-rb gem, without breaking older redis-rb versions (Luke Melia)
+  
+  * Other
+  
+    * Refactoring and code cleanup (Tim Connor)
+    * Testing cleanup - better isolation of Rails vs. non-Rails in tests (Tim Connor)
+
+== 0.3.0 / 2010-05-28
+
+  * New features
+
+    * Log panel includes log level and timestamp (Tim Connor)
+    * Sphinx panel (George Chatzigeorgiou)
+    * Backtraces for Redis panel (Luke Melia & Joey Aghion)
+
+  * Minor fixes
+
+    * Don't "enable" rack bug if you hit cancel on the bookmarklet prompt (Mischa Fierer)
+
+  * Compatibilty
+
+    * backtrace filtering now supports more than just Rails (Alex Chaffee)
+    * compatibility with current rack-test (Luke Melia & Joey Aghion)
+    * update Sinatra sample app (Tim Conner)
+
+== 0.2.1
+
+  * The beginning of recorded history

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    rack-insight (0.5.0)
+      rack
+      sqlite3 (>= 1.3.3)
+      uuidtools (>= 2.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    nokogiri (1.5.4)
+    rack (1.3.5)
+    rack-protection (1.1.4)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    redcarpet (2.1.1)
+    reek (1.2.12)
+      ripper_ruby_parser (~> 0.0.7)
+      ruby2ruby (~> 1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ripper_ruby_parser (0.0.8)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.2.0)
+    sinatra (1.3.1)
+      rack (~> 1.3, >= 1.3.4)
+      rack-protection (~> 1.1, >= 1.1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sqlite3 (1.3.6)
+    tilt (1.3.3)
+    uuidtools (2.1.3)
+    webrat (0.7.3)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-insight!
+  rake
+  redcarpet
+  reek (>= 1.2.8)
+  roodi (>= 2.1.0)
+  rspec (>= 2.11.0)
+  ruby-debug19
+  sinatra
+  webrat

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012 Peter H. Boling as rack-insight
+Copyright (c) 2011-12 LR Design as logical-insight
+Copyright (c) 2009 Bryan Helmkamp as rack-bug
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,189 @@
+Rack::Insight
+=========
+
+Rack::Insight began life as an fork of Logical::Insight by LRDesign.  I started a
+fork because LogicalInsight was namespaced as "Insight", which is causing namespace
+collisions everywhere I have an Insight model.  I had to re-namespace all the code.
+I also needed to build a few extension gems with additional panels, and added the
+Config class to allow for custom panel load paths, and other future extensions
+that don't work in the *use Middleware* declaration.  It should be *even* easier
+to extend than LogicalInsight was, because extension gems can access the Config class
+and truly bolt-on cleanly.
+
+Having made really significant architectural changes, I'll be keeping Rack::Insight
+a separate project for the forseeable future.
+
+* Forked From: [logical-insight](http://github.com/LRDesign/logical-insight), [documentation](http://lrdesign.github.com/rack-insight/)
+* Which Was Forked From: [rack-bug](http://github.com/brynary/rack-bug)
+
+Description
+-----------
+
+Rack::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.   Rack::Insight
+stores debugging info over many requests, incuding AJAX requests.
+
+Features
+--------
+
+* Password-based security
+* IP-based security
+* Rack::Insight instrumentation/reporting is broken up into panels.
+    * Panels in default configuration:
+        * Rails Info
+        * Timer
+        * Request Variables
+        * SQL
+        * Active Record
+        * Cache
+        * Templates
+        * Log
+        * Memory
+    * Other bundled panels:
+        * Redis
+        * Speedtracer
+    * Retired panels - if needed they could come back quickly:
+        * Sphinx
+        * Mongo
+    * The API for adding your own panels is simple and very powerful
+        * Consistent interface to instrument application code
+        * Consistent timing across panels
+        * Easy to add sub-applications for more detailed reports (c.f. SQLPanel)
+        * The documentation is scarce, so there's a feeling of adventure :/
+
+Rails quick start
+---------------------------
+
+Add this to your Gemfile
+    gem "rack-insight"
+
+In config/environments/development.rb, add:
+
+    config.middleware.use "Rack::Insight::App",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
+
+Any environment with Rack::Insight loaded will have a link to "Rack::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 "rack-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
+------------------------------
+
+Just 'use Rack::Insight' as any other middleware.  See the SampleApp in the
+spec/fixtures folder for an example Sinatra app.
+
+If you wish to use the logger panel define the LOGGER constant that is a ruby
+Logger or ActiveSupport::BufferedLogger
+
+Configuring custom panels
+-------------------------
+
+Specify the set of panels you want, in the order you want them to appear:
+
+    require "rack-insight"
+
+    ActionController::Dispatcher.middleware.use "Rack::Insight::App",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :panel_files => %w[
+        timer_panel
+        request_variables_panel
+        redis_panel
+        templates_panel
+        log_panel
+        memory_panel
+      ]
+
+By default panel files are looked up by prepending "rack/insight/panels/" and requiring them.
+Subclasses of Rack::Insight::Panel are loaded and added to the toolbar.  This makes
+it easier to work with the configuration and extend Rack::Insight with plugin gems.
+
+If you need to customize the load paths where Rack::Insight will look for panels you can configure the load paths in an
+initializer.  Example config/initializers/rack_insight.rb:
+
+    Rack::Insight::Config.configure do |config|
+
+      # Note: The parent directory of the 'special' directory must already be in Ruby's load path.
+      config[:panel_load_paths] = File.join('special','path')
+
+      # Example 1: Do not load any of the regular Rack::Insight panels:
+      config[:panel_load_paths] = File.join('my','custom','panel','directory')
+
+      # Example 2: Add your custom path to the existing load paths, to have your panels join the party!
+      config[:panel_load_paths] << 'custom/panels'
+
+    end
+
+Running Rack::Insight in staging or production
+------------------------------------------
+
+We have have found that Rack::Insight is fast enough to run in production for specific troubleshooting efforts.
+
+### Configuration ####
+
+Add the middleware configuration to an initializer or the appropriate
+environment files, taking the rest of this section into consideration.
+
+### Security ####
+
+Restrict access to particular IP addresses:
+
+    require "ipaddr"
+
+    ActionController::Dispatcher.middleware.use "Rack::Insight::App"
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :ip_masks   => [IPAddr.new("2.2.2.2/0")]
+
+Restrict access using a password:
+
+    ActionController::Dispatcher.middleware.use "Rack::Insight::App",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :password   => "yourpassword"
+
+#### custom file path for the logging database ####
+
+Logical Rack::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 "Rack::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
+------
+Rack::Insight owes a lot to both LogicalInsight and Rack::Bug, as the basis projects.  There's a lot of smart
+in there.  Many thanks to Evan, Judson, and Bryan for building them.
+
+Inspiration for Rack::Bug is primarily from the Django debug toolbar.
+Additional ideas from Rails footnotes, Rack's ShowException middleware, Oink,
+and Rack::Cache
+
+License
+-------
+
+See LICENSE.txt in this directory.
+
+Notes
+-----
+
+Legacy files: would like to re-include them, but they need work
+
+    lib/insight/views/panels/mongo.html.erb
+    lib/insight/panels/mongo_panel/mongo_extension.rb
+    lib/insight/panels/mongo_panel/stats.rb
+    lib/insight/panels/mongo_panel.rb
+
+    lib/insight/views/panels/sphinx.html.erb
+    lib/insight/panels/sphinx_panel/stats.rb
+    lib/insight/panels/sphinx_panel.rb
+
+This one is mostly just a curiosity
+    lib/insight/panels/speedtracer_panel/profiling.rb

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/TODO

@@ -0,0 +1,7 @@
+Speedtracer Resymbolization: seems like it would be possible to get Speedtracer to pull up the Ruby code that was slow... ????
+
+Speedtracer call tagging: right now we just say "everything is either HTTP or METHOD" - maybe more accurate tagging would be useful.
+
+Config: panels in required files automatically turned on - explicit exclude?
+
+Config: Explore other parts that may benefit from a config option.

data/lib/rack-insight.rb

@@ -0,0 +1 @@
+require 'rack/insight'

data/lib/rack/insight.rb

@@ -0,0 +1,19 @@
+require 'rack/insight/app'
+
+module Rack
+  module Insight
+    class << self
+      def enable
+        Thread.current["rack-insight.enabled"] = true
+      end
+
+      def disable
+        Thread.current["rack-insight.enabled"] = false
+      end
+
+      def enabled?
+        Thread.current["rack-insight.enabled"] == true
+      end
+    end
+  end
+end