Class: RubyProf::GraphHtmlPrinter

Inherits:
AbstractPrinter show all
Includes:
ERB::Util
Defined in:
lib/ruby-prof/printers/graph_html_printer.rb

Overview

Generates graph profile reports as html. To use the graph html printer:

result = RubyProf.profile do
  [code to profile]
end

printer = RubyProf::GraphHtmlPrinter.new(result)
printer.print(STDOUT, :min_percent=>0)

The Graph printer takes the following options in its print methods:

:filename    - specify a file to use that contains the ERB
               template to use, instead of the built-in self.template

:template    - specify an ERB template to use, instead of the
               built-in self.template

Constant Summary collapse

PERCENTAGE_WIDTH = 
8
TIME_WIDTH = 
10
CALL_WIDTH = 
20

Instance Method Summary collapse

Methods inherited from AbstractPrinter

#initialize, #method_name, #min_percent, #print_file, #print_footer, #print_header, #print_thread, #print_threads, #sort_method

Constructor Details

This class inherits a constructor from RubyProf::AbstractPrinter

Instance Method Details

Creates a link to a method. Note that we do not create links to methods which are under the min_perecent specified by the user, since they will not be printed out.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ruby-prof/printers/graph_html_printer.rb', line 50

def create_link(thread, overall_time, method)
  total_percent = (method.total_time/overall_time) * 100
  if total_percent < min_percent
    # Just return name
    h method.full_name
  else
    href = '#' + method_href(thread, method)
    "<a href=\"#{href}\">#{h method.full_name}</a>"
  end
end

#file_link(path, linenum) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ruby-prof/printers/graph_html_printer.rb', line 65

def file_link(path, linenum)
  srcfile = File.expand_path(path)
  if srcfile =~ /\/ruby_runtime$/
    ""
  else
    if RUBY_PLATFORM =~ /darwin/
      "<a href=\"txmt://open?url=file://#{h srcfile}&line=#{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
    else
      "<a href=\"file://#{h srcfile}##{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
    end
  end
end

#method_href(thread, method) ⇒ Object 



61
62
63
 
# File 'lib/ruby-prof/printers/graph_html_printer.rb', line 61

def method_href(thread, method)
  h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
end

#print(output = STDOUT, options = {}) ⇒ Object 



40
41
42
43
44
 
# File 'lib/ruby-prof/printers/graph_html_printer.rb', line 40

def print(output = STDOUT, options = {})
  @output = output
  setup_options(options)
  @output << @erb.result(binding)
end

#setup_options(options) ⇒ Object 



31
32
33
34
35
36
37
38
 
# File 'lib/ruby-prof/printers/graph_html_printer.rb', line 31

def setup_options(options)
  super(options)

  filename = options[:filename]
  template = filename ? File.read(filename).untaint : (options[:template] || self.template)
  @erb = ERB.new(template, nil, nil)
  @erb.filename = filename
end

#template ⇒ Object 



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/ruby-prof/printers/graph_html_printer.rb', line 78

def template
'
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <style media="all" type="text/css">
table {
  border-collapse: collapse;
  border: 1px solid #CCC;
  font-family: Verdana, Arial, Helvetica, sans-serif;
  font-size: 9pt;
  line-height: normal;
  width: 100%;
}

th {
  text-align: center;
  border-top: 1px solid #FB7A31;
  border-bottom: 1px solid #FB7A31;
  background: #FFC;
  padding: 0.3em;
  border-left: 1px solid silver;
}

tr.break td {
  border: 0;
  border-top: 1px solid #FB7A31;
  padding: 0;
  margin: 0;
}

tr.method td {
  font-weight: bold;
}

td {
  padding: 0.3em;
}

td:first-child {
  width: 190px;
  }

td {
  border-left: 1px solid #CCC;
  text-align: center;
}

.method_name {
  text-align: left;
}

tfoot td {
  text-align: left;
}
  </style>
  </head>
  <body>
<h1>Profile Report: <%= RubyProf.measure_mode_string %></h1>
<!-- Threads Table -->
<table>
  <tr>
    <th>Thread ID</th>
    <th>Fiber ID</th>
    <th>Total Time</th>
  </tr>
  <% for thread in @result.threads %>
  <tr>
    <td><%= thread.id %></td>
    <td><a href="#<%= thread.fiber_id %>"><%= thread.fiber_id %></a></td>
    <td><%= thread.total_time %></td>
  </tr>
  <% end %>
</table>

<!-- Methods Tables -->
<% for thread in @result.threads
     methods = thread.methods
     total_time = thread.total_time %>
  <h2><a name="<%= thread.fiber_id %>">Thread <%= thread.id %>, Fiber: <%= thread.fiber_id %></a></h2>
  <table>
    <thead>
      <tr>
        <th><%= sprintf("%#{PERCENTAGE_WIDTH}s", "%Total") %></th>
        <th><%= sprintf("%#{PERCENTAGE_WIDTH}s", "%Self") %></th>
        <th><%= sprintf("%#{TIME_WIDTH}s", "Total") %></th>
        <th><%= sprintf("%#{TIME_WIDTH}s", "Self") %></th>
        <th><%= sprintf("%#{TIME_WIDTH}s", "Wait") %></th>
        <th><%= sprintf("%#{TIME_WIDTH+2}s", "Child") %></th>
        <th><%= sprintf("%#{CALL_WIDTH}s", "Calls") %></th>
        <th class="method_name">Name</th>
        <th>Line</th>
      </tr>
    </thead>

    <tbody>
      <% min_time = @options[:min_time] || (@options[:nonzero] ? 0.005 : nil)
         methods.sort_by(&sort_method).reverse_each do |method|
           total_percentage = (method.total_time/total_time) * 100

           next if total_percentage < min_percent
           next if min_time && method.total_time < min_time

           self_percentage = (method.self_time/total_time) * 100 %>

           <!-- Parents -->
           <% for caller in method.aggregate_parents.sort_by(&:total_time)
                next unless caller.parent
                next if min_time && caller.total_time < min_time  %>
             <tr>
               <td>&nbsp;</td>
               <td>&nbsp;</td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.total_time) %></td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.self_time) %></td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.wait_time) %></td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", caller.children_time) %></td>
               <% called = "#{caller.called}/#{method.called}" %>
               <td><%= sprintf("%#{CALL_WIDTH}s", called) %></td>
               <td class="method_name"><%= create_link(thread, total_time, caller.parent.target) %></td>
               <td><%= file_link(caller.parent.target.source_file, caller.line) %></td>
             </tr>
           <% end %>

           <tr class="method">
             <td><%= sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", total_percentage) %></td>
             <td><%= sprintf("%#{PERCENTAGE_WIDTH-1}.2f\%", self_percentage) %></td>
             <td><%= sprintf("%#{TIME_WIDTH}.2f", method.total_time) %></td>
             <td><%= sprintf("%#{TIME_WIDTH}.2f", method.self_time) %></td>
             <td><%= sprintf("%#{TIME_WIDTH}.2f", method.wait_time) %></td>
             <td><%= sprintf("%#{TIME_WIDTH}.2f", method.children_time) %></td>
             <td><%= sprintf("%#{CALL_WIDTH}i", method.called) %></td>
             <td class="method_name">
               <a name="<%= method_href(thread, method) %>">
                 <%= method.recursive? ? "*" : " "%><%= h method.full_name %>
               </a>
             </td>
             <td><%= file_link(method.source_file, method.line) %></td>
           </tr>

           <!-- Children -->
           <% method.recalc_recursion unless method.non_recursive? %>
           <% for callee in method.aggregate_children.sort_by(&:total_time).reverse %>
           <%   next if min_time && callee.total_time < min_time  %>
             <tr>
               <td>&nbsp;</td>
               <td>&nbsp;</td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.total_time) %></td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.self_time) %></td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.wait_time) %></td>
               <td><%= sprintf("%#{TIME_WIDTH}.2f", callee.children_time) %></td>
               <% called = "#{callee.called}/#{callee.target.called}" %>
               <td><%= sprintf("%#{CALL_WIDTH}s", called) %></td>
               <td class="method_name"><%= create_link(thread, total_time, callee.target) %></td>
               <td><%= file_link(method.source_file, callee.line) %></td>
             </tr>
           <% end %>
           <!-- Create divider row -->
           <tr class="break"><td colspan="9"></td></tr>
        <% thread.recalc_recursion unless method.non_recursive? %>
      <% end %>
    </tbody>
    <tfoot>
      <tr>
        <td colspan="9">* indicates recursively called methods</td>
      </tr>
    </tfoot>
  </table>
<% end %>
  </body>
</html>'
end