ruby-prof 0.16.2 → 1.1.0

data/lib/ruby-prof/measurement.rb

@@ -0,0 +1,14 @@
+module RubyProf
+  # The Measurement class is a helper class used by RubyProf::MethodInfo to store information about the method.
+  # You cannot create a CallInfo object directly, they are generated while running a profile.
+  class Measurement
+    # :nodoc:
+    def to_s
+      "c: #{called}, tt: #{total_time}, st: #{self_time}"
+    end
+
+    def inspect
+      super + "(#{self.to_s})"
+    end
+  end
+end

data/lib/ruby-prof/method_info.rb

@@ -1,129 +1,90 @@
-# encoding: utf-8
-
-module RubyProf
-  class MethodInfo
-    include Comparable
-
-    def <=>(other)
-      if self.total_time < other.total_time
-        -1
-      elsif self.total_time > other.total_time
-        1
-      elsif self.min_depth < other.min_depth
-        1
-      elsif self.min_depth > other.min_depth
-        -1
-      else
-        self.full_name <=> other.full_name
-      end
-    end
-
-    def detect_recursion
-      call_infos.each(&:detect_recursion)
-    end
-
-    def called
-      @called ||= begin
-        call_infos.inject(0) do |sum, call_info|
-          sum + call_info.called
-        end
-      end
-    end
-
-    def total_time
-      @total_time ||= begin
-        call_infos.inject(0) do |sum, call_info|
-          sum += call_info.total_time unless call_info.recursive
-          sum
-        end
-      end
-    end
-
-    def self_time
-      @self_time ||= begin
-        call_infos.inject(0) do |sum, call_info|
-          sum += call_info.self_time unless call_info.recursive
-          sum
-        end
-      end
-    end
-
-    def wait_time
-      @wait_time ||= begin
-        call_infos.inject(0) do |sum, call_info|
-          sum += call_info.wait_time unless call_info.recursive
-          sum
-        end
-      end
-    end
-
-    def children_time
-      @children_time ||= begin
-        call_infos.inject(0) do |sum, call_info|
-          sum += call_info.children_time unless call_info.recursive
-          sum
-        end
-      end
-    end
-
-    def min_depth
-      @min_depth ||= call_infos.map(&:depth).min
-    end
-
-    def root?
-      @root ||= begin
-        call_infos.find do |call_info|
-          not call_info.root?
-        end.nil?
-      end
-    end
-
-    def recursive?
-      (@recursive ||= call_infos.detect(&:recursive) ? :true : :false) == :true
-    end
-
-    def children
-      @children ||= call_infos.map(&:children).flatten
-    end
-
-    def parents
-      @parents ||= call_infos.map(&:parent)
-    end
-
-    def aggregate_parents
-      # group call infos based on their parents
-      groups = self.call_infos.each_with_object({}) do |call_info, hash|
-        key = call_info.parent ? call_info.parent.target : self
-        (hash[key] ||= []) << call_info
-      end
-
-      groups.map do |key, value|
-        AggregateCallInfo.new(value, self)
-      end
-    end
-
-    def aggregate_children
-      # group call infos based on their targets
-      groups = self.children.each_with_object({}) do |call_info, hash|
-        key = call_info.target
-        (hash[key] ||= []) << call_info
-      end
-
-      groups.map do |key, value|
-        AggregateCallInfo.new(value, self)
-      end
-    end
-
-    def to_s
-      "#{self.full_name} (c: #{self.called}, tt: #{self.total_time}, st: #{self.self_time}, wt: #{wait_time}, ct: #{self.children_time})"
-    end
-
-    # remove method from the call graph. should not be called directly.
-    def eliminate!
-      # $stderr.puts "eliminating #{self}"
-      call_infos.each{ |call_info| call_info.eliminate! }
-      call_infos.clear
-    end
-
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # The MethodInfo class is used to track information about each method that is profiled.
+  # You cannot create a MethodInfo object directly, they are generated while running a profile.
+  class MethodInfo
+    include Comparable
+
+    # Returns the full name of a class. The interpretation of method names is:
+    #
+    # * MyObject#test - An method defined in a class
+    # * <Class:MyObject>#test - A method defined in a singleton class.
+    # * <Module:MyObject>#test - A method defined in a singleton module.
+    # * <Object:MyObject>#test - A method defined in a singleton object.
+    def full_name
+      decorated_class_name = case self.klass_flags
+                             when 0x2
+                               "<Class::#{klass_name}>"
+                             when 0x4
+                               "<Module::#{klass_name}>"
+                             when 0x8
+                               "<Object::#{klass_name}>"
+                             else
+                               klass_name
+                             end
+
+      "#{decorated_class_name}##{method_name}"
+    end
+
+    # The number of times this method was called
+    def called
+      self.measurement.called
+    end
+
+    # The total time this method took - includes self time + wait time + child time
+    def total_time
+      self.measurement.total_time
+    end
+
+    # The time this method took to execute
+    def self_time
+      self.measurement.self_time
+    end
+
+    # The time this method waited for other fibers/threads to execute
+    def wait_time
+      self.measurement.wait_time
+    end
+
+    # The time this method's children took to execute
+    def children_time
+      self.total_time - self.self_time - self.wait_time
+    end
+
+    # The min call depth of this method
+    def min_depth
+      @min_depth ||= callers.map(&:depth).min
+    end
+
+    # :enddoc:
+    def <=>(other)
+      if other == nil
+        -1
+      elsif self.full_name == other.full_name
+        0
+      elsif self.total_time < other.total_time
+        -1
+      elsif self.total_time > other.total_time
+        1
+      elsif self.min_depth < other.min_depth
+        1
+      elsif self.min_depth > other.min_depth
+        -1
+      else
+        self.full_name <=> other.full_name
+      end
+    end
+
+    def to_s
+      "#{self.full_name} (c: #{self.called}, tt: #{self.total_time}, st: #{self.self_time}, wt: #{wait_time}, ct: #{self.children_time})"
+    end
+
+    # Remove method from the call graph. should not be called directly.
+    def eliminate!
+      # $stderr.puts "eliminating #{self}"
+      callers.each{ |call_info| call_info.eliminate! }
+      callers.clear
+    end
+  end
+end

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

@@ -1,85 +1,127 @@
-# encoding: utf-8
-
-module RubyProf
-  class AbstractPrinter
-    # Create a new printer.
-    #
-    # result should be the output generated from a profiling run
-    def initialize(result)
-      @result = result
-      @output = nil
-    end
-
-    # Specify print options.
-    #
-    # options - Hash table
-    #   :min_percent - Number 0 to 100 that specifes the minimum
-    #                  %self (the methods self time divided by the
-    #                  overall total time) that a method must take
-    #                  for it to be printed out in the report.
-    #                  Default value is 0.
-    #
-    #   :print_file  - True or false. Specifies if a method's source
-    #                  file should be printed.  Default value if false.
-    #
-    #   :sort_method - Specifies method used for sorting method infos.
-    #                  Available values are :total_time, :self_time,
-    #                  :wait_time, :children_time
-    #                  Default value is :total_time
-    def setup_options(options = {})
-      @options = options
-    end
-
-    def min_percent
-      @options[:min_percent] || 0
-    end
-
-    def print_file
-      @options[:print_file] || false
-    end
-
-    def sort_method
-      @options[:sort_method] || :total_time
-    end
-
-    def method_name(method)
-      name = method.full_name
-      if print_file
-        name += " (#{method.source_file}:#{method.line}}"
-      end
-      name
-    end
-
-    # Print a profiling 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.  Note that each printer can
-    # define its own set of options.
-    def print(output = STDOUT, options = {})
-      @output = output
-      setup_options(options)
-      print_threads
-    end
-
-    def print_threads
-      @result.threads.each do |thread|
-        print_thread(thread)
-      end
-    end
-
-    def print_thread(thread)
-      print_header(thread)
-      print_methods(thread)
-      print_footer(thread)
-    end
-
-    def print_header(thread)
-    end
-
-    def print_footer(thread)
-    end
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # This is the base class for all Printers. It is never used directly.
+  class AbstractPrinter
+    # :stopdoc:
+    def self.needs_dir?
+      false
+    end
+    # :startdoc:
+
+    # Create a new printer.
+    #
+    # result should be the output generated from a profiling run
+    def initialize(result)
+      @result = result
+      @output = nil
+    end
+
+    # Returns the min_percent of total time a method must take to be included in a profiling report
+    def min_percent
+      @options[:min_percent] || 0
+    end
+
+    # Returns the time format used to show when a profile was run
+    def time_format
+      '%A, %B %-d at %l:%M:%S %p (%Z)'
+    end
+
+    # Returns how profile data should be sorted
+    def sort_method
+      @options[:sort_method]
+    end
+
+    # Prints a report to the provided output.
+    #
+    # output - Any IO object, including STDOUT or a file.
+    # The default value is STDOUT.
+    #
+    # options - Hash of print options. Note that each printer can
+    # define its own set of options.
+    #
+    #   :min_percent - Number 0 to 100 that specifes the minimum
+    #                  %self (the methods self time divided by the
+    #                  overall total time) that a method must take
+    #                  for it to be printed out in the report.
+    #                  Default value is 0.
+    #
+    #   :sort_method - Specifies method used for sorting method infos.
+    #                  Available values are :total_time, :self_time,
+    #                  :wait_time, :children_time
+    #                  Default value is :total_time
+    def print(output = STDOUT, options = {})
+      @output = output
+      setup_options(options)
+      print_threads
+    end
+
+    # :nodoc:
+    def setup_options(options = {})
+      @options = options
+    end
+
+    def method_location(method)
+      if method.source_file
+        "#{method.source_file}:#{method.line}"
+      end
+    end
+
+    def method_href(thread, method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
+    end
+
+    def open_asset(file)
+      path = File.join(File.expand_path('../../assets', __FILE__), file)
+      File.open(path, 'rb').read
+    end
+
+    def print_threads
+      @result.threads.each do |thread|
+        print_thread(thread)
+      end
+    end
+
+    def print_thread(thread)
+      print_header(thread)
+      print_methods(thread)
+      print_footer(thread)
+    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"
+      print_column_headers
+    end
+
+    def print_column_headers
+    end
+
+    def print_footer(thread)
+      @output << <<~EOT
+      
+        * recursively called methods
+
+        Columns are:
+
+          %self     - The percentage of time spent in this method, derived from self_time/total_time.
+          total     - The time spent in this method and its children.
+          self      - The time spent in this method.
+          wait      - The amount of time this method waited for other threads.
+          child     - The time spent in this method's children.
+          calls     - The number of times this method was called.
+          name      - The name of the method.
+          location  - The location of the method.
+
+        The interpretation of method names is:
+
+          * MyObject#test - An instance method "test" of the class "MyObject"
+          * <Object:MyObject>#test - The <> characters indicate a method on a singleton class.
+      EOT
+    end
+  end
+end

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

@@ -1,41 +1,51 @@
-# encoding: utf-8
-
-module RubyProf
-  # Prints out the call graph based on CallInfo instances. This
-  # is mainly for debugging purposes as it provides access into
-  # into RubyProf's internals.
-
-  class CallInfoPrinter < AbstractPrinter
-    TIME_WIDTH = 0
-
-    private
-
-    def print_header(thread)
-      @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"
-    end
-
-    def print_methods(thread)
-      visitor = CallInfoVisitor.new(thread.top_call_infos)
-
-      visitor.visit do |call_info, event|
-        if event == :enter
-          @output << "  " * call_info.depth
-          @output << call_info.target.full_name
-          @output << " ("
-          @output << "tt:#{sprintf("%#{TIME_WIDTH}.2f", call_info.total_time)}, "
-          @output << "st:#{sprintf("%#{TIME_WIDTH}.2f", call_info.self_time)}, "
-          @output << "wt:#{sprintf("%#{TIME_WIDTH}.2f", call_info.wait_time)}, "
-          @output << "ct:#{sprintf("%#{TIME_WIDTH}.2f", call_info.children_time)}, "
-          @output << "call:#{call_info.called}, "
-          @output << "rec:#{call_info.recursive}"
-          @output << ")"
-          @output << "\n"
-        end
-      end
-    end
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # Prints out the call graph based on CallInfo instances. This
+  # is mainly for debugging purposes as it provides access into
+  # into RubyProf's internals.
+  #
+  # To use the printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::CallInfoPrinter.new(result)
+  #   printer.print(STDOUT)
+  class CallInfoPrinter < AbstractPrinter
+    TIME_WIDTH = 0
+
+    private
+
+    def print_header(thread)
+      @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"
+    end
+
+    def print_methods(thread)
+      visitor = CallInfoVisitor.new(thread.root_methods)
+
+      visitor.visit do |call_info, event|
+        if event == :enter
+          @output << "  " * call_info.depth
+          @output << call_info.target.full_name
+          @output << " ("
+          @output << "tt:#{sprintf("%#{TIME_WIDTH}.2f", call_info.total_time)}, "
+          @output << "st:#{sprintf("%#{TIME_WIDTH}.2f", call_info.self_time)}, "
+          @output << "wt:#{sprintf("%#{TIME_WIDTH}.2f", call_info.wait_time)}, "
+          @output << "ct:#{sprintf("%#{TIME_WIDTH}.2f", call_info.children_time)}, "
+          @output << "call:#{call_info.called}, "
+          @output << ")"
+          @output << "\n"
+        end
+      end
+    end
+
+    def print_footer(thread)
+    end
+  end
+end