ruby-prof 0.16.2 → 1.1.0

data/lib/ruby-prof/printers/dot_printer.rb

@@ -1,132 +1,132 @@
-# encoding: utf-8
-
-require 'set'
-
-module RubyProf
-  # Generates a graphviz graph in dot format.
-  # To use the dot printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::DotPrinter.new(result)
-  #   printer.print(STDOUT)
-  #
-  # You can use either dot viewer such as GraphViz, or the dot command line tool
-  # to reformat the output into a wide variety of outputs:
-  #
-  #   dot -Tpng graph.dot > graph.png
-  #
-  class DotPrinter < RubyProf::AbstractPrinter
-    CLASS_COLOR = '"#666666"'
-    EDGE_COLOR  = '"#666666"'
-
-    # Creates the DotPrinter using a RubyProf::Proile.
-    def initialize(result)
-      super(result)
-      @seen_methods = Set.new
-    end
-
-    # Print a graph report to the provided output.
-    #
-    # output - Any IO object, including STDOUT or a file. The default value is
-    # STDOUT.
-    #
-    # options - Hash of print options.  See #setup_options
-    # for more information.
-    #
-    # When profiling results that cover a large number of method calls it
-    # helps to use the :min_percent option, for example:
-    #
-    #   DotPrinter.new(result).print(STDOUT, :min_percent=>5)
-    #
-    def print(output = STDOUT, options = {})
-      @output = output
-      setup_options(options)
-
-      puts 'digraph "Profile" {'
-      #puts "label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"
-      puts "labelloc=t;"
-      puts "labeljust=l;"
-      print_threads
-      puts '}'
-    end
-
-    private
-
-    # Something of a hack, figure out which constant went with the
-    # RubyProf.measure_mode so that we can display it.  Otherwise it's easy to
-    # forget what measurement was made.
-    def mode_name
-      RubyProf.constants.find{|c| RubyProf.const_get(c) == RubyProf.measure_mode}
-    end
-
-    def print_threads
-      @result.threads.each do |thread|
-        puts "subgraph \"Thread #{thread.id}\" {"
-
-        print_thread(thread)
-        puts "}"
-
-        print_classes(thread)
-      end
-    end
-
-    # Determines an ID to use to represent the subject in the Dot file.
-    def dot_id(subject)
-      subject.object_id
-    end
-
-    def print_thread(thread)
-      total_time = thread.total_time
-      thread.methods.sort_by(&sort_method).reverse_each do |method|
-        total_percentage = (method.total_time/total_time) * 100
-
-        next if total_percentage < min_percent
-        name = method_name(method).split("#").last
-        puts "#{dot_id(method)} [label=\"#{name}\\n(#{total_percentage.round}%)\"];"
-        @seen_methods << method
-        print_edges(total_time, method)
-      end
-    end
-
-    def print_classes(thread)
-      grouped = {}
-      thread.methods.each{|m| grouped[m.klass_name] ||= []; grouped[m.klass_name] << m}
-      grouped.each do |cls, methods2|
-        # Filter down to just seen methods
-        big_methods = methods2.select{|m| @seen_methods.include? m}
-
-        if !big_methods.empty?
-          puts "subgraph cluster_#{cls.object_id} {"
-          puts "label = \"#{cls}\";"
-          puts "fontcolor = #{CLASS_COLOR};"
-          puts "fontsize = 16;"
-          puts "color = #{CLASS_COLOR};"
-          big_methods.each do |m|
-            puts "#{m.object_id};"
-          end
-          puts "}"
-        end
-      end
-    end
-
-    def print_edges(total_time, method)
-      method.aggregate_children.sort_by(&:total_time).reverse.each do |child|
-
-        target_percentage = (child.target.total_time / total_time) * 100.0
-        next if target_percentage < min_percent
-
-        # Get children method
-        puts "#{dot_id(method)} -> #{dot_id(child.target)} [label=\"#{child.called}/#{child.target.called}\" fontsize=10 fontcolor=#{EDGE_COLOR}];"
-      end
-    end
-
-    # Silly little helper for printing to the @output
-    def puts(str)
-      @output.puts(str)
-    end
-
-  end
-end
+# encoding: utf-8
+
+require 'set'
+
+module RubyProf
+  # Generates a graphviz graph in dot format.
+  #
+  # To use the dot printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::DotPrinter.new(result)
+  #   printer.print(STDOUT)
+  #
+  # You can use either dot viewer such as GraphViz, or the dot command line tool
+  # to reformat the output into a wide variety of outputs:
+  #
+  #   dot -Tpng graph.dot > graph.png
+  #
+  class DotPrinter < RubyProf::AbstractPrinter
+    CLASS_COLOR = '"#666666"'
+    EDGE_COLOR  = '"#666666"'
+
+    # Creates the DotPrinter using a RubyProf::Proile.
+    def initialize(result)
+      super(result)
+      @seen_methods = Set.new
+    end
+
+    # Print a graph report to the provided output.
+    #
+    # output - Any IO object, including STDOUT or a file. The default value is
+    # STDOUT.
+    #
+    # options - Hash of print options.  See #setup_options
+    # for more information.
+    #
+    # When profiling results that cover a large number of method calls it
+    # helps to use the :min_percent option, for example:
+    #
+    #   DotPrinter.new(result).print(STDOUT, :min_percent=>5)
+    #
+    def print(output = STDOUT, options = {})
+      @output = output
+      setup_options(options)
+
+      puts 'digraph "Profile" {'
+      #puts "label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"
+      puts "labelloc=t;"
+      puts "labeljust=l;"
+      print_threads
+      puts '}'
+    end
+
+    private
+
+    # Something of a hack, figure out which constant went with the
+    # RubyProf.measure_mode so that we can display it.  Otherwise it's easy to
+    # forget what measurement was made.
+    def mode_name
+      RubyProf.constants.find{|c| RubyProf.const_get(c) == RubyProf.measure_mode}
+    end
+
+    def print_threads
+      @result.threads.each do |thread|
+        puts "subgraph \"Thread #{thread.id}\" {"
+
+        print_thread(thread)
+        puts "}"
+
+        print_classes(thread)
+      end
+    end
+
+    # Determines an ID to use to represent the subject in the Dot file.
+    def dot_id(subject)
+      subject.object_id
+    end
+
+    def print_thread(thread)
+      total_time = thread.total_time
+      thread.methods.sort_by(&sort_method).reverse_each do |method|
+        total_percentage = (method.total_time/total_time) * 100
+
+        next if total_percentage < min_percent
+        name = method.full_name.split("#").last
+        puts "#{dot_id(method)} [label=\"#{name}\\n(#{total_percentage.round}%)\"];"
+        @seen_methods << method
+        print_edges(total_time, method)
+      end
+    end
+
+    def print_classes(thread)
+      grouped = {}
+      thread.methods.each{|m| grouped[m.klass_name] ||= []; grouped[m.klass_name] << m}
+      grouped.each do |cls, methods2|
+        # Filter down to just seen methods
+        big_methods = methods2.select{|m| @seen_methods.include? m}
+
+        if !big_methods.empty?
+          puts "subgraph cluster_#{cls.object_id} {"
+          puts "label = \"#{cls}\";"
+          puts "fontcolor = #{CLASS_COLOR};"
+          puts "fontsize = 16;"
+          puts "color = #{CLASS_COLOR};"
+          big_methods.each do |m|
+            puts "#{m.object_id};"
+          end
+          puts "}"
+        end
+      end
+    end
+
+    def print_edges(total_time, method)
+      method.callers.sort_by(&:total_time).reverse.each do |call_info|
+        target_percentage = (call_info.target.total_time / total_time) * 100.0
+        next if target_percentage < min_percent
+
+        # Get children method
+        puts "#{dot_id(method)} -> #{dot_id(call_info.target)} [label=\"#{call_info.called}/#{call_info.target.called}\" fontsize=10 fontcolor=#{EDGE_COLOR}];"
+      end
+    end
+
+    # Silly little helper for printing to the @output
+    def puts(str)
+      @output.puts(str)
+    end
+
+  end
+end

data/lib/ruby-prof/printers/flat_printer.rb

@@ -1,70 +1,52 @@
-# encoding: utf-8
-
-module RubyProf
-  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
-  # To use the flat printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::FlatPrinter.new(result)
-  #   printer.print(STDOUT, {})
-  #
-  class FlatPrinter < AbstractPrinter
-    # Override for this printer to sort by self time by default
-    def sort_method
-      @options[:sort_method] || :self_time
-    end
-
-    private
-
-    #def print_threads
-    #  @result.threads.each do |thread|
-    #    print_thread(thread)
-    #    @output << "\n" * 2
-    #  end
-    #end
-
-    def print_header(thread)
-      @output << "Measure Mode: %s\n" % RubyProf.measure_mode_string
-      @output << "Thread ID: %d\n" % thread.id
-      @output << "Fiber ID: %d\n" % thread.fiber_id unless thread.id == thread.fiber_id
-      @output << "Total: %0.6f\n" % thread.total_time
-      @output << "Sort by: #{sort_method}\n"
-      @output << "\n"
-      @output << " %self      total      self      wait     child     calls  name\n"
-    end
-
-    def print_methods(thread)
-      total_time = thread.total_time
-      methods = thread.methods.sort_by(&sort_method).reverse
-
-      sum = 0
-      methods.each do |method|
-        self_percent = (method.self_time / total_time) * 100
-        next if self_percent < min_percent
-
-        sum += method.self_time
-        #self_time_called = method.called > 0 ? method.self_time/method.called : 0
-        #total_time_called = method.called > 0? method.total_time/method.called : 0
-
-        @output << "%6.2f  %9.3f %9.3f %9.3f %9.3f %8d  %s%s\n" % [
-                      method.self_time / total_time * 100, # %self
-                      method.total_time,                   # total
-                      method.self_time,                    # self
-                      method.wait_time,                    # wait
-                      method.children_time,                # children
-                      method.called,                       # calls
-                      method.recursive? ? "*" : " ",       # cycle
-                      method_name(method)                  # name
-                  ]
-      end
-    end
-
-    def print_footer(thread)
-      @output << "\n"
-      @output << "* indicates recursively called methods\n"
-    end
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
+  # To use the flat printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlatPrinter.new(result)
+  #   printer.print(STDOUT, {})
+  #
+  class FlatPrinter < AbstractPrinter
+    # Override for this printer to sort by self time by default
+    def sort_method
+      @options[:sort_method] || :self_time
+    end
+
+    private
+
+    def print_column_headers
+      @output << " %self      total      self      wait     child     calls  name                           location\n"
+    end
+
+    def print_methods(thread)
+      total_time = thread.total_time
+      methods = thread.methods.sort_by(&sort_method).reverse
+
+      sum = 0
+      methods.each do |method|
+        self_percent = (method.self_time / total_time) * 100
+        next if self_percent < min_percent
+
+        sum += method.self_time
+        #self_time_called = method.called > 0 ? method.self_time/method.called : 0
+        #total_time_called = method.called > 0? method.total_time/method.called : 0
+
+        @output << "%6.2f  %9.3f %9.3f %9.3f %9.3f %8d  %s%-30s %s\n" % [
+                      method.self_time / total_time * 100, # %self
+                      method.total_time,                   # total
+                      method.self_time,                    # self
+                      method.wait_time,                    # wait
+                      method.children_time,                # children
+                      method.called,                       # calls
+                      method.recursive? ? "*" : " ",       # cycle
+                      method.full_name,                    # method_name]
+                      method_location(method)]             # location]
+      end
+    end
+  end
+end

data/lib/ruby-prof/printers/graph_html_printer.rb

@@ -1,244 +1,63 @@
-# encoding: utf-8
-
-require 'erb'
-
-module RubyProf
-  # Generates graph[link:files/examples/graph_html.html] 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
-  #
-
-  class GraphHtmlPrinter < AbstractPrinter
-    include ERB::Util
-
-    def setup_options(options)
-      super(options)
-
-      filename = options[:filename]
-      template = filename ? File.read(filename).untaint : (options[:template] || self.template)
-      @erb = ERB.new(template)
-      @erb.filename = filename
-    end
-
-    def print(output = STDOUT, options = {})
-      @output = output
-      setup_options(options)
-      @output << @erb.result(binding).split("\n").map(&:rstrip).join("\n") << "\n"
-    end
-
-    # 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.
-    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
-
-    def method_href(thread, method)
-      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
-    end
-
-    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
-
-    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>%Total</th>
-            <th>%Self</th>
-            <th>Total</th>
-            <th>Self</th>
-            <th>Wait</th>
-            <th>Child</th>
-            <th>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("%.2f", caller.total_time) %></td>
-                   <td><%= sprintf("%.2f", caller.self_time) %></td>
-                   <td><%= sprintf("%.2f", caller.wait_time) %></td>
-                   <td><%= sprintf("%.2f", caller.children_time) %></td>
-                   <td><%= "#{caller.called}/#{method.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("%.2f\%", total_percentage) %></td>
-                 <td><%= sprintf("%.2f\%", self_percentage) %></td>
-                 <td><%= sprintf("%.2f", method.total_time) %></td>
-                 <td><%= sprintf("%.2f", method.self_time) %></td>
-                 <td><%= sprintf("%.2f", method.wait_time) %></td>
-                 <td><%= sprintf("%.2f", method.children_time) %></td>
-                 <td><%= sprintf("%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 -->
-               <%
-                  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("%.2f", callee.total_time) %></td>
-                   <td><%= sprintf("%.2f", callee.self_time) %></td>
-                   <td><%= sprintf("%.2f", callee.wait_time) %></td>
-                   <td><%= sprintf("%.2f", callee.children_time) %></td>
-                   <td><%= "#{callee.called}/#{callee.target.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>
-          <% end %>
-        </tbody>
-        <tfoot>
-          <tr>
-            <td colspan="9">* indicates recursively called methods</td>
-          </tr>
-        </tfoot>
-      </table>
-    <% end %>
-  </body>
-</html>'
-    end
-  end
-end
-
+# encoding: utf-8
+
+require 'erb'
+
+module RubyProf
+  # Generates graph[link:files/examples/graph_html.html] 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:
+
+  class GraphHtmlPrinter < AbstractPrinter
+    include ERB::Util
+
+    def setup_options(options)
+      super(options)
+      @erb = ERB.new(self.template)
+    end
+
+    def print(output = STDOUT, options = {})
+      setup_options(options)
+      output << @erb.result(binding)
+    end
+
+    # 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.
+    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
+
+    def method_href(thread, method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
+    end
+
+    def file_link(path, linenum)
+      if path.nil?
+        ""
+      else
+        srcfile = File.expand_path(path)
+        "<a href=\"file://#{h srcfile}##{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
+      end
+    end
+
+    def template
+      open_asset('graph_printer.html.erb')
+    end
+  end
+end