logical-insight 0.4.0

data/History.txt

@@ -0,0 +1,45 @@
+== HEAD
+
+  * 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/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Bryan Helmkamp
+
+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,123 @@
+Rack::Bug (Logical Reality Design Fork)
+=========
+
+LRDesign fork of Rack::Bug.  We maintain our own fork because the base (by brynary)
+seems focussed on Rails 2, and we want to improve Rails 3 compatibility and add features.
+
+* Repository: [http://github.com/lrdesign/rack-bug](http://github.com/lrdesign/rack-bug)
+
+* Forked From: [http://github.com/brynary/rack-bug](http://github.com/brynary/rack-bug)
+
+Description
+-----------
+
+Rack::Bug adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
+allowing exploration of logging, database queries, template rendering times, etc.
+
+Features
+--------
+
+* Password-based security
+* IP-based security
+* Rack::Bug 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
+        * Sphinx
+    * The API for adding your own panels is simple and powerful
+
+Rails quick start
+---------------------------
+
+    script/plugin install git://github.com/brynary/rack-bug.git
+
+In config/environments/development.rb, add:
+
+    config.middleware.use "Rack::Bug",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
+
+Add the bookmarklet to your browser:
+
+    open http://RAILS_APP/__rack_bug__/bookmarklet.html
+
+Using with non-Rails Rack apps
+------------------------------
+
+Just 'use Rack::Bug' 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/bug"
+
+    ActionController::Dispatcher.middleware.use Rack::Bug,
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :panel_classes => [
+        Rack::Bug::TimerPanel,
+        Rack::Bug::RequestVariablesPanel,
+        Rack::Bug::RedisPanel,
+        Rack::Bug::TemplatesPanel,
+        Rack::Bug::LogPanel,
+        Rack::Bug::MemoryPanel
+      ]
+
+
+Running Rack::Bug in staging or production
+------------------------------------------
+
+We have have found that Rack::Bug 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::Bug"
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :ip_masks   => [IPAddr.new("2.2.2.2/0")]
+
+Restrict access using a password:
+
+    ActionController::Dispatcher.middleware.use "Rack::Bug",
+      :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
+      :password   => "yourpassword"
+
+
+Authors
+-------
+
+- Maintained by [Evan Dorn](mailto:bryan@brynary.com)
+- Contributions from Luke Melia, Joey Aghion, Tim Connor, and more
+
+Thanks
+------
+Inspiration for Rack::Bug is primarily from the Django debug toolbar. Additional ideas from Rails footnotes, Rack's ShowException middleware, Oink, and Rack::Cache
+
+Thanks to Weplay.com for supporting the development of Rack::Bug
+
+Development
+-----------
+For development, you'll need to install the following gems: rspec, rack-test, webrat, sinatra
+
+License
+-------
+
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'corundum'
+require 'corundum/tasklibs'
+
+module Corundum
+  tk = Toolkit.new do |tk|
+  end
+
+  tk.in_namespace do
+    sanity = GemspecSanity.new(tk)
+    rspec = RSpec.new(tk)
+    cov = SimpleCov.new(tk, rspec) do |cov|
+      cov.threshold = 90
+    end
+    gem = GemBuilding.new(tk)
+    cutter = GemCutter.new(tk,gem)
+    email = Email.new(tk)
+    vc = Git.new(tk) do |vc|
+      vc.branch = "master"
+    end
+    task tk.finished_files.build => vc["is_checked_in"]
+    docs = YARDoc.new(tk)
+  end
+end
+

data/Thorfile

@@ -0,0 +1,113 @@
+module GemHelpers
+
+  def generate_gemspec
+    $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
+    require "rack/bug"
+
+    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  = "TODO"
+      s.rubyforge_project = "rack-bug"
+
+      require "git"
+      repo = Git.open(".")
+
+      s.files      = normalize_files(repo.ls_files.keys - repo.lib.ignored_files)
+      s.test_files = normalize_files(Dir['spec/**/*.rb'] - repo.lib.ignored_files)
+
+      s.has_rdoc = true
+      s.extra_rdoc_files = %w[README.md MIT-LICENSE.txt]
+
+      s.add_dependency "rack", ">= 1.0"
+      s.add_development_dependency "webrat"
+      s.add_development_dependency "rspec"
+      s.add_development_dependency "sinatra"
+      s.add_development_dependency "git"
+    end
+  end
+
+  def normalize_files(array)
+    # only keep files, no directories, and sort
+    array.select do |path|
+      File.file?(path)
+    end.sort
+  end
+
+  # Adds extra space when outputting an array. This helps create better version
+  # control diffs, because otherwise it is all on the same line.
+  def prettyify_array(gemspec_ruby, array_name)
+    gemspec_ruby.gsub(/s\.#{array_name.to_s} = \[.+?\]/) do |match|
+      leadin, files = match[0..-2].split("[")
+      leadin + "[\n    #{files.split(",").join(",\n   ")}\n  ]"
+    end
+  end
+
+  def read_gemspec
+    @read_gemspec ||= eval(File.read("rack-bug.gemspec"))
+  end
+
+  def sh(command)
+    puts command
+    system command
+  end
+end
+
+class Default < Thor
+  include GemHelpers
+
+  desc "gemspec", "Regenerate rack-bug.gemspec"
+  def gemspec
+    File.open("rack-bug.gemspec", "w") do |file|
+      gemspec_ruby = generate_gemspec.to_ruby
+      gemspec_ruby = prettyify_array(gemspec_ruby, :files)
+      gemspec_ruby = prettyify_array(gemspec_ruby, :test_files)
+      gemspec_ruby = prettyify_array(gemspec_ruby, :extra_rdoc_files)
+
+      file.write gemspec_ruby
+    end
+
+    puts "Wrote gemspec to rack-bug.gemspec"
+    read_gemspec.validate
+  end
+
+  desc "build", "Build a rack-bug gem"
+  def build
+    sh "gem build rack-bug.gemspec"
+    FileUtils.mkdir_p "pkg"
+    FileUtils.mv read_gemspec.file_name, "pkg"
+  end
+
+  desc "install", "Install the latest built gem"
+  def install
+    sh "gem install --local pkg/#{read_gemspec.file_name}"
+  end
+
+  desc "release", "Release the current branch to GitHub and Gemcutter"
+  def release
+    gemspec
+    build
+    Release.new.tag
+    Release.new.gem
+  end
+end
+
+class Release < Thor
+  include GemHelpers
+
+  desc "tag", "Tag the gem on the origin server"
+  def tag
+    release_tag = "v#{read_gemspec.version}"
+    sh "git tag -a #{release_tag} -m 'Tagging #{release_tag}'"
+    sh "git push origin #{release_tag}"
+  end
+
+  desc "gem", "Push the gem to Gemcutter"
+  def gem
+    sh "gem push pkg/#{read_gemspec.file_name}"
+  end
+end

data/lib/insight.rb

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

data/lib/insight/app.rb

@@ -0,0 +1,189 @@
+require "rack"
+require "digest/sha1"
+require "insight/filtered_backtrace"
+require "insight/options"
+require "insight/logger"
+require "insight/panel"
+require "insight/panel_app"
+require "insight/params_signature"
+require "insight/rack_static_bug_avoider"
+require "insight/redirect_interceptor"
+require "insight/render"
+require "insight/toolbar"
+require "insight/enable-button"
+require 'insight/logger'
+require 'insight/request-recorder'
+require 'insight/instrumentation/setup'
+require 'insight/panels-content'
+require 'insight/panels-header'
+
+module Insight
+  class App
+    include Options
+    INSIGHT_ROOT = "/__insight__"
+    INSIGHT_REGEX = %r{^#{INSIGHT_ROOT}}
+
+    VERSION = "0.3.1"
+
+    class SecurityError < StandardError
+    end
+
+    def initialize(app, options = {}, &block)
+      initialize_options options
+      @base_app = app
+      @panels = []
+      instance_eval(&block) if block_given?
+
+      @logger = Logger.new(read_option(:log_level), read_option(:log_path))
+      Thread.current['insight.logger'] = @logger
+      build_normal_stack
+      build_debug_stack
+      if options[:on_initialize]
+        options[:on_initialize].call(self)
+      end
+    end
+    attr_reader :logger
+    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
+
+      if insight_active?
+        Insight.enable
+        env["insight.panels"] = []
+        result = @debug_stack.call(env)
+        result
+      else
+        @normal_stack.call(env)
+      end
+    end
+
+
+    def reset(new_options=nil)
+      initialize_options(new_options)
+
+      Insight::Instrumentation::ClassProbe::all_probes.each do |probe|
+        probe.clear_collectors
+      end
+      Insight::Instrumentation::InstanceProbe::all_probes.each do |probe|
+        probe.clear_collectors
+      end
+      Insight::Instrumentation::PackageDefinition.clear_collectors
+
+      build_debug_stack
+    end
+
+    private
+
+    def insight_active?
+      return (toolbar_requested? && ip_authorized? && password_authorized?)
+    end
+
+    def build_normal_stack
+      builder = Rack::Builder.new
+      builder.use EnableButton, self
+      builder.run Rack::Cascade.new([ asset_mapped(Rack::Builder.new), @base_app ])
+      @normal_stack = builder.to_app
+    end
+
+    def build_debug_stack
+      @panels.clear
+      builder = Rack::Builder.new
+      builder.use Toolbar, self
+      builder.run Rack::Cascade.new([panel_mappings, collection_stack(@base_app)])
+      @debug_stack = builder.to_app
+    end
+
+    def panel_mappings
+      classes = read_option(:panel_classes)
+      root = INSIGHT_ROOT
+      insight = self
+      builder = Rack::Builder.new do
+        classes.each do |panel_class|
+          panel_class.panel_mappings.each do |path, app|
+            map [root, path].join("/") do
+              run app
+            end
+          end
+        end
+        map root + "/panels_content" do
+          run PanelsContent.new(insight)
+        end
+        map root + "/panels_header" do
+          run PanelsHeader.new(insight)
+        end
+      end
+      return asset_mapped(builder)
+    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
+      end
+    end
+
+    def asset_mapped(builder)
+      path = public_path
+      builder.map INSIGHT_ROOT do
+        run Rack::File.new(path)
+      end
+      builder.to_app
+    end
+
+    def public_path
+      ::File.expand_path("../../insight/public/__insight__", __FILE__)
+    end
+
+    def toolbar_requested?
+      @original_request.cookies["insight_enabled"]
+    end
+
+    def ip_authorized?
+      return true unless options["insight.ip_masks"]
+
+      logger.debug{ "Checking #{@original_request.ip} against ip_masks" }
+      ip = IPAddr.new(@original_request.ip)
+
+      mask = options["insight.ip_masks"].find do |ip_mask|
+        ip_mask.include?(ip)
+      end
+      if mask
+        logger.debug{ "Matched #{mask}" }
+        return true
+      else
+        logger.debug{ "Matched no masks" }
+        return false
+      end
+    end
+
+    def password_authorized?
+      return true unless options["insight.password"]
+
+      logger.debug{"Checking password"}
+
+      expected_sha = Digest::SHA1.hexdigest ["insight", options["insight.password"]].join(":")
+      actual_sha = @original_request.cookies["insight_password"]
+
+      logger.debug{"Password result: #{actual_sha == expected_sha}"}
+      actual_sha == expected_sha
+    end
+  end
+end