rack-bug 0.2.1

data/spec/rack/bug/panels/templates_panel_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Rack::Bug
+  describe TemplatesPanel do
+    before do
+      TemplatesPanel.reset
+      header "rack-bug.panel_classes", [TemplatesPanel]
+    end
+    
+    describe "heading" do
+      it "displays the total rendering time" do
+        response = get "/"
+        response.should have_heading("Templates: 0.00ms")
+      end
+    end
+    
+    describe "content" do
+      it "displays the template paths" do
+        TemplatesPanel.record("users/show") { }
+        response = get "/"
+        response.should contain("users/show")
+      end
+      
+      it "displays the template children" do
+        TemplatesPanel.record("users/show") do
+          TemplatesPanel.record("users/toolbar") { }
+        end
+        
+        response = get "/"
+        response.should have_selector("li", :content => "users/show") do |li|
+          li.should contain("users/toolbar")
+        end
+      end
+      
+      context "for templates that rendered templates" do
+        it "displays the total time" do
+          TemplatesPanel.record("users/show") do
+            TemplatesPanel.record("users/toolbar") { }
+          end
+          
+          response = get "/"
+          response.should have_selector("li", :content => "users/show") do |li|
+            li.should contain(TIME_MS_REGEXP)
+          end
+        end
+        
+        it "displays the exclusive time" do
+          TemplatesPanel.record("users/show") do
+            TemplatesPanel.record("users/toolbar") { }
+          end
+          
+          response = get "/"
+          response.should have_selector("li", :content => "users/show") do |li|
+            li.should contain(/\d\.\d{2} exclusive/)
+          end
+        end
+      end
+      
+      context "for leaf templates" do
+        it "does not display the exclusive time" do
+          TemplatesPanel.record("users/show") { }
+          
+          response = get "/"
+          response.should contain("users/show") do |li|
+            li.should_not contain("exclusive")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/timer_panel_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+module Rack::Bug
+  describe TimerPanel do
+    before do
+      header "rack-bug.panel_classes", [TimerPanel]
+    end
+    
+    describe "heading" do
+      it "displays the elapsed time" do
+        response = get "/"
+        response.should have_heading(TIME_MS_REGEXP)
+      end
+    end
+    
+    describe "content" do
+      it "displays the user CPU time" do
+        response = get "/"
+        response.should have_row("#timer", "User CPU time", TIME_MS_REGEXP)
+      end
+      
+      it "displays the system CPU time" do
+        response = get "/"
+        response.should have_row("#timer", "System CPU time", TIME_MS_REGEXP)
+      end
+      
+      it "displays the total CPU time" do
+        response = get "/"
+        response.should have_row("#timer", "Total CPU time", TIME_MS_REGEXP)
+      end
+      
+      it "displays the elapsed time" do
+        response = get "/"
+        response.should have_row("#timer", "Elapsed time", TIME_MS_REGEXP)
+      end
+    end
+  end
+end

data/spec/rack/toolbar_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Rack::Bug do
+  it "inserts the Rack::Bug toolbar" do
+    response = get "/"
+    response.should have_selector("div#rack_bug")
+  end
+  
+  it "updates the Content-Length" do
+    response = get "/"
+    response["Content-Length"].should == response.body.size.to_s
+  end
+  
+  it "serves the Rack::Bug assets under /__rack_bug__/" do
+    response = get "/__rack_bug__/bug.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_bug")
+  end
+  
+  it "does not modify XMLHttpRequest responses" do
+    response = get "/", {}, { :xhr => true }
+    response.should_not have_selector("div#rack_bug")
+  end
+  
+  it "modifies XHTML responses" do
+    response = get "/", :content_type => "application/xhtml+xml"
+    response.should have_selector("div#rack_bug")
+  end
+  
+  it "does not modify non-HTML responses" do
+    response = get "/", :content_type => "text/csv"
+    response.should_not have_selector("div#rack_bug")
+  end
+
+  it "does not modify redirects" do
+    response = get "/redirect"
+    response.body.should == ""
+  end
+  
+  it "does not modify server errors" do
+    response = get "/error"
+    response.should_not have_selector("div#rack_bug")
+  end
+  
+  context "configured to intercept redirects" do
+    it "inserts the Rack::Bug toolbar for redirects" do
+      response = get "/redirect", {}, "rack-bug.intercept_redirects" => true
+      response.should contain("Location: /")
+    end
+  end
+  
+  context "configured with an IP address restriction" do
+    before do
+      header "rack-bug.ip_masks", [IPAddr.new("127.0.0.1/255.255.255.0")]
+    end
+    
+    it "inserts the Rack::Bug toolbar when the IP matches" do
+      response = get "/", {}, "REMOTE_ADDR" => "127.0.0.2"
+      response.should have_selector("div#rack_bug")
+    end
+    
+    it "is disabled when the IP doesn't match" do
+      response = get "/", {}, "REMOTE_ADDR" => "128.0.0.1"
+      response.should_not have_selector("div#rack_bug")
+    end
+    
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      header "rack-bug.panel_classes", [DummyPanel]
+      get "/", {}, "REMOTE_ADDR" => "128.0.0.1"
+    end
+  end
+  
+  context "configured with a password" do
+    before do
+      header "rack-bug.password", "secret"
+    end
+    
+    it "inserts the Rack::Bug toolbar when the password matches" do
+      sha = "545049d1c5e2a6e0dfefd37f9a9e0beb95241935"
+      response = get "/", {}, :cookie => ["rack_bug_enabled=1", "rack_bug_password=#{sha}"]
+      response.should have_selector("div#rack_bug")
+    end
+    
+    it "is disabled when the password doesn't match" do
+      response = get "/"
+      response.should_not have_selector("div#rack_bug")
+    end
+    
+    it "doesn't use any panels" do
+      DummyPanel.should_not_receive(:new)
+      header "rack-bug.panel_classes", [DummyPanel]
+      get "/"
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+-x gems,spec\/

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+require "rubygems"
+require "spec"
+require "webrat"
+require "rack/test"
+
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+
+require "rack/bug"
+require "spec/fixtures/sample_app"
+require "spec/fixtures/dummy_panel"
+
+module Rails
+  def self.version
+    ""
+  end
+  
+  class Info
+    def self.properties
+      []
+    end
+  end
+end
+
+module ActiveRecord
+  class Base
+  end
+end
+
+Spec::Runner.configure do |config|
+  TIME_MS_REGEXP = /\d+\.\d{2}ms/
+  
+  config.include Rack::Test::Methods
+  config.include Webrat::Matchers
+  
+  config.before do
+    # This allows specs to record data outside the request
+    Rack::Bug.enable
+    
+    # Set the cookie that triggers Rack::Bug under normal conditions
+    header :cookie, "rack_bug_enabled=1"
+  end
+  
+  def app
+    Rack::Builder.new do
+      use Rack::Bug
+      run SampleApp.new
+    end
+  end
+  
+  def have_row(container, key, value = nil)
+    simple_matcher("contain row") do |response|
+      if value
+        response.should have_selector("#{container} tr", :content => key) do |row|
+          row.should contain(value)
+        end
+      else
+        response.should have_selector("#{container} tr", :content => key)
+      end
+    end
+  end
+  
+  def have_heading(text)
+    simple_matcher("have heading") do |response|
+      response.should have_selector("#rack_bug_toolbar li") do |heading|
+        heading.should contain(text)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: rack-bug
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Bryan Helmkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-06 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: bryan@brynary.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE.txt
+- README.rdoc
+files: 
+- .gitignore
+- History.txt
+- MIT-LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/bug.rb
+- lib/rack/bug/options.rb
+- lib/rack/bug/panel.rb
+- lib/rack/bug/panel_app.rb
+- lib/rack/bug/panels/active_record_panel.rb
+- lib/rack/bug/panels/active_record_panel/activerecord_extensions.rb
+- lib/rack/bug/panels/cache_panel.rb
+- lib/rack/bug/panels/cache_panel/memcache_extension.rb
+- lib/rack/bug/panels/cache_panel/panel_app.rb
+- lib/rack/bug/panels/cache_panel/stats.rb
+- lib/rack/bug/panels/log_panel.rb
+- lib/rack/bug/panels/log_panel/rails_extension.rb
+- lib/rack/bug/panels/memory_panel.rb
+- lib/rack/bug/panels/rails_info_panel.rb
+- lib/rack/bug/panels/redis_panel.rb
+- lib/rack/bug/panels/redis_panel/redis_extension.rb
+- lib/rack/bug/panels/redis_panel/stats.rb
+- lib/rack/bug/panels/request_variables_panel.rb
+- lib/rack/bug/panels/sql_panel.rb
+- lib/rack/bug/panels/sql_panel/panel_app.rb
+- lib/rack/bug/panels/sql_panel/query.rb
+- lib/rack/bug/panels/sql_panel/sql_extension.rb
+- lib/rack/bug/panels/templates_panel.rb
+- lib/rack/bug/panels/templates_panel/actionview_extension.rb
+- lib/rack/bug/panels/templates_panel/rendering.rb
+- lib/rack/bug/panels/templates_panel/trace.rb
+- lib/rack/bug/panels/timer_panel.rb
+- lib/rack/bug/params_signature.rb
+- lib/rack/bug/public/__rack_bug__/bookmarklet.html
+- lib/rack/bug/public/__rack_bug__/bookmarklet.js
+- lib/rack/bug/public/__rack_bug__/bug.css
+- lib/rack/bug/public/__rack_bug__/bug.js
+- lib/rack/bug/public/__rack_bug__/jquery-1.3.2.js
+- lib/rack/bug/public/__rack_bug__/jquery.tablesorter.min.js
+- lib/rack/bug/public/__rack_bug__/spinner.gif
+- lib/rack/bug/render.rb
+- lib/rack/bug/toolbar.rb
+- lib/rack/bug/views/error.html.erb
+- lib/rack/bug/views/panels/active_record.html.erb
+- lib/rack/bug/views/panels/cache.html.erb
+- lib/rack/bug/views/panels/execute_sql.html.erb
+- lib/rack/bug/views/panels/explain_sql.html.erb
+- lib/rack/bug/views/panels/log.html.erb
+- lib/rack/bug/views/panels/profile_sql.html.erb
+- lib/rack/bug/views/panels/rails_info.html.erb
+- lib/rack/bug/views/panels/redis.html.erb
+- lib/rack/bug/views/panels/request_variables.html.erb
+- lib/rack/bug/views/panels/sql.html.erb
+- lib/rack/bug/views/panels/templates.html.erb
+- lib/rack/bug/views/panels/timer.html.erb
+- lib/rack/bug/views/panels/view_cache.html.erb
+- lib/rack/bug/views/redirect.html.erb
+- lib/rack/bug/views/toolbar.html.erb
+- rack-bug.gemspec
+- spec/fixtures/config.ru
+- spec/fixtures/dummy_panel.rb
+- spec/fixtures/sample_app.rb
+- spec/rack/bug/panels/active_record_panel_spec.rb
+- spec/rack/bug/panels/cache_panel_spec.rb
+- spec/rack/bug/panels/log_panel_spec.rb
+- spec/rack/bug/panels/memory_panel_spec.rb
+- spec/rack/bug/panels/rails_info_panel_spec.rb
+- spec/rack/bug/panels/redis_panel_spec.rb
+- spec/rack/bug/panels/sql_panel_spec.rb
+- spec/rack/bug/panels/templates_panel_spec.rb
+- spec/rack/bug/panels/timer_panel_spec.rb
+- spec/rack/toolbar_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/brynary/rack-bug
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Debugging toolbar for Rack applications implemented as middleware
+test_files: 
+- spec/fixtures/dummy_panel.rb
+- spec/fixtures/sample_app.rb
+- spec/rack/bug/panels/active_record_panel_spec.rb
+- spec/rack/bug/panels/cache_panel_spec.rb
+- spec/rack/bug/panels/log_panel_spec.rb
+- spec/rack/bug/panels/memory_panel_spec.rb
+- spec/rack/bug/panels/rails_info_panel_spec.rb
+- spec/rack/bug/panels/redis_panel_spec.rb
+- spec/rack/bug/panels/sql_panel_spec.rb
+- spec/rack/bug/panels/templates_panel_spec.rb
+- spec/rack/bug/panels/timer_panel_spec.rb
+- spec/rack/toolbar_spec.rb
+- spec/spec_helper.rb