ruby-prof 0.10.8 → 0.11.0.rc1

data/CHANGES

@@ -1,48 +1,68 @@
-0.10.8
+0.11.0.rc1 (2012-03-24)
 ======================
-rename extension to ruby_prof_ext to avoid confusion when people ran require 'ruby_prof' accidentally.
+* On Windows, use QueryPerformanceCounter and QueryPerformanceFrequency to measure CPU time instead
+  of rdtsc.  This change is based on Microsoft's recommendation (Charlie Savage).
+* On Windows use GetProcessTimes to return real PROCESS_TIME times instead of wall times (Charlie Savage).
+* Big internal refactoring of C code to make RubyProf easier to understand and extend (Charlie Savage).
+* Profile results are now returned as instances of a new class RubyProf::Profile.  The old api 
+  is supported via a compatability layer that at some point will be deprecated.  (Charlie Savage).
+* Split out tests for cpu_time, process_time and wall_time into separate files (Charlie Savage).
+* Dropped support for Ruby 1.8.4 and 1.8.6 - does anybody still use these? (Charlie Savage).
+* Added support for sorting results by total, self, wait and child times (Jan Suchal)
+* Added tests for sorting behaviour & removed options from constructor to print method (Jan Suchal)
+* Fix line number tests due to changes at top of file (Charlie Savage).
+* Add encoding statement to top of all files for Ruby 1.9.x compatability (Charlie Savage).
+* Add def file for VC to avoid the whole declspec annoyance (Charlie Savage).
+* Update test suite to ensure current working directory is correct (Charlie Savage).
+* Modernize gem file and remove various custom/home grown solutions that aren't needed anymore (Charlie Savage).
+* Remove custom mingw build scripts, use rake compiler instead  (Charlie Savage).
+* Fixes for compiling with VC 2010 (Charlie Savage).
+
+0.10.8 (2011-07-06)
+======================
+* 1.9.3 super class (Roger Pack)
 
-0.10.7
+0.10.7 (2011-05-09)
 ======================
-Fix a bug with REE's GC stats. Issue #53 [thanks graaff]
+* Fix a bug with REE's GC stats. Issue #53 [thanks graaff]
 
-0.10.6
+0.10.6 (2011-04-29)
 ======================
-Slightly more normalized url for linux/windows links to files.
+* Slightly more normalized url for linux/windows links to files.
 
-0.10.5
+0.10.5 (2011-04-20)
 =======================
-1.8.6 compat for -v command (bug fix)
+* 1.8.6 compat for -v command (bug fix)
 
-0.10.4
+0.10.4 (2011-04-20)
 =======================
-Faster load time for ruby-prof itself.
+* Faster load time for ruby-prof itself.
 
 0.10.3
 =======================
-Can cleanly load before rubygems now.
+* Can cleanly load before rubygems now.
 
 0.10.2
 =======================
-Fix for 1.9.2, os x for latest commits (thanks skaes!)
+* Fix for 1.9.2, os x for latest commits (thanks skaes!)
 
 0.10.1
 =======================
-Fix bug in linux wall time, also load with only relative paths so that you can use it to benchmark rubygems startup overhead,
-itself.
+* Fix bug in linux wall time, also load with only relative paths so that you can use it to benchmark rubygems startup overhead,
+  itself.
 
 0.10.0
 =======================
-Some rdoc changes, for linux wall time attempt to use higher granularity (thanks to all the contributors for this round!)
+* Some rdoc changes, for linux wall time attempt to use higher granularity (thanks to all the contributors for this round!)
 
 0.9.2
 =======================
-Make graphviz work on 1.8.6
-roll back some 1.9.2 optimizations until I can figure out what caused them.
+* Make graphviz work on 1.8.6
+* Roll back some 1.9.2 optimizations until I can figure out what caused them.
 
 0.9.1
 =======================
-Add a graphviz output
+* Add a graphviz output
 
 0.9.0
 =======================

data/LICENSE

@@ -1,15 +1,16 @@
-Copyright (C) 2005  Shugo Maeda <shugo@ruby-lang.org>
+Copyright (C) 2005 - 20011 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
 All rights reserved.
- *
+
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
+
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
- *
+
 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

data/README.rdoc

@@ -15,7 +15,7 @@ ruby-prof is a fast code profiler for Ruby.  Its features include:
 
 == Requirements
 
-ruby-prof requires Ruby 1.8.4 or higher.
+ruby-prof requires Ruby 1.8.7 or 1.9.1 and higher.
 
 If you are running Linux or Unix you'll need a C compiler so the extension
 can be compiled when it is installed.
@@ -29,16 +29,12 @@ The easiest way to install ruby-prof is by using Ruby Gems.  To install:
 
   gem install ruby-prof
 
-If you on windows mswin [not mingw] (check via ruby -v) and
-don't have an MSVC compiler, please install v0.8.1 which
-has a prebuilt binary
-C:> gem install ruby-prof -v0.8.1
-
-If you're on mingw, please install the devkit first, then install the latest gem version (via gem install ruby-prof).
+If you're on windows then a prebuilt binary gem is available.  You may of course
+compile it yourself via use of devkit on MinGW.
 
 == Usage
 
-There are three ways of running ruby-prof.
+There are two ways of running ruby-prof, via the command line or via its API.
 
 === ruby-prof executable
 
@@ -81,8 +77,7 @@ to profile:
   printer = RubyProf::GraphPrinter.new(result)
   printer.print(STDOUT, {})
 
-Starting with the 0.6.1 release, ruby-prof also supports pausing and resuming
-profiling runs.
+ruby-prof also supports pausing and resuming profiling runs.
 
   require 'ruby-prof'
 
@@ -110,18 +105,10 @@ has not yet started.  In addition, resume can also take a block:
 With this usage, resume will automatically call pause at the
 end of the block.
 
-=== require unprof
-
-The third way of using ruby-prof is by requiring unprof.rb:
-
-  require 'unprof'
-
-This will start profiling immediately at that point and will output the results
-using a flat profile report when the process ends.
 
-== Method Elimination
+== Method and Thread Elimination
 
-Starting with release 0.9.0, ruby-prof supports eliminating methods from profiling
+ruby-prof supports eliminating specific methods and threads from profiling
 results. This is useful for reducing connectivity in the call graph, making it easier to
 identify the source of performance problems when using a graph printer.
 
@@ -141,6 +128,15 @@ the name of a file containing a list of regular expressions (line separated text
 After eliminating methods the resulting profile will appear exactly as if those methods
 had been inlined at their call sites.
 
+In a similar manner, threads can be excluded so they are not profiled at all.  To do this,
+pass an array of threads to exclude to ruby-prof:
+
+  RubyProf::exclude_threads = [ thread2 ]
+  RubyProf.start
+
+Note that the excluded threads must be specified *before* profiling.
+
+
 == Benchmarking full load time including rubygems startup cost ==
 
 If you want to get a more accurate measurement of what takes all of a gem's bin/xxx
@@ -160,7 +156,7 @@ $ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof ./some_fil
 
 == Profiling Tests
 
-Starting with the 0.6.1 release, ruby-prof supports profiling tests cases
+ruby-prof supports profiling tests cases
 written using Ruby's built-in unit test framework (ie, test derived from
 Test::Unit::TestCase).  To enable profiling simply add the following line
 of code to within your test class:
@@ -189,49 +185,23 @@ profile.rb.
 
 So to profile Rails:
 
-1.  Create a new profile.rb environment - or simply copy the example file
-    in ruby-prof/rails/environment/profile.rb
-
-2.  Copy the file:
-
-      ruby-prof/rails/profile_test_helper.rb
-
-    To:
-
-      your_rails_app/test/profile_test_helper.rb
+1.  Create a new profile.rb environment.  Make sure to turn on cache_classes
+and cache_template_loading.  Otherwise your profiling results will be
+overwhelemed by the time Rails spends loading required files.
 
-3.  Create a new test directory for profiling:
+2.  Add the ruby prof rack adapter to your middleware stack.  One way to
+do this is by adding the following code to config.ru:
 
-      your_rails_app/test/profile
-
-
-4.  Write unit, functional or integration tests specifically designed
-    to profile some part of your Rails application.  At the top
-    of each test, replace this line:
-
-      require File.dirname(__FILE__) + '/../test_helper'
-
-    With:
-
-      require File.dirname(__FILE__) + '/../profile_test_helper'
-
-    For example:
-
-    require File.dirname(__FILE__) + '/../profile_test_helper'
-
-    class ExampleTest < Test::Unit::TestCase
-      include RubyProf::Test
-      fixtures ....
-
-      def test_stuff
-        puts "Test method"
-      end
-    end
-
-5.  Now run your tests.  Results will be written to:
+  if Rails.env.profile?
+    use Rack::RubyProf, :path => '/temp/profile'
+  end
 
-      your_rails_app/tmp/profile
+The path is where you want profiling results to be stored.  By default the
+rack adapter will generate a html call graph report and flat text report.
 
+3.  Now make a request to your running server.  New profiling information will
+be generated for each request.  Note that each request will overwrite
+the profiling reports created by the previous request!
 
 == Reports
 
@@ -389,8 +359,6 @@ environment variable:
 * export RUBY_PROF_MEASURE_MODE=gc_runs
 * export RUBY_PROF_MEASURE_MODE=gc_time
 
-Note that these values have changed since ruby-prof-0.3.0.
-
 On Linux, process time is measured using the clock method provided
 by the C runtime library. Note that the clock method does not
 report time spent in the kernel or child processes and therefore
@@ -446,10 +414,6 @@ profiled.  Most programs will run approximately twice as slow
 while highly recursive programs (like the fibonacci series test)
 will run three times slower.
 
-Because of some threading difficulties in 1.9, it currently runs a 
-bit slower there, as well.
-http://www.ruby-forum.com/topic/201329
-
 == License
 
 See LICENSE for license information.

data/Rakefile

@@ -1,38 +1,61 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/testtask'
-require 'date'
+# encoding: utf-8
 
-# to release a version of ruby-prof, do a git tag, then rake cleanr default and publish that
-# git tag 0.10.1
-# git push origin 0.10.1
-# rake cleanr default
-# gem push pkg/ruby-prof-0.10.1.gem
+require "rubygems/package_task"
+require "rake/extensiontask"
+require "rake/testtask"
+require "rdoc/task"
+require "date"
 
-default_spec = eval File.read(File.expand_path('../ruby-prof.gemspec', __FILE__))
+# To release a version of ruby-prof:
+#   * Update version.h
+#   * Update CHANGES
+#   * Update rdocs
+#   * git  commit to commit files
+#   * rake clobber to remove extra files
+#   * rake compile to build windows gems
+#   * rake package to create the gems
+#   * Tag the release in git (tag 0.10.1)
+#   * Push to ruybgems.org (gem push pkg/<gem files>)
 
-desc 'deprecated--build native .gem files -- use like "native_gems clobber cross native gem"--for non native gem creation use "native_gems clobber" then "clean gem"'
-task :native_gems do
-  # we don't do cross compiler anymore, now that mingw has devkit
-  ENV['RUBY_CC_VERSION'] = '1.8.6:1.9.1'
-  require 'rake/extensiontask'
-  Rake::ExtensionTask.new('ruby_prof', default_spec) do |ext|
-    ext.cross_compile = true
-    ext.cross_platform = ['x86-mswin32-60', 'x86-mingw32-60']
-  end
+GEM_NAME = 'ruby-prof'
+SO_NAME = 'ruby_prof'
+
+default_spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
+
+Rake::ExtensionTask.new do |ext|
+  ext.gem_spec = default_spec
+  ext.name = SO_NAME
+  ext.ext_dir = "ext/#{SO_NAME}"
+  ext.lib_dir = "lib/#{RUBY_VERSION.sub(/\.\d$/, '')}"
+  ext.cross_compile = true
+  ext.cross_platform = ['x86-mswin32-60', 'x86-mingw32-60']
 end
 
 # Rake task to build the default package
-Rake::GemPackageTask.new(default_spec) do |pkg|
+Gem::PackageTask.new(default_spec) do |pkg|
   pkg.need_tar = true
-  #pkg.need_zip = true
 end
 
+# Setup Windows Gem
+if RUBY_PLATFORM.match(/win32|mingw32/)
+  # Windows specification
+  win_spec = default_spec.clone
+  win_spec.platform = Gem::Platform::CURRENT
+  win_spec.files += Dir.glob('lib/**/*.so')
+  win_spec.instance_variable_set(:@cache_file, nil) # Hack to work around gem issue
+
+  # Unset extensions
+  win_spec.extensions = nil
+
+  # Rake task to build the windows package
+  Gem::PackageTask.new(win_spec) do |pkg|
+    pkg.need_tar = false
+  end
+end
 
 # ---------  RDoc Documentation ------
 desc "Generate rdoc documentation"
-Rake::RDocTask.new("rdoc") do |rdoc|
+RDoc::Task.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = "ruby-prof"
   # Show source inline with line numbers
@@ -60,34 +83,4 @@ Rake::TestTask.new do |t|
   t.test_files = Dir['test/test_suite.rb']
   t.verbose = true
   t.warning = true
-end
-
-require 'fileutils'
-
-desc 'Build ruby_prof.so'
-task :build do
- Dir.chdir('ext/ruby_prof') do
-  unless File.exist? 'Makefile'
-    system(Gem.ruby + " extconf.rb")
-    system("make clean")
-  end
-  raise 'make failed' unless system("make")
-  FileUtils.cp 'ruby_prof.so', '../../lib' if File.exist? 'lib/ruby_prof.so'
-  FileUtils.cp 'ruby_prof.bundle', '../../lib' if File.exist? 'lib/ruby_prof.bundle'
- end
-end
-
-desc 'clean stuff'
-task :cleanr do
- Dir['**/*.{so,bundle}'].each{|f| File.delete f}
- Dir.chdir('ext/ruby_prof') do
-  if File.exist? 'Makefile'
-    system("make clean")
-    FileUtils.rm 'Makefile'
-  end
-  Dir.glob('*~') do |file|
-    FileUtils.rm file
-  end
- end
- system("rm -rf pkg")
-end
+end

data/bin/ruby-prof

@@ -15,7 +15,7 @@
 
 require 'ostruct'
 require 'optparse'
-require File.dirname(__FILE__) + "/../lib/ruby-prof"
+require File.expand_path('../../lib/ruby-prof', __FILE__)
 
 options = OpenStruct.new
 options.measure_mode = RubyProf::PROCESS_TIME
@@ -104,7 +104,26 @@ opts = OptionParser.new do |opts|
         options.measure_mode = RubyProf::GC_TIME
       end
   end
-        
+
+  opts.on('-s sort_mode', '--sort=sort_mode', [:total, :self, :wait, :child],
+      'Select how ruby-prof results should be sorted:',
+      '  total - Total time',
+      '  self - Self time',
+      '  wait - Wait time',
+      '  child - Child time') do |sort_mode|
+
+      options.sort_method = case sort_mode
+        when :total
+          :total_time
+        when :self
+          :self_time
+        when :wait
+          :wait_time
+        when :child
+          :children_time
+       end
+  end
+
   opts.on("--replace-progname", "Replace $0 when loading the .rb files.") do
           options.replace_prog_name = true
   end
@@ -184,18 +203,19 @@ at_exit {
 
   # Create a printer
   printer = options.printer.new(result)
+  printer_options = {:min_percent => options.min_percent, :sort_method => options.sort_method}
 
   # Get output
   if options.file
     # write it relative to the dir they *started* in, as it's a bit surprising to write it in the dir they end up in.
     Dir.chdir(options.old_wd) do
       File.open(options.file, 'w') do |file|
-        printer.print(file, {:min_percent => options.min_percent})
+        printer.print(file, printer_options)
       end
     end
   else
     # Print out results 
-    printer.print(STDOUT, {:min_percent => options.min_percent})
+    printer.print(STDOUT, printer_options)
   end
 }