ruby-prof 1.7.2 → 2.0.1

data/lib/unprof.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
-
-require "ruby-prof"
-
-at_exit {
-  result = RubyProf.stop
-  printer = RubyProf::FlatPrinter.new(result)
-  printer.print(STDOUT)
-}
-RubyProf.start
+# encoding: utf-8
+
+require "ruby-prof"
+
+at_exit {
+  result = RubyProf.stop
+  printer = RubyProf::FlatPrinter.new(result)
+  printer.print(STDOUT)
+}
+RubyProf.start

data/ruby-prof.gemspec

@@ -1,66 +1,66 @@
-# -*- encoding: utf-8 -*-
-
-$:.push File.expand_path("../lib", __FILE__)
-require "ruby-prof/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "ruby-prof"
-
-  spec.homepage = "https://github.com/ruby-prof/ruby-prof/"
-  spec.summary = "Fast Ruby profiler"
-  spec.description = <<-EOF
-ruby-prof is a fast code profiler for Ruby. It is a C extension and
-therefore is many times faster than the standard Ruby profiler. It
-supports both flat and graph profiles.  For each method, graph profiles
-show how long the method ran, which methods called it and which
-methods it called. RubyProf generate both text and html and can output
-it to standard out or to a file.
-EOF
-  spec.license = 'BSD-2-Clause'
-  spec.version = RubyProf::VERSION
-
-  spec.metadata = {
-    "bug_tracker_uri"   => "https://github.com/ruby-prof/ruby-prof/issues",
-    "changelog_uri"     => "https://github.com/ruby-prof/ruby-prof/blob/master/CHANGES",
-    "documentation_uri" => "https://ruby-prof.github.io/",
-    "source_code_uri"   => "https://github.com/ruby-prof/ruby-prof/tree/v#{spec.version}",
-  }
-
-  spec.author = "Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes"
-  spec.email = "shugo@ruby-lang.org, cfis@savagexi.com, rogerdpack@gmail.com, skaes@railsexpress.de"
-  spec.platform = Gem::Platform::RUBY
-  spec.require_path = "lib"
-  spec.bindir = "bin"
-  spec.executables = ["ruby-prof", "ruby-prof-check-trace"]
-  spec.extensions = ["ext/ruby_prof/extconf.rb"]
-  spec.files = Dir['CHANGES',
-                   'LICENSE',
-                   'Rakefile',
-                   'README.md',
-                   'ruby-prof.gemspec',
-                   'bin/ruby-prof',
-                   'bin/ruby-prof-check-trace',
-                   'doc/**/*',
-                   'examples/*',
-                   'ext/ruby_prof/extconf.rb',
-                   'ext/ruby_prof/*.c',
-                   'ext/ruby_prof/*.h',
-                   'ext/ruby_prof/vc/*.sln',
-                   'ext/ruby_prof/vc/*.vcxproj',
-                   'lib/ruby-prof.rb',
-                   'lib/unprof.rb',
-                   'lib/ruby-prof/*.rb',
-                   'lib/ruby-prof/assets/*',
-                   'lib/ruby-prof/profile/*.rb',
-                   'lib/ruby-prof/printers/*.rb',
-                   'test/*.rb']
-
-  spec.test_files = Dir["test/test_*.rb"]
-  spec.required_ruby_version = '>= 3.0.0'
-  spec.date = Time.now.strftime('%Y-%m-%d')
-  spec.homepage = 'https://github.com/ruby-prof/ruby-prof'
-  spec.add_dependency('base64')
-  spec.add_development_dependency('minitest')
-  spec.add_development_dependency('rake-compiler')
-  spec.add_development_dependency('rdoc')
-end
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-prof/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-prof"
+
+  spec.homepage = "https://github.com/ruby-prof/ruby-prof/"
+  spec.summary = "Fast Ruby profiler"
+  spec.description = <<-EOF
+ruby-prof is a fast code profiler for Ruby. It is a C extension and
+therefore is many times faster than the standard Ruby profiler. It
+supports both flat and graph profiles.  For each method, graph profiles
+show how long the method ran, which methods called it and which
+methods it called. RubyProf generate both text and html and can output
+it to standard out or to a file.
+EOF
+  spec.license = 'BSD-2-Clause'
+  spec.version = RubyProf::VERSION
+
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/ruby-prof/ruby-prof/issues",
+    "changelog_uri"     => "https://github.com/ruby-prof/ruby-prof/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://ruby-prof.github.io/",
+    "source_code_uri"   => "https://github.com/ruby-prof/ruby-prof/tree/v#{spec.version}",
+  }
+
+  spec.author = "Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes"
+  spec.email = "shugo@ruby-lang.org, cfis@savagexi.com, rogerdpack@gmail.com, skaes@railsexpress.de"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "lib"
+  spec.bindir = "bin"
+  spec.executables = ["ruby-prof", "ruby-prof-check-trace"]
+  spec.extensions = ["ext/ruby_prof/extconf.rb"]
+  spec.files = Dir['CHANGELOG.md',
+                   'LICENSE',
+                   'Rakefile',
+                   'README.md',
+                   'ruby-prof.gemspec',
+                   'bin/ruby-prof',
+                   'bin/ruby-prof-check-trace',
+                   'docs/**/*',
+                   'ext/ruby_prof/extconf.rb',
+                   'ext/ruby_prof/*.c',
+                   'ext/ruby_prof/*.h',
+                   'ext/ruby_prof/vc/*.sln',
+                   'ext/ruby_prof/vc/*.vcxproj',
+                   'lib/ruby-prof.rb',
+                   'lib/unprof.rb',
+                   'lib/ruby-prof/*.rb',
+                   'lib/ruby-prof/assets/*',
+                   'lib/ruby-prof/profile/*.rb',
+                   'lib/ruby-prof/printers/*.rb',
+                   'test/*.rb']
+
+  spec.test_files = Dir["test/test_*.rb"]
+  spec.required_ruby_version = '>= 3.2.0'
+  spec.date = Time.now.strftime('%Y-%m-%d')
+  spec.homepage = 'https://github.com/ruby-prof/ruby-prof'
+  spec.add_dependency('base64')
+  spec.add_dependency('ostruct')
+  spec.add_development_dependency('minitest')
+  spec.add_development_dependency('rake-compiler')
+  spec.add_development_dependency('rdoc')
+end

data/test/abstract_printer_test.rb

@@ -1,27 +1,25 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require File.expand_path('../test_helper', __FILE__)
-
-class AbstractPrinterTest < TestCase
-  def setup
-    super
-    @result = {}
-    @printer = RubyProf::AbstractPrinter.new(@result)
-    @options = {}
-    @printer.setup_options(@options)
-  end
-
-  private
-
-  def with_const_stubbed(name, value)
-    old_verbose, $VERBOSE = $VERBOSE, nil
-    old_value = Object.const_get(name)
-
-    Object.const_set(name, value)
-    yield
-    Object.const_set(name, old_value)
-
-    $VERBOSE = old_verbose
-  end
-end
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class AbstractPrinterTest < TestCase
+  def setup
+    super
+    @result = {}
+    @printer = RubyProf::AbstractPrinter.new(@result)
+  end
+
+  private
+
+  def with_const_stubbed(name, value)
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    old_value = Object.const_get(name)
+
+    Object.const_set(name, value)
+    yield
+    Object.const_set(name, old_value)
+
+    $VERBOSE = old_verbose
+  end
+end

data/test/alias_test.rb

@@ -1,117 +1,203 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require File.expand_path("../test_helper", __FILE__)
-
-class AliasTest < TestCase
-  class TestMe
-    def some_method
-      sleep(0.1)
-    end
-
-    alias :some_method_original :some_method
-    def some_method
-      some_method_original
-    end
-  end
-
-  def test_alias
-    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
-      TestMe.new.some_method
-    end
-
-    methods = result.threads.first.methods
-    assert_equal(6, methods.count)
-
-    # Method 0
-    method = methods[0]
-    assert_equal('AliasTest#test_alias', method.full_name)
-    assert_equal(20, method.line)
-    refute(method.recursive?)
-
-    assert_equal(0, method.call_trees.callers.count)
-
-    assert_equal(2, method.call_trees.callees.count)
-    call_tree = method.call_trees.callees[0]
-    assert_equal('Class#new', call_tree.target.full_name)
-    assert_equal(20, call_tree.line)
-
-    call_tree = method.call_trees.callees[1]
-    assert_equal('AliasTest::TestMe#some_method', call_tree.target.full_name)
-    assert_equal(20, call_tree.line)
-
-    # Method 1
-    method = methods[1]
-    assert_equal('Class#new', method.full_name)
-    assert_equal(0, method.line)
-    refute(method.recursive?)
-
-    assert_equal(1, method.call_trees.callers.count)
-    call_tree = method.call_trees.callers[0]
-    assert_equal('AliasTest#test_alias', call_tree.parent.target.full_name)
-    assert_equal(20, call_tree.line)
-
-    assert_equal(1, method.call_trees.callees.count)
-    call_tree = method.call_trees.callees[0]
-    assert_equal('BasicObject#initialize', call_tree.target.full_name)
-    assert_equal(0, call_tree.line)
-
-    # Method 2
-    method = methods[2]
-    assert_equal('BasicObject#initialize', method.full_name)
-    assert_equal(0, method.line)
-    refute(method.recursive?)
-
-    assert_equal(1, method.call_trees.callers.count)
-    call_tree = method.call_trees.callers[0]
-    assert_equal('Class#new', call_tree.parent.target.full_name)
-    assert_equal(0, call_tree.line)
-
-    assert_equal(0, method.call_trees.callees.count)
-
-    # Method 3
-    method = methods[3]
-    assert_equal('AliasTest::TestMe#some_method', method.full_name)
-    assert_equal(13, method.line)
-    refute(method.recursive?)
-
-    assert_equal(1, method.call_trees.callers.count)
-    call_tree = method.call_trees.callers[0]
-    assert_equal('AliasTest#test_alias', call_tree.parent.target.full_name)
-    assert_equal(20, call_tree.line)
-
-    assert_equal(1, method.call_trees.callees.count)
-    call_tree = method.call_trees.callees[0]
-    assert_equal('AliasTest::TestMe#some_method_original', call_tree.target.full_name)
-    assert_equal(14, call_tree.line)
-
-    # Method 4
-    method = methods[4]
-    assert_equal('AliasTest::TestMe#some_method_original', method.full_name)
-    assert_equal(8, method.line)
-    refute(method.recursive?)
-
-    assert_equal(1, method.call_trees.callers.count)
-    call_tree = method.call_trees.callers[0]
-    assert_equal('AliasTest::TestMe#some_method', call_tree.parent.target.full_name)
-    assert_equal(14, call_tree.line)
-
-    assert_equal(1, method.call_trees.callees.count)
-    call_tree = method.call_trees.callees[0]
-    assert_equal('Kernel#sleep', call_tree.target.full_name)
-    assert_equal(9, call_tree.line)
-
-    # Method 5
-    method = methods[5]
-    assert_equal('Kernel#sleep', method.full_name)
-    assert_equal(0, method.line)
-    refute(method.recursive?)
-
-    assert_equal(1, method.call_trees.callers.count)
-    call_tree = method.call_trees.callers[0]
-    assert_equal('AliasTest::TestMe#some_method_original', call_tree.parent.target.full_name)
-    assert_equal(9, call_tree.line)
-
-    assert_equal(0, method.call_trees.callees.count)
-  end
-end
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path("../test_helper", __FILE__)
+
+class AliasTest < TestCase
+  class TestMe
+    def some_method
+      sleep(0.1)
+    end
+
+    alias :some_method_original :some_method
+    def some_method
+      some_method_original
+    end
+  end
+
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('4.0')
+    def test_alias
+      result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+        TestMe.new.some_method
+      end
+
+      methods = result.threads.first.methods
+      assert_equal(6, methods.count)
+
+      # Method 0
+      method = methods[0]
+      assert_equal('AliasTest#test_alias', method.full_name)
+      assert_equal(21, method.line)
+      refute(method.recursive?)
+
+      assert_equal(0, method.call_trees.callers.count)
+
+      assert_equal(2, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('Class#new', call_tree.target.full_name)
+      assert_equal(21, call_tree.line)
+
+      call_tree = method.call_trees.callees[1]
+      assert_equal('AliasTest::TestMe#some_method', call_tree.target.full_name)
+      assert_equal(21, call_tree.line)
+
+      # Method 1
+      method = methods[1]
+      assert_equal('Class#new', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest#test_alias', call_tree.parent.target.full_name)
+      assert_equal(21, call_tree.line)
+
+      assert_equal(1, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('BasicObject#initialize', call_tree.target.full_name)
+      assert_equal(0, call_tree.line)
+
+      # Method 2
+      method = methods[2]
+      assert_equal('BasicObject#initialize', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('Class#new', call_tree.parent.target.full_name)
+      assert_equal(0, call_tree.line)
+
+      assert_equal(0, method.call_trees.callees.count)
+
+      # Method 3
+      method = methods[3]
+      assert_equal('AliasTest::TestMe#some_method', method.full_name)
+      assert_equal(13, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest#test_alias', call_tree.parent.target.full_name)
+      assert_equal(21, call_tree.line)
+
+      assert_equal(1, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('AliasTest::TestMe#some_method_original', call_tree.target.full_name)
+      assert_equal(14, call_tree.line)
+
+      # Method 4
+      method = methods[4]
+      assert_equal('AliasTest::TestMe#some_method_original', method.full_name)
+      assert_equal(8, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest::TestMe#some_method', call_tree.parent.target.full_name)
+      assert_equal(14, call_tree.line)
+
+      assert_equal(1, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('Kernel#sleep', call_tree.target.full_name)
+      assert_equal(9, call_tree.line)
+
+      # Method 5
+      method = methods[5]
+      assert_equal('Kernel#sleep', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest::TestMe#some_method_original', call_tree.parent.target.full_name)
+      assert_equal(9, call_tree.line)
+
+      assert_equal(0, method.call_trees.callees.count)
+    end
+  else
+    def test_alias
+      result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+        TestMe.new.some_method
+      end
+
+      methods = result.threads.first.methods
+      assert_equal(5, methods.count)
+
+      # Method 0
+      method = methods[0]
+      assert_equal('AliasTest#test_alias', method.full_name)
+      assert_equal(121, method.line)
+      refute(method.recursive?)
+
+      assert_equal(0, method.call_trees.callers.count)
+
+      assert_equal(2, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('BasicObject#initialize', call_tree.target.full_name)
+      assert_equal(121, call_tree.line)
+
+      call_tree = method.call_trees.callees[1]
+      assert_equal('AliasTest::TestMe#some_method', call_tree.target.full_name)
+      assert_equal(121, call_tree.line)
+
+      # Method 1
+      method = methods[1]
+      assert_equal('BasicObject#initialize', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest#test_alias', call_tree.parent.target.full_name)
+      assert_equal(121, call_tree.line)
+
+      assert_equal(0, method.call_trees.callees.count)
+
+      # Method 2
+      method = methods[2]
+      assert_equal('AliasTest::TestMe#some_method', method.full_name)
+      assert_equal(13, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest#test_alias', call_tree.parent.target.full_name)
+      assert_equal(121, call_tree.line)
+
+      assert_equal(1, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('AliasTest::TestMe#some_method_original', call_tree.target.full_name)
+      assert_equal(14, call_tree.line)
+
+      # Method 3
+      method = methods[3]
+      assert_equal('AliasTest::TestMe#some_method_original', method.full_name)
+      assert_equal(8, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest::TestMe#some_method', call_tree.parent.target.full_name)
+      assert_equal(14, call_tree.line)
+
+      assert_equal(1, method.call_trees.callees.count)
+      call_tree = method.call_trees.callees[0]
+      assert_equal('Kernel#sleep', call_tree.target.full_name)
+      assert_equal(9, call_tree.line)
+
+      # Method 4
+      method = methods[4]
+      assert_equal('Kernel#sleep', method.full_name)
+      assert_equal(0, method.line)
+      refute(method.recursive?)
+
+      assert_equal(1, method.call_trees.callers.count)
+      call_tree = method.call_trees.callers[0]
+      assert_equal('AliasTest::TestMe#some_method_original', call_tree.parent.target.full_name)
+      assert_equal(9, call_tree.line)
+
+      assert_equal(0, method.call_trees.callees.count)
+    end
+  end
+end

data/test/call_tree_builder.rb

@@ -20,9 +20,9 @@ def build_call_tree(tree_hash)
   # tree_hash is a hash keyed on the parent method_name whose values are
   # child methods. Example:
   #
-  # tree_hash = {:root => [:a, :b],
-  #              :a => [:aa, :ab],
-  #              :b => [:bb]}
+  # tree_hash = {root: [:a, :b],
+  #              a: [:aa, :ab],
+  #              b: [:bb]}
   #
   # Note this is a simplified structure for testing. It assumes methods
   # are only called from one call_tree.
@@ -49,9 +49,9 @@ def create_call_tree_1
   #
 
   # ------ Call Trees 1 -------------
-  tree_hash = {:root => [:a, :b],
-               :a => [:aa, :ab],
-               :b => [:bb]}
+  tree_hash = {root: [:a, :b],
+               a: [:aa, :ab],
+               b: [:bb]}
 
   call_trees = build_call_tree(tree_hash)
 
@@ -90,9 +90,9 @@ def create_call_tree_2
   #    \     / \
   #    ab  ba  bb
 
-  tree_hash = {:root => [:a, :b],
-               :a => [:ab],
-               :b => [:ba, :bb]}
+  tree_hash = {root: [:a, :b],
+               a: [:ab],
+               b: [:ba, :bb]}
 
   call_trees = build_call_tree(tree_hash)
 

data/test/call_tree_visitor_test.rb

@@ -1,27 +1,27 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require File.expand_path('../test_helper', __FILE__)
-require_relative './measure_times'
-
-class CallTreeVisitorTest < TestCase
-  def test_visit
-    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
-      RubyProf::C1.sleep_wait
-    end
-
-    visitor = RubyProf::CallTreeVisitor.new(result.threads.first.call_tree)
-
-    method_names = Array.new
-
-    visitor.visit do |call_tree, event|
-      method_names << call_tree.target.full_name if event == :enter
-    end
-
-    assert_equal(3, method_names.length)
-    assert_equal("CallTreeVisitorTest#test_visit", method_names[0])
-    assert_equal("<Class::RubyProf::C1>#sleep_wait", method_names[1])
-    assert_equal("Kernel#sleep", method_names[2])
-  end
-end
-
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require_relative './measure_times'
+
+class CallTreeVisitorTest < TestCase
+  def test_visit
+    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+      RubyProf::C1.sleep_wait
+    end
+
+    visitor = RubyProf::CallTreeVisitor.new(result.threads.first.call_tree)
+
+    method_names = Array.new
+
+    visitor.visit do |call_tree, event|
+      method_names << call_tree.target.full_name if event == :enter
+    end
+
+    assert_equal(3, method_names.length)
+    assert_equal("CallTreeVisitorTest#test_visit", method_names[0])
+    assert_equal("<Class::RubyProf::C1>#sleep_wait", method_names[1])
+    assert_equal("Kernel#sleep", method_names[2])
+  end
+end
+