rack-insight 0.5.0

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

@@ -0,0 +1,25 @@
+<div id="request_<%=request_id%>">
+  <% panels.each do |panel| %>
+    <% if panel.has_content? %>
+      <div class="panel_content" id="<%= panel.name %>">
+        <div class="panel_controls">
+          <form action="#">
+            <select id="request_id_menu" name="current_request">
+              <% requests.sort{|l,r| r[:id] <=> l[:id]}.each do |request| %>
+                <option value="<%= request[:id] %>" <%= request[:id] == request_id ? "selected" : "" %>>
+                <%= request[:id] %>: <%= request[:method] %> <%= request[:path] %>
+                </option>
+              <% end %>
+            </select>
+          </form>
+          <a href="" class="rack-insight_close">Close</a>
+        </div>
+        <% begin %>
+          <%=  panel.content_for_request(request_id) %>
+        <% rescue Object => ex %>
+          <%= "Error #{ex.class.name}: #{ex.message} <!-- #{ex.backtrace[0..5]} -->" %>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+</div>

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

@@ -0,0 +1,29 @@
+<script type="text/javascript" charset="utf-8">
+  if (typeof jQuery == 'undefined') {
+    var jquery_url = '/__insight__/jquery-1.3.2.js';
+    document.write(unescape('%3Cscript src="' + jquery_url + '" type="text/javascript"%3E%3C/script%3E'));
+}
+</script>
+<script type="text/javascript" src="/__insight__/jquery.tablesorter.min.js"></script>
+<script type="text/javascript" src="/__insight__/bookmarklet.js"></script>
+<script type="text/javascript" src="/__insight__/insight.js"></script>
+<style type="text/css" media="screen">
+  @import url(/__insight__/insight.css);
+</style>
+<script>
+  $(function($) {
+    $.insight.request_id = <%= request_id %>
+  })
+</script>
+
+<div id="rack-insight" class="rack-insight_top">
+  <div id="rack-insight_toolbar">
+    <ul class="panels">
+      <%= headers_fragment %>
+    </ul>
+  </div>
+
+  <%= request_fragment %>
+
+  <div id="rack-insight_debug_window" class="panel_content"></div>
+</div>

data/rack-insight.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/insight/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-insight}
+  s.version = Rack::Insight::VERSION
+
+  s.authors = ["Peter Boling", "Evan Dorn", "Judson Lester", "Bryan Helmkamp"]
+  s.email = %w{peter.boling@gmail.com evan@lrdesign.com judson@lrdesign.com bryan@brynary.com}
+  s.extra_rdoc_files = [
+    "README.md",
+    "LICENSE",
+    "CHANGELOG"
+  ]
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.homepage      = "https://github.com/pboling/rack-insight"
+  s.summary = %q{Debugging toolbar for Rack applications implemented as
+    middleware.}
+  s.description = %q{Debugging toolbar for Rack applications implemented as
+    middleware.  Based on logical-insight and rack-bug. }
+
+  s.add_runtime_dependency("rack")
+  s.add_runtime_dependency("uuidtools", ">= 2.1.2") # incurs far fewer dependencies that the uuid gem, and no shell forking
+  s.add_runtime_dependency("sqlite3", ">= 1.3.3")
+  s.add_development_dependency "redcarpet"
+  s.add_development_dependency(%q<reek>, [">= 1.2.8"])
+  s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
+  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency "rspec", ">= 2.11.0"
+  s.add_development_dependency "sinatra"
+  s.add_development_dependency "webrat"
+  s.add_development_dependency "ruby-debug19"
+
+
+end

data/spec/fixtures/config.ru

@@ -0,0 +1,8 @@
+require "rubygems"
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require "sample_app"
+
+#Example usage, but moved inside sample app for easier testing
+#use Rack::Bug, :password => "secret"
+run SampleApp

data/spec/fixtures/dummy_panel.rb

@@ -0,0 +1,2 @@
+class DummyPanel < Rack::Insight::Panel
+end

data/spec/fixtures/sample_app.rb

@@ -0,0 +1,72 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+require "sinatra/base"
+require 'logger'
+
+RAILS_ENV = "development" unless defined?(RAILS_ENV)
+log_to = RAILS_ENV == "test" ? StringIO.new : STDOUT
+LOGGER = Logger.new(log_to)
+
+class SampleApp < Sinatra::Base
+  class OneLastThing
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      st,hd,bd = @app.call(env)
+      unless SampleApp.before_returning.nil?
+        SampleApp.before_returning.call
+        SampleApp.before_returning = nil
+      end
+      return st,hd,bd
+    end
+  end
+
+  class << self
+    attr_accessor :insight_app
+    attr_accessor :before_returning
+    def before_return(&block)
+      self.before_returning = block
+    end
+  end
+
+
+
+  use Rack::Insight::App, :log_path => "rack-insight-test.log", :on_initialize => proc {|app|
+    self.insight_app = app
+  }
+  use OneLastThing
+
+  set :environment, 'test'
+
+  configure :test do
+    set :raise_errors, true
+  end
+
+  get "/redirect" do
+    redirect "/"
+  end
+
+  get "/error" do
+    raise "Error!"
+  end
+
+  get "/" do
+    if params[:content_type]
+      headers["Content-Type"] = params[:content_type]
+    end
+    LOGGER.error "I am a log message"
+    <<-HTML
+      <html>
+        <head>
+        </head>
+        <body>
+          <p>Hello</p>
+          <p><a href="__insight__/bookmarklet.html">Page with bookmarklet for enabling Rack::Insight</a></p>
+          <p><a href="/error">Page with an error to check insight not rescuing errors</a></p>
+        </body>
+      </html>
+    HTML
+  end
+
+end

data/spec/fixtures/star_trek_panel.rb

@@ -0,0 +1 @@
+class StarTrekPanel < Rack::Insight::Panel; end

data/spec/insight_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+describe Rack::Insight do
+  before :each do
+    reset_insight
+  end
+
+  it "inserts the Rack::Insight toolbar" do
+    response = get "/"
+    response.should have_selector("div#rack-insight")
+  end
+
+  it "updates the Content-Length" do
+    response = get "/"
+    response["Content-Length"].should == response.body.size.to_s
+  end
+
+  it "serves the Rack::Insight assets under /__insight__/" do
+    response = get "/__insight__/insight.css"
+    response.should be_ok
+  end
+
+  it "modifies HTML responses with a charset" do
+    response = get "/", :content_type => "application/xhtml+xml; charset=utf-8"
+    response.should have_selector("div#rack-insight")
+  end
+
+  it "does not modify XMLHttpRequest responses" do
+    response = get "/", {}, { :xhr => true }
+    response.should_not have_selector("div#rack-insight")
+  end
+
+  it "modifies XHTML responses" do
+    response = get "/", :content_type => "application/xhtml+xml"
+    response.should have_selector("div#rack-insight")
+  end
+
+  it "does not modify non-HTML responses" do
+    response = get "/", :content_type => "text/csv"
+    response.should_not have_selector("div#rack-insight")
+  end
+
+  it "does not modify server errors" do
+    app.disable :raise_errors
+    response = get "/error"
+    app.enable :raise_errors
+    response.should_not have_selector("div#rack-insight")
+  end
+
+  context "redirected when not configured to intercept redirects" do
+    it "passes the redirect unmodified" do
+      response = get "/redirect"
+      response.status.should == 302
+    end
+
+    it "does not show the interception page" do
+      response = get "/redirect"
+      response.body.should_not contain("Location: /")
+    end
+
+    it "does not insert the toolbar" do
+      header 'cookie', ""
+      response = get "/redirect"
+      response.should_not have_selector("div#rack-insight")
+    end
+
+    it "does not insert the toolbar if even toolbar requested" do
+      response = get "/redirect"
+      response.should_not have_selector("div#rack-insight")
+    end
+  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"
+      response.should have_selector("div#rack-insight")
+    end
+
+    it "should provide a link to the target URL" do
+      response = get "/redirect"
+      response.should have_selector("a[href='http://example.org/']")
+    end
+
+    it "inserts the toolbar if requested" do
+      response = get "/redirect"
+      response.should have_selector("div#rack-insight")
+    end
+
+    it "does not inserts the toolbar if not requested" do
+      header 'cookie', ""
+      response = get "/redirect"
+      response.should_not have_selector("div#rack-insight")
+    end
+  end
+
+  context "configured with an IP address restriction" do
+    before do
+      app.insight_app.ip_masks = [IPAddr.new("127.0.0.1/255.255.255.0")]
+    end
+
+    it "inserts the Rack::Insight toolbar when the IP matches" do
+      response = get_via_rack "/", {}, "REMOTE_ADDR" => "127.0.0.2"
+      response.should have_selector("div#rack-insight")
+    end
+
+    it "is disabled when the IP doesn't match" do
+      response = get_via_rack "/", {}, "REMOTE_ADDR" => "128.0.0.1"
+      response.should_not have_selector("div#rack-insight")
+    end
+
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      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
+      app.insight_app.password = "secret"
+    end
+
+    it "should insert the Rack::Insight toolbar when the password matches" do
+      sha = Digest::SHA1.hexdigest ["rack-insight", "secret"].join(":")
+      set_cookie ["rack-insight_enabled=1", "rack-insight_password=#{sha}"]
+      response = get_via_rack "/"
+      response.should have_selector("div#rack-insight")
+    end
+
+    it "should be disabled when the password doesn't match" do
+      response = get_via_rack "/"
+      response.should_not have_selector("div#rack-insight")
+    end
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      app.insight_app.panel_classes = [DummyPanel]
+      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
+      require 'fileutils'
+      FileUtils.rm_rf("my_custom_db_path.sqlite") #because it doesn't count if it's already there
+      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
+      FileUtils.rm_rf("my_custom_db_path.sqlite")
+      reset_insight :database_path => nil
+    end
+
+  end
+end

data/spec/instrumentation_spec.rb

@@ -0,0 +1,188 @@
+require 'rack/insight/instrumentation'
+require 'rack/insight/instrumentation/setup'
+
+class One
+  def initialize(arry)
+    @array = arry
+  end
+
+  def self.record_self(array)
+    array << self
+  end
+
+  def self.a_class_method(array)
+    yield(array)
+  end
+
+  def an_instance_method()
+    yield(@array)
+  end
+end
+
+module Mod
+  def module_method(array)
+    yield(array)
+  end
+end
+
+class Two < One
+  def an_instance_method
+    super
+  end
+
+  def self.a_class_method(array)
+    super
+  end
+end
+
+describe "Setting up probes" do
+  let :method_calls do [] end
+  let :method_subject do [] end
+  let :recording_list do [] end
+
+  let :test_collector do
+    collector = Object.new
+    collector.extend Rack::Insight::Instrumentation::Client
+    collector.instance_variable_set("@calls", method_calls)
+    def collector.after_detect(method_call, timing, arguments, results)
+      @calls << [method_call, timing, arguments, results]
+    end
+    collector
+  end
+
+  let :instrument_setup do
+    Rack::Insight::Instrumentation::Setup.new(nil)
+  end
+
+  let :fake_env do
+    {}
+  end
+
+  before :each do
+    test_collector.probe(test_collector) do
+      instrument "One" do
+        instance_probe :an_instance_method
+        class_probe :a_class_method
+        class_probe :record_self
+        class_probe :allocate
+      end
+    end
+    instrument_setup.setup(fake_env)
+  end
+
+  after :each do
+    instrument_setup.teardown(fake_env, 200, {}, "")
+  end
+
+  # Test cases:
+  #
+  # Methods are called on
+  #   instance
+  #   class
+  #   modules
+  #
+  # Methods are defined/probed at/called on
+  # Called on:
+  #   obj: instance of class C
+  #
+  # Defined:
+  #   class C
+  #   super class B
+  #   class C and parent B (overridden)
+  #   module Mc - included in C
+  #   class C and Mc
+  #   module Mb - included in B
+  #   class C and Mb
+  #   module Me - extended in obj
+  #   Me and C - Me overrides C
+  #
+  # Probed:
+  #   On C
+  #   On B
+  #   On Mc, Mb, Me
+  #
+  # Not interfere with:
+  #   Arguments
+  #   Blocks
+  #   Return Values
+  #   Exceptions
+  #
+
+  it "should catch class methods defined on a superclass" do
+    #expect do
+      One.allocate
+    #end.to change(method_calls.length).by(1)
+    method_calls.last[0].method.should == :allocate
+  end
+
+  it "should not interfere with instance method call on One" do
+    expect do
+      One.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should not interfere with class method call" do
+    expect do
+      One.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should collect calls made on One#an_instance_method" do
+    expect do
+      One.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(1)
+    method_calls.last[0].method.should == :an_instance_method
+  end
+
+  it "should collect calls made on One#a_class_method" do
+    expect do
+      One.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(1)
+    method_calls.last[0].method.should == :a_class_method
+  end
+
+  it "should not mess with receive of class methods" do
+    One.record_self(recording_list)
+    recording_list.should include(One)
+  end
+
+  it "should not mess with receive of class methods on subclasses" do
+    Two.record_self(recording_list)
+    recording_list.should include(Two)
+  end
+
+
+  it "should not interfere with instance method call on Two" do
+    expect do
+      Two.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should not interfere with class method call" do
+    expect do
+      Two.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_subject.length}.by(1)
+  end
+
+  it "should collect calls made on Two#an_instance_method" do
+    expect do
+      Two.new(method_subject).an_instance_method{|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(2)
+    method_calls.each do |method_call|
+      method_call[0].method.should == :an_instance_method
+    end
+
+    method_calls.map{|mc| mc[0].context}.should include("One", "Two")
+  end
+
+  it "should collect calls made on Two#a_class_method" do
+    expect do
+      Two.a_class_method(method_subject){|arr| arr << __LINE__}
+    end.to change{method_calls.length}.by(2)
+    method_calls.each do |method_call|
+      method_call[0].method.should == :a_class_method
+    end
+
+    method_calls.map{|mc| mc[0].context}.should include("One", "Two")
+  end
+end