ruby-prof 0.15.4 → 0.15.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES +7 -1
  3. data/README.rdoc +1 -1
  4. data/bin/ruby-prof +16 -4
  5. data/doc/LICENSE.html +114 -0
  6. data/doc/README_rdoc.html +592 -0
  7. data/doc/Rack.html +95 -0
  8. data/doc/Rack/RubyProf.html +264 -0
  9. data/doc/RubyProf.html +962 -0
  10. data/doc/RubyProf/AbstractPrinter.html +546 -0
  11. data/doc/RubyProf/AggregateCallInfo.html +537 -0
  12. data/doc/RubyProf/CallInfo.html +468 -0
  13. data/doc/RubyProf/CallInfoPrinter.html +120 -0
  14. data/doc/RubyProf/CallInfoVisitor.html +200 -0
  15. data/doc/RubyProf/CallStackPrinter.html +1604 -0
  16. data/doc/RubyProf/CallTreePrinter.html +359 -0
  17. data/doc/RubyProf/Cmd.html +631 -0
  18. data/doc/RubyProf/DotPrinter.html +257 -0
  19. data/doc/RubyProf/FlatPrinter.html +163 -0
  20. data/doc/RubyProf/FlatPrinterWithLineNumbers.html +208 -0
  21. data/doc/RubyProf/GraphHtmlPrinter.html +575 -0
  22. data/doc/RubyProf/GraphPrinter.html +139 -0
  23. data/doc/RubyProf/MethodInfo.html +685 -0
  24. data/doc/RubyProf/MultiPrinter.html +358 -0
  25. data/doc/RubyProf/Profile.html +764 -0
  26. data/doc/RubyProf/ProfileTask.html +490 -0
  27. data/doc/RubyProf/Thread.html +199 -0
  28. data/doc/created.rid +14 -14
  29. data/doc/examples/flat_txt.html +149 -0
  30. data/doc/examples/graph_html.html +850 -0
  31. data/doc/examples/graph_txt.html +274 -0
  32. data/doc/images/add.png +0 -0
  33. data/doc/images/arrow_up.png +0 -0
  34. data/doc/images/brick.png +0 -0
  35. data/doc/images/brick_link.png +0 -0
  36. data/doc/images/bug.png +0 -0
  37. data/doc/images/bullet_black.png +0 -0
  38. data/doc/images/bullet_toggle_minus.png +0 -0
  39. data/doc/images/bullet_toggle_plus.png +0 -0
  40. data/doc/images/date.png +0 -0
  41. data/doc/images/delete.png +0 -0
  42. data/doc/images/find.png +0 -0
  43. data/doc/images/macFFBgHack.png +0 -0
  44. data/doc/images/package.png +0 -0
  45. data/doc/images/page_green.png +0 -0
  46. data/doc/images/page_white_text.png +0 -0
  47. data/doc/images/page_white_width.png +0 -0
  48. data/doc/images/plugin.png +0 -0
  49. data/doc/images/ruby.png +0 -0
  50. data/doc/images/tag_blue.png +0 -0
  51. data/doc/images/tag_green.png +0 -0
  52. data/doc/images/transparent.png +0 -0
  53. data/doc/images/wrench.png +0 -0
  54. data/doc/images/wrench_orange.png +0 -0
  55. data/doc/images/zoom.png +0 -0
  56. data/doc/index.html +618 -0
  57. data/doc/js/search_index.js.gz +0 -0
  58. data/doc/table_of_contents.html +859 -0
  59. data/lib/ruby-prof/printers/flat_printer_with_line_numbers.rb +21 -14
  60. data/lib/ruby-prof/printers/graph_printer.rb +1 -0
  61. data/lib/ruby-prof/version.rb +1 -1
  62. data/test/measure_cpu_time_test.rb +1 -1
  63. metadata +54 -2
@@ -0,0 +1,546 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class RubyProf::AbstractPrinter - ruby-prof</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "../";
11
+ </script>
12
+
13
+ <script src="../js/jquery.js"></script>
14
+ <script src="../js/darkfish.js"></script>
15
+
16
+ <link href="../css/fonts.css" rel="stylesheet">
17
+ <link href="../css/rdoc.css" rel="stylesheet">
18
+
19
+
20
+
21
+ <body id="top" role="document" class="class">
22
+ <nav role="navigation">
23
+ <div id="project-navigation">
24
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
25
+ <h2>
26
+ <a href="../index.html" rel="home">Home</a>
27
+ </h2>
28
+
29
+ <div id="table-of-contents-navigation">
30
+ <a href="../table_of_contents.html#pages">Pages</a>
31
+ <a href="../table_of_contents.html#classes">Classes</a>
32
+ <a href="../table_of_contents.html#methods">Methods</a>
33
+ </div>
34
+ </div>
35
+
36
+ <div id="search-section" role="search" class="project-section initially-hidden">
37
+ <form action="#" method="get" accept-charset="utf-8">
38
+ <div id="search-field-wrapper">
39
+ <input id="search-field" role="combobox" aria-label="Search"
40
+ aria-autocomplete="list" aria-controls="search-results"
41
+ type="text" name="search" placeholder="Search" spellcheck="false"
42
+ title="Type to search, Up and Down to navigate, Enter to load">
43
+ </div>
44
+
45
+ <ul id="search-results" aria-label="Search Results"
46
+ aria-busy="false" aria-expanded="false"
47
+ aria-atomic="false" class="initially-hidden"></ul>
48
+ </form>
49
+ </div>
50
+
51
+ </div>
52
+
53
+
54
+
55
+ <div id="class-metadata">
56
+
57
+ <div id="parent-class-section" class="nav-section">
58
+ <h3>Parent</h3>
59
+
60
+
61
+ <p class="link">Object
62
+
63
+ </div>
64
+
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <div id="method-list-section" class="nav-section">
69
+ <h3>Methods</h3>
70
+
71
+ <ul class="link-list" role="directory">
72
+
73
+ <li ><a href="#method-c-new">::new</a>
74
+
75
+ <li ><a href="#method-i-method_name">#method_name</a>
76
+
77
+ <li ><a href="#method-i-min_percent">#min_percent</a>
78
+
79
+ <li ><a href="#method-i-print">#print</a>
80
+
81
+ <li ><a href="#method-i-print_file">#print_file</a>
82
+
83
+ <li ><a href="#method-i-print_footer">#print_footer</a>
84
+
85
+ <li ><a href="#method-i-print_header">#print_header</a>
86
+
87
+ <li ><a href="#method-i-print_thread">#print_thread</a>
88
+
89
+ <li ><a href="#method-i-print_threads">#print_threads</a>
90
+
91
+ <li ><a href="#method-i-setup_options">#setup_options</a>
92
+
93
+ <li ><a href="#method-i-sort_method">#sort_method</a>
94
+
95
+ </ul>
96
+ </div>
97
+
98
+ </div>
99
+ </nav>
100
+
101
+ <main role="main" aria-labelledby="class-RubyProf::AbstractPrinter">
102
+ <h1 id="class-RubyProf::AbstractPrinter" class="class">
103
+ class RubyProf::AbstractPrinter
104
+ </h1>
105
+
106
+ <section class="description">
107
+
108
+ </section>
109
+
110
+
111
+
112
+
113
+ <section id="5Buntitled-5D" class="documentation-section">
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
124
+ <header>
125
+ <h3>Public Class Methods</h3>
126
+ </header>
127
+
128
+
129
+ <div id="method-c-new" class="method-detail ">
130
+
131
+ <div class="method-heading">
132
+ <span class="method-name">new</span><span
133
+ class="method-args">(result)</span>
134
+
135
+ <span class="method-click-advice">click to toggle source</span>
136
+
137
+ </div>
138
+
139
+
140
+ <div class="method-description">
141
+
142
+ <p>Create a new printer.</p>
143
+
144
+ <p>result should be the output generated from a profiling run</p>
145
+
146
+
147
+
148
+
149
+ <div class="method-source-code" id="new-source">
150
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 7</span>
151
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result</span>)
152
+ <span class="ruby-ivar">@result</span> = <span class="ruby-identifier">result</span>
153
+ <span class="ruby-ivar">@output</span> = <span class="ruby-keyword">nil</span>
154
+ <span class="ruby-keyword">end</span></pre>
155
+ </div>
156
+
157
+ </div>
158
+
159
+
160
+
161
+
162
+ </div>
163
+
164
+
165
+ </section>
166
+
167
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
168
+ <header>
169
+ <h3>Public Instance Methods</h3>
170
+ </header>
171
+
172
+
173
+ <div id="method-i-method_name" class="method-detail ">
174
+
175
+ <div class="method-heading">
176
+ <span class="method-name">method_name</span><span
177
+ class="method-args">(method)</span>
178
+
179
+ <span class="method-click-advice">click to toggle source</span>
180
+
181
+ </div>
182
+
183
+
184
+ <div class="method-description">
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <div class="method-source-code" id="method_name-source">
192
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 44</span>
193
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">method_name</span>(<span class="ruby-identifier">method</span>)
194
+ <span class="ruby-identifier">name</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">full_name</span>
195
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">print_file</span>
196
+ <span class="ruby-identifier">name</span> <span class="ruby-operator">+=</span> <span class="ruby-node">&quot; (#{method.source_file}:#{method.line}}&quot;</span>
197
+ <span class="ruby-keyword">end</span>
198
+ <span class="ruby-identifier">name</span>
199
+ <span class="ruby-keyword">end</span></pre>
200
+ </div>
201
+
202
+ </div>
203
+
204
+
205
+
206
+
207
+ </div>
208
+
209
+
210
+ <div id="method-i-min_percent" class="method-detail ">
211
+
212
+ <div class="method-heading">
213
+ <span class="method-name">min_percent</span><span
214
+ class="method-args">()</span>
215
+
216
+ <span class="method-click-advice">click to toggle source</span>
217
+
218
+ </div>
219
+
220
+
221
+ <div class="method-description">
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <div class="method-source-code" id="min_percent-source">
229
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 32</span>
230
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">min_percent</span>
231
+ <span class="ruby-ivar">@options</span>[<span class="ruby-value">:min_percent</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>
232
+ <span class="ruby-keyword">end</span></pre>
233
+ </div>
234
+
235
+ </div>
236
+
237
+
238
+
239
+
240
+ </div>
241
+
242
+
243
+ <div id="method-i-print" class="method-detail ">
244
+
245
+ <div class="method-heading">
246
+ <span class="method-name">print</span><span
247
+ class="method-args">(output = STDOUT, options = {})</span>
248
+
249
+ <span class="method-click-advice">click to toggle source</span>
250
+
251
+ </div>
252
+
253
+
254
+ <div class="method-description">
255
+
256
+ <p>Print a profiling report to the provided output.</p>
257
+
258
+ <p>output - Any IO object, including STDOUT or a file. The default value is
259
+ STDOUT.</p>
260
+
261
+ <p>options - Hash of print options. See <a
262
+ href="AbstractPrinter.html#method-i-setup_options">setup_options</a> for
263
+ more information. Note that each printer can define its own set of
264
+ options.</p>
265
+
266
+
267
+
268
+
269
+ <div class="method-source-code" id="print-source">
270
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 60</span>
271
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print</span>(<span class="ruby-identifier">output</span> = <span class="ruby-constant">STDOUT</span>, <span class="ruby-identifier">options</span> = {})
272
+ <span class="ruby-ivar">@output</span> = <span class="ruby-identifier">output</span>
273
+ <span class="ruby-identifier">setup_options</span>(<span class="ruby-identifier">options</span>)
274
+ <span class="ruby-identifier">print_threads</span>
275
+ <span class="ruby-keyword">end</span></pre>
276
+ </div>
277
+
278
+ </div>
279
+
280
+
281
+
282
+
283
+ </div>
284
+
285
+
286
+ <div id="method-i-print_file" class="method-detail ">
287
+
288
+ <div class="method-heading">
289
+ <span class="method-name">print_file</span><span
290
+ class="method-args">()</span>
291
+
292
+ <span class="method-click-advice">click to toggle source</span>
293
+
294
+ </div>
295
+
296
+
297
+ <div class="method-description">
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <div class="method-source-code" id="print_file-source">
305
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 36</span>
306
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_file</span>
307
+ <span class="ruby-ivar">@options</span>[<span class="ruby-value">:print_file</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>
308
+ <span class="ruby-keyword">end</span></pre>
309
+ </div>
310
+
311
+ </div>
312
+
313
+
314
+
315
+
316
+ </div>
317
+
318
+
319
+ <div id="method-i-print_footer" class="method-detail ">
320
+
321
+ <div class="method-heading">
322
+ <span class="method-name">print_footer</span><span
323
+ class="method-args">(thread)</span>
324
+
325
+ <span class="method-click-advice">click to toggle source</span>
326
+
327
+ </div>
328
+
329
+
330
+ <div class="method-description">
331
+
332
+
333
+
334
+
335
+
336
+
337
+ <div class="method-source-code" id="print_footer-source">
338
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 81</span>
339
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_footer</span>(<span class="ruby-identifier">thread</span>)
340
+ <span class="ruby-keyword">end</span></pre>
341
+ </div>
342
+
343
+ </div>
344
+
345
+
346
+
347
+
348
+ </div>
349
+
350
+
351
+ <div id="method-i-print_header" class="method-detail ">
352
+
353
+ <div class="method-heading">
354
+ <span class="method-name">print_header</span><span
355
+ class="method-args">(thread)</span>
356
+
357
+ <span class="method-click-advice">click to toggle source</span>
358
+
359
+ </div>
360
+
361
+
362
+ <div class="method-description">
363
+
364
+
365
+
366
+
367
+
368
+
369
+ <div class="method-source-code" id="print_header-source">
370
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 78</span>
371
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_header</span>(<span class="ruby-identifier">thread</span>)
372
+ <span class="ruby-keyword">end</span></pre>
373
+ </div>
374
+
375
+ </div>
376
+
377
+
378
+
379
+
380
+ </div>
381
+
382
+
383
+ <div id="method-i-print_thread" class="method-detail ">
384
+
385
+ <div class="method-heading">
386
+ <span class="method-name">print_thread</span><span
387
+ class="method-args">(thread)</span>
388
+
389
+ <span class="method-click-advice">click to toggle source</span>
390
+
391
+ </div>
392
+
393
+
394
+ <div class="method-description">
395
+
396
+
397
+
398
+
399
+
400
+
401
+ <div class="method-source-code" id="print_thread-source">
402
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 72</span>
403
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_thread</span>(<span class="ruby-identifier">thread</span>)
404
+ <span class="ruby-identifier">print_header</span>(<span class="ruby-identifier">thread</span>)
405
+ <span class="ruby-identifier">print_methods</span>(<span class="ruby-identifier">thread</span>)
406
+ <span class="ruby-identifier">print_footer</span>(<span class="ruby-identifier">thread</span>)
407
+ <span class="ruby-keyword">end</span></pre>
408
+ </div>
409
+
410
+ </div>
411
+
412
+
413
+
414
+
415
+ </div>
416
+
417
+
418
+ <div id="method-i-print_threads" class="method-detail ">
419
+
420
+ <div class="method-heading">
421
+ <span class="method-name">print_threads</span><span
422
+ class="method-args">()</span>
423
+
424
+ <span class="method-click-advice">click to toggle source</span>
425
+
426
+ </div>
427
+
428
+
429
+ <div class="method-description">
430
+
431
+
432
+
433
+
434
+
435
+
436
+ <div class="method-source-code" id="print_threads-source">
437
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 66</span>
438
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_threads</span>
439
+ <span class="ruby-ivar">@result</span>.<span class="ruby-identifier">threads</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">thread</span><span class="ruby-operator">|</span>
440
+ <span class="ruby-identifier">print_thread</span>(<span class="ruby-identifier">thread</span>)
441
+ <span class="ruby-keyword">end</span>
442
+ <span class="ruby-keyword">end</span></pre>
443
+ </div>
444
+
445
+ </div>
446
+
447
+
448
+
449
+
450
+ </div>
451
+
452
+
453
+ <div id="method-i-setup_options" class="method-detail ">
454
+
455
+ <div class="method-heading">
456
+ <span class="method-name">setup_options</span><span
457
+ class="method-args">(options = {})</span>
458
+
459
+ <span class="method-click-advice">click to toggle source</span>
460
+
461
+ </div>
462
+
463
+
464
+ <div class="method-description">
465
+
466
+ <p>Specify print options.</p>
467
+
468
+ <p>options - Hash table</p>
469
+
470
+ <pre>:min_percent - Number 0 to 100 that specifes the minimum
471
+ %self (the methods self time divided by the
472
+ overall total time) that a method must take
473
+ for it to be printed out in the report.
474
+ Default value is 0.
475
+
476
+ :print_file - True or false. Specifies if a method&#39;s source
477
+ file should be printed. Default value if false.
478
+
479
+ :sort_method - Specifies method used for sorting method infos.
480
+ Available values are :total_time, :self_time,
481
+ :wait_time, :children_time
482
+ Default value is :total_time</pre>
483
+
484
+
485
+
486
+
487
+ <div class="method-source-code" id="setup_options-source">
488
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 28</span>
489
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">setup_options</span>(<span class="ruby-identifier">options</span> = {})
490
+ <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
491
+ <span class="ruby-keyword">end</span></pre>
492
+ </div>
493
+
494
+ </div>
495
+
496
+
497
+
498
+
499
+ </div>
500
+
501
+
502
+ <div id="method-i-sort_method" class="method-detail ">
503
+
504
+ <div class="method-heading">
505
+ <span class="method-name">sort_method</span><span
506
+ class="method-args">()</span>
507
+
508
+ <span class="method-click-advice">click to toggle source</span>
509
+
510
+ </div>
511
+
512
+
513
+ <div class="method-description">
514
+
515
+
516
+
517
+
518
+
519
+
520
+ <div class="method-source-code" id="sort_method-source">
521
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/abstract_printer.rb, line 40</span>
522
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">sort_method</span>
523
+ <span class="ruby-ivar">@options</span>[<span class="ruby-value">:sort_method</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:total_time</span>
524
+ <span class="ruby-keyword">end</span></pre>
525
+ </div>
526
+
527
+ </div>
528
+
529
+
530
+
531
+
532
+ </div>
533
+
534
+
535
+ </section>
536
+
537
+ </section>
538
+ </main>
539
+
540
+
541
+ <footer id="validator-badges" role="contentinfo">
542
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
543
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
544
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
545
+ </footer>
546
+