ghazel-rack-bug 0.3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. data/.gitignore +3 -0
  2. data/History.txt +45 -0
  3. data/MIT-LICENSE.txt +19 -0
  4. data/README.md +118 -0
  5. data/Rakefile +23 -0
  6. data/Thorfile +113 -0
  7. data/lib/rack/bug.rb +83 -0
  8. data/lib/rack/bug/autoloading.rb +24 -0
  9. data/lib/rack/bug/filtered_backtrace.rb +38 -0
  10. data/lib/rack/bug/options.rb +89 -0
  11. data/lib/rack/bug/panel.rb +50 -0
  12. data/lib/rack/bug/panel_app.rb +33 -0
  13. data/lib/rack/bug/panels/active_record_panel.rb +45 -0
  14. data/lib/rack/bug/panels/active_record_panel/activerecord_extensions.rb +18 -0
  15. data/lib/rack/bug/panels/cache_panel.rb +51 -0
  16. data/lib/rack/bug/panels/cache_panel/dalli_extension.rb +16 -0
  17. data/lib/rack/bug/panels/cache_panel/memcache_extension.rb +129 -0
  18. data/lib/rack/bug/panels/cache_panel/panel_app.rb +48 -0
  19. data/lib/rack/bug/panels/cache_panel/stats.rb +97 -0
  20. data/lib/rack/bug/panels/log_panel.rb +56 -0
  21. data/lib/rack/bug/panels/log_panel/logger_extension.rb +24 -0
  22. data/lib/rack/bug/panels/memory_panel.rb +27 -0
  23. data/lib/rack/bug/panels/rails_info_panel.rb +23 -0
  24. data/lib/rack/bug/panels/redis_panel.rb +44 -0
  25. data/lib/rack/bug/panels/redis_panel/redis_extension.rb +28 -0
  26. data/lib/rack/bug/panels/redis_panel/stats.rb +52 -0
  27. data/lib/rack/bug/panels/request_variables_panel.rb +52 -0
  28. data/lib/rack/bug/panels/sphinx_panel.rb +44 -0
  29. data/lib/rack/bug/panels/sphinx_panel/sphinx_extension.rb +25 -0
  30. data/lib/rack/bug/panels/sphinx_panel/stats.rb +96 -0
  31. data/lib/rack/bug/panels/sql_panel.rb +55 -0
  32. data/lib/rack/bug/panels/sql_panel/panel_app.rb +37 -0
  33. data/lib/rack/bug/panels/sql_panel/query.rb +63 -0
  34. data/lib/rack/bug/panels/sql_panel/sql_extension.rb +11 -0
  35. data/lib/rack/bug/panels/templates_panel.rb +44 -0
  36. data/lib/rack/bug/panels/templates_panel/actionview_extension.rb +12 -0
  37. data/lib/rack/bug/panels/templates_panel/rendering.rb +67 -0
  38. data/lib/rack/bug/panels/templates_panel/trace.rb +34 -0
  39. data/lib/rack/bug/panels/timer_panel.rb +40 -0
  40. data/lib/rack/bug/params_signature.rb +63 -0
  41. data/lib/rack/bug/public/__rack_bug__/bookmarklet.html +10 -0
  42. data/lib/rack/bug/public/__rack_bug__/bookmarklet.js +217 -0
  43. data/lib/rack/bug/public/__rack_bug__/bug.css +216 -0
  44. data/lib/rack/bug/public/__rack_bug__/bug.js +84 -0
  45. data/lib/rack/bug/public/__rack_bug__/jquery-1.3.2.js +4376 -0
  46. data/lib/rack/bug/public/__rack_bug__/jquery.tablesorter.min.js +1 -0
  47. data/lib/rack/bug/public/__rack_bug__/spinner.gif +0 -0
  48. data/lib/rack/bug/rack_static_bug_avoider.rb +16 -0
  49. data/lib/rack/bug/redirect_interceptor.rb +27 -0
  50. data/lib/rack/bug/render.rb +66 -0
  51. data/lib/rack/bug/toolbar.rb +66 -0
  52. data/lib/rack/bug/views/error.html.erb +16 -0
  53. data/lib/rack/bug/views/panels/active_record.html.erb +17 -0
  54. data/lib/rack/bug/views/panels/cache.html.erb +93 -0
  55. data/lib/rack/bug/views/panels/execute_sql.html.erb +32 -0
  56. data/lib/rack/bug/views/panels/explain_sql.html.erb +32 -0
  57. data/lib/rack/bug/views/panels/log.html.erb +21 -0
  58. data/lib/rack/bug/views/panels/profile_sql.html.erb +32 -0
  59. data/lib/rack/bug/views/panels/rails_info.html.erb +19 -0
  60. data/lib/rack/bug/views/panels/redis.html.erb +46 -0
  61. data/lib/rack/bug/views/panels/request_variables.html.erb +29 -0
  62. data/lib/rack/bug/views/panels/sphinx.html.erb +32 -0
  63. data/lib/rack/bug/views/panels/sql.html.erb +43 -0
  64. data/lib/rack/bug/views/panels/templates.html.erb +7 -0
  65. data/lib/rack/bug/views/panels/timer.html.erb +19 -0
  66. data/lib/rack/bug/views/panels/view_cache.html.erb +19 -0
  67. data/lib/rack/bug/views/redirect.html.erb +16 -0
  68. data/lib/rack/bug/views/toolbar.html.erb +42 -0
  69. data/rack-bug.gemspec +147 -0
  70. data/spec/fixtures/config.ru +8 -0
  71. data/spec/fixtures/dummy_panel.rb +2 -0
  72. data/spec/fixtures/sample_app.rb +46 -0
  73. data/spec/rack/bug/panels/active_record_panel_spec.rb +30 -0
  74. data/spec/rack/bug/panels/cache_panel_spec.rb +167 -0
  75. data/spec/rack/bug/panels/log_panel_spec.rb +43 -0
  76. data/spec/rack/bug/panels/memory_panel_spec.rb +22 -0
  77. data/spec/rack/bug/panels/rails_info_panel_spec.rb +40 -0
  78. data/spec/rack/bug/panels/redis_panel_spec.rb +69 -0
  79. data/spec/rack/bug/panels/sql_panel_spec.rb +146 -0
  80. data/spec/rack/bug/panels/templates_panel_spec.rb +71 -0
  81. data/spec/rack/bug/panels/timer_panel_spec.rb +38 -0
  82. data/spec/rack/bug_spec.rb +137 -0
  83. data/spec/rcov.opts +1 -0
  84. data/spec/spec.opts +1 -0
  85. data/spec/spec_helper.rb +44 -0
  86. metadata +201 -0
@@ -0,0 +1,89 @@
1
+ class Rack::Bug
2
+
3
+ module Options
4
+ class << self
5
+ private
6
+ def option_accessor(key)
7
+ define_method(key) { || read_option(key) }
8
+ define_method("#{key}=") { |value| write_option(key, value) }
9
+ define_method("#{key}?") { || !! read_option(key) }
10
+ end
11
+ end
12
+
13
+ option_accessor :secret_key
14
+ option_accessor :ip_masks
15
+ option_accessor :password
16
+ option_accessor :panel_classes
17
+ option_accessor :intercept_redirects
18
+
19
+ # The underlying options Hash. During initialization (or outside of a
20
+ # request), this is a default values Hash. During a request, this is the
21
+ # Rack environment Hash. The default values Hash is merged in underneath
22
+ # the Rack environment before each request is processed.
23
+ def options
24
+ @env || @default_options
25
+ end
26
+
27
+ # Set multiple options.
28
+ def options=(hash={})
29
+ hash.each { |key,value| write_option(key, value) }
30
+ end
31
+
32
+ # Set an option. When +option+ is a Symbol, it is set in the Rack
33
+ # Environment as "rack-cache.option". When +option+ is a String, it
34
+ # exactly as specified. The +option+ argument may also be a Hash in
35
+ # which case each key/value pair is merged into the environment as if
36
+ # the #set method were called on each.
37
+ def set(option, value=self, &block)
38
+ if block_given?
39
+ write_option option, block
40
+ elsif value == self
41
+ self.options = option.to_hash
42
+ else
43
+ write_option option, value
44
+ end
45
+ end
46
+
47
+ private
48
+
49
+ def read_option(key)
50
+ options[option_name(key)]
51
+ end
52
+
53
+ def write_option(key, value)
54
+ options[option_name(key)] = value
55
+ end
56
+
57
+ def option_name(key)
58
+ case key
59
+ when Symbol ; "rack-bug.#{key}"
60
+ when String ; key
61
+ else raise ArgumentError
62
+ end
63
+ end
64
+
65
+ def initialize_options(options={})
66
+ @default_options = {
67
+ 'rack-bug.ip_masks' => [IPAddr.new("127.0.0.1")],
68
+ 'rack-bug.password' => nil,
69
+ 'rack-bug.verbose' => nil,
70
+ 'rack-bug.secret_key' => nil,
71
+ 'rack-bug.intercept_redirects' => false,
72
+ 'rack-bug.panels' => [],
73
+ 'rack-bug.panel_classes' => [
74
+ RailsInfoPanel,
75
+ TimerPanel,
76
+ RequestVariablesPanel,
77
+ SQLPanel,
78
+ ActiveRecordPanel,
79
+ CachePanel,
80
+ TemplatesPanel,
81
+ LogPanel,
82
+ MemoryPanel
83
+ ]
84
+ }
85
+ self.options = options
86
+ end
87
+
88
+ end
89
+ end
@@ -0,0 +1,50 @@
1
+ require "erb"
2
+
3
+ module Rack
4
+ class Bug
5
+
6
+ # Panels are also Rack middleware
7
+ class Panel
8
+ include Render
9
+ include ERB::Util
10
+
11
+ attr_reader :request
12
+
13
+ def initialize(app)
14
+ if panel_app
15
+ @app = Rack::Cascade.new([panel_app, app])
16
+ else
17
+ @app = app
18
+ end
19
+ end
20
+
21
+ def call(env)
22
+ before(env)
23
+ status, headers, body = @app.call(env)
24
+ @request = Request.new(env)
25
+ after(env, status, headers, body)
26
+ env["rack-bug.panels"] << self
27
+ return [status, headers, body]
28
+ end
29
+
30
+ def panel_app
31
+ nil
32
+ end
33
+
34
+ def has_content?
35
+ true
36
+ end
37
+
38
+ def before(env)
39
+ end
40
+
41
+ def after(env, status, headers, body)
42
+ end
43
+
44
+ def render(template)
45
+ end
46
+
47
+ end
48
+
49
+ end
50
+ end
@@ -0,0 +1,33 @@
1
+ module Rack
2
+ class Bug
3
+
4
+ class PanelApp
5
+ include Rack::Bug::Render
6
+
7
+ attr_reader :request
8
+
9
+ def call(env)
10
+ @request = Rack::Request.new(env)
11
+ dispatch
12
+ end
13
+
14
+ def render_template(*args)
15
+ Rack::Response.new([super]).to_a
16
+ end
17
+
18
+ def params
19
+ @request.GET
20
+ end
21
+
22
+ def not_found
23
+ [404, {}, []]
24
+ end
25
+
26
+ def validate_params
27
+ ParamsSignature.new(request).validate!
28
+ end
29
+
30
+ end
31
+
32
+ end
33
+ end
@@ -0,0 +1,45 @@
1
+ require "rack/bug/panels/active_record_panel/activerecord_extensions"
2
+
3
+ module Rack
4
+ class Bug
5
+
6
+ class ActiveRecordPanel < Panel
7
+
8
+ def self.record(class_name)
9
+ return unless Rack::Bug.enabled?
10
+ records[class_name] += 1
11
+ end
12
+
13
+ def self.reset
14
+ Thread.current["rack.bug.active_records"] = Hash.new { 0 }
15
+ end
16
+
17
+ def self.records
18
+ Thread.current["rack.bug.active_records"] ||= Hash.new { 0 }
19
+ end
20
+
21
+ def self.total
22
+ records.inject(0) do |memo, (key, value)|
23
+ memo + value
24
+ end
25
+ end
26
+
27
+ def name
28
+ "active_record"
29
+ end
30
+
31
+ def heading
32
+ "#{self.class.total} AR Objects"
33
+ end
34
+
35
+ def content
36
+ records = self.class.records.to_a.sort_by { |key, value| value }.reverse
37
+ result = render_template "panels/active_record", :records => records
38
+ self.class.reset
39
+ result
40
+ end
41
+
42
+ end
43
+
44
+ end
45
+ end
@@ -0,0 +1,18 @@
1
+ if defined?(ActiveRecord)
2
+ ActiveRecord::Base.class_eval do
3
+
4
+ if instance_methods.include?("after_initialize")
5
+ def after_initialize_with_rack_bug
6
+ Rack::Bug::ActiveRecordPanel.record(self.class.base_class.name)
7
+ after_initialize_without_rack_bug
8
+ end
9
+
10
+ alias_method_chain :after_initialize, :rack_bug
11
+ else
12
+ def after_initialize
13
+ Rack::Bug::ActiveRecordPanel.record(self.class.base_class.name)
14
+ end
15
+ end
16
+
17
+ end
18
+ end
@@ -0,0 +1,51 @@
1
+ require "rack/bug/panels/cache_panel/memcache_extension"
2
+ require "rack/bug/panels/cache_panel/dalli_extension"
3
+
4
+ module Rack
5
+ class Bug
6
+
7
+ class CachePanel < Panel
8
+ autoload :PanelApp, "rack/bug/panels/cache_panel/panel_app"
9
+ autoload :Stats, "rack/bug/panels/cache_panel/stats"
10
+
11
+ def self.record(method, *keys, &block)
12
+ return block.call unless Rack::Bug.enabled?
13
+
14
+ start_time = Time.now
15
+ result = block.call
16
+ total_time = Time.now - start_time
17
+ hit = result.nil? ? false : true
18
+ stats.record_call(method, total_time * 1_000, hit, *keys)
19
+ return result
20
+ end
21
+
22
+ def self.reset
23
+ Thread.current["rack.bug.cache"] = Stats.new
24
+ end
25
+
26
+ def self.stats
27
+ Thread.current["rack.bug.cache"] ||= Stats.new
28
+ end
29
+
30
+ def panel_app
31
+ PanelApp.new
32
+ end
33
+
34
+ def name
35
+ "cache"
36
+ end
37
+
38
+ def heading
39
+ "Cache: %.2fms (#{self.class.stats.queries.size} calls)" % self.class.stats.time
40
+ end
41
+
42
+ def content
43
+ result = render_template "panels/cache", :stats => self.class.stats
44
+ self.class.reset
45
+ return result
46
+ end
47
+
48
+ end
49
+
50
+ end
51
+ end
@@ -0,0 +1,16 @@
1
+ begin
2
+
3
+ require 'dalli'
4
+
5
+ Dalli::Client.class_eval do
6
+ def perform_with_rack_bug(op, *args)
7
+ Rack::Bug::CachePanel.record(op, args.first) do
8
+ perform_without_rack_bug(op, *args)
9
+ end
10
+ end
11
+
12
+ alias_method_chain :perform, :rack_bug
13
+ end
14
+
15
+ rescue NameError, LoadError
16
+ end
@@ -0,0 +1,129 @@
1
+ if defined?(Memcached)
2
+ Memcached.class_eval do
3
+
4
+ def set_with_rack_bug(key, value, timeout=0, marshal=true)
5
+ Rack::Bug::CachePanel.record(:set, key) do
6
+ set_without_rack_bug(key, value, timeout, marshal)
7
+ end
8
+ end
9
+
10
+ def add_with_rack_bug(key, value, timeout=0, marshal=true)
11
+ Rack::Bug::CachePanel.record(:add, key) do
12
+ add_without_rack_bug(key, value, timeout, marshal)
13
+ end
14
+ end
15
+
16
+ def increment_with_rack_bug(key, offset=1)
17
+ Rack::Bug::CachePanel.record(:incr, key) do
18
+ increment_without_rack_bug(key, offset)
19
+ end
20
+ end
21
+
22
+ def decrement_with_rack_bug(key, offset=1)
23
+ Rack::Bug::CachePanel.record(:decr, key) do
24
+ decrement_without_rack_bug(key, offset)
25
+ end
26
+ end
27
+
28
+ def replace_with_rack_bug(key, value, timeout=0, marshal=true)
29
+ Rack::Bug::CachePanel.record(:replace, key) do
30
+ replace_without_rack_bug(key, value, timeout, marshal)
31
+ end
32
+ end
33
+
34
+ def append_with_rack_bug(key, value)
35
+ Rack::Bug::CachePanel.record(:append, key) do
36
+ append_without_rack_bug(key, value)
37
+ end
38
+ end
39
+
40
+ def prepend_with_rack_bug(key, value)
41
+ Rack::Bug::CachePanel.record(:prepend, key) do
42
+ prepend_without_rack_bug(key, value)
43
+ end
44
+ end
45
+
46
+ def delete_with_rack_bug(key)
47
+ Rack::Bug::CachePanel.record(:delete, key) do
48
+ delete_without_rack_bug(key)
49
+ end
50
+ end
51
+
52
+ def get_with_rack_bug(keys, marshal=true)
53
+ if keys.is_a? Array
54
+ Rack::Bug::CachePanel.record(:get_multi, *keys) do
55
+ get_without_rack_bug(keys, marshal)
56
+ end
57
+ else
58
+ Rack::Bug::CachePanel.record(:get, keys) do
59
+ get_without_rack_bug(keys, marshal)
60
+ end
61
+ end
62
+ end
63
+
64
+ alias_method_chain :decrement, :rack_bug
65
+ alias_method_chain :get, :rack_bug
66
+ alias_method_chain :increment, :rack_bug
67
+ alias_method_chain :set, :rack_bug
68
+ alias_method_chain :add, :rack_bug
69
+ alias_method_chain :replace, :rack_bug
70
+ alias_method_chain :delete, :rack_bug
71
+ alias_method_chain :prepend, :rack_bug
72
+ alias_method_chain :append, :rack_bug
73
+ end
74
+ end
75
+
76
+ if defined?(MemCache)
77
+ MemCache.class_eval do
78
+
79
+ def decr_with_rack_bug(key, amount = 1)
80
+ Rack::Bug::CachePanel.record(:decr, key) do
81
+ decr_without_rack_bug(key, amount)
82
+ end
83
+ end
84
+
85
+ def get_with_rack_bug(key, raw = false)
86
+ Rack::Bug::CachePanel.record(:get, key) do
87
+ get_without_rack_bug(key, raw)
88
+ end
89
+ end
90
+
91
+ def get_multi_with_rack_bug(*keys)
92
+ Rack::Bug::CachePanel.record(:get_multi, *keys) do
93
+ get_multi_without_rack_bug(*keys)
94
+ end
95
+ end
96
+
97
+ def incr_with_rack_bug(key, amount = 1)
98
+ Rack::Bug::CachePanel.record(:incr, key) do
99
+ incr_without_rack_bug(key, amount)
100
+ end
101
+ end
102
+
103
+ def set_with_rack_bug(key, value, expiry = 0, raw = false)
104
+ Rack::Bug::CachePanel.record(:set, key) do
105
+ set_without_rack_bug(key, value, expiry, raw)
106
+ end
107
+ end
108
+
109
+ def add_with_rack_bug(key, value, expiry = 0, raw = false)
110
+ Rack::Bug::CachePanel.record(:add, key) do
111
+ add_without_rack_bug(key, value, expiry, raw)
112
+ end
113
+ end
114
+
115
+ def delete_with_rack_bug(key, expiry = 0)
116
+ Rack::Bug::CachePanel.record(:delete, key) do
117
+ delete_without_rack_bug(key, expiry)
118
+ end
119
+ end
120
+
121
+ alias_method_chain :decr, :rack_bug
122
+ alias_method_chain :get, :rack_bug
123
+ alias_method_chain :get_multi, :rack_bug
124
+ alias_method_chain :incr, :rack_bug
125
+ alias_method_chain :set, :rack_bug
126
+ alias_method_chain :add, :rack_bug
127
+ alias_method_chain :delete, :rack_bug
128
+ end
129
+ end
@@ -0,0 +1,48 @@
1
+ module Rack
2
+ class Bug
3
+ class CachePanel
4
+
5
+ class PanelApp < ::Rack::Bug::PanelApp
6
+
7
+ def dispatch
8
+ case request.path_info
9
+ when "/__rack_bug__/view_cache" then view_cache
10
+ when "/__rack_bug__/delete_cache" then delete_cache
11
+ when "/__rack_bug__/delete_cache_list" then delete_cache_list
12
+ else not_found
13
+ end
14
+ end
15
+
16
+ def ok
17
+ Rack::Response.new(["OK"]).to_a
18
+ end
19
+
20
+ def view_cache
21
+ validate_params
22
+ render_template "panels/view_cache", :key => params["key"], :value => Rails.cache.read(params["key"])
23
+ end
24
+
25
+ def delete_cache
26
+ validate_params
27
+ raise "Rails not found... can't delete key" unless defined?(Rails)
28
+ Rails.cache.delete(params["key"])
29
+ ok
30
+ end
31
+
32
+ def delete_cache_list
33
+ validate_params
34
+ raise "Rails not found... can't delete key" unless defined?(Rails)
35
+
36
+ params.each do |key, value|
37
+ next unless key =~ /^keys_/
38
+ Rails.cache.delete(value)
39
+ end
40
+
41
+ ok
42
+ end
43
+
44
+ end
45
+
46
+ end
47
+ end
48
+ end