ruby-prof 1.7.2 → 2.0.0

data/test/unique_call_path_test.rb

@@ -1,123 +1,123 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require File.expand_path('../test_helper', __FILE__)
-
-class UniqueCallPath
-  def method_a(i)
-    if i==1
-      method_b
-    else
-      method_c
-    end
-  end
-
-  def method_b
-    method_c
-  end
-
-  def method_c
-  end
-
-  def method_k(i)
-    method_a(i)
-  end
-end
-
-
-# --  Tests ----
-class UniqueCallPathTest < TestCase
-  def test_root
-    unique_call_path = UniqueCallPath.new
-
-    result = RubyProf::Profile.profile do
-      unique_call_path.method_a(1)
-    end
-
-    root_call_info = result.threads.first.call_tree
-    assert_equal("UniqueCallPathTest#test_root", root_call_info.target.full_name)
-  end
-
-  def test_root_children
-    unique_call_path = UniqueCallPath.new
-
-    result = RubyProf::Profile.profile do
-      unique_call_path.method_a(1)
-      unique_call_path.method_k(2)
-    end
-
-    root_call_info = result.threads.first.call_tree
-    children = root_call_info.children.sort do |c1, c2|
-      c1.target.full_name <=> c2.target.full_name
-    end
-
-    assert_equal(2, children.length)
-    assert_equal("UniqueCallPath#method_a", children[0].target.full_name)
-    assert_equal("UniqueCallPath#method_k", children[1].target.full_name)
-  end
-
-  def test_children_of
-    unique_call_path = UniqueCallPath.new
-
-    result = RubyProf::Profile.profile do
-      unique_call_path.method_a(1)
-      unique_call_path.method_k(2)
-    end
-
-    root_call_info = result.threads.first.call_tree
-    assert_equal("UniqueCallPathTest#test_children_of", root_call_info.target.full_name)
-
-    call_info_a = root_call_info.children.detect do |call_tree|
-      call_tree.target.full_name == "UniqueCallPath#method_a"
-    end
-    refute_nil(call_info_a)
-
-    _children_of_a = call_info_a.children.inject(Array.new) do |array, c|
-      if c.parent.eql?(call_info_a)
-        array << c
-      end
-      array
-    end
-
-    assert_equal(2, call_info_a.children.length)
-    assert_equal("Integer#==", call_info_a.children[0].target.full_name)
-    assert_equal("UniqueCallPath#method_b", call_info_a.children[1].target.full_name)
-  end
-
-  def test_unique_path
-    unique_call_path = UniqueCallPath.new
-
-    result = RubyProf::Profile.profile do
-      unique_call_path.method_a(1)
-      unique_call_path.method_k(1)
-    end
-
-    root_call_info = result.threads.first.call_tree
-    assert_equal("UniqueCallPathTest#test_unique_path", root_call_info.target.full_name)
-
-    call_info_a = root_call_info.children.detect do |call_tree|
-      call_tree.target.full_name == "UniqueCallPath#method_a"
-    end
-    refute_nil(call_info_a)
-
-    children_of_a = call_info_a.children.reduce(Array.new) do |array, c|
-      if c.parent.eql?(call_info_a)
-        array << c
-      end
-      array
-    end
-
-    children_of_a = children_of_a.sort do |c1, c2|
-      c1.target.full_name <=> c2.target.full_name
-    end
-
-    assert_equal(2, call_info_a.children.length)
-    assert_equal(2, children_of_a.length)
-
-    assert_equal(1, children_of_a[0].called)
-    assert_equal("Integer#==", children_of_a[0].target.full_name)
-
-    assert_equal(1, children_of_a[1].called)
-    assert_equal("UniqueCallPath#method_b", children_of_a[1].target.full_name)
-  end
-end
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class UniqueCallPath
+  def method_a(i)
+    if i==1
+      method_b
+    else
+      method_c
+    end
+  end
+
+  def method_b
+    method_c
+  end
+
+  def method_c
+  end
+
+  def method_k(i)
+    method_a(i)
+  end
+end
+
+
+# --  Tests ----
+class UniqueCallPathTest < TestCase
+  def test_root
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf::Profile.profile do
+      unique_call_path.method_a(1)
+    end
+
+    root_call_info = result.threads.first.call_tree
+    assert_equal("UniqueCallPathTest#test_root", root_call_info.target.full_name)
+  end
+
+  def test_root_children
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf::Profile.profile do
+      unique_call_path.method_a(1)
+      unique_call_path.method_k(2)
+    end
+
+    root_call_info = result.threads.first.call_tree
+    children = root_call_info.children.sort do |c1, c2|
+      c1.target.full_name <=> c2.target.full_name
+    end
+
+    assert_equal(2, children.length)
+    assert_equal("UniqueCallPath#method_a", children[0].target.full_name)
+    assert_equal("UniqueCallPath#method_k", children[1].target.full_name)
+  end
+
+  def test_children_of
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf::Profile.profile do
+      unique_call_path.method_a(1)
+      unique_call_path.method_k(2)
+    end
+
+    root_call_info = result.threads.first.call_tree
+    assert_equal("UniqueCallPathTest#test_children_of", root_call_info.target.full_name)
+
+    call_info_a = root_call_info.children.detect do |call_tree|
+      call_tree.target.full_name == "UniqueCallPath#method_a"
+    end
+    refute_nil(call_info_a)
+
+    _children_of_a = call_info_a.children.inject(Array.new) do |array, c|
+      if c.parent.eql?(call_info_a)
+        array << c
+      end
+      array
+    end
+
+    assert_equal(2, call_info_a.children.length)
+    assert_equal("Integer#==", call_info_a.children[0].target.full_name)
+    assert_equal("UniqueCallPath#method_b", call_info_a.children[1].target.full_name)
+  end
+
+  def test_unique_path
+    unique_call_path = UniqueCallPath.new
+
+    result = RubyProf::Profile.profile do
+      unique_call_path.method_a(1)
+      unique_call_path.method_k(1)
+    end
+
+    root_call_info = result.threads.first.call_tree
+    assert_equal("UniqueCallPathTest#test_unique_path", root_call_info.target.full_name)
+
+    call_info_a = root_call_info.children.detect do |call_tree|
+      call_tree.target.full_name == "UniqueCallPath#method_a"
+    end
+    refute_nil(call_info_a)
+
+    children_of_a = call_info_a.children.reduce(Array.new) do |array, c|
+      if c.parent.eql?(call_info_a)
+        array << c
+      end
+      array
+    end
+
+    children_of_a = children_of_a.sort do |c1, c2|
+      c1.target.full_name <=> c2.target.full_name
+    end
+
+    assert_equal(2, call_info_a.children.length)
+    assert_equal(2, children_of_a.length)
+
+    assert_equal(1, children_of_a[0].called)
+    assert_equal("Integer#==", children_of_a[0].target.full_name)
+
+    assert_equal(1, children_of_a[1].called)
+    assert_equal("UniqueCallPath#method_b", children_of_a[1].target.full_name)
+  end
+end

data/test/yarv_test.rb

@@ -1,56 +1,56 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require File.expand_path('../test_helper', __FILE__)
-
-# tests for bugs reported by users
-class YarvTest < TestCase
-  def setup
-    super
-    define_methods
-  end
-
-  def test_array_push_unoptimized
-    a = nil
-    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
-      a = self.array_push_unoptimized
-    end
-    assert_equal 2, a.length
-    assert_equal ["YarvTest#test_array_push_unoptimized", "YarvTest#array_push_unoptimized", 'Array#<<', "Array#push"], result.threads.first.methods.map(&:full_name)
-  end
-
-  def test_array_push_optimized
-    a = nil
-    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
-      a = self.array_push_optimized
-    end
-    assert_equal(2, a.length)
-    assert_equal(["YarvTest#test_array_push_optimized", "YarvTest#array_push_optimized", "Array#<<", "Array#push"], result.threads.first.methods.map(&:full_name))
-  end
-
-  private
-
-  def define_methods
-    return if respond_to?(:array_push_optimized)
-    old_compile_option = RubyVM::InstructionSequence.compile_option
-    RubyVM::InstructionSequence.compile_option = {
-      :trace_instruction => true,
-      :specialized_instruction => false
-    }
-    self.class.class_eval <<-"EOM"
-      def array_push_unoptimized
-        a = []
-        a << 1
-        a.push 2
-      end
-    EOM
-    RubyVM::InstructionSequence.compile_option = old_compile_option
-    self.class.class_eval <<-"EOM"
-      def array_push_optimized
-        a = []
-        a << 1
-        a.push 2
-      end
-    EOM
-  end
-end
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# tests for bugs reported by users
+class YarvTest < TestCase
+  def setup
+    super
+    define_methods
+  end
+
+  def test_array_push_unoptimized
+    a = nil
+    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+      a = self.array_push_unoptimized
+    end
+    assert_equal 2, a.length
+    assert_equal ["YarvTest#test_array_push_unoptimized", "YarvTest#array_push_unoptimized", 'Array#<<', "Array#push"], result.threads.first.methods.map(&:full_name)
+  end
+
+  def test_array_push_optimized
+    a = nil
+    result = RubyProf::Profile.profile(measure_mode: RubyProf::WALL_TIME) do
+      a = self.array_push_optimized
+    end
+    assert_equal(2, a.length)
+    assert_equal(["YarvTest#test_array_push_optimized", "YarvTest#array_push_optimized", "Array#<<", "Array#push"], result.threads.first.methods.map(&:full_name))
+  end
+
+  private
+
+  def define_methods
+    return if respond_to?(:array_push_optimized)
+    old_compile_option = RubyVM::InstructionSequence.compile_option
+    RubyVM::InstructionSequence.compile_option = {
+      trace_instruction: true,
+      specialized_instruction: false
+    }
+    self.class.class_eval <<-"EOM"
+      def array_push_unoptimized
+        a = []
+        a << 1
+        a.push 2
+      end
+    EOM
+    RubyVM::InstructionSequence.compile_option = old_compile_option
+    self.class.class_eval <<-"EOM"
+      def array_push_optimized
+        a = []
+        a << 1
+        a.push 2
+      end
+    EOM
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-prof
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes
 bindir: bin
 cert_chain: []
-date: 2025-05-21 00:00:00.000000000 Z
+date: 2026-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,12 +94,41 @@ extensions:
 - ext/ruby_prof/extconf.rb
 extra_rdoc_files: []
 files:
-- CHANGES
+- 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
@@ -94,7 +137,6 @@ files:
 - ext/ruby_prof/rp_call_trees.c
 - ext/ruby_prof/rp_call_trees.h
 - ext/ruby_prof/rp_measure_allocations.c
-- ext/ruby_prof/rp_measure_memory.c
 - ext/ruby_prof/rp_measure_process_time.c
 - ext/ruby_prof/rp_measure_wall_time.c
 - ext/ruby_prof/rp_measurement.c
@@ -114,10 +156,10 @@ files:
 - lib/ruby-prof.rb
 - lib/ruby-prof/assets/call_stack_printer.html.erb
 - lib/ruby-prof/assets/call_stack_printer.png
+- lib/ruby-prof/assets/flame_graph_printer.html.erb
 - lib/ruby-prof/assets/graph_printer.html.erb
 - lib/ruby-prof/call_tree.rb
 - lib/ruby-prof/call_tree_visitor.rb
-- lib/ruby-prof/compatibility.rb
 - lib/ruby-prof/exclude_common_methods.rb
 - lib/ruby-prof/measurement.rb
 - lib/ruby-prof/method_info.rb
@@ -126,6 +168,7 @@ files:
 - lib/ruby-prof/printers/call_stack_printer.rb
 - lib/ruby-prof/printers/call_tree_printer.rb
 - lib/ruby-prof/printers/dot_printer.rb
+- lib/ruby-prof/printers/flame_graph_printer.rb
 - lib/ruby-prof/printers/flat_printer.rb
 - lib/ruby-prof/printers/graph_html_printer.rb
 - lib/ruby-prof/printers/graph_printer.rb
@@ -143,7 +186,6 @@ files:
 - test/call_tree_test.rb
 - test/call_tree_visitor_test.rb
 - test/call_trees_test.rb
-- test/compatibility_test.rb
 - test/duplicate_names_test.rb
 - test/dynamic_method_test.rb
 - test/enumerable_test.rb
@@ -157,7 +199,6 @@ files:
 - test/marshal_test.rb
 - test/measure_allocations.rb
 - test/measure_allocations_test.rb
-- test/measure_memory_test.rb
 - test/measure_process_time_test.rb
 - test/measure_times.rb
 - test/measure_wall_time_test.rb
@@ -171,6 +212,7 @@ files:
 - 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
@@ -192,9 +234,9 @@ licenses:
 - BSD-2-Clause
 metadata:
   bug_tracker_uri: https://github.com/ruby-prof/ruby-prof/issues
-  changelog_uri: https://github.com/ruby-prof/ruby-prof/blob/master/CHANGES
+  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/v1.7.2
+  source_code_uri: https://github.com/ruby-prof/ruby-prof/tree/v2.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -202,14 +244,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Fast Ruby profiler
 test_files:

data/ext/ruby_prof/rp_measure_memory.c

@@ -1,46 +0,0 @@
-/* Copyright (C) 2005-2013 Shugo Maeda <shugo@ruby-lang.org> and Charlie Savage <cfis@savagexi.com>
-   Please see the LICENSE file for copyright and distribution information */
-
-/* :nodoc: */
-
-#include "rp_measurement.h"
-
-static VALUE cMeasureMemory;
-
-static double measure_memory(rb_trace_arg_t* trace_arg)
-{
-    static double result = 0;
-
-    if (trace_arg)
-    {
-        // Only process creation of new objects
-        rb_event_flag_t event = rb_tracearg_event_flag(trace_arg);
-        if (event == RUBY_INTERNAL_EVENT_NEWOBJ)
-        {
-            // Don't count allocations of internal IMemo objects
-            VALUE object = rb_tracearg_object(trace_arg);
-            if (BUILTIN_TYPE(object) != T_IMEMO)
-                result += rb_obj_memsize_of(object);
-        }
-    }
-
-    return result;
-}
-
-prof_measurer_t* prof_measurer_memory(bool track_allocations)
-{
-  prof_measurer_t* measure = ALLOC(prof_measurer_t);
-  measure->mode = MEASURE_MEMORY;
-  measure->measure = measure_memory;
-  measure->multiplier = 1;
-  // Need to track allocations to get RUBY_INTERNAL_EVENT_NEWOBJ event
-  measure->track_allocations = true;
-  return measure;
-}
-
-void rp_init_measure_memory(void)
-{
-    rb_define_const(mProf, "MEMORY", INT2NUM(MEASURE_MEMORY));
-
-    cMeasureMemory = rb_define_class_under(mMeasure, "Allocations", rb_cObject);
-}

data/lib/ruby-prof/compatibility.rb

@@ -1,113 +0,0 @@
-# encoding: utf-8
-
-# These methods are deprecated and are available for backwards compatability.
-module RubyProf
-  # call-seq:
-  # measure_mode -> measure_mode
-  #
-  # Returns what ruby-prof is measuring.  Valid values include:
-  #
-  # * RubyProf::WALL_TIME
-  # * RubyProf::PROCESS_TIME
-  # * RubyProf::ALLOCATIONS
-  # * RubyProf::MEMORY
-  def self.measure_mode
-    @measure_mode ||= RubyProf::WALL_TIME
-  end
-
-  # call-seq:
-  # measure_mode=value -> void
-  #
-  # Specifies what ruby-prof should measure.  Valid values include:
-  #
-  # * RubyProf::WALL_TIME - Wall time measures the real-world time elapsed between any two moments. If there are other processes concurrently running on the system that use significant CPU or disk time during a profiling run then the reported results will be larger than expected. On Windows, wall time is measured using GetTickCount(), on MacOS by mach_absolute_time, on Linux by clock_gettime and otherwise by gettimeofday.
-  # * RubyProf::PROCESS_TIME - Process time measures the time used by a process between any two moments. It is unaffected by other processes concurrently running on the system. Remember with process time that calls to methods like sleep will not be included in profiling results. On Windows, process time is measured using GetProcessTimes and on other platforms by clock_gettime.
-  # * RubyProf::ALLOCATIONS - Object allocations measures show how many objects each method in a program allocates. Measurements are done via Ruby's GC.stat api.
-  # * RubyProf::MEMORY - Memory measures how much memory each method in a program uses. Measurements are done via Ruby's TracePoint api.
-  def self.measure_mode=(value)
-    @measure_mode = value
-  end
-
-  # Returns the threads that ruby-prof should exclude from profiling
-  def self.exclude_threads
-    @exclude_threads ||= Array.new
-  end
-
-  # Specifies which threads ruby-prof should exclude from profiling
-  def self.exclude_threads=(value)
-    @exclude_threads = value
-  end
-
-  # Starts profiling
-  def self.start
-    ensure_not_running!
-    @profile = Profile.new(:measure_mode => measure_mode, :exclude_threads => exclude_threads)
-    @profile.start
-  end
-
-  # Pauses profiling
-  def self.pause
-    ensure_running!
-    @profile.pause
-  end
-
-  # Is a profile running?
-  def self.running?
-    if defined?(@profile) and @profile
-      @profile.running?
-    else
-      false
-    end
-  end
-
-  # Resume profiling
-  def self.resume
-    ensure_running!
-    @profile.resume
-  end
-
-  # Stops profiling
-  def self.stop
-    ensure_running!
-    result = @profile.stop
-    @profile = nil
-    result
-  end
-
-  # Profiles a block
-  def self.profile(options = {}, &block)
-    ensure_not_running!
-    options = {:measure_mode => measure_mode, :exclude_threads => exclude_threads }.merge!(options)
-    Profile.profile(options, &block)
-  end
-
-  # :nodoc:
-  def self.start_script(script)
-    start
-    load script
-  end
-
-  private
-
-  def self.ensure_running!
-    raise(RuntimeError, "RubyProf.start was not yet called") unless running?
-  end
-
-  def self.ensure_not_running!
-    raise(RuntimeError, "RubyProf is already running") if running?
-  end
-
-  class << self
-    extend Gem::Deprecate
-    deprecate :measure_mode, "RubyProf::Profile#measure_mode", 2023, 6
-    deprecate :measure_mode=, "RubyProf::Profile.new(measure_mode: ...)", 2023, 6
-    deprecate :exclude_threads, "RubyProf::Profile#exclude_threads", 2023, 6
-    deprecate :exclude_threads=, "RubyProf::Profile#initialize", 2023, 6
-    deprecate :start, "RubyProf::Profile#start", 2023, 6
-    deprecate :pause, "RubyProf::Profile#pause", 2023, 6
-    deprecate :stop, "RubyProf::Profile#stop", 2023, 6
-    deprecate :resume, "RubyProf::Profile#resume", 2023, 6
-    deprecate :running?, "RubyProf::Profile#running?", 2023, 6
-    deprecate :profile, "RubyProf::Profile.profile", 2023, 6
-  end
-end