ruby-prof 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 998f8b9ded9813ff8861c7a4fb23aaf5bd71ce92
-  data.tar.gz: a72b21161e6538935337a6321361449592663a66
+  metadata.gz: 94e9eba05612bbd737798359bcf898e176123b9d
+  data.tar.gz: 6847861b3f77dc3fb2debd860d5c7ea98c9ffd5d
 SHA512:
-  metadata.gz: 61004f65fda9b55bc3eb68ade93060c5ae1d074215c44b94500517ea18704c7b40942d705cdd07b0bdc3a830e8ea3a3ff47af43873057769f8dcc3ecfddf4d38
-  data.tar.gz: 06208b57ce6d33668f5210a5c19869e0e434ab9933ce657b455adea1d8167868439976fbdb76dcf9da157f774c7744af786324405bfe85202475d7b7d6fb07ff
+  metadata.gz: e36f147192ce9457a88baeaec6c28702d33fd1316307697d720b1f1531eefc85362a27b715b806aa41e8dce76aeeb994583a5078f14c554c234905eea8cfd338
+  data.tar.gz: fea5bf49e7b6d00ac22d54d5f7852dab1726e88595a3e188e8352934f82e66e97f9780e811bfc073e52c3fba256693a0d9cb34892356b9cf048216001ba1b6c3

data/CHANGES

@@ -1,3 +1,18 @@
+0.17.0 (2017-12-17)
+=====================
+* Changed method/class names produced by the callgrind printer to be more kcachegrind
+  friendly (thx to Nelson Gauthier and Ben Hughes, see https://github.com/ruby-prof/ruby-prof/pull/200).
+* Recursive instances of a method call are now dtected during profiling (thx to Nelson Gauthier and
+  Ben Hughes, see https://github.com/ruby-prof/ruby-prof/pull/201).
+* Methods can now be ignored during a profiling run instead of eliminating them
+  after a profile run, which has been deprecated (thx to Nelson Gauthier and Ben Hughes,
+  see https://github.com/ruby-prof/ruby-prof/pull/202).
+* Use RUBY_PROF_EDITOR_URI=emacs to open source code links in the one true editor.
+  (thx Alexander Egorov, see https://github.com/ruby-prof/ruby-prof/pull/183 and
+  https://github.com/typester/emacs-handler).
+* Fixed that calling profile.stop would stop profiling all active profiling runs.
+* Fixed that remembering parent call frame pointer before stack reallocation could cause a segfault.
+
 0.16.2 (2016-08-25)
 =====================
 * fixed incorrect setting of RUBY_VERSION macro

data/README.rdoc

@@ -48,7 +48,7 @@ line, via its convenience API or via its core API.
 
 The first is to use ruby-prof to run the Ruby program you want to
 profile.  For more information refer to the documentation of the
-ruby-prof command.
+ruby-prof command: `$ ruby-prof -h.`
 
 
 === ruby-prof Convenience API
@@ -153,7 +153,7 @@ RubyProf::Profile#profile::
    as RubyProf::Profile.new.
 
 
-== Method Elimination
+== Method Elimination (Deprecated)
 
 ruby-prof supports eliminating specific methods and threads from
 profiling results. This is useful for reducing connectivity in the
@@ -180,6 +180,27 @@ After eliminating methods the resulting profile will appear exactly as if those
 had been inlined at their call sites.
 
 
+== Method Exclusion
+
+ruby-prof supports exluding methods from profiling. The effect on
+collected metrics are identical to eliminating methods from the
+profiling result in a prost process step. The interface is slightly
+different though:
+
+    profile = RubyProf.new(...)
+    profile.exclude_methods!(Integer, :times, ...)
+    profile.start
+
+A convenience method is provided to exclude a large number of methods
+which usually clutter up profiles:
+
+    profile.exclude_common_methods!
+
+However, this is a somewhat opinionated method collection. It's
+usually better to view it as an inspiration instead of using it
+directly (see https://github.com/ruby-prof/ruby-prof/blob/e087b7d7ca11eecf1717d95a5c5fea1e36ea3136/lib/ruby-prof/profile/exclude_common_methods.rb).
+
+
 == Profiling Rails
 
 To profile a Rails application it is vital to run it using production like
@@ -295,7 +316,7 @@ RubyProf::CallStackPrinter::
 RubyProf::MultiPrinter::
   Uses the other printers to create several reports in one profiling run
 
-To use a printer:
+Most printers are used in the following way:
 
     result = RubyProf.stop
     printer = RubyProf::GraphPrinter.new(result)
@@ -311,12 +332,15 @@ documentation for the different printers.
 The other option is <tt>:print_file => true</tt> (default false),
 which adds the filename to the output (GraphPrinter only).
 
-<tt>MultiPrinter</tt> differs from the other printers in that it
-requires a directory path and a basename for the files it produces.
+<tt>MultiPrinter</tt> and <tt>CallTreePrinter</tt>differ from the
+other printers in that they require a directory path and a profile
+basename for the files they produce:
 
     printer = RubyProf::MultiPrinter.new(result)
     printer.print(:path => ".", :profile => "profile")
 
+The values given in the example above are the defaults.
+
 == Measurements
 
 Depending on the mode and platform, ruby-prof can measure various
@@ -435,6 +459,13 @@ profiled.  Most programs will run approximately twice as slow
 while highly recursive programs (like the fibonacci series test)
 will run three times slower.
 
+== Editing links
+
+Use <tt>RUBY_PROF_EDITOR_URI</tt> environment variable to open source
+code files in your favorite text editor. For example,
+<tt>RUBY_PROF_EDITOR_URI=atm</tt> will produce links for Atom text
+editor.
+
 == License
 
 See LICENSE for license information.

data/bin/ruby-prof

@@ -250,9 +250,14 @@ module RubyProf
 
       self.option_parser.parse! ARGV
 
-      if options.printer == RubyProf::MultiPrinter
+      if options.printer.needs_dir?
         options.file ||= "."
         options.old_wd ||= Dir.pwd
+        if !File.directory?(options.file)
+          puts "'#{options.file}' is not a directory"
+          puts "#{options.printer} needs an existing directory path to put profiles under."
+          exit(-1)
+        end
       end
     rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument => e
       puts self.option_parser
@@ -322,7 +327,7 @@ at_exit {
   if cmd.options.file
     # write it relative to the dir they *started* in, as it's a bit surprising to write it in the dir they end up in.
     Dir.chdir(cmd.options.old_wd) do
-      if printer.is_a?(RubyProf::MultiPrinter)
+      if printer.class.needs_dir?
         printer.print(printer_options.merge(:path => cmd.options.file))
       else
         File.open(cmd.options.file, 'w') do |file|

data/doc/LICENSE.html

@@ -8,6 +8,7 @@
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
 </script>
 
 <script src="./js/jquery.js"></script>
@@ -108,7 +109,7 @@ DAMAGE.</p>
 
 <footer id="validator-badges" role="contentinfo">
   <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>
 

data/doc/README_rdoc.html

@@ -8,6 +8,7 @@
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
 </script>
 
 <script src="./js/jquery.js"></script>
@@ -63,7 +64,8 @@
     <li><a href="#label-ruby-prof+Executable">ruby-prof Executable</a>
     <li><a href="#label-ruby-prof+Convenience+API">ruby-prof Convenience API</a>
     <li><a href="#label-Profiling+Selected+Threads+-28Core+API-29">Profiling Selected Threads (Core API)</a>
-    <li><a href="#label-Method+Elimination">Method Elimination</a>
+    <li><a href="#label-Method+Elimination+-28Deprecated-29">Method Elimination (Deprecated)</a>
+    <li><a href="#label-Method+Exclusion">Method Exclusion</a>
     <li><a href="#label-Profiling+Rails">Profiling Rails</a>
     <li><a href="#label-Reports">Reports</a>
     <li><a href="#label-Printers">Printers</a>
@@ -72,6 +74,7 @@
     <li><a href="#label-Measure+modes">Measure modes</a>
     <li><a href="#label-Multi-threaded+Applications">Multi-threaded Applications</a>
     <li><a href="#label-Performance">Performance</a>
+    <li><a href="#label-Editing+links">Editing links</a>
     <li><a href="#label-License">License</a>
     <li><a href="#label-API+Documentation">API Documentation</a>
     <li><a href="#label-Development">Development</a>
@@ -169,7 +172,8 @@ via its convenience API or via its core API.</p>
 <h3 id="label-ruby-prof+Executable">ruby-prof Executable<span><a href="#label-ruby-prof+Executable">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
 <p>The first is to use ruby-prof to run the Ruby program you want to profile. 
-For more information refer to the documentation of the ruby-prof command.</p>
+For more information refer to the documentation of the ruby-prof command:
+`$ ruby-prof -h.`</p>
 
 <h3 id="label-ruby-prof+Convenience+API">ruby-prof Convenience API<span><a href="#label-ruby-prof+Convenience+API">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
@@ -273,13 +277,13 @@ profiles.</p>
 </dd><dt><a href="RubyProf/Profile.html#method-i-stop">RubyProf::Profile#stop</a>
 <dd>
 <p>Stop profiling and return self</p>
-</dd><dt>RubyProf::Profile#profile
+</dd><dt><a href="RubyProf/Profile.html#method-i-profile">RubyProf::Profile#profile</a>
 <dd>
 <p>Perform a profile run and return result. Accepts the same arguments as <a
 href="RubyProf/Profile.html#method-c-new">RubyProf::Profile.new</a>.</p>
 </dd></dl>
 
-<h2 id="label-Method+Elimination">Method Elimination<span><a href="#label-Method+Elimination">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<h2 id="label-Method+Elimination+-28Deprecated-29">Method Elimination (Deprecated)<span><a href="#label-Method+Elimination+-28Deprecated-29">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>ruby-prof supports eliminating specific methods and threads from profiling
 results. This is useful for reducing connectivity in the call graph, making
@@ -306,6 +310,26 @@ expressions (line separated text).</p>
 <p>After eliminating methods the resulting profile will appear exactly as if
 those methods had been inlined at their call sites.</p>
 
+<h2 id="label-Method+Exclusion">Method Exclusion<span><a href="#label-Method+Exclusion">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>ruby-prof supports exluding methods from profiling. The effect on collected
+metrics are identical to eliminating methods from the profiling result in a
+prost process step. The interface is slightly different though:</p>
+
+<pre>profile = RubyProf.new(...)
+profile.exclude_methods!(Integer, :times, ...)
+profile.start</pre>
+
+<p>A convenience method is provided to exclude a large number of methods which
+usually clutter up profiles:</p>
+
+<pre class="ruby"><span class="ruby-identifier">profile</span>.<span class="ruby-identifier">exclude_common_methods!</span>
+</pre>
+
+<p>However, this is a somewhat opinionated method collection. It&#39;s usually
+better to view it as an inspiration instead of using it directly (see <a
+href="https://github.com/ruby-prof/ruby-prof/blob/e087b7d7ca11eecf1717d95a5c5fea1e36ea3136/lib/ruby-prof/profile/exclude_common_methods.rb">github.com/ruby-prof/ruby-prof/blob/e087b7d7ca11eecf1717d95a5c5fea1e36ea3136/lib/ruby-prof/profile/exclude_common_methods.rb</a>).</p>
+
 <h2 id="label-Profiling+Rails">Profiling Rails<span><a href="#label-Profiling+Rails">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>To profile a Rails application it is vital to run it using production like
@@ -431,7 +455,7 @@ converted to an image</p>
 <p>Uses the other printers to create several reports in one profiling run</p>
 </dd></dl>
 
-<p>To use a printer:</p>
+<p>Most printers are used in the following way:</p>
 
 <pre class="ruby"><span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
 <span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
@@ -447,13 +471,16 @@ the different printers.</p>
 <p>The other option is <code>:print_file =&gt; true</code> (default false),
 which adds the filename to the output (GraphPrinter only).</p>
 
-<p><code>MultiPrinter</code> differs from the other printers in that it
-requires a directory path and a basename for the files it produces.</p>
+<p><code>MultiPrinter</code> and <code>CallTreePrinter</code>differ from the
+other printers in that they require a directory path and a profile basename
+for the files they produce:</p>
 
 <pre class="ruby"><span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MultiPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
 <span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(:<span class="ruby-identifier">path</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;.&quot;</span>, :<span class="ruby-identifier">profile</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;profile&quot;</span>)
 </pre>
 
+<p>The values given in the example above are the defaults.</p>
+
 <h2 id="label-Measurements">Measurements<span><a href="#label-Measurements">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>Depending on the mode and platform, ruby-prof can measure various aspects
@@ -570,6 +597,13 @@ profiling code varies considerably with the code being profiled.  Most
 programs will run approximately twice as slow while highly recursive
 programs (like the fibonacci series test) will run three times slower.</p>
 
+<h2 id="label-Editing+links">Editing links<span><a href="#label-Editing+links">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Use <code>RUBY_PROF_EDITOR_URI</code> environment variable to open source
+code files in your favorite text editor. For example,
+<code>RUBY_PROF_EDITOR_URI=atm</code> will produce links for Atom text
+editor.</p>
+
 <h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>See <a href="LICENSE.html">LICENSE</a> for license information.</p>
@@ -597,7 +631,7 @@ or open a github issue.</p>
 
 <footer id="validator-badges" role="contentinfo">
   <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>
 

data/doc/Rack.html

@@ -8,6 +8,7 @@
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
 </script>
 
 <script src="./js/jquery.js"></script>
@@ -89,7 +90,7 @@
 
 <footer id="validator-badges" role="contentinfo">
   <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>
 

data/doc/Rack/RubyProf.html

@@ -8,6 +8,7 @@
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
 </script>
 
 <script src="../js/jquery.js"></script>
@@ -130,19 +131,18 @@
             <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 5</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">options</span> = {})
   <span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</span>
-  <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
-  <span class="ruby-ivar">@options</span>[<span class="ruby-value">:min_percent</span>] <span class="ruby-operator">||=</span> <span class="ruby-value">1</span>
 
-  <span class="ruby-ivar">@tmpdir</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:path</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-ivar">@tmpdir</span>)
+  <span class="ruby-identifier">options</span>[<span class="ruby-value">:min_percent</span>] <span class="ruby-operator">||=</span> <span class="ruby-value">1</span>
 
-  <span class="ruby-ivar">@printer_klasses</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-value">:printers</span>]  <span class="ruby-operator">||</span> {<span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">FlatPrinter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;flat.txt&#39;</span>,
-                                              <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;graph.txt&#39;</span>,
-                                              <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphHtmlPrinter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;graph.html&#39;</span>,
-                                              <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CallStackPrinter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;call_stack.html&#39;</span>}
+  <span class="ruby-identifier">options</span>[<span class="ruby-value">:path</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
+  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:path</span>])
 
   <span class="ruby-ivar">@skip_paths</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:skip_paths</span>] <span class="ruby-operator">||</span> [<span class="ruby-regexp">%r{^/assets}</span>, <span class="ruby-regexp">%r{\.(css|js|png|jpeg|jpg|gif)$}</span>]
   <span class="ruby-ivar">@only_paths</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:only_paths</span>]
+
+  <span class="ruby-ivar">@max_requests</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:max_requests</span>]
+
+  <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
           
@@ -181,23 +181,30 @@
 
           
           <div class="method-source-code" id="call-source">
-            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 22</span>
+            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 21</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
   <span class="ruby-identifier">request</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">env</span>)
 
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">should_profile?</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">path</span>)
+    <span class="ruby-identifier">profiler</span>.<span class="ruby-identifier">resume</span>
     <span class="ruby-keyword">begin</span>
-      <span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
-      <span class="ruby-identifier">data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">Profile</span>.<span class="ruby-identifier">profile</span>(<span class="ruby-identifier">profiling_options</span>) <span class="ruby-keyword">do</span>
-        <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
-      <span class="ruby-keyword">end</span>
+      <span class="ruby-identifier">result</span> = <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
+    <span class="ruby-keyword">ensure</span>
+      <span class="ruby-identifier">profiler</span>.<span class="ruby-identifier">pause</span>
+    <span class="ruby-keyword">end</span>
 
-      <span class="ruby-identifier">path</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">&#39;/&#39;</span>, <span class="ruby-string">&#39;-&#39;</span>)
-      <span class="ruby-identifier">path</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span>)
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">profiler</span>.<span class="ruby-identifier">max_requests_reached?</span>
+      <span class="ruby-identifier">prefix</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">aggregate_requests?</span>
+          <span class="ruby-keyword">nil</span>
+        <span class="ruby-keyword">else</span>
+          <span class="ruby-identifier">request</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">&#39;/&#39;</span>, <span class="ruby-string">&#39;-&#39;</span>)[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
+        <span class="ruby-keyword">end</span>
 
-      <span class="ruby-identifier">print</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">path</span>)
-      <span class="ruby-identifier">result</span>
+      <span class="ruby-identifier">profiler</span>.<span class="ruby-identifier">print!</span>(<span class="ruby-identifier">prefix</span>)
+      <span class="ruby-identifier">delete_profiler!</span>
     <span class="ruby-keyword">end</span>
+
+    <span class="ruby-identifier">result</span>
   <span class="ruby-keyword">else</span>
     <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
   <span class="ruby-keyword">end</span>
@@ -220,7 +227,7 @@
 
 <footer id="validator-badges" role="contentinfo">
   <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>
 

data/doc/Rack/RubyProf/RackProfiler.html

@@ -0,0 +1,343 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Rack::RubyProf::RackProfiler - ruby-prof</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../../";
+  var index_rel_prefix = "../../";
+</script>
+
+<script src="../../js/jquery.js"></script>
+<script src="../../js/darkfish.js"></script>
+
+<link href="../../css/fonts.css" rel="stylesheet">
+<link href="../../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../../table_of_contents.html#pages">Pages</a>
+    <a href="../../table_of_contents.html#classes">Classes</a>
+    <a href="../../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">Object
+  
+</div>
+
+    
+    
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    
+    <li ><a href="#method-c-new">::new</a>
+    
+    <li ><a href="#method-i-max_requests_reached-3F">#max_requests_reached?</a>
+    
+    <li ><a href="#method-i-pause">#pause</a>
+    
+    <li ><a href="#method-i-print-21">#print!</a>
+    
+    <li ><a href="#method-i-resume">#resume</a>
+    
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Rack::RubyProf::RackProfiler">
+  <h1 id="class-Rack::RubyProf::RackProfiler" class="class">
+    class Rack::RubyProf::RackProfiler
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(options)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>)
+  <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
+
+  <span class="ruby-ivar">@profile</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">Profile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">profiling_options</span>)
+  <span class="ruby-ivar">@profile</span>.<span class="ruby-identifier">start</span>
+  <span class="ruby-ivar">@profile</span>.<span class="ruby-identifier">pause</span>
+
+  <span class="ruby-ivar">@printer_klasses</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:printers</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">default_printers</span>
+
+  <span class="ruby-ivar">@tmpdir</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:path</span>]
+
+  <span class="ruby-ivar">@max_requests</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:max_requests</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
+  <span class="ruby-ivar">@requests_count</span> = <span class="ruby-value">0</span>
+
+  <span class="ruby-ivar">@printed</span> = <span class="ruby-keyword">false</span>
+  <span class="ruby-comment"># if running across multiple requests, we want to make sure that the</span>
+  <span class="ruby-comment"># ongoing profile is not lost if the process shuts down before the</span>
+  <span class="ruby-comment"># max request count is reached</span>
+  <span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">define_finalizer</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">proc</span> { <span class="ruby-identifier">print!</span> })
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+    
+      <div id="method-i-max_requests_reached-3F" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">max_requests_reached?</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="max_requests_reached-3F-source">
+            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 82</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">max_requests_reached?</span>
+  <span class="ruby-ivar">@requests_count</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@max_requests</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-pause" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">pause</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="pause-source">
+            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 77</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">pause</span>
+  <span class="ruby-ivar">@profile</span>.<span class="ruby-identifier">pause</span>
+  <span class="ruby-ivar">@requests_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-print-21" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">print!</span><span
+            class="method-args">(prefix = nil)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="print-21-source">
+            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 86</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">print!</span>(<span class="ruby-identifier">prefix</span> = <span class="ruby-keyword">nil</span>)
+  <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@printed</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@requests_count</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
+
+  <span class="ruby-identifier">data</span> = <span class="ruby-ivar">@profile</span>.<span class="ruby-identifier">stop</span>
+
+  <span class="ruby-identifier">prefix</span> <span class="ruby-operator">||=</span> <span class="ruby-node">&quot;multi-requests-#{@requests_count}&quot;</span>
+
+  <span class="ruby-ivar">@printer_klasses</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">printer_klass</span>, <span class="ruby-identifier">base_name</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">printer</span> = <span class="ruby-identifier">printer_klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">data</span>)
+
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">base_name</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
+      <span class="ruby-identifier">base_name</span> = <span class="ruby-identifier">base_name</span>.<span class="ruby-identifier">call</span>
+    <span class="ruby-keyword">end</span>
+
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">printer_klass</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MultiPrinter</span>                <span class="ruby-operator">||</span> <span class="ruby-identifier">printer_klass</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CallTreePrinter</span>
+      <span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:profile</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{prefix}-#{base_name}&quot;</span>))
+    <span class="ruby-keyword">else</span>
+      <span class="ruby-identifier">file_name</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@tmpdir</span>, <span class="ruby-node">&quot;#{prefix}-#{base_name}&quot;</span>)
+      <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file_name</span>, <span class="ruby-string">&#39;wb&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">file</span>, <span class="ruby-ivar">@options</span>)
+      <span class="ruby-keyword">end</span>
+    <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">end</span>
+
+  <span class="ruby-ivar">@printed</span> = <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-resume" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">resume</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="resume-source">
+            <pre><span class="ruby-comment"># File lib/ruby-prof/rack.rb, line 73</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">resume</span>
+  <span class="ruby-ivar">@profile</span>.<span class="ruby-identifier">resume</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+