ruby-prof 1.7.2 → 2.0.0

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

@@ -1,113 +1,112 @@
-# encoding: utf-8
-
-module RubyProf
-  # Generates graph[link:files/examples/graph_txt.html] profile reports as text.
-  # To use the graph printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::GraphPrinter.new(result)
-  #   printer.print(STDOUT, {})
-  #
-  # The constructor takes two arguments. See the README
-
-  class GraphPrinter < AbstractPrinter
-    PERCENTAGE_WIDTH = 8
-    TIME_WIDTH = 11
-    CALL_WIDTH = 17
-
-    private
-
-    def sort_method
-      @options[:sort_method] || :total_time
-    end
-
-    def print_header(thread)
-      @output << "Measure Mode: %s\n" % @result.measure_mode_string
-      @output << "Thread ID: #{thread.id}\n"
-      @output << "Fiber ID: #{thread.fiber_id}\n"
-      @output << "Total Time: #{thread.total_time}\n"
-      @output << "Sort by: #{sort_method}\n"
-      @output << "\n"
-
-      # 1 is for % sign
-      @output << sprintf("%#{PERCENTAGE_WIDTH}s", "%total")
-      @output << sprintf("%#{PERCENTAGE_WIDTH}s", "%self")
-      @output << sprintf("%#{TIME_WIDTH}s", "total")
-      @output << sprintf("%#{TIME_WIDTH}s", "self")
-      @output << sprintf("%#{TIME_WIDTH}s", "wait")
-      @output << sprintf("%#{TIME_WIDTH}s", "child")
-      @output << sprintf("%#{CALL_WIDTH}s", "calls")
-      @output << "     name"
-      @output << "                          location"
-      @output << "\n"
-    end
-
-    def print_methods(thread)
-      total_time = thread.total_time
-      # Sort methods from longest to shortest total time
-      methods = thread.methods.sort_by(&sort_method)
-
-      # Print each method in total time order
-      methods.reverse_each do |method|
-        total_percentage = (method.total_time/total_time) * 100
-        next if total_percentage < min_percent
-
-        self_percentage = (method.self_time/total_time) * 100
-
-        @output << "-" * 150 << "\n"
-        print_parents(thread, method)
-
-        # 1 is for % sign
-        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f%%", total_percentage)
-        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f%%", self_percentage)
-        @output << sprintf("%#{TIME_WIDTH}.3f", method.total_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", method.self_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", method.wait_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", method.children_time)
-        @output << sprintf("%#{CALL_WIDTH}i", method.called)
-        @output << sprintf("    %s",  method.recursive? ? "*" : " ")
-        @output << sprintf("%-30s", method.full_name)
-        @output << sprintf(" %s", method_location(method))
-        @output << "\n"
-
-        print_children(method)
-      end
-    end
-
-    def print_parents(thread, method)
-      method.call_trees.callers.sort_by(&:total_time).each do |caller|
-        @output << " " * 2 * PERCENTAGE_WIDTH
-        @output << sprintf("%#{TIME_WIDTH}.3f", caller.total_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", caller.self_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", caller.wait_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", caller.children_time)
-
-        call_called = "#{caller.called}/#{method.called}"
-        @output << sprintf("%#{CALL_WIDTH}s", call_called)
-        @output << sprintf("     %s", caller.parent.target.full_name)
-        @output << "\n"
-      end
-    end
-
-    def print_children(method)
-      method.call_trees.callees.sort_by(&:total_time).reverse.each do |child|
-        # Get children method
-
-        @output << " " * 2 * PERCENTAGE_WIDTH
-
-        @output << sprintf("%#{TIME_WIDTH}.3f", child.total_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", child.self_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", child.wait_time)
-        @output << sprintf("%#{TIME_WIDTH}.3f", child.children_time)
-
-        call_called = "#{child.called}/#{child.target.called}"
-        @output << sprintf("%#{CALL_WIDTH}s", call_called)
-        @output << sprintf("     %s", child.target.full_name)
-        @output << "\n"
-      end
-    end
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # Generates graph[link:files/examples/graph_txt.html] profile reports as text.
+  # To use the graph printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::GraphPrinter.new(result)
+  #   printer.print(STDOUT)
+
+  class GraphPrinter < AbstractPrinter
+    PERCENTAGE_WIDTH = 8
+    TIME_WIDTH = 11
+    CALL_WIDTH = 17
+
+    # Override to default sort by total time
+    def print(output = STDOUT, sort_method: :total_time, **options)
+      super(output, sort_method: sort_method, **options)
+    end
+
+    private
+
+    def print_header(thread)
+      @output << "Measure Mode: %s\n" % @result.measure_mode_string
+      @output << "Thread ID: #{thread.id}\n"
+      @output << "Fiber ID: #{thread.fiber_id}\n"
+      @output << "Total Time: #{thread.total_time}\n"
+      @output << "Sort by: #{sort_method}\n"
+      @output << "\n"
+
+      # 1 is for % sign
+      @output << sprintf("%#{PERCENTAGE_WIDTH}s", "%total")
+      @output << sprintf("%#{PERCENTAGE_WIDTH}s", "%self")
+      @output << sprintf("%#{TIME_WIDTH}s", "total")
+      @output << sprintf("%#{TIME_WIDTH}s", "self")
+      @output << sprintf("%#{TIME_WIDTH}s", "wait")
+      @output << sprintf("%#{TIME_WIDTH}s", "child")
+      @output << sprintf("%#{CALL_WIDTH}s", "calls")
+      @output << "     name"
+      @output << "                          location"
+      @output << "\n"
+    end
+
+    def print_methods(thread)
+      total_time = thread.total_time
+      # Sort methods from longest to shortest total time
+      methods = thread.methods.sort_by(&sort_method)
+
+      # Print each method in total time order
+      methods.reverse_each do |method|
+        total_percentage = (method.total_time/total_time) * 100
+        next if total_percentage < min_percent
+
+        self_percentage = (method.self_time/total_time) * 100
+
+        @output << "-" * 150 << "\n"
+        print_parents(thread, method)
+
+        # 1 is for % sign
+        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f%%", total_percentage)
+        @output << sprintf("%#{PERCENTAGE_WIDTH-1}.2f%%", self_percentage)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", method.children_time)
+        @output << sprintf("%#{CALL_WIDTH}i", method.called)
+        @output << sprintf("    %s",  method.recursive? ? "*" : " ")
+        @output << sprintf("%-30s", method.full_name)
+        @output << sprintf(" %s", method_location(method))
+        @output << "\n"
+
+        print_children(method)
+      end
+    end
+
+    def print_parents(thread, method)
+      method.call_trees.callers.sort_by(&:total_time).each do |caller|
+        @output << " " * 2 * PERCENTAGE_WIDTH
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", caller.children_time)
+
+        call_called = "#{caller.called}/#{method.called}"
+        @output << sprintf("%#{CALL_WIDTH}s", call_called)
+        @output << sprintf("     %s", caller.parent.target.full_name)
+        @output << "\n"
+      end
+    end
+
+    def print_children(method)
+      method.call_trees.callees.sort_by(&:total_time).reverse.each do |child|
+        # Get children method
+
+        @output << " " * 2 * PERCENTAGE_WIDTH
+
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.total_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.self_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.wait_time)
+        @output << sprintf("%#{TIME_WIDTH}.3f", child.children_time)
+
+        call_called = "#{child.called}/#{child.target.called}"
+        @output << sprintf("%#{CALL_WIDTH}s", call_called)
+        @output << sprintf("     %s", child.target.full_name)
+        @output << "\n"
+      end
+    end
+  end
+end

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

@@ -1,127 +1,134 @@
-# encoding: utf-8
-
-module RubyProf
-  # Helper class to simplify printing profiles of several types from
-  # one profiling run. Currently prints a flat profile, a callgrind
-  # profile, a call stack profile and a graph profile.
-  class MultiPrinter
-    def initialize(result, printers = [:flat, :graph_html])
-      @flat_printer = printers.include?(:flat) ? FlatPrinter.new(result) : nil
-
-      @graph_printer = printers.include?(:graph) ? GraphPrinter.new(result) : nil
-      @graph_html_printer = printers.include?(:graph_html) ? GraphHtmlPrinter.new(result) : nil
-
-      @tree_printer = printers.include?(:tree) ? CallTreePrinter.new(result) : nil
-      @call_info_printer = printers.include?(:call_tree) ? CallInfoPrinter.new(result) : nil
-
-      @stack_printer = printers.include?(:stack) ? CallStackPrinter.new(result) : nil
-      @dot_printer = printers.include?(:dot) ? DotPrinter.new(result) : nil
-    end
-
-    def self.needs_dir?
-      true
-    end
-
-    # create profile files under options[:path] or the current
-    # directory. options[:profile] is used as the base name for the
-    # profile file, defaults to "profile".
-    def print(options)
-      validate_print_params(options)
-
-      @file_name = options.delete(:profile) || "profile"
-      @directory = options.delete(:path) || File.expand_path(".")
-
-      print_to_flat(options) if @flat_printer
-
-      print_to_graph(options) if @graph_printer
-      print_to_graph_html(options) if @graph_html_printer
-
-      print_to_stack(options) if @stack_printer
-      print_to_call_info(options) if @call_info_printer
-      print_to_tree(options) if @tree_printer
-      print_to_dot(options) if @dot_printer
-    end
-
-    # the name of the flat profile file
-    def flat_report
-      "#{@directory}/#{@file_name}.flat.txt"
-    end
-
-    # the name of the graph profile file
-    def graph_report
-      "#{@directory}/#{@file_name}.graph.txt"
-    end
-
-    def graph_html_report
-      "#{@directory}/#{@file_name}.graph.html"
-    end
-
-    # the name of the callinfo profile file
-    def call_info_report
-      "#{@directory}/#{@file_name}.call_tree.txt"
-    end
-
-    # the name of the callgrind profile file
-    def tree_report
-      "#{@directory}/#{@file_name}.callgrind.out.#{$$}"
-    end
-
-    # the name of the call stack profile file
-    def stack_report
-      "#{@directory}/#{@file_name}.stack.html"
-    end
-
-    # the name of the call stack profile file
-    def dot_report
-      "#{@directory}/#{@file_name}.dot"
-    end
-
-    def print_to_flat(options)
-      File.open(flat_report, "wb") do |file|
-        @flat_printer.print(file, options)
-      end
-    end
-
-    def print_to_graph(options)
-      File.open(graph_report, "wb") do |file|
-        @graph_printer.print(file, options)
-      end
-    end
-
-    def print_to_graph_html(options)
-      File.open(graph_html_report, "wb") do |file|
-        @graph_html_printer.print(file, options)
-      end
-    end
-
-    def print_to_call_info(options)
-      File.open(call_info_report, "wb") do |file|
-        @call_info_printer.print(file, options)
-      end
-    end
-
-    def print_to_tree(options)
-      @tree_printer.print(options.merge(:path => @directory, :profile => @file_name))
-    end
-
-    def print_to_stack(options)
-      File.open(stack_report, "wb") do |file|
-        @stack_printer.print(file, options.merge(:graph => "#{@file_name}.graph.html"))
-      end
-    end
-
-    def print_to_dot(options)
-      File.open(dot_report, "wb") do |file|
-        @dot_printer.print(file, options)
-      end
-    end
-
-    def validate_print_params(options)
-      if options.is_a?(IO)
-        raise ArgumentError, "#{self.class.name}#print cannot print to IO objects"
-      elsif !options.is_a?(Hash)
-        raise ArgumentError, "#{self.class.name}#print requires an options hash"
-      end
-    end
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # Helper class to simplify printing profiles of several types from
+  # one profiling run. Currently prints a flat profile, a callgrind
+  # profile, a call stack profile and a graph profile.
+  class MultiPrinter
+    def initialize(result, printers = [:flat, :graph, :graph_html, :flame_graph, :stack])
+      @flat_printer = printers.include?(:flat) ? FlatPrinter.new(result) : nil
+
+      @graph_printer = printers.include?(:graph) ? GraphPrinter.new(result) : nil
+      @graph_html_printer = printers.include?(:graph_html) ? GraphHtmlPrinter.new(result) : nil
+
+      @tree_printer = printers.include?(:tree) ? CallTreePrinter.new(result) : nil
+      @call_info_printer = printers.include?(:call_tree) ? CallInfoPrinter.new(result) : nil
+
+      @stack_printer = printers.include?(:stack) ? CallStackPrinter.new(result) : nil
+      @flame_graph_printer = printers.include?(:flame_graph) ? FlameGraphPrinter.new(result) : nil
+      @dot_printer = printers.include?(:dot) ? DotPrinter.new(result) : nil
+    end
+
+    def self.needs_dir?
+      true
+    end
+
+    # Create profile files under the specified directory.
+    #
+    # Keyword arguments:
+    #   profile: - Base name for profile files. Default is "profile".
+    #   path:    - Directory to write files to. Default is current directory.
+    #
+    # Also accepts min_percent:, sort_method:, and other printer-specific kwargs.
+    def print(profile: "profile", path: File.expand_path("."), **options)
+      @file_name = profile
+      @directory = path
+
+      print_to_flat(**options) if @flat_printer
+
+      print_to_graph(**options) if @graph_printer
+      print_to_graph_html(**options) if @graph_html_printer
+
+      print_to_stack(**options) if @stack_printer
+      print_to_flame_graph(**options) if @flame_graph_printer
+      print_to_call_info(**options) if @call_info_printer
+      print_to_tree(**options) if @tree_printer
+      print_to_dot(**options) if @dot_printer
+    end
+
+    # the name of the flat profile file
+    def flat_report
+      "#{@directory}/#{@file_name}.flat.txt"
+    end
+
+    # the name of the graph profile file
+    def graph_report
+      "#{@directory}/#{@file_name}.graph.txt"
+    end
+
+    def graph_html_report
+      "#{@directory}/#{@file_name}.graph.html"
+    end
+
+    # the name of the callinfo profile file
+    def call_info_report
+      "#{@directory}/#{@file_name}.call_tree.txt"
+    end
+
+    # the name of the callgrind profile file
+    def tree_report
+      "#{@directory}/#{@file_name}.callgrind.out.#{$$}"
+    end
+
+    # the name of the call stack profile file
+    def stack_report
+      "#{@directory}/#{@file_name}.stack.html"
+    end
+
+    # the name of the flame graph profile file
+    def flame_graph_report
+      "#{@directory}/#{@file_name}.flame_graph.html"
+    end
+
+    # the name of the call stack profile file
+    def dot_report
+      "#{@directory}/#{@file_name}.dot"
+    end
+
+    def print_to_flat(**options)
+      File.open(flat_report, "wb") do |file|
+        @flat_printer.print(file, **options)
+      end
+    end
+
+    def print_to_graph(**options)
+      File.open(graph_report, "wb") do |file|
+        @graph_printer.print(file, **options)
+      end
+    end
+
+    def print_to_graph_html(**options)
+      File.open(graph_html_report, "wb") do |file|
+        @graph_html_printer.print(file, **options)
+      end
+    end
+
+    def print_to_call_info(**options)
+      File.open(call_info_report, "wb") do |file|
+        @call_info_printer.print(file, **options)
+      end
+    end
+
+    def print_to_tree(**options)
+      @tree_printer.print(path: @directory, **options)
+    end
+
+    def print_to_stack(**options)
+      File.open(stack_report, "wb") do |file|
+        @stack_printer.print(file, **options)
+      end
+    end
+
+    def print_to_flame_graph(**options)
+      File.open(flame_graph_report, "wb") do |file|
+        @flame_graph_printer.print(file, **options)
+      end
+    end
+
+    def print_to_dot(**options)
+      File.open(dot_report, "wb") do |file|
+        @dot_printer.print(file, **options)
+      end
+    end
+  end
+end

data/lib/ruby-prof/profile.rb

@@ -17,6 +17,19 @@ module RubyProf
       end
     end
 
+    def measure_mode_name
+      case self.measure_mode
+        when WALL_TIME
+          "Wall Time"
+        when PROCESS_TIME
+          "Process Time"
+        when ALLOCATIONS
+          "Allocations"
+        when MEMORY
+          "Memory"
+      end
+    end
+
     # Hides methods that, when represented as a call graph, have
     # extremely large in and out degrees and make navigation impossible.
     def exclude_common_methods!