ruby-prof 2.0.2 → 2.0.4

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

@@ -1,168 +1,169 @@
-# encoding: utf-8
-
-require 'erb'
-require 'fileutils'
-require 'base64'
-require 'set'
-require 'stringio'
-
-module RubyProf
-  # Prints a HTML visualization of the call tree.
-  #
-  # To use the printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::CallStackPrinter.new(result)
-  #   printer.print(STDOUT)
-
-  class CallStackPrinter < AbstractPrinter
-    include ERB::Util
-
-    # Specify print options.
-    #
-    # output     - Any IO object, including STDOUT or a file.
-    #
-    # Keyword arguments:
-    #   title:       - a String to override the default "ruby-prof call stack"
-    #                  title of the report.
-    #
-    #   threshold:   - a float from 0 to 100 that sets the threshold of
-    #                  results displayed.
-    #                  Default value is 1.0
-    #
-    #   expansion:   - a float from 0 to 100 that sets the threshold of
-    #                  results that are expanded, if the percent_total
-    #                  exceeds it.
-    #                  Default value is 10.0
-    #
-    #   application: - a String to override the name of the application,
-    #                  as it appears on the report.
-    #
-    # Also accepts min_percent:, max_percent:, filter_by:, and sort_method:
-    # from AbstractPrinter.
-    def print(output = STDOUT, title: "ruby-prof call stack", threshold: 1.0,
-              expansion: 10.0, application: $PROGRAM_NAME,
-              min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, **)
-      @min_percent = min_percent
-      @max_percent = max_percent
-      @filter_by = filter_by
-      @sort_method = sort_method
-      @title = title
-      @threshold = threshold
-      @expansion = expansion
-      @application = application
-      output << ERB.new(self.template).result(binding)
-    end
-
-    def print_stack(output, visited, call_tree, parent_time)
-      total_time = call_tree.total_time
-      percent_parent = (total_time/parent_time)*100
-      percent_total = (total_time/@overall_time)*100
-      return unless percent_total > min_percent
-      color = self.color(percent_total)
-      visible = percent_total >= threshold
-      expanded = percent_total >= expansion
-      display = visible ? "block" : "none"
-
-      output << "<li class=\"color#{color}\" style=\"display:#{display}\">" << "\n"
-
-      if visited.include?(call_tree)
-        output << "<a href=\"#\" class=\"toggle empty\" ></a>" << "\n"
-        output << "<span>%s %s</span>" % [link(call_tree.target, true), graph_link(call_tree)] << "\n"
-      else
-        visited << call_tree
-
-        if call_tree.children.empty?
-          output << "<a href=\"#\" class=\"toggle empty\" ></a>" << "\n"
-        else
-          visible_children = call_tree.children.any?{|ci| (ci.total_time/@overall_time)*100 >= threshold}
-          image = visible_children ? (expanded ? "minus" : "plus") : "empty"
-          output << "<a href=\"#\" class=\"toggle #{image}\" ></a>" << "\n"
-        end
-        output << "<span>%4.2f%% (%4.2f%%) %s %s</span>" % [percent_total, percent_parent,
-                                                            link(call_tree.target, false), graph_link(call_tree)] << "\n"
-
-        unless call_tree.children.empty?
-          output <<  (expanded ? '<ul>' : '<ul style="display:none">')  << "\n"
-          call_tree.children.sort_by{|c| -c.total_time}.each do |child_call_tree|
-            print_stack(output, visited, child_call_tree, total_time)
-          end
-          output << '</ul>' << "\n"
-        end
-
-        visited.delete(call_tree)
-      end
-      output << '</li>' << "\n"
-    end
-
-    def name(call_tree)
-      method = call_tree.target
-      method.full_name
-    end
-
-    def link(method, recursive)
-      method_name = "#{recursive ? '*' : ''}#{method.full_name}"
-      if method.source_file.nil?
-        h method_name
-      else
-        file = File.expand_path(method.source_file)
-       "<a href=\"file://#{file}##{method.line}\">#{h method_name}</a>"
-      end
-    end
-
-    def graph_link(call_tree)
-      total_calls = call_tree.target.called
-      totals = total_calls.to_s
-      "[#{call_tree.called} calls, #{totals} total]"
-    end
-
-    def method_href(method)
-      h(method.full_name.gsub(/[><#\.\?=:]/,"_"))
-    end
-
-    def total_time(call_trees)
-      sum(call_trees.map{|ci| ci.total_time})
-    end
-
-    def sum(a)
-      a.inject(0.0){|s,t| s+=t}
-    end
-
-    def dump(ci)
-      $stderr.printf "%s/%d t:%f s:%f w:%f  \n", ci, ci.object_id, ci.total_time, ci.self_time, ci.wait_time
-    end
-
-    def color(p)
-      case i = p.to_i
-      when 0..5
-        "01"
-      when 5..10
-        "05"
-      when 100
-        "9"
-      else
-        "#{i/10}"
-      end
-    end
-
-    attr_reader :application, :title, :threshold, :expansion
-
-    def arguments
-      ARGV.join(' ')
-    end
-
-    def base64_image
-      @data ||= begin
-        file = open_asset('call_stack_printer.png')
-        Base64.encode64(file).gsub(/\n/, '')
-      end
-    end
-
-    def template
-      open_asset('call_stack_printer.html.erb')
-    end
-  end
-end
+# encoding: utf-8
+
+require 'erb'
+require 'fileutils'
+require 'base64'
+require 'set'
+require 'stringio'
+
+module RubyProf
+  # Prints a HTML visualization of the call tree.
+  #
+  # To use the printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::CallStackPrinter.new(result)
+  #   printer.print(STDOUT)
+
+  class CallStackPrinter < AbstractPrinter
+    include ERB::Util
+
+    # Specify print options.
+    #
+    # output     - Any IO object, including STDOUT or a file.
+    #
+    # Keyword arguments:
+    #   title:       - a String to override the default "ruby-prof call stack"
+    #                  title of the report.
+    #
+    #   threshold:   - a float from 0 to 100 that sets the threshold of
+    #                  results displayed.
+    #                  Default value is 1.0
+    #
+    #   expansion:   - a float from 0 to 100 that sets the threshold of
+    #                  results that are expanded, if the percent_total
+    #                  exceeds it.
+    #                  Default value is 10.0
+    #
+    #   application: - a String to override the name of the application,
+    #                  as it appears on the report.
+    #
+    # Also accepts min_percent:, max_percent:, filter_by:, and sort_method:
+    # from AbstractPrinter.
+    def print(output = STDOUT, title: "ruby-prof call stack", threshold: 1.0,
+              expansion: 10.0, application: $PROGRAM_NAME,
+              min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, max_depth: nil, **)
+      @min_percent = min_percent
+      @max_percent = max_percent
+      @filter_by = filter_by
+      @sort_method = sort_method
+      @max_depth = max_depth
+      @title = title
+      @threshold = threshold
+      @expansion = expansion
+      @application = application
+      output << ERB.new(self.template).result(binding)
+    end
+
+    def print_stack(output, visited, call_tree, parent_time, depth = 0)
+      total_time = call_tree.total_time
+      percent_parent = (total_time/parent_time)*100
+      percent_total = (total_time/@overall_time)*100
+      return unless percent_total > min_percent
+      color = self.color(percent_total)
+      visible = percent_total >= threshold
+      expanded = percent_total >= expansion
+      display = visible ? "block" : "none"
+
+      output << "<li class=\"color#{color}\" style=\"display:#{display}\">" << "\n"
+
+      if visited.include?(call_tree)
+        output << "<a href=\"#\" class=\"toggle empty\" ></a>" << "\n"
+        output << "<span>%s %s</span>" % [link(call_tree.target, true), graph_link(call_tree)] << "\n"
+      else
+        visited << call_tree
+
+        if call_tree.children.empty? || (@max_depth && depth >= @max_depth)
+          output << "<a href=\"#\" class=\"toggle empty\" ></a>" << "\n"
+        else
+          visible_children = call_tree.children.any?{|ci| (ci.total_time/@overall_time)*100 >= threshold}
+          image = visible_children ? (expanded ? "minus" : "plus") : "empty"
+          output << "<a href=\"#\" class=\"toggle #{image}\" ></a>" << "\n"
+        end
+        output << "<span>%4.2f%% (%4.2f%%) %s %s</span>" % [percent_total, percent_parent,
+                                                            link(call_tree.target, false), graph_link(call_tree)] << "\n"
+
+        unless call_tree.children.empty? || (@max_depth && depth >= @max_depth)
+          output <<  (expanded ? '<ul>' : '<ul style="display:none">')  << "\n"
+          call_tree.children.sort_by{|c| -c.total_time}.each do |child_call_tree|
+            print_stack(output, visited, child_call_tree, total_time, depth + 1)
+          end
+          output << '</ul>' << "\n"
+        end
+
+        visited.delete(call_tree)
+      end
+      output << '</li>' << "\n"
+    end
+
+    def name(call_tree)
+      method = call_tree.target
+      method.full_name
+    end
+
+    def link(method, recursive)
+      method_name = "#{recursive ? '*' : ''}#{method.full_name}"
+      if method.source_file.nil?
+        h method_name
+      else
+        file = File.expand_path(method.source_file)
+       "<a href=\"file://#{file}##{method.line}\">#{h method_name}</a>"
+      end
+    end
+
+    def graph_link(call_tree)
+      total_calls = call_tree.target.called
+      totals = total_calls.to_s
+      "[#{call_tree.called} calls, #{totals} total]"
+    end
+
+    def method_href(method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_"))
+    end
+
+    def total_time(call_trees)
+      sum(call_trees.map{|ci| ci.total_time})
+    end
+
+    def sum(a)
+      a.inject(0.0){|s,t| s+=t}
+    end
+
+    def dump(ci)
+      $stderr.printf "%s/%d t:%f s:%f w:%f  \n", ci, ci.object_id, ci.total_time, ci.self_time, ci.wait_time
+    end
+
+    def color(p)
+      case i = p.to_i
+      when 0..5
+        "01"
+      when 5..10
+        "05"
+      when 100
+        "9"
+      else
+        "#{i/10}"
+      end
+    end
+
+    attr_reader :application, :title, :threshold, :expansion
+
+    def arguments
+      ARGV.join(' ')
+    end
+
+    def base64_image
+      @data ||= begin
+        file = open_asset('call_stack_printer.png')
+        Base64.encode64(file).gsub(/\n/, '')
+      end
+    end
+
+    def template
+      open_asset('call_stack_printer.html.erb')
+    end
+  end
+end

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

@@ -1,79 +1,78 @@
-# encoding: utf-8
-
-require 'erb'
-require 'json'
-
-module RubyProf
-  # Prints a HTML flame graph visualization of the call tree.
-  #
-  # To use the printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::FlameGraphPrinter.new(result)
-  #   printer.print(STDOUT)
-
-  class FlameGraphPrinter < AbstractPrinter
-    include ERB::Util
-
-    # Specify print options.
-    #
-    # output - Any IO object, including STDOUT or a file.
-    #
-    # Keyword arguments:
-    #   title:       - a String to override the default "ruby-prof flame graph"
-    #                  title of the report.
-    #
-    # Also accepts min_percent:, max_percent:, filter_by:, and sort_method:
-    # from AbstractPrinter.
-    def print(output = STDOUT, title: "ruby-prof flame graph",
-              min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, **)
-      @min_percent = min_percent
-      @max_percent = max_percent
-      @filter_by = filter_by
-      @sort_method = sort_method
-      @title = title
-      output << ERB.new(self.template).result(binding)
-    end
-
-    attr_reader :title
-
-    def build_flame_data(call_tree, visited = Set.new)
-      node = {
-        name: call_tree.target.full_name,
-        value: call_tree.total_time,
-        self_value: call_tree.self_time,
-        called: call_tree.called,
-        children: []
-      }
-
-      unless visited.include?(call_tree.target)
-        visited.add(call_tree.target)
-        call_tree.children.sort_by { |c| -c.total_time }.each do |child|
-          node[:children] << build_flame_data(child, visited)
-        end
-        visited.delete(call_tree.target)
-      end
-
-      node
-    end
-
-    def flame_data_json
-      threads = @result.threads.map do |thread|
-        {
-          id: thread.id,
-          fiber_id: thread.fiber_id,
-          total_time: thread.total_time,
-          data: build_flame_data(thread.call_tree)
-        }
-      end
-      JSON.generate(threads)
-    end
-
-    def template
-      open_asset('flame_graph_printer.html.erb')
-    end
-  end
-end
+# encoding: utf-8
+
+require 'erb'
+require 'json'
+
+module RubyProf
+  # Prints a HTML flame graph visualization of the call tree.
+  #
+  # To use the printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlameGraphPrinter.new(result)
+  #   printer.print(STDOUT)
+
+  class FlameGraphPrinter < AbstractPrinter
+    include ERB::Util
+
+    # Specify print options.
+    #
+    # output - Any IO object, including STDOUT or a file.
+    #
+    # Keyword arguments:
+    #   title:       - a String to override the default "ruby-prof flame graph"
+    #                  title of the report.
+    #
+    # Also accepts min_percent:, max_percent:, filter_by:, and sort_method:
+    # from AbstractPrinter.
+    def print(output = STDOUT, title: "ruby-prof flame graph",
+              min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, max_depth: nil, **)
+      @min_percent = min_percent
+      @max_percent = max_percent
+      @filter_by = filter_by
+      @sort_method = sort_method
+      @max_depth = max_depth
+      @title = title
+      output << ERB.new(self.template).result(binding)
+    end
+
+    attr_reader :title
+
+    def build_flame_data(call_tree, depth = 0)
+      node = {
+        name: call_tree.target.full_name,
+        value: call_tree.total_time,
+        self_value: call_tree.self_time,
+        called: call_tree.called,
+        children: []
+      }
+
+      if @max_depth.nil? || depth < @max_depth
+        call_tree.children.each do |child|
+          node[:children] << build_flame_data(child, depth + 1)
+        end
+      end
+
+      node
+    end
+
+    def flame_data_json
+      threads = @result.threads.map do |thread|
+        {
+          id: thread.id,
+          fiber_id: thread.fiber_id,
+          total_time: thread.total_time,
+          data: build_flame_data(thread.call_tree)
+        }
+      end
+      JSON.generate(threads)
+    end
+
+    def template
+      open_asset('flame_graph_printer.html.erb')
+    end
+  end
+end

data/lib/ruby-prof/version.rb

@@ -1,3 +1,3 @@
 module RubyProf
-  VERSION = "2.0.2"
+  VERSION = "2.0.4"
 end

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/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
+# -*- 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/#{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/printer_flat_test.rb

@@ -96,4 +96,15 @@ class PrinterFlatTest < TestCase
 
     assert self_percents.min >= 0.1
   end
+
+  def test_flat_result_nil_sort_method
+    printer = RubyProf::FlatPrinter.new(self.run_profile)
+
+    output = StringIO.new
+    printer.print(output, sort_method: nil)
+    total_times = flat_output_nth_column_values(output.string, 2)
+
+    # nil sort_method should fall back to default (total_time)
+    assert_sorted total_times
+  end
 end