ruby-prof 2.0.3 → 2.0.5

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

@@ -1,143 +1,143 @@
-# 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
-
-    attr_reader :min_percent, :max_percent, :filter_by, :sort_method
-
-    # 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
-
-    # Prints a report to the provided output.
-    #
-    # output - Any IO object, including STDOUT or a file.
-    # The default value is STDOUT.
-    #
-    # Keyword arguments:
-    #   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.
-    #
-    #   max_percent  - Number 0 to 100 that specifies the maximum
-    #                  %self for methods to include.
-    #                  Default value is 100.
-    #
-    #   filter_by    - Which time metric to use when applying
-    #                  min_percent and max_percent filters.
-    #                  Default value is :self_time.
-    #
-    #   sort_method  - Specifies method used for sorting method infos.
-    #                  Available values are :total_time, :self_time,
-    #                  :wait_time, :children_time.
-    #                  Default value depends on the printer.
-    def print(output = STDOUT, min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, max_depth: nil, **)
-      @output = output
-      @min_percent = min_percent
-      @max_percent = max_percent
-      @filter_by = filter_by
-      @sort_method = sort_method
-      @max_depth = max_depth
-      print_threads
-    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
+# 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
+
+    attr_reader :min_percent, :max_percent, :filter_by, :sort_method
+
+    # 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
+
+    # Prints a report to the provided output.
+    #
+    # output - Any IO object, including STDOUT or a file.
+    # The default value is STDOUT.
+    #
+    # Keyword arguments:
+    #   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.
+    #
+    #   max_percent  - Number 0 to 100 that specifies the maximum
+    #                  %self for methods to include.
+    #                  Default value is 100.
+    #
+    #   filter_by    - Which time metric to use when applying
+    #                  min_percent and max_percent filters.
+    #                  Default value is :self_time.
+    #
+    #   sort_method  - Specifies method used for sorting method infos.
+    #                  Available values are :total_time, :self_time,
+    #                  :wait_time, :children_time.
+    #                  Default value depends on the printer.
+    def print(output = STDOUT, min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, max_depth: nil, **)
+      @output = output
+      @min_percent = min_percent
+      @max_percent = max_percent
+      @filter_by = filter_by
+      @sort_method = sort_method || :total_time
+      @max_depth = max_depth
+      print_threads
+    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/printers/flame_graph_printer.rb

@@ -1,78 +1,80 @@
-# 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
+# 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
+      # Disable JSON nesting limit (default 100) so deep call trees serialize.
+      # See https://github.com/ruby-prof/ruby-prof/issues/353
+      JSON.generate(threads, max_nesting: false)
+    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.3"
-end
+module RubyProf
+  VERSION = "2.0.5"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-prof
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.5
 platform: ruby
 authors:
 - Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes
 bindir: bin
 cert_chain: []
-date: 2026-02-28 00:00:00.000000000 Z
+date: 2026-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -97,38 +97,8 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
 - bin/ruby-prof
 - bin/ruby-prof-check-trace
-- docs/advanced-usage.md
-- docs/alternatives.md
-- docs/architecture.md
-- docs/best-practices.md
-- docs/getting-started.md
-- docs/history.md
-- docs/index.md
-- docs/profiling-rails.md
-- docs/public/examples/example.rb
-- docs/public/examples/generate_reports.rb
-- docs/public/examples/reports/call_info.txt
-- docs/public/examples/reports/call_stack.html
-- docs/public/examples/reports/callgrind.out
-- docs/public/examples/reports/flame_graph.html
-- docs/public/examples/reports/flat.txt
-- docs/public/examples/reports/graph.dot
-- docs/public/examples/reports/graph.html
-- docs/public/examples/reports/graph.txt
-- docs/public/examples/reports/graphviz_viewer.html
-- docs/public/images/call_stack.png
-- docs/public/images/class_diagram.png
-- docs/public/images/dot_printer.png
-- docs/public/images/flame_graph.png
-- docs/public/images/flat.png
-- docs/public/images/graph.png
-- docs/public/images/graph_html.png
-- docs/public/images/ruby-prof-logo.svg
-- docs/reports.md
-- docs/stylesheets/extra.css
 - ext/ruby_prof/extconf.rb
 - ext/ruby_prof/rp_allocation.c
 - ext/ruby_prof/rp_allocation.h
@@ -179,56 +149,6 @@ files:
 - lib/ruby-prof/thread.rb
 - lib/ruby-prof/version.rb
 - lib/unprof.rb
-- ruby-prof.gemspec
-- test/abstract_printer_test.rb
-- test/alias_test.rb
-- test/call_tree_builder.rb
-- test/call_tree_test.rb
-- test/call_tree_visitor_test.rb
-- test/call_trees_test.rb
-- test/duplicate_names_test.rb
-- test/dynamic_method_test.rb
-- test/enumerable_test.rb
-- test/exceptions_test.rb
-- test/exclude_methods_test.rb
-- test/exclude_threads_test.rb
-- test/fiber_test.rb
-- test/gc_test.rb
-- test/inverse_call_tree_test.rb
-- test/line_number_test.rb
-- test/marshal_test.rb
-- test/measure_allocations.rb
-- test/measure_allocations_test.rb
-- test/measure_process_time_test.rb
-- test/measure_times.rb
-- test/measure_wall_time_test.rb
-- test/measurement_test.rb
-- test/merge_test.rb
-- test/method_info_test.rb
-- test/multi_printer_test.rb
-- test/no_method_class_test.rb
-- test/pause_resume_test.rb
-- test/prime.rb
-- test/prime_script.rb
-- test/printer_call_stack_test.rb
-- test/printer_call_tree_test.rb
-- test/printer_flame_graph_test.rb
-- test/printer_flat_test.rb
-- test/printer_graph_html_test.rb
-- test/printer_graph_test.rb
-- test/printers_test.rb
-- test/printing_recursive_graph_test.rb
-- test/profile_test.rb
-- test/rack_test.rb
-- test/recursive_test.rb
-- test/scheduler.rb
-- test/singleton_test.rb
-- test/stack_printer_test.rb
-- test/start_stop_test.rb
-- test/test_helper.rb
-- test/thread_test.rb
-- test/unique_call_path_test.rb
-- test/yarv_test.rb
 homepage: https://github.com/ruby-prof/ruby-prof
 licenses:
 - BSD-2-Clause
@@ -236,7 +156,7 @@ 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/v2.0.3
+  source_code_uri: https://github.com/ruby-prof/ruby-prof/tree/2.0.5
 rdoc_options: []
 require_paths:
 - lib
@@ -254,5 +174,4 @@ requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
 summary: Fast Ruby profiler
-test_files:
-- test/test_helper.rb
+test_files: []

data/Rakefile

@@ -1,98 +0,0 @@
-# encoding: utf-8
-
-require "rubygems/package_task"
-require "rake/extensiontask"
-require "rake/testtask"
-require "rdoc/task"
-require "date"
-require "rake/clean"
-
-# To release a version of ruby-prof:
-#   * Update lib/ruby-prof/version.rb
-#   * Update CHANGES
-#   * 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 (git tag 0.10.1)
-#   * Push to ruybgems.org (gem push pkg/<gem files>)
-
-GEM_NAME = 'ruby-prof'
-SO_NAME = 'ruby_prof'
-
-default_spec = Gem::Specification.load("#{GEM_NAME}.gemspec")
-
-# specify which versions/builds to cross compile
-Rake::ExtensionTask.new do |ext|
-  ext.gem_spec = default_spec
-  ext.name = SO_NAME
-  ext.ext_dir = "ext/#{SO_NAME}"
-  ext.lib_dir = "lib/#{Gem::Version.new(RUBY_VERSION).segments[0..1].join('.')}"
-  ext.cross_compile = true
-  ext.cross_platform = ['x64-mingw32']
-end
-
-# Rake task to build the default package
-Gem::PackageTask.new(default_spec) do |pkg|
-  pkg.need_tar = true
-end
-
-# make sure rdoc has been built when packaging
-# why do we ship rdoc as part of the gem?
-Rake::Task[:package].enhance [:rdoc]
-
-# Setup Windows Gem
-if RUBY_PLATFORM.match(/mswin|mingw/)
-  # Windows specification
-  win_spec = default_spec.clone
-  win_spec.platform = Gem::Platform::CURRENT
-  win_spec.files += Dir.glob('lib/**/*.so')
-
-  # 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"
-RDoc::Task.new("rdoc") do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title = "ruby-prof"
-  # Show source inline with line numbers
-  rdoc.options << "--line-numbers"
-  # Make the readme file the start page for the generated html
-  rdoc.options << '--main' << 'README.md'
-  rdoc.rdoc_files.include('bin/*',
-                          'doc/*.rdoc',
-                          'lib/**/*.rb',
-                          'ext/ruby_prof/*.c',
-                          'ext/ruby_prof/*.h',
-                          'README.md',
-                          'LICENSE')
-end
-
-task :default => :test
-
-for file in Dir['lib/**/*.{o,so,bundle}']
-  CLEAN.include file
-end
-for file in Dir['doc/**/*.{txt,dat,png,html}']
-  CLEAN.include file
-end
-CLEAN.reject!{|f| !File.exist?(f)}
-task :clean do
-  # remove tmp dir contents completely after cleaning
-  FileUtils.rm_rf('tmp/*')
-end
-
-desc 'Run the ruby-prof test suite'
-Rake::TestTask.new do |t|
-  t.libs += %w(lib ext test)
-  t.test_files = Dir['test/**_test.rb']
-  t.verbose = true
-  t.warning = true
-end