ruby-prof 0.17.0 → 0.18.0

data/lib/ruby-prof/method_info.rb

@@ -1,121 +1,121 @@
-# 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 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 if !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 if !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 if !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 if !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 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
+  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 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 if !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 if !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 if !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 if !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 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

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

@@ -1,103 +1,104 @@
-# 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
-    #    :editor_uri - Specifies editor uri scheme used for opening files
-    #                  e.g. :atm or :mvim. For OS X default is :txmt.
-    #                  Use RUBY_PROF_EDITOR_URI environment variable to overide.
-    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 editor_uri
-      default_uri = if RUBY_PLATFORM =~ /darwin/ \
-                    && !ENV['RUBY_PROF_EDITOR_URI']
-                      'txmt'
-                    else
-                      false
-                    end
-      ENV['RUBY_PROF_EDITOR_URI'] || @options[:editor_uri] || default_uri
-    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
-
-    # whether this printer need a :path option pointing to a directory
-    def self.needs_dir?
-      false
-    end
-  end
-end
+# 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
+    #    :editor_uri - Specifies editor uri scheme used for opening files
+    #                  e.g. :atm or :mvim. For OS X default is :txmt.
+    #                  Pass false to print bare filenames.
+    #                  Use RUBY_PROF_EDITOR_URI environment variable to override.
+    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 editor_uri
+      if ENV.key?('RUBY_PROF_EDITOR_URI')
+        ENV['RUBY_PROF_EDITOR_URI'] || false
+      elsif @options.key?(:editor_uri)
+        @options[:editor_uri]
+      else
+        RUBY_PLATFORM =~ /darwin/ ? 'txmt' : false
+      end
+    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
+
+    # whether this printer need a :path option pointing to a directory
+    def self.needs_dir?
+      false
+    end
+  end
+end

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

@@ -1,41 +1,41 @@
-# 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.
+
+  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