ruby-prof 0.7.9 → 0.7.10

data/README

@@ -65,7 +65,7 @@ particular segments of code.
   
   # Print a flat profile to text
   printer = RubyProf::FlatPrinter.new(result)
-  printer.print(STDOUT, 0)
+  printer.print(STDOUT)
   
 Alternatively, you can use a block to tell ruby-prof what
 to profile:
@@ -245,6 +245,7 @@ the {KCachegrind}[link:http://kcachegrind.sourceforge.net/cgi-bin/show.cgi/Kcach
 Reports are created by printers.  Supported printers include:
 
 * RubyProf::FlatPrinter - Creates a flat report in text format
+* RubyProf::FlatPrinterWithLineNumbers - same as above but more verbose
 * RubyProf::GraphPrinter - Creates a call graph report in text format
 * RubyProf::GraphHtmlPrinter - Creates a call graph report in HTML (separate files per thread)
 * RubyProf::CallTreePrinter - Creates a call tree report compatible with KCachegrind.
@@ -375,23 +376,23 @@ You can also directly set the cpu frequency by calling:
 Recursive calls occur when method A calls method A and cycles
 occur when method A calls method B calls method C calls method A.
 ruby-prof detects both direct recursive calls and cycles.  Both
-are indicated in reports by a dash and number following a method
+are indicated in reports by a "d number" in parentheses following a method
 name.  For example, here is a flat profile from the test method
-RecursiveTest#test_recursive:
 
+RecursiveTest#test_recursive:
 
 %self     total     self     wait    child    calls  name
 100.00      2.00     2.00     0.00     0.00        2  Kernel#sleep
   0.00      2.00     0.00     0.00     2.00        0  RecursiveTest#test_cycle
   0.00      0.00     0.00     0.00     0.00        2  Fixnum#==
   0.00      0.00     0.00     0.00     0.00        2  Fixnum#-
-  0.00      1.00     0.00     0.00     1.00        1  Object#sub_cycle-1
+  0.00      1.00     0.00     0.00     1.00        1  Object#sub_cycle(d1)
   0.00      2.00     0.00     0.00     2.00        1  Object#sub_cycle
   0.00      2.00     0.00     0.00     2.00        1  Object#cycle
-  0.00      1.00     0.00     0.00     1.00        1  Object#cycle-1
+  0.00      1.00     0.00     0.00     1.00        1  Object#cycle(d1)
 
-Notice the presence of Object#cycle and Object#cycle-1.  The -1 means
-the method was either recursively called (directly or indirectly).
+Notice the presence of Object#cycle and Object#cycle(d1).  The d1 means
+depth 1 -- the method was either recursively called (directly or indirectly).
 
 However, the self time values for recursive calls should always 
 be accurate.  It is also believed that the total times are

data/Rakefile

@@ -123,9 +123,9 @@ end
 
 require 'fileutils'
 
-desc 'Build ruby_prof.so with debug output on'
+desc 'Build ext/ruby_prof.so'
 task :build do
- build(true)
+ build(false)
 end
 
 def build(with_debug)
@@ -143,9 +143,9 @@ def build(with_debug)
  end
 end
 
-desc 'build ruby_prof.so'
-task :build_no_debug do
- build(false)
+desc 'build ruby_prof.so with verbose symbols enabled'
+task :build_with_debug do
+ build(true)
 end
 
 task :clean do

data/bin/ruby-prof

@@ -11,6 +11,7 @@
 # Options:
 #     -p, --printer=printer            Select a printer:
 #                                        flat - Prints a flat profile as text (default).
+#                                        flat_with_line_numbers - Above, with line numbers
 #                                        graph - Prints a graph profile as text.
 #                                        graph_html - Prints a graph profile as html.
 #                                        call_tree - format for KCacheGrind
@@ -35,6 +36,8 @@
 #         --specialized-instruction    Turn on specialized instruction.
 #     -h, --help                       Show help message
 #         --version                    Show version
+#     -v                               Show version, set $VERBOSE to true, run file
+#     -d                               Set $DEBUG to true
 # 
 #
 # See also: {flat profiles}[link:files/examples/flat_txt.html], {graph profiles}[link:files/examples/graph_txt.html], {html graph profiles}[link:files/examples/graph_html.html]
@@ -60,17 +63,21 @@ opts = OptionParser.new do |opts|
   opts.separator "Options:"
 
     
-  opts.on('-p printer', '--printer=printer', [:flat, :graph, :graph_html, :call_tree],
+  opts.on('-p printer', '--printer=printer', [:flat, :flat_with_line_numbers, :graph, :graph_html, :call_tree],
           'Select a printer:',
           '  flat - Prints a flat profile as text (default).',
+          '  flat_with_line_numbers - same as flat, with line numbers.',
           '  graph - Prints a graph profile as text.',
           '  graph_html - Prints a graph profile as html.',
-          '  call_tree - format for KCacheGrind' ) do |printer|
+          '  call_tree - format for KCacheGrind'
+           ) do |printer|
 
           
     case printer
       when :flat
         options.printer = RubyProf::FlatPrinter
+      when :flat_with_line_numbers
+        options.printer = RubyProf::FlatPrinterWithLineNumbers
       when :graph
         options.printer = RubyProf::GraphPrinter
       when :graph_html
@@ -136,10 +143,20 @@ opts = OptionParser.new do |opts|
       exit
   end
   
-  opts.on_tail("-v", "--version", "Show version") do
+  opts.on_tail("--version", "Show version #{RubyProf::VERSION}") do
       puts "ruby_prof " + RubyProf::VERSION
       exit
   end
+  
+  opts.on("-v","Show version, set $VERBOSE to true, profile script") do
+      puts "ruby_prof " + RubyProf::VERSION
+      puts "ruby " + RUBY_DESCRIPTION
+      $VERBOSE= true
+  end
+  
+  opts.on("-d", "Set $DEBUG to true") do
+    $DEBUG = true
+  end
 end
 
 begin

data/ext/ruby_prof.c

@@ -149,8 +149,7 @@ method_name(ID mid, int depth)
     if (depth > 0)
     {
       char buffer[65];
-      sprintf(buffer, "d%i", depth);
-      rb_str_cat2(result, "-");
+      sprintf(buffer, "(d%i)", depth);
       rb_str_cat2(result, buffer);
     }
 
@@ -1208,7 +1207,7 @@ prof_event_hook(rb_event_flag_t event, NODE *node, VALUE self, ID mid, VALUE kla
           // sometimes frames don't have line and source somehow [like blank]
           // if we hit one there's not much we can do...I guess...
           // or maybe we don't have one because we're at the top or something.
-        while( frame->call_info->target->key->mid && frame->call_info->target->key->klass && ((frame->call_info->target->key->mid != mid) || (frame->call_info->target->key->klass != klass))){
+        while( frame && frame->call_info->target->key->mid && frame->call_info->target->key->klass && ((frame->call_info->target->key->mid != mid) || (frame->call_info->target->key->klass != klass))){
            frame = pop_frame(thread_data, now);
          }      
 #endif

data/ext/version.h

@@ -1,4 +1,4 @@
-#define RUBY_PROF_VERSION  "0.7.9"
+#define RUBY_PROF_VERSION  "0.7.10"
 #define RUBY_PROF_VERSION_MAJ   0
 #define RUBY_PROF_VERSION_MIN   7
-#define RUBY_PROF_VERSION_MIC   9
+#define RUBY_PROF_VERSION_MIC   10

data/lib/ruby-prof.rb

@@ -1,15 +1,14 @@
-require File.dirname(__FILE__) + "/../ext/ruby_prof.so"
+require File.dirname(__FILE__) + "/../ext/ruby_prof" # .so
 
 require "ruby-prof/method_info"
 require "ruby-prof/call_info"
 require "ruby-prof/aggregate_call_info"
 require "ruby-prof/flat_printer"
+require "ruby-prof/flat_printer_with_line_numbers"
 require "ruby-prof/graph_printer"
 require "ruby-prof/graph_html_printer"
 require "ruby-prof/call_tree_printer"
-require "ruby-prof/symbol_to_proc"
-
-#require "ruby-prof/test"
+require "ruby-prof/symbol_to_proc" # for 1.8's benefit
 
 module RubyProf
   # See if the user specified the clock mode via 
@@ -46,4 +45,4 @@ module RubyProf
   end
 end
 
-RubyProf::figure_measure_mode
+RubyProf::figure_measure_mode

data/lib/ruby-prof/flat_printer.rb

@@ -70,7 +70,7 @@ module RubyProf
                       method.wait_time,                    # wait
                       method.children_time,                # children
                       method.called,                       # calls
-                    method_name(method)                  # name
+                      method_name(method)                  # name
                   ]
       end
     end

data/lib/ruby-prof/flat_printer_with_line_numbers.rb

@@ -0,0 +1,63 @@
+require 'ruby-prof/abstract_printer'
+
+module RubyProf
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text. 
+  # To use the flat printer with line numbers:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlatPrinterWithLineNumbers.new(result)
+  #   printer.print(STDOUT, 0)
+  #
+  class FlatPrinterWithLineNumbers < FlatPrinter
+
+    def print_methods(thread_id, methods)
+      # Get total time
+      toplevel = methods.max
+      total_time = toplevel.total_time
+      if total_time == 0
+        total_time = 0.01
+      end
+      
+      # Now sort methods by largest self time,
+      # not total time like in other printouts
+      methods = methods.sort do |m1, m2|
+        m1.self_time <=> m2.self_time
+      end.reverse
+      
+      @output << "Thread ID: %d\n" % thread_id
+      @output << "Total: %0.6f\n" % total_time
+      @output << "\n"
+      @output << " %self     total     self     wait    child    calls  name\n"
+
+      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  %8.2f %8.2f %8.2f %8.2f %8d  %s " % [
+                      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_name(method),                 # name
+                      method.source_file,                  # filename
+                      method.line                          # line in said file 
+                  ]
+         if method.source_file != 'ruby_runtime'
+           @output << "  %s:%s" % [method.source_file, method.line]
+         end
+         @output << "\n"         
+      end
+    end
+  end
+end 
+

data/lib/ruby-prof/graph_printer.rb

@@ -11,13 +11,7 @@ module RubyProf
   #   printer = RubyProf::GraphPrinter.new(result, 5)
   #   printer.print(STDOUT, 0)
   #
-  # The constructor takes two arguments.  The first is
-  # a RubyProf::Result object generated from a profiling
-  # run.  The second is the minimum %total (the methods 
-  # total time divided by the overall total time) that
-  # a method must take for it to be printed out in 
-  # the report.  Use this parameter to eliminate methods
-  # that are not important to the overall profiling results.
+  # The constructor takes two arguments. See the README
 
   class GraphPrinter < AbstractPrinter
     PERCENTAGE_WIDTH = 8
@@ -38,9 +32,8 @@ module RubyProf
       @result.threads.each do |thread_id, methods|
         top = methods.max
         
-        thread_time = 0.01
-        thread_time = top.total_time if top.total_time > 0
-
+        thread_time = [top.total_time, 0.01].max
+        
         @thread_times[thread_id] = thread_time 
       end
     end

data/lib/ruby-prof/symbol_to_proc.rb

@@ -1,5 +1,4 @@
 unless (:a.respond_to?(:to_proc))
-
  class Symbol
    def to_proc
       proc {|stuff| stuff.send(self)}

data/test/aggregate_test.rb

@@ -115,7 +115,7 @@ class AggregateTest < Test::Unit::TestCase
     assert_in_delta(3, call_info.total_time, 0.05)
     assert_in_delta(0, call_info.wait_time, 0.01)
     assert_in_delta(0, call_info.self_time, 0.05)
-    assert_in_delta(3, call_info.children_time, 0.01)
+    assert_in_delta(3, call_info.children_time, 0.05)
     assert_equal(3, call_info.called)
   end
 end

data/test/basic_test.rb

@@ -137,7 +137,7 @@ class BasicTest < Test::Unit::TestCase
 
     methods = result.threads.values.first.sort.reverse
     assert_equal(6, methods.length)
-    names = methods.map &:full_name
+    names = methods.map(&:full_name)
     assert_equal('BasicTest#test_instance_methods', names[0])
     assert_equal('C1#hello', names[1])
     assert_equal('Kernel#sleep', names[2])
@@ -218,7 +218,7 @@ class BasicTest < Test::Unit::TestCase
 
     methods = result.threads.values.first.sort.reverse
     assert_equal(6, methods.length)
-    names = methods.map &:full_name 
+    names = methods.map(&:full_name)
     assert_equal('BasicTest#test_module_instance_methods', names[0])
     assert_equal('M1#hello', names[1])
     assert_equal('Kernel#sleep', names[2])

data/test/printers_test.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'test/unit'
 require 'ruby-prof'
-require 'prime'
+require './prime'
 
 # --  Tests ----
 class PrintersTest < Test::Unit::TestCase
@@ -16,6 +16,9 @@ class PrintersTest < Test::Unit::TestCase
     printer = RubyProf::FlatPrinter.new(@result)
     printer.print(STDOUT)
     
+    printer = RubyProf::FlatPrinterWithLineNumbers.new(@result)
+    printer.print(STDOUT)
+    
     printer = RubyProf::GraphHtmlPrinter.new(@result)
     printer.print
     
@@ -24,20 +27,32 @@ class PrintersTest < Test::Unit::TestCase
     
     printer = RubyProf::CallTreePrinter.new(@result)
     printer.print(STDOUT)
-
+    
     # we should get here
     assert(true)
   end
 
   def test_flat_string
+    output = helper_test_flat_string RubyProf::FlatPrinter
+    assert_no_match(/prime.rb/, output)
+  end
+
+  def helper_test_flat_string klass
     output = ''
     
-    printer = RubyProf::FlatPrinter.new(@result)
+    printer = klass.new(@result)
     assert_nothing_raised { printer.print(output) }
     
     assert_match(/Thread ID: -?\d+/i, output)
     assert_match(/Total: \d+\.\d+/i, output)
     assert_match(/Object#run_primes/i, output)
+    output
+  end
+  
+  def test_flat_string_with_numbers
+    output = helper_test_flat_string RubyProf::FlatPrinterWithLineNumbers
+    assert_match(/prime.rb/, output)    
+    assert_no_match(/ruby_runtime:0/, output)
   end
     
   def test_graph_html_string

data/test/recursive_test.rb

@@ -84,11 +84,11 @@ class RecursiveTest < Test::Unit::TestCase
     assert_equal(0, call_info.children.length)
 
     call_info = method.call_infos[1]
-    assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple-d1->Kernel#sleep', call_info.call_sequence)
+    assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple(d1)->Kernel#sleep', call_info.call_sequence)
     assert_equal(0, call_info.children.length)
 
     method = methods[3]
-    assert_equal('Object#simple-d1', method.full_name)
+    assert_equal('Object#simple(d1)', method.full_name)
     assert_equal(1, method.called)
     assert_in_delta(1, method.total_time, 0.01)
     assert_in_delta(0, method.self_time, 0.01)
@@ -97,7 +97,7 @@ class RecursiveTest < Test::Unit::TestCase
 
     assert_equal(1, method.call_infos.length)
     call_info = method.call_infos[0]
-    assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple-d1', call_info.call_sequence)
+    assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple(d1)', call_info.call_sequence)
     if RUBY_VERSION < '1.9'
       assert_equal(3, call_info.children.length)
 
@@ -115,7 +115,7 @@ class RecursiveTest < Test::Unit::TestCase
       assert_equal(0, call_info.children.length)
 
       call_info = method.call_infos[1]
-      assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple-d1->Fixnum#-', call_info.call_sequence)
+      assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple(d1)->Fixnum#-', call_info.call_sequence)
       assert_equal(0, call_info.children.length)
 
       method = methods[5]
@@ -132,7 +132,7 @@ class RecursiveTest < Test::Unit::TestCase
       assert_equal(0, call_info.children.length)
 
       call_info = method.call_infos[1]
-      assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple-d1->Fixnum#==', call_info.call_sequence)
+      assert_equal('RecursiveTest#test_simple->Object#simple->Object#simple(d1)->Fixnum#==', call_info.call_sequence)
       assert_equal(0, call_info.children.length)
 
     else
@@ -208,11 +208,11 @@ class RecursiveTest < Test::Unit::TestCase
     assert_equal(0, call_info.children.length)
 
     call_info = method.call_infos[1]
-    assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle-d1->Object#sub_cycle-d1->Kernel#sleep', call_info.call_sequence)
+    assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle(d1)->Object#sub_cycle(d1)->Kernel#sleep', call_info.call_sequence)
     assert_equal(0, call_info.children.length)
 
     method = methods[4]
-    assert_equal('Object#cycle-d1', method.full_name)
+    assert_equal('Object#cycle(d1)', method.full_name)
     assert_equal(1, method.called)
     assert_in_delta(1, method.total_time, 0.05)
     assert_in_delta(0, method.self_time, 0.01)
@@ -221,20 +221,17 @@ class RecursiveTest < Test::Unit::TestCase
 
     assert_equal(1, method.call_infos.length)
     call_info = method.call_infos[0]
-    assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle-d1', call_info.call_sequence)
+    assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle(d1)', call_info.call_sequence)
     assert_equal(1, call_info.children.length)
 
     method = methods[5]
-    assert_equal('Object#sub_cycle-d1', method.full_name)
+    assert_equal('Object#sub_cycle(d1)', method.full_name)
     assert_equal(1, method.called)
     assert_in_delta(1, method.total_time, 0.01)
     assert_in_delta(0, method.self_time, 0.01)
     assert_in_delta(0, method.wait_time, 0.01)
-    assert_in_delta(1, method.children_time, 0.01)
-
-    assert_equal(1, method.call_infos.length)
     call_info = method.call_infos[0]
-    assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle-d1->Object#sub_cycle-d1', call_info.call_sequence)
+    assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle(d1)->Object#sub_cycle(d1)', call_info.call_sequence)
     if RUBY_VERSION < '1.9'
       assert_equal(3, call_info.children.length)
       method = methods[6]
@@ -251,7 +248,7 @@ class RecursiveTest < Test::Unit::TestCase
       assert_equal(0, call_info.children.length)
 
       call_info = method.call_infos[1]
-      assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle-d1->Object#sub_cycle-d1->Fixnum#-', call_info.call_sequence)
+      assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle(d1)->Object#sub_cycle(d1)->Fixnum#-', call_info.call_sequence)
       assert_equal(0, call_info.children.length)
 
       method = methods[7]
@@ -268,7 +265,7 @@ class RecursiveTest < Test::Unit::TestCase
       assert_equal(0, call_info.children.length)
 
       call_info = method.call_infos[1]
-      assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle-d1->Object#sub_cycle-d1->Fixnum#==', call_info.call_sequence)
+      assert_equal('RecursiveTest#test_cycle->Object#cycle->Object#sub_cycle->Object#cycle(d1)->Object#sub_cycle(d1)->Fixnum#==', call_info.call_sequence)
       assert_equal(0, call_info.children.length)
     else
       assert_equal(1, call_info.children.length)

data/test/thread_test.rb

@@ -38,8 +38,8 @@ class ThreadTest < Test::Unit::TestCase
     assert(thread_ids.include?(threads[1].object_id))
     
     assert_instance_of(Thread, ObjectSpace._id2ref(thread_ids[0]))
-    assert(threads.include? (ObjectSpace._id2ref(thread_ids[0])))
-
+    assert(threads.include?(ObjectSpace._id2ref(thread_ids[0])))
+    
     assert_instance_of(Thread, ObjectSpace._id2ref(thread_ids[1]))
     assert(threads.include?(ObjectSpace._id2ref(thread_ids[1])))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-prof
 version: !ruby/object:Gem::Version 
-  version: 0.7.9
+  version: 0.7.10
 platform: ruby
 authors: 
 - Shugo Maeda, Charlie Savage, Roger Pack
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-15 00:00:00 -07:00
+date: 2010-01-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - lib/ruby-prof/call_info.rb
 - lib/ruby-prof/call_tree_printer.rb
 - lib/ruby-prof/flat_printer.rb
+- lib/ruby-prof/flat_printer_with_line_numbers.rb
 - lib/ruby-prof/graph_html_printer.rb
 - lib/ruby-prof/graph_printer.rb
 - lib/ruby-prof/method_info.rb