1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
module Peek
module Views
class View
def initialize(options = {})
@options = options
parse_options
setup_subscribers
end
# Where any subclasses should pick and pull from @options to set any and
# all instance variables they like.
#
# Returns nothing.
def parse_options
# pass
end
# Conditionally enable views based on any gathered data. Helpful
# if you don't want views to show up when they return 0 or are
# touched during the request.
#
# Returns true.
def enabled?
true
end
# The path to the partial that will be rendered to the Peek bar.
#
# Examples:
#
# Peek::Views::PerformanceBar.partial_path => "peek/views/performance_bar"
# CustomResque.partial_path => "performance_bar"
#
# Returns String.
def partial_path
self.class.to_s.underscore
end
# The defer key that is derived from the classname.
#
# Examples:
#
# Peek::Views::PerformanceBar => "performance-bar"
# Peek::Views::Resque => "resque"
#
# Returns String.
def key
self.class.to_s.split('::').last.underscore.gsub(/\_/, '-')
end
alias defer_key key
# The context id that is derived from the classname.
#
# Examples:
#
# Peek::Views::PerformanceBar => "peek-context-performance-bar"
# Peek::Views::Resque => "peek-context-resque"
#
# Returns String.
def context_id
"peek-context-#{key}"
end
# The wrapper ID for the individual view in the Peek bar.
#
# Returns String.
def dom_id
"peek-view-#{key}"
end
# Additional context for any view to render tooltips for.
#
# Returns Hash.
def context
{}
end
def context?
context.any?
end
# The data results that are inserted at the end of the request for use in
# deferred placeholders in the Peek the bar.
#
# Returns Hash.
def results
{}
end
def results?
results.any?
end
def subscribe(*args)
ActiveSupport::Notifications.subscribe(*args) do |name, start, finish, id, payload|
yield name, start, finish, id, payload
end
end
private
def setup_subscribers
# pass
end
# Helper method for subscribing to the event that is fired when new
# requests are made.
def before_request
subscribe 'start_processing.action_controller' do |name, start, finish, id, payload|
yield name, start, finish, id, payload
end
end
# Helper method for subscribing to the event that is fired when requests
# are finished.
def after_request
subscribe 'process_action.action_controller' do |name, start, finish, id, payload|
yield name, start, finish, id, payload
end
end
end
end
end
|
