RubyGems - rack-bug - Versions diffs - 0.2.1 - Mend

rack-bug 0.2.1

Files changed (77) hide show

data/.gitignore +3 -0
data/History.txt +0 -0
data/MIT-LICENSE.txt +19 -0
data/README.rdoc +29 -0
data/Rakefile +36 -0
data/VERSION +1 -0
data/lib/rack/bug.rb +43 -0
data/lib/rack/bug/options.rb +89 -0
data/lib/rack/bug/panel.rb +50 -0
data/lib/rack/bug/panel_app.rb +33 -0
data/lib/rack/bug/panels/active_record_panel.rb +45 -0
data/lib/rack/bug/panels/active_record_panel/activerecord_extensions.rb +18 -0
data/lib/rack/bug/panels/cache_panel.rb +50 -0
data/lib/rack/bug/panels/cache_panel/memcache_extension.rb +129 -0
data/lib/rack/bug/panels/cache_panel/panel_app.rb +48 -0
data/lib/rack/bug/panels/cache_panel/stats.rb +97 -0
data/lib/rack/bug/panels/log_panel.rb +39 -0
data/lib/rack/bug/panels/log_panel/rails_extension.rb +11 -0
data/lib/rack/bug/panels/memory_panel.rb +27 -0
data/lib/rack/bug/panels/rails_info_panel.rb +23 -0
data/lib/rack/bug/panels/redis_panel.rb +44 -0
data/lib/rack/bug/panels/redis_panel/redis_extension.rb +14 -0
data/lib/rack/bug/panels/redis_panel/stats.rb +48 -0
data/lib/rack/bug/panels/request_variables_panel.rb +25 -0
data/lib/rack/bug/panels/sql_panel.rb +55 -0
data/lib/rack/bug/panels/sql_panel/panel_app.rb +37 -0
data/lib/rack/bug/panels/sql_panel/query.rb +73 -0
data/lib/rack/bug/panels/sql_panel/sql_extension.rb +11 -0
data/lib/rack/bug/panels/templates_panel.rb +44 -0
data/lib/rack/bug/panels/templates_panel/actionview_extension.rb +12 -0
data/lib/rack/bug/panels/templates_panel/rendering.rb +67 -0
data/lib/rack/bug/panels/templates_panel/trace.rb +34 -0
data/lib/rack/bug/panels/timer_panel.rb +40 -0
data/lib/rack/bug/params_signature.rb +65 -0
data/lib/rack/bug/public/__rack_bug__/bookmarklet.html +10 -0
data/lib/rack/bug/public/__rack_bug__/bookmarklet.js +215 -0
data/lib/rack/bug/public/__rack_bug__/bug.css +211 -0
data/lib/rack/bug/public/__rack_bug__/bug.js +84 -0
data/lib/rack/bug/public/__rack_bug__/jquery-1.3.2.js +4376 -0
data/lib/rack/bug/public/__rack_bug__/jquery.tablesorter.min.js +1 -0
data/lib/rack/bug/public/__rack_bug__/spinner.gif +0 -0
data/lib/rack/bug/render.rb +66 -0
data/lib/rack/bug/toolbar.rb +137 -0
data/lib/rack/bug/views/error.html.erb +16 -0
data/lib/rack/bug/views/panels/active_record.html.erb +17 -0
data/lib/rack/bug/views/panels/cache.html.erb +93 -0
data/lib/rack/bug/views/panels/execute_sql.html.erb +32 -0
data/lib/rack/bug/views/panels/explain_sql.html.erb +32 -0
data/lib/rack/bug/views/panels/log.html.erb +23 -0
data/lib/rack/bug/views/panels/profile_sql.html.erb +32 -0
data/lib/rack/bug/views/panels/rails_info.html.erb +19 -0
data/lib/rack/bug/views/panels/redis.html.erb +32 -0
data/lib/rack/bug/views/panels/request_variables.html.erb +107 -0
data/lib/rack/bug/views/panels/sql.html.erb +43 -0
data/lib/rack/bug/views/panels/templates.html.erb +7 -0
data/lib/rack/bug/views/panels/timer.html.erb +19 -0
data/lib/rack/bug/views/panels/view_cache.html.erb +19 -0
data/lib/rack/bug/views/redirect.html.erb +16 -0
data/lib/rack/bug/views/toolbar.html.erb +42 -0
data/rack-bug.gemspec +126 -0
data/spec/fixtures/config.ru +8 -0
data/spec/fixtures/dummy_panel.rb +2 -0
data/spec/fixtures/sample_app.rb +29 -0
data/spec/rack/bug/panels/active_record_panel_spec.rb +30 -0
data/spec/rack/bug/panels/cache_panel_spec.rb +159 -0
data/spec/rack/bug/panels/log_panel_spec.rb +25 -0
data/spec/rack/bug/panels/memory_panel_spec.rb +21 -0
data/spec/rack/bug/panels/rails_info_panel_spec.rb +25 -0
data/spec/rack/bug/panels/redis_panel_spec.rb +57 -0
data/spec/rack/bug/panels/sql_panel_spec.rb +136 -0
data/spec/rack/bug/panels/templates_panel_spec.rb +71 -0
data/spec/rack/bug/panels/timer_panel_spec.rb +38 -0
data/spec/rack/toolbar_spec.rb +100 -0
data/spec/rcov.opts +1 -0
data/spec/spec.opts +1 -0
data/spec/spec_helper.rb +70 -0
metadata +143 -0

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

data/spec/fixtures/sample_app.rb ADDED

@@ -0,0 +1,29 @@
+require "sinatra/base"
+class SampleApp < Sinatra::Default
+  get "/redirect" do
+    redirect "/"
+  end
+  get "/error" do
+    raise "Error!"
+  end
+  get "/" do
+    if params[:content_type]
+      headers["Content-Type"] = params[:content_type]
+    end
+    <<-HTML
+      <html>
+        <head>
+        </head>
+        <body>
+          <p>Hello</p>
+        </body>
+      </html>
+    HTML
+  end
+end

data/spec/rack/bug/panels/active_record_panel_spec.rb ADDED

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+module Rack::Bug
+  describe ActiveRecordPanel do
+    before do
+      ActiveRecordPanel.reset
+      header "rack-bug.panel_classes", [ActiveRecordPanel]
+    end
+    describe "heading" do
+      it "displays the total number of instantiated AR objects" do
+        ActiveRecordPanel.record("User")
+        ActiveRecordPanel.record("Group")
+        response = get "/"
+        response.should have_heading("2 AR Objects")
+      end
+    end
+    describe "content" do
+      it "displays the count of instantiated objects for each class" do
+        ActiveRecordPanel.record("User")
+        ActiveRecordPanel.record("User")
+        ActiveRecordPanel.record("Group")
+        response = get "/"
+        response.should have_row("#active_record", "User", "2")
+        response.should have_row("#active_record", "Group", "1")
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/cache_panel_spec.rb ADDED

@@ -0,0 +1,159 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+module Rack::Bug
+  describe CachePanel do
+    before do
+      CachePanel.reset
+      header "rack-bug.panel_classes", [CachePanel]
+    end
+    describe "heading" do
+      it "displays the total memcache time" do
+        response = get "/"
+        response.should have_heading("Cache: 0.00ms")
+      end
+    end
+    describe "content" do
+      describe "usage table" do
+        it "displays the total number of memcache calls" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          # This causes a bus error:
+          # response.should have_selector("th:content('Total Calls') + td", :content => "1")
+          response.should have_row("#cache_usage", "Total Calls", "1")
+        end
+        it "displays the total memcache time" do
+          response = get "/"
+          response.should have_row("#cache_usage", "Total Time", "0.00ms")
+        end
+        it "dispays the number of memcache hits" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_usage", "Hits", "0")
+        end
+        it "displays the number of memcache misses" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_usage", "Misses", "1")
+        end
+        it "displays the number of memcache gets" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_usage", "gets", "1")
+        end
+        it "displays the number of memcache sets" do
+          CachePanel.record(:set, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_usage", "sets", "1")
+        end
+        it "displays the number of memcache deletes" do
+          CachePanel.record(:delete, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_usage", "deletes", "1")
+        end
+        it "displays the number of memcache get_multis" do
+          CachePanel.record(:get_multi, "user:1", "user:2") { }
+          response = get "/"
+          response.should have_row("#cache_usage", "get_multis", "1")
+        end
+      end
+      describe "breakdown" do
+        it "displays each memcache operation" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_breakdown", "get")
+        end
+        it "displays the time for each memcache call" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_breakdown", "user:1", TIME_MS_REGEXP)
+        end
+        it "displays the keys for each memcache call" do
+          CachePanel.record(:get, "user:1") { }
+          response = get "/"
+          response.should have_row("#cache_breakdown", "user:1", "get")
+        end
+      end
+    end
+    describe "expire_all" do
+      before do
+        header "rack-bug.secret_key", 'abc'
+      end
+      it "expires the cache keys" do
+        Rails.stub!(:cache => mock("cache"))
+        Rails.cache.should_receive(:delete).with("user:1")
+        Rails.cache.should_receive(:delete).with("user:2")
+        Rails.cache.should_receive(:delete).with("user:3")
+        Rails.cache.should_receive(:delete).with("user:4")
+        get "/__rack_bug__/delete_cache_list",
+          :keys_1 => "user:1", :keys_2 => "user:2", :keys_3 => "user:3", :keys_4 => "user:4",
+          :hash => "c367b76e0199c308862a3afd8fba32b8715e7976"
+      end
+      it "returns OK" do
+        Rails.stub!(:cache => mock("cache", :delete => nil))
+        response = get "/__rack_bug__/delete_cache_list",
+          :keys_1 => "user:1", :keys_2 => "user:2", :keys_3 => "user:3", :keys_4 => "user:4",
+          :hash => "c367b76e0199c308862a3afd8fba32b8715e7976"
+        response.should contain("OK")
+      end
+    end
+    describe "expire" do
+      before do
+        header "rack-bug.secret_key", 'abc'
+      end
+      it "expires the cache key" do
+        Rails.stub!(:cache => mock("cache"))
+        Rails.cache.should_receive(:delete).with("user:1")
+        get "/__rack_bug__/delete_cache", :key => "user:1",
+          :hash => "f87215442d312d8e42cf51e6b66fc3eb3d59ac74"
+      end
+      it "returns OK" do
+        Rails.stub!(:cache => mock("cache", :delete => nil))
+        response = get "/__rack_bug__/delete_cache", :key => "user:1",
+          :hash => "f87215442d312d8e42cf51e6b66fc3eb3d59ac74"
+        response.should contain("OK")
+      end
+    end
+    describe "view_cache" do
+      before do
+        header "rack-bug.secret_key", 'abc'
+      end
+      it "renders the cache key" do
+        Rails.stub!(:cache => mock("cache", :read => "cache body"))
+        response = get "/__rack_bug__/view_cache", :key => "user:1",
+          :hash => "f87215442d312d8e42cf51e6b66fc3eb3d59ac74"
+        response.should contain("cache body")
+      end
+      it "renders non-String cache values properly" do
+        Rails.stub!(:cache => mock("cache", :read => [1, 2]))
+        response = get "/__rack_bug__/view_cache", :key => "user:1",
+          :hash => "f87215442d312d8e42cf51e6b66fc3eb3d59ac74"
+        response.should contain("[1, 2]")
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/log_panel_spec.rb ADDED

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+module Rack::Bug
+  describe LogPanel do
+    before do
+      LogPanel.reset
+      header "rack-bug.panel_classes", [LogPanel]
+    end
+    describe "heading" do
+      it "displays 'Log'" do
+        response = get "/"
+        response.should have_heading("Log")
+      end
+    end
+    describe "content" do
+      it "displays recorded log lines" do
+        LogPanel.record("This is a logged message")
+        response = get "/"
+        response.should contain("This is a logged message")
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/memory_panel_spec.rb ADDED

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+module Rack::Bug
+  describe MemoryPanel do
+    before do
+      header "rack-bug.panel_classes", [MemoryPanel]
+    end
+    describe "heading" do
+      it "displays the total memory" do
+        response = get "/"
+        response.should have_heading(/\d+ KB total/)
+      end
+      it "displays the memory change during the request" do
+        response = get "/"
+        response.should have_heading(/\d+ KB Δ/)
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/rails_info_panel_spec.rb ADDED

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+module Rack::Bug
+  describe RailsInfoPanel do
+    before do
+      header "rack-bug.panel_classes", [RailsInfoPanel]
+    end
+    describe "heading" do
+      it "displays the Rails version" do
+        Rails.stub!(:version => "v2.3.0")
+        response = get "/"
+        response.should have_heading("Rails v2.3.0")
+      end
+    end
+    describe "content" do
+      it "displays the Rails::Info properties" do
+        Rails::Info.stub!(:properties => [["Name", "Value"]])
+        response = get "/"
+        response.should have_row("#rails_info", "Name", "Value")
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/redis_panel_spec.rb ADDED

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+$LOADED_FEATURES << "redis.rb" #avoid dependency on redis
+module Rack::Bug
+  describe RedisPanel do
+    before do
+      RedisPanel.reset
+      header "rack-bug.panel_classes", [RedisPanel]
+    end
+    describe "heading" do
+      it "displays the total redis time" do
+        response = get "/"
+        response.should have_heading("Redis: 0.00ms")
+      end
+    end
+    describe "content" do
+      describe "usage table" do
+        it "displays the total number of redis calls" do
+          RedisPanel.record(["get, user:1"]) { }
+          response = get "/"
+          # This causes a bus error:
+          # response.should have_selector("th:content('Total Calls') + td", :content => "1")
+          response.should have_row("#redis_usage", "Total Calls", "1")
+        end
+        it "displays the total redis time" do
+          response = get "/"
+          response.should have_row("#redis_usage", "Total Time", "0.00ms")
+        end
+      end
+      describe "breakdown" do
+        it "displays each redis operation" do
+          RedisPanel.record(["get, user:1"]) { }
+          response = get "/"
+          response.should have_row("#redis_breakdown", "get")
+        end
+        it "displays the time for redis call" do
+          RedisPanel.record(["get, user:1"]) { }
+          response = get "/"
+          response.should have_row("#redis_breakdown", "user:1", TIME_MS_REGEXP)
+        end
+        it "displays the arguments for each redis call" do
+          RedisPanel.record(["get, user:1"]) { }
+          response = get "/"
+          response.should have_row("#redis_breakdown", "user:1", "get")
+        end
+      end
+    end
+  end
+end

data/spec/rack/bug/panels/sql_panel_spec.rb ADDED

@@ -0,0 +1,136 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+module Rack::Bug
+  describe SQLPanel do
+    before do
+      SQLPanel.reset
+      header "rack-bug.panel_classes", [SQLPanel]
+    end
+    describe "heading" do
+      it "displays the total SQL query count" do
+        SQLPanel.record("SELECT NOW();") { }
+        response = get "/"
+        response.should have_heading("1 Queries")
+      end
+      it "displays the total SQL time" do
+        SQLPanel.record("SELECT NOW();") { }
+        response = get "/"
+        response.should have_heading(/Queries \(\d+\.\d{2}ms\)/)
+      end
+    end
+    describe "content" do
+      it "displays each executed SQL query" do
+        SQLPanel.record("SELECT NOW();") { }
+        response = get "/"
+        response.should have_row("#sql", "SELECT NOW();")
+      end
+      it "displays the time of each executed SQL query" do
+        SQLPanel.record("SELECT NOW();") { }
+        response = get "/"
+        response.should have_row("#sql", "SELECT NOW();", TIME_MS_REGEXP)
+      end
+    end
+    def stub_result(results = [[]])
+      columns = results.first
+      fields = columns.map { |c| stub("field", :name => c) }
+      rows = results[1..-1]
+      result = stub("result", :fetch_fields => fields)
+      result.stub!(:each).and_yield(*rows)
+      return result
+    end
+    def expect_query(sql, results)
+      conn = stub("connection")
+      ActiveRecord::Base.stub!(:connection => conn)
+      conn.should_receive(:execute).with(sql).and_return(stub_result(results))
+    end
+    describe "execute_sql" do
+      it "displays the query results" do
+        header "rack-bug.secret_key", "abc"
+        expect_query "SELECT username FROM users",
+          [["username"],
+           ["bryan"]]
+        response = get "/__rack_bug__/execute_sql", :query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        response.should contain("SELECT username FROM users")
+        response.should be_ok
+      end
+      it "is forbidden when the hash is missing or wrong" do
+        header "rack-bug.secret_key", 'abc'
+        lambda {
+          get "/__rack_bug__/execute_sql", :query => "SELECT username FROM users",
+            :hash => "foobar"
+        }.should raise_error(SecurityError)
+      end
+      it "is not available when the rack-bug.secret_key is nil" do
+        header "rack-bug.secret_key", nil
+        lambda {
+          get "/__rack_bug__/execute_sql", :query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+      it "is not available when the rack-bug.secret_key is an empty string" do
+        header "rack-bug.secret_key", ""
+        lambda {
+          get "/__rack_bug__/execute_sql", :query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+    end
+    describe "explain_sql" do
+      it "displays the query explain plan" do
+        header "rack-bug.secret_key", "abc"
+        expect_query "EXPLAIN SELECT username FROM users",
+          [["table"],
+           ["users"]]
+        response = get "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+          :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        response.should contain("SELECT username FROM users")
+        response.should be_ok
+      end
+      it "is forbidden when the hash is missing or wrong" do
+        header "rack-bug.secret_key", 'abc'
+        lambda {
+          get "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+            :hash => "foobar"
+        }.should raise_error(SecurityError)
+      end
+      it "is not available when the rack-bug.secret_key is nil" do
+        header "rack-bug.secret_key", nil
+        lambda {
+          get "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+      it "is not available when the rack-bug.secret_key is an empty string" do
+        header "rack-bug.secret_key", ""
+        lambda {
+          get "/__rack_bug__/explain_sql", :query => "SELECT username FROM users",
+            :hash => "6f286f55b75716e5c91f16d77d09fa73b353ebc1"
+        }.should raise_error(SecurityError)
+      end
+    end
+  end
+end