ruby-prof 0.16.2 → 0.17.0

data/ext/ruby_prof/ruby_prof.h

@@ -42,11 +42,14 @@ typedef struct
 {
     VALUE running;
     VALUE paused;
+
     prof_measurer_t* measurer;
     VALUE threads;
+
     st_table* threads_tbl;
     st_table* exclude_threads_tbl;
     st_table* include_threads_tbl;
+    st_table* exclude_methods_tbl;
     thread_data_t* last_thread_data;
     double measurement_at_pause_resume;
     int merge_fibers;

data/lib/ruby-prof.rb

@@ -8,6 +8,16 @@ rescue LoadError
   require "ruby_prof.so"
 end
 
+module RubyProf
+  module DeprecationWarnings
+    def deprecation_warning(feature, recommendation = nil)
+      $stderr.puts "DEPRECATION WARNING: #{feature}"
+      $stderr.puts recommendation unless recommendation.nil?
+    end
+  end
+  extend DeprecationWarnings
+end
+
 require 'ruby-prof/version'
 require 'ruby-prof/call_info'
 require 'ruby-prof/compatibility'

data/lib/ruby-prof/call_info.rb

@@ -9,17 +9,6 @@ module RubyProf
     # children:   array of call info children (can be empty)
     # target:     method info (containing an array of call infos)
 
-    attr_reader :recursive
-
-    def detect_recursion(visited_methods = Hash.new(0))
-      @recursive = (visited_methods[target] += 1) > 1
-      children.each do |child|
-        child.detect_recursion(visited_methods)
-      end
-      visited_methods.delete(target) if (visited_methods[target] -= 1) == 0
-      return @recursive
-    end
-
     def children_time
       children.inject(0) do |sum, call_info|
         sum += call_info.total_time

data/lib/ruby-prof/method_info.rb

@@ -18,10 +18,6 @@ module RubyProf
       end
     end
 
-    def detect_recursion
-      call_infos.each(&:detect_recursion)
-    end
-
     def called
       @called ||= begin
         call_infos.inject(0) do |sum, call_info|
@@ -33,7 +29,7 @@ module RubyProf
     def total_time
       @total_time ||= begin
         call_infos.inject(0) do |sum, call_info|
-          sum += call_info.total_time unless call_info.recursive
+          sum += call_info.total_time if !call_info.recursive?
           sum
         end
       end
@@ -42,7 +38,7 @@ module RubyProf
     def self_time
       @self_time ||= begin
         call_infos.inject(0) do |sum, call_info|
-          sum += call_info.self_time unless call_info.recursive
+          sum += call_info.self_time if !call_info.recursive?
           sum
         end
       end
@@ -51,7 +47,7 @@ module RubyProf
     def wait_time
       @wait_time ||= begin
         call_infos.inject(0) do |sum, call_info|
-          sum += call_info.wait_time unless call_info.recursive
+          sum += call_info.wait_time if !call_info.recursive?
           sum
         end
       end
@@ -60,7 +56,7 @@ module RubyProf
     def children_time
       @children_time ||= begin
         call_infos.inject(0) do |sum, call_info|
-          sum += call_info.children_time unless call_info.recursive
+          sum += call_info.children_time if !call_info.recursive?
           sum
         end
       end
@@ -78,10 +74,6 @@ module RubyProf
       end
     end
 
-    def recursive?
-      (@recursive ||= call_infos.detect(&:recursive) ? :true : :false) == :true
-    end
-
     def children
       @children ||= call_infos.map(&:children).flatten
     end

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

@@ -26,6 +26,9 @@ module RubyProf
     #                  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
@@ -42,6 +45,16 @@ module RubyProf
       @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
@@ -81,5 +94,10 @@ module RubyProf
 
     def print_footer(thread)
     end
+
+    # whether this printer need a :path option pointing to a directory
+    def self.needs_dir?
+      false
+    end
   end
-end
+end

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

@@ -31,7 +31,7 @@ module RubyProf
           @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 << "rec:#{call_info.recursive?}"
           @output << ")"
           @output << "\n"
         end

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

@@ -36,9 +36,13 @@ module RubyProf
     #   :application - a String to overide the name of the application,
     #                  as it appears on the report.
     #
+    #    :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 print(output = STDOUT, options = {})
       @output = output
       setup_options(options)
+      @editor = editor_uri
       if @graph_html = options.delete(:graph)
         @graph_html = "file://" + @graph_html if @graph_html[0]=="/"
       end
@@ -52,7 +56,7 @@ module RubyProf
       @result.threads.each do |thread|
         @current_thread_id = thread.fiber_id
         @overall_time = thread.total_time
-        thread_info = "Thread: #{thread.id}"
+				thread_info = String.new("Thread: #{thread.id}")
         thread_info << ", Fiber: #{thread.fiber_id}" unless thread.id == thread.fiber_id
         thread_info << " (#{"%4.2f%%" % ((@overall_time/@overall_threads_time)*100)} ~ #{@overall_time})"
         @output.print "<div class=\"thread\">#{thread_info}</div>"
@@ -116,8 +120,10 @@ module RubyProf
       if file =~ /\/ruby_runtime$/
         h(name(call_info))
       else
-        if RUBY_PLATFORM =~ /darwin/
-          "<a href=\"txmt://open?url=file://#{file}&line=#{method.line}\">#{h(name(call_info))}</a>"
+        if @editor
+          "<a href=\"#{@editor}://" \
+          "open?url=file://#{file}&line=#{method.line}\">" \
+          "#{h(name(call_info))}</a>"
         else
           "<a href=\"file://#{file}##{method.line}\">#{h(name(call_info))}</a>"
         end
@@ -257,4 +263,3 @@ end_help
     end
   end
 end
-

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

@@ -44,11 +44,20 @@ module RubyProf
     end
 
     def print(options = {})
+      validate_print_params(options)
       setup_options(options)
       determine_event_specification_and_value_scale
       print_threads
     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
+
     def print_threads
       remove_subsidiary_files_from_previous_profile_runs
       # TODO: merge fibers of a given thread here, instead of relying
@@ -79,6 +88,10 @@ module RubyProf
       @options[:path] || "."
     end
 
+    def self.needs_dir?
+      true
+    end
+
     def base_name
       @options[:profile] || "profile"
     end
@@ -110,7 +123,7 @@ module RubyProf
     def print_method(output, method)
       # Print out the file and method name
       output << "fl=#{file(method)}\n"
-      output << "fn=#{method_name(method)}\n"
+      output << "fn=#{method.calltree_name}\n"
 
       # Now print out the function line number and its self time
       output << "#{method.line} #{convert(method.self_time)}\n"
@@ -118,7 +131,7 @@ module RubyProf
       # Now print out all the children methods
       method.children.each do |callee|
         output << "cfl=#{file(callee.target)}\n"
-        output << "cfn=#{method_name(callee.target)}\n"
+        output << "cfn=#{callee.target.calltree_name}\n"
         output << "calls=#{callee.called} #{callee.line}\n"
 
         # Print out total times here!

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

@@ -13,6 +13,7 @@ module RubyProf
   #
   class FlatPrinterWithLineNumbers < FlatPrinter
     def print_methods(thread)
+      @editor = editor_uri
       total_time = thread.total_time
 
       methods = thread.methods.sort_by(&sort_method).reverse
@@ -38,8 +39,8 @@ module RubyProf
          if method.source_file == 'ruby_runtime'
            @output << "\n"
          else
-           @output << "\n      defined at:\n"
-           @output << "          %s:%s\n" % [File.expand_path(method.source_file), method.line]
+           @output << "\n    defined at:\n"
+           @output << defined_at_format % [File.expand_path(method.source_file), method.line]
          end
 
          callers = []
@@ -52,13 +53,31 @@ module RubyProf
          callers.uniq!
 
          unless callers.empty?
-           @output << "      called from:\n"
+           @output << "    called from:\n"
            callers.each do |args|
-             @output << "          %s (%s:%s)\n" % args
+             @output << called_from_format % args
            end
          end
          @output << "\n"
       end
     end
+
+    private
+
+    def defined_at_format
+      if @editor
+        "      #{@editor}://open?url=file://%s&line=%s\n"
+      else
+        "      %s:%s\n"
+      end
+    end
+
+    def called_from_format
+      if @editor
+        "      %s (#{@editor}://open?url=file://%s&line=%s)\n"
+      else
+        "      %s (%s:%s)\n"
+      end
+    end
   end
 end

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

@@ -20,6 +20,9 @@ module RubyProf
   #   :template    - specify an ERB template to use, instead of the
   #                  built-in self.template
   #
+  #    :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.
 
   class GraphHtmlPrinter < AbstractPrinter
     include ERB::Util
@@ -36,6 +39,7 @@ module RubyProf
     def print(output = STDOUT, options = {})
       @output = output
       setup_options(options)
+      @editor = editor_uri
       @output << @erb.result(binding).split("\n").map(&:rstrip).join("\n") << "\n"
     end
 
@@ -63,8 +67,10 @@ module RubyProf
       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>"
+        if @editor
+          "<a href=\"#{@editor}://" \
+          "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
@@ -194,8 +200,8 @@ module RubyProf
                  </tr>
                <% end %>
                <tr class="method">
-                 <td><%= sprintf("%.2f\%", total_percentage) %></td>
-                 <td><%= sprintf("%.2f\%", self_percentage) %></td>
+                 <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>
@@ -241,4 +247,3 @@ module RubyProf
     end
   end
 end
-

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

@@ -56,8 +56,8 @@ module RubyProf
         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("%#{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)

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

@@ -5,33 +5,30 @@ module RubyProf
   # one profiling run. Currently prints a flat profile, a callgrind
   # profile, a call stack profile and a graph profile.
   class MultiPrinter
-    def initialize(result)
-      @stack_printer = CallStackPrinter.new(result)
-      @graph_printer = GraphHtmlPrinter.new(result)
-      @tree_printer = CallTreePrinter.new(result)
-      @flat_printer = FlatPrinter.new(result)
+    def initialize(result, printers = [:stack, :graph, :tree, :flat])
+      @stack_printer = CallStackPrinter.new(result) if printers.include?(:stack)
+      @graph_printer = GraphHtmlPrinter.new(result) if printers.include?(:graph)
+      @tree_printer = CallTreePrinter.new(result) if printers.include?(:tree)
+      @flat_printer = FlatPrinter.new(result) if printers.include?(:flat)
+    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
     # pofile file, defaults to "profile".
     def print(options)
+      validate_print_params(options)
+
       @profile = options.delete(:profile) || "profile"
       @directory = options.delete(:path) || File.expand_path(".")
 
-      File.open(stack_profile, "w") do |f|
-        @stack_printer.print(f, options.merge(:graph => "#{@profile}.graph.html"))
-      end
-
-      File.open(graph_profile, "w") do |f|
-        @graph_printer.print(f, options)
-      end
-
-      @tree_printer.print(options.merge(:path => @directory, :profile => @profile))
-
-      File.open(flat_profile, "w") do |f|
-        @flat_printer.print(f, options)
-      end
+      print_to_stack(options) if @stack_printer
+      print_to_graph(options) if @graph_printer
+      print_to_tree(options) if @tree_printer
+      print_to_flat(options) if @flat_printer
     end
 
     # the name of the call stack profile file
@@ -54,5 +51,34 @@ module RubyProf
       "#{@directory}/#{@profile}.flat.txt"
     end
 
+    def print_to_stack(options)
+      File.open(stack_profile, "w") do |f|
+        @stack_printer.print(f, options.merge(:graph => "#{@profile}.graph.html"))
+      end
+    end
+
+    def print_to_graph(options)
+      File.open(graph_profile, "w") do |f|
+        @graph_printer.print(f, options)
+      end
+    end
+
+    def print_to_tree(options)
+      @tree_printer.print(options.merge(:path => @directory, :profile => @profile))
+    end
+
+    def print_to_flat(options)
+      File.open(flat_profile, "w") do |f|
+        @flat_printer.print(f, 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

data/lib/ruby-prof/profile.rb

@@ -1,55 +1,26 @@
 # encoding: utf-8
 
+require 'ruby-prof/profile/exclude_common_methods'
+require 'ruby-prof/profile/legacy_method_elimination'
+
 module RubyProf
   class Profile
-    # This method gets called once profiling has been completed
-    # but before results are returned to the user.  Thus it provides
-    # a hook to do any necessary post-processing on the call graph.
-    def post_process
-      self.threads.each do |thread|
-        thread.detect_recursion
-      end
-    end
+    include LegacyMethodElimination
 
-    # eliminate some calls from the graph by merging the information into callers.
-    # matchers can be a list of strings or regular expressions or the name of a file containing regexps.
-    def eliminate_methods!(matchers)
-      matchers = read_regexps_from_file(matchers) if matchers.is_a?(String)
-      eliminated = []
-      threads.each do |thread|
-        matchers.each{ |matcher| eliminated.concat(eliminate_methods(thread.methods, matcher)) }
-      end
-      eliminated
+    # Hides methods that, when represented as a call graph, have
+    # extremely large in and out degrees and make navigation impossible.
+    def exclude_common_methods!
+      ExcludeCommonMethods.apply!(self)
     end
 
-    private
-
-    # read regexps from file
-    def read_regexps_from_file(file_name)
-      matchers = []
-      File.open(file_name).each_line do |l|
-        next if (l =~ /^(#.*|\s*)$/) # emtpy lines and lines starting with #
-        matchers << Regexp.new(l.strip)
+    def exclude_methods!(mod, *method_or_methods)
+      [method_or_methods].flatten.each do |name|
+        exclude_method!(mod, name)
       end
     end
 
-    # eliminate methods matching matcher
-    def eliminate_methods(methods, matcher)
-      eliminated = []
-      i = 0
-      while i < methods.size
-        method_info = methods[i]
-        method_name = method_info.full_name
-        if matcher === method_name
-          raise "can't eliminate root method" if method_info.root?
-          eliminated << methods.delete_at(i)
-          method_info.eliminate!
-        else
-          i += 1
-        end
-      end
-      eliminated
+    def exclude_singleton_methods!(mod, *method_or_methods)
+      exclude_methods!(mod.singleton_class, *method_or_methods)
     end
-
   end
 end