ruby-prof 1.7.1 → 1.7.2

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

@@ -1,138 +1,156 @@
-# encoding: utf-8
-
-module RubyProf
-  # This is the base class for all Printers. It is never used directly.
-  class AbstractPrinter
-    # :stopdoc:
-    def self.needs_dir?
-      false
-    end
-    # :startdoc:
-
-    # Create a new printer.
-    #
-    # result should be the output generated from a profiling run
-    def initialize(result)
-      @result = result
-      @output = nil
-    end
-
-    # Returns the min_percent of time a method must take to be included in a profiling report
-    def min_percent
-      @options[:min_percent] || 0
-    end
-
-    # Returns the max_percent of time a method can take to be included in a profiling report
-    def max_percent
-      @options[:max_percent] || 100
-    end
-
-    # Returns the method to filter methods by (when using min_percent and max_percent)
-    def filter_by
-      @options[:filter_by] || :self_time
-    end
-
-    # Returns the time format used to show when a profile was run
-    def time_format
-      '%A, %B %-d at %l:%M:%S %p (%Z)'
-    end
-
-    # Returns how profile data should be sorted
-    def sort_method
-      @options[:sort_method]
-    end
-
-    # Prints a report to the provided output.
-    #
-    # output - Any IO object, including STDOUT or a file.
-    # The default value is STDOUT.
-    #
-    # options - Hash of print options. Note that each printer can
-    # define its own set of options.
-    #
-    #   :min_percent - Number 0 to 100 that specifies 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.
-    #
-    #   :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
-    def print(output = STDOUT, options = {})
-      @output = output
-      setup_options(options)
-      print_threads
-    end
-
-    # :nodoc:
-    def setup_options(options = {})
-      @options = options
-    end
-
-    def method_location(method)
-      if method.source_file
-        "#{method.source_file}:#{method.line}"
-      end
-    end
-
-    def method_href(thread, method)
-      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
-    end
-
-    def open_asset(file)
-      path = File.join(File.expand_path('../../assets', __FILE__), file)
-      File.open(path, 'rb').read
-    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)
-      @output << "Measure Mode: %s\n" % @result.measure_mode_string
-      @output << "Thread ID: %d\n" % thread.id
-      @output << "Fiber ID: %d\n" % thread.fiber_id unless thread.id == thread.fiber_id
-      @output << "Total: %0.6f\n" % thread.total_time
-      @output << "Sort by: #{sort_method}\n"
-      @output << "\n"
-      print_column_headers
-    end
-
-    def print_column_headers
-    end
-
-    def print_footer(thread)
-      @output << <<~EOT
-
-        * recursively called methods
-
-        Columns are:
-
-          %self     - The percentage of time spent in this method, derived from self_time/total_time.
-          total     - The time spent in this method and its children.
-          self      - The time spent in this method.
-          wait      - The amount of time this method waited for other threads.
-          child     - The time spent in this method's children.
-          calls     - The number of times this method was called.
-          name      - The name of the method.
-          location  - The location of the method.
-
-        The interpretation of method names is:
-
-          * MyObject#test - An instance method "test" of the class "MyObject"
-          * <Object:MyObject>#test - The <> characters indicate a method on a singleton class.
-
-      EOT
-    end
-  end
-end
+# encoding: utf-8
+
+module RubyProf
+  # This is the base class for all Printers. It is never used directly.
+  class AbstractPrinter
+    # :stopdoc:
+    def self.needs_dir?
+      false
+    end
+    # :startdoc:
+
+    # Create a new printer.
+    #
+    # result should be the output generated from a profiling run
+    def initialize(result)
+      @result = result
+      @output = nil
+    end
+
+    # Returns the min_percent of time a method must take to be included in a profiling report
+    def min_percent
+      @options[:min_percent] || 0
+    end
+
+    # Returns the max_percent of time a method can take to be included in a profiling report
+    def max_percent
+      @options[:max_percent] || 100
+    end
+
+    # Returns the method to filter methods by (when using min_percent and max_percent)
+    def filter_by
+      @options[:filter_by] || :self_time
+    end
+
+    # Returns the time format used to show when a profile was run
+    def time_format
+      '%A, %B %-d at %l:%M:%S %p (%Z)'
+    end
+
+    # Returns how profile data should be sorted
+    def sort_method
+      @options[:sort_method]
+    end
+
+    # Prints a report to the provided output.
+    #
+    # output - Any IO object, including STDOUT or a file.
+    # The default value is STDOUT.
+    #
+    # options - Hash of print options. Note that each printer can
+    # define its own set of options.
+    #
+    #   :min_percent - Number 0 to 100 that specifies 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.
+    #
+    #   :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
+    def print(output = STDOUT, options = {})
+      @output = output
+      setup_options(options)
+      print_threads
+    end
+
+    # :nodoc:
+    def setup_options(options = {})
+      @options = options
+    end
+
+    def method_location(method)
+      if method.source_file
+        "#{method.source_file}:#{method.line}"
+      end
+    end
+
+    def method_href(thread, method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
+    end
+
+    def open_asset(file)
+      path = File.join(File.expand_path('../../assets', __FILE__), file)
+      File.open(path, 'rb').read
+    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)
+      @output << "Measure Mode: %s\n" % @result.measure_mode_string
+      @output << "Thread ID: %d\n" % thread.id
+      @output << "Fiber ID: %d\n" % thread.fiber_id unless thread.id == thread.fiber_id
+      @output << "Total: %0.6f\n" % thread.total_time
+      @output << "Sort by: #{sort_method}\n"
+      @output << "\n"
+      print_column_headers
+    end
+
+    def print_column_headers
+    end
+
+    def print_footer(thread)
+      metric_data = {
+        0 => { label: "time", prefix: "", suffix: "spent" },
+        1 => { label: "time", prefix: "", suffix: "spent" },
+        2 => { label: "allocations", prefix: "number of ", suffix: "made" },
+        3 => { label: "memory", prefix: "", suffix: "used" }
+      }
+
+      metric = metric_data[@result.measure_mode]
+
+      metric_label = metric[:label]
+      metric_suffix = metric[:suffix]
+      metric_prefix = metric[:prefix]
+
+      metric1 = "#{metric_label} #{metric_suffix}"
+      metric2 = "#{metric_prefix}#{metric1}"
+      metric3 = metric_label
+
+      # Output the formatted text
+      @output << <<~EOT
+
+        * recursively called methods
+
+        Columns are:
+
+          %self     - The percentage of #{metric1} by this method relative to the total #{metric3} in the entire program.
+          total     - The total #{metric2} by this method and its children.
+          self      - The #{metric2} by this method.
+          wait      - The time this method spent waiting for other threads.
+          child     - The #{metric2} by this method's children.
+          calls     - The number of times this method was called.
+          name      - The name of the method.
+          location  - The location of the method.
+
+        The interpretation of method names is:
+
+          * MyObject#test - An instance method "test" of the class "MyObject"
+          * <Object:MyObject>#test - The <> characters indicate a method on a singleton class.
+
+      EOT
+    end
+  end
+end

data/lib/ruby-prof/version.rb

@@ -1,3 +1,3 @@
-module RubyProf
-  VERSION = "1.7.1"
-end
+module RubyProf
+  VERSION = "1.7.2"
+end

data/ruby-prof.gemspec

@@ -1,65 +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_development_dependency("base64")
-  spec.add_development_dependency('minitest')
-  spec.add_development_dependency('rake-compiler')
-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/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

data/test/dynamic_method_test.rb

@@ -35,27 +35,15 @@ class DynamicMethodTest < TestCase
 
     methods = result.threads.first.methods.sort.reverse
 
-    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.1')
-      expected_method_names = %w(
-        DynamicMethodTest#test_dynamic_method
-        Kernel#sleep
-        DynamicMethodTest::FruitMedley#peach
-        DynamicMethodTest::FruitMedley#banana
-        DynamicMethodTest::FruitMedley#orange
-        DynamicMethodTest::FruitMedley#apple
-        Symbol#to_s
-      )
-    else
-      expected_method_names = %w(
-        DynamicMethodTest#test_dynamic_method
-        Kernel#sleep
-        DynamicMethodTest::FruitMedley#peach
-        DynamicMethodTest::FruitMedley#banana
-        DynamicMethodTest::FruitMedley#orange
-        DynamicMethodTest::FruitMedley#apple
-        Integer#==
-      )
-    end
+    expected_method_names = %w(
+      DynamicMethodTest#test_dynamic_method
+      Kernel#sleep
+      DynamicMethodTest::FruitMedley#peach
+      DynamicMethodTest::FruitMedley#banana
+      DynamicMethodTest::FruitMedley#orange
+      DynamicMethodTest::FruitMedley#apple
+      Integer#==
+    )
 
     assert_equal expected_method_names.join("\n"), methods.map(&:full_name).join("\n")
   end

data/test/enumerable_test.rb

@@ -1,21 +1,23 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require File.expand_path('../test_helper', __FILE__)
-
-# --  Test for bug
-# http://github.com/rdp/ruby-prof/issues#issue/12
-
-class EnumerableTest < TestCase
-  def test_enumerable
-    result = RubyProf::Profile.profile do
-      3.times {  [1,2,3].any? {|n| n} }
-    end
-    methods = if RUBY_VERSION >= "3.3.0"
-                %w(EnumerableTest#test_enumerable Integer#times Kernel#block_given? Integer#< Array#any? Integer#succ)
-              else
-                %w(EnumerableTest#test_enumerable Integer#times Array#any?)
-              end
-    assert_equal(methods, result.threads.first.methods.map(&:full_name))
-  end
-end
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# --  Test for bug
+# http://github.com/rdp/ruby-prof/issues#issue/12
+
+class EnumerableTest < TestCase
+  def test_enumerable
+    result = RubyProf::Profile.profile do
+      3.times {  [1,2,3].any? {|n| n} }
+    end
+    methods = if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.3')
+                %w(EnumerableTest#test_enumerable Integer#times Array#any?)
+              elsif Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.4')
+                %w(EnumerableTest#test_enumerable Integer#times Kernel#block_given? Integer#< Array#any? Integer#succ)
+              else
+                %w(EnumerableTest#test_enumerable Integer#times Integer#< Array#any? Integer#succ)
+              end
+    assert_equal(methods, result.threads.first.methods.map(&:full_name))
+  end
+end