ruby-prof 1.4.3 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d823139ee13d55c54104dd034274b61316a525b54ac3802b90dcb111d8ccb3d2
-  data.tar.gz: c9ae3a108bbe1f9559848df06a943c4d42e10e4b62a450f8e0278d796ed90f80
+  metadata.gz: 416c147d8497f94d50b9b142596873a4f3bd5c9809bb5079f229fa413f626497
+  data.tar.gz: a7cceb2728e182181bac58ecd791a2d425be2e33c6ab1314a8fa66758a4d2ee1
 SHA512:
-  metadata.gz: 505e983efedd32bed3cdadff2256e4c9c875551caba829999ec2dd87a36052024612eec9e70ebe586b05b3ee70b95d8c3dba3bd5b14bd01ca1243317a5336313
-  data.tar.gz: 9e3430bd9af49f2a045485bc9322f2deabe23bd43575ae00e0718316829d1468492db17476b7a428f6592f7d5fc65ad3f96e68de97a084ff606971ef89d5e14b
+  metadata.gz: 754d7fd2b208eb398cbb5a3fb6830dc78f0164f0f0ee3024314587982a16a6329c9ae2b54f525d425ec13c2aac54209dfc97febc5920ca72b34aa9c8004c787d
+  data.tar.gz: 076c3bb65e7d71c036e8b393dd74ab51b6d4be4428998445e0c8af1e16f2ce384c36ba7a5417661933eb40d522dcee274a7040e26dd1a4eb2352a395e1fc8ed9

data/CHANGES

@@ -1,15 +1,65 @@
-1.4.3 (2021-02-15)
+1.6.3 (2023-04-20)
+=====================
+* Remove debug code unintentionally left in ruby-prof command line program (Charlie Savage)
+
+1.6.2 (2023-04-17)
+=====================
+* Fix Profile#merge! implementation (asksurya)
+* Fix ruby-prof command line program (Charlie Savage)
+* Added CMakeLists.txt file (Charlie Savage)
+
+1.6.1 (2023-02-21)
+=====================
+* Fix loading C extension for MacOS (Charlie Savage)
+
+1.6.0 (2023-02-20)
+=====================
+* Add support for Ruby's compacting garbage collector (Charlie Savage)
+* Add rbs signature files (Charlie Savage)
+* Update rack adapter used for profiling Rails to include latest ruby-prof features (Charlie Savage)
+* Add warnings for deprecated methods (Charlie Savage)
+* Update tests to not use deprecated methods (Charlie Savage)
+* Improve tests on OSX (Charlie Savage)
+
+1.5.0 (2023-02-06)
+=====================
+* Add new Profile#merge! method that merges results for threads/fibers that share the same root method (Charlie Savage)
+* Expand API to allow creation of +Measurement+, +CallTree+, +MethodInfo+ and +Thread+ instances. This
+ was done to make is possible to write tests for the new Profile#merge! functionality (Charlie Savage)
+
+1.4.5 (2022-12-27)
+=====================
+* Look for ruby_prof extension built on install in the lib directory (Charlie Savage)
+* Added Ruby 3.2.0 build for mingw-urct
+
+1.4.4 (2022-12-11)
+=====================
+* Update tests for Ruby 3.1 (Charlie Savage)
+* When tracing allocations always use the RUBY_INTERNAL_EVENT_NEWOBJ trace event. Previously GC stats could also be used, but that includes the creation of internal T_IMEMO objects makes reviewing results confusing (Charlie Savage)
+* Remove :profile option that lets a user set the prefix on callgrind output files since KCacheGrind will not automatically show these files in its open dialog. Fixes #313. (Charlie Savage)
+* Don't expose threads to Ruby that don't have a call tree. This can happen when a user is profiling memory usage and then sends a signint to the profiled process. New objects will be created in a new thread, but no method enter/exit trace events are generated by Ruby. Thus the thread has no call tree. Fixes #312 (Charlie Savage)
+* Update github Actions - change 3.0 to '3.0', add Windows mswin (MSP-Greg)
+* Add Ruby 3.1 to test matrix (Charlie Savage)
+* Use normal weight text instead of bold in call strack printer output. Fixes #297 (Charlie Savage)
+* Update VC project to Ruby 3.1 and Visual Studio 2022 (Charlie Savage)
+* Fix marshaling of profile measure. Fixes #315 (Charlie Savage)
+* CI: Omit duplicate 'bundle install'. PR #309 (Olle Jonsson)
+* Fix typo. s/perecent/percent/ (Paarth Madan)
+* Remove support for Ruby 2.5 and 2.6 which are now end of life (Charlie Savage)
+
+1.4.3 (2021-02-16)
 =====================
 * Remove trailing spaces (sergioro)
-* Enable loading ruby_prof.so from ext directory for development purposes (sergioro)
-* Create temp directory for test output (sergioro)
+* Load "ruby-prof.so" with require_relative (sergioro)
+* Use same file permissions for all test files (sergioro)
+* Create tmp directory for test output (sergioro)
+* Update git-ignore to add mkmf log (sergioro)
 * Fix minitest warning about using MT_CPU instead of N (sergioro)
-* Fix minitest warning "Use assert_nil if expecting nil"  (sergioro)
-* Fix file permissions (sergioro)
-* Fix failing test by forcing GC to run (Charlie Savage)
-* Switch to GitHub actions (Charlie Savage)
-* Switch to C11 (Charlie Savage)
-* Greatly slim down library size by removing symbols on GCC (Charlie Savage)
+* Fix minitest warning "Use assert_nil if expecting nil (sergioro)
+* Add xcode project (Charlie Savage)
+* Update test for Ruby 3.0 (Charlie Savage)
+* Remove Ruby 2.4 support since it is no longer maintained (Charlie Savage)
+* Replace travis status badge with github status badge (Charlie Savage)
 
 1.4.2 (2020-11-3)
 =====================

data/{README.rdoc → README.md}

@@ -1,5 +1,5 @@
-= ruby-prof
+# ruby-prof
 
 ![ruby-prof](https://github.com/ruby-prof/ruby-prof/workflows/ruby-prof/badge.svg)
 
-For an overview of ruby-prof please see https://ruby-prof.github.io
+For an overview of ruby-prof please see https://ruby-prof.github.io

data/Rakefile

@@ -42,7 +42,7 @@ end
 Rake::Task[:package].enhance [:rdoc]
 
 # Setup Windows Gem
-if RUBY_PLATFORM.match(/win32|mingw32/)
+if RUBY_PLATFORM.match(/mswin|mingw/)
   # Windows specification
   win_spec = default_spec.clone
   win_spec.platform = Gem::Platform::CURRENT
@@ -61,17 +61,17 @@ end
 desc "Generate rdoc documentation"
 RDoc::Task.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "ruby-prof"
+  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.rdoc'
+  rdoc.options << '--main' << 'README.md'
   rdoc.rdoc_files.include('bin/*',
                           'doc/*.rdoc',
                           'lib/**/*.rb',
                           'ext/ruby_prof/*.c',
                           'ext/ruby_prof/*.h',
-                          'README.rdoc',
+                          'README.md',
                           'LICENSE')
 end
 

data/bin/ruby-prof

@@ -16,37 +16,38 @@ module RubyProf
   # ruby-prof [options] <script.rb> [--] [profiled-script-command-line-options]
   #
   # Options:
-  #    -p, --printer=printer            Select a printer:
-  #                                       flat - Prints a flat profile as text (default).
-  #                                       graph - Prints a graph profile as text.
-  #                                       graph_html - Prints a graph profile as html.
-  #                                       call_tree - format for KCacheGrind
-  #                                       call_stack - prints a HTML visualization of the call tree
-  #                                       dot - Prints a graph profile as a dot file
-  #                                       multi - Creates several reports in output directory
+  #        --allow_exceptions           Raise exceptions encountered during profiling (true) or suppress them (false)
+  #    -E, --eval-noprof=code           execute the ruby statements (not profiled)
+  #        --exclude=methods    A comma separated list of methods to exclude.
+  #                                       Specify instance methods via # (Integer#times)
+  #                                       Specify class methods via . (Integer.superclass)
+  #        --exclude-common             Remove common methods from the profile
+  #    -f, --file=path                  Output results to a file instead of standard out.
   #    -m, --min_percent=min_percent    The minimum percent a method must take before
   #                                       being included in output reports.
   #                                       This option is not supported for call tree.
-  #    -f, --file=path                  Output results to a file instead of standard out.
   #        --mode=measure_mode          Select what ruby-prof should measure:
   #                                       wall - Wall time (default).
   #                                       process - Process time.
   #                                       allocations - Object allocations (requires patched Ruby interpreter).
   #                                       memory - Allocated memory in KB (requires patched Ruby interpreter).
+  #    -p, --printer=printer            Select a printer:
+  #                                       flat - Prints a flat profile as text (default).
+  #                                       graph - Prints a graph profile as text.
+  #                                       graph_html - Prints a graph profile as html.
+  #                                       call_tree - format for KCacheGrind
+  #                                       call_stack - prints a HTML visualization of the call tree
+  #                                       dot - Prints a graph profile as a dot file
+  #                                       multi - Creates several reports in output directory
+  #    -R, --require-noprof=lib         require a specific library (not profiled)
   #    -s, --sort=sort_mode             Select how ruby-prof results should be sorted:
   #                                       total - Total time
   #                                       self - Self time
   #                                       wait - Wait time
   #                                       child - Child time
-  #        --allow_exceptions           Raise exceptions encountered during profiling (true) or suppress them (false)
-  #    -R, --require-noprof=lib         require a specific library (not profiled)
-  #    -E, --eval-noprof=code           execute the ruby statements (not profiled)
-  #        --exclude=methods    A comma separated list of methods to exclude.
-  #                                       Specify instance methods via # (Integer#times)
-  #                                       Specify class methods via . (Integer.superclass)
-  #        --exclude-common             Remove common methods from the profile
-  #    -h, --help                       Show help message
+  #        --track_allocations          Track allocations while profiling
   #    -v, --version version            Show version (1.1.0)
+  #    -h, --help                       Show help message
 
   class Cmd
     # :enddoc:
@@ -63,15 +64,16 @@ module RubyProf
 
     def setup_options
       @options = OpenStruct.new
-      options.printer = RubyProf::FlatPrinter
-      options.measure_mode = RubyProf::WALL_TIME
-      options.min_percent = 0
-      options.file = nil
       options.allow_exceptions = false
-      options.exclude_common = false
       options.exclude = Array.new
+      options.exclude_common = false
+      options.file = nil
+      options.measure_mode = RubyProf::WALL_TIME
+      options.min_percent = 0
       options.pre_libs = Array.new
       options.pre_execs = Array.new
+      options.printer = RubyProf::FlatPrinter
+      options.track_allocations = false
     end
 
     # This is copied from ActiveSupport:
@@ -118,40 +120,31 @@ module RubyProf
         opts.separator ""
         opts.separator "Options:"
 
-        opts.on('-p printer', '--printer=printer', [:flat, :flat_with_line_numbers, :graph, :graph_html, :call_tree, :call_stack, :dot, :multi],
-                'Select a printer:',
-                '  flat - Prints a flat profile as text (default).',
-                '  graph - Prints a graph profile as text.',
-                '  graph_html - Prints a graph profile as html.',
-                '  call_tree - format for KCacheGrind',
-                '  call_stack - prints a HTML visualization of the call tree',
-                '  dot - Prints a graph profile as a dot file',
-                '  multi - Creates several reports in output directory'
-        ) do |printer|
+        opts.on('--allow_exceptions', 'Raise exceptions encountered during profiling (true) or suppress them (false)') do
+          options.allow_exceptions = true
+        end
 
-          case printer
-          when :flat
-            options.printer = RubyProf::FlatPrinter
-          when :graph
-            options.printer = RubyProf::GraphPrinter
-          when :graph_html
-            options.printer = RubyProf::GraphHtmlPrinter
-          when :call_tree
-            options.printer = RubyProf::CallTreePrinter
-          when :call_stack
-            options.printer = RubyProf::CallStackPrinter
-          when :dot
-            options.printer = RubyProf::DotPrinter
-          when :multi
-            options.printer = RubyProf::MultiPrinter
+        opts.on('-E code', '--eval-noprof=code', 'execute the ruby statements (not profiled)') do |code|
+          options.pre_execs << code
+        end
+
+        opts.on('--exclude=methods', String,
+                'A comma separated list of methods to exclude.',
+                '  Specify instance methods via # (Integer#times)',
+                '  Specify class methods via . (Integer.superclass)') do |exclude_string|
+          exclude_string.split(',').each do |string|
+            match = string.strip.match(/(.*)(#|\.)(.*)/)
+            klass = constantize(match[1])
+            if match[2] == '.'
+              klass = klass.singleton_class
+            end
+            method = match[3].to_sym
+            options.exclude << [klass, method]
           end
         end
 
-        opts.on('-m min_percent', '--min_percent=min_percent', Float,
-                'The minimum percent a method must take before ',
-                '  being included in output reports.',
-                '  This option is not supported for call tree.') do |min_percent|
-          options.min_percent = min_percent
+        opts.on('--exclude-common', 'Remove common methods from the profile') do
+          options.exclude_common = true
         end
 
         opts.on('-f path', '--file=path',
@@ -160,6 +153,13 @@ module RubyProf
           options.old_wd = Dir.pwd
         end
 
+        opts.on('-m min_percent', '--min_percent=min_percent', Float,
+                'The minimum percent a method must take before ',
+                '  being included in output reports.',
+                '  This option is not supported for call tree.') do |min_percent|
+          options.min_percent = min_percent
+        end
+
         opts.on('--mode=measure_mode',
                 [:process, :wall, :allocations, :memory],
                 'Select what ruby-prof should measure:',
@@ -180,6 +180,39 @@ module RubyProf
           end
         end
 
+        opts.on('-p printer', '--printer=printer', [:flat, :flat_with_line_numbers, :graph, :graph_html, :call_tree, :call_stack, :dot, :multi],
+                'Select a printer:',
+                '  flat - Prints a flat profile as text (default).',
+                '  graph - Prints a graph profile as text.',
+                '  graph_html - Prints a graph profile as html.',
+                '  call_tree - format for KCacheGrind',
+                '  call_stack - prints a HTML visualization of the call tree',
+                '  dot - Prints a graph profile as a dot file',
+                '  multi - Creates several reports in output directory'
+        ) do |printer|
+
+          case printer
+            when :flat
+              options.printer = RubyProf::FlatPrinter
+            when :graph
+              options.printer = RubyProf::GraphPrinter
+            when :graph_html
+              options.printer = RubyProf::GraphHtmlPrinter
+            when :call_tree
+              options.printer = RubyProf::CallTreePrinter
+            when :call_stack
+              options.printer = RubyProf::CallStackPrinter
+            when :dot
+              options.printer = RubyProf::DotPrinter
+            when :multi
+              options.printer = RubyProf::MultiPrinter
+          end
+        end
+
+        opts.on('-R lib', '--require-noprof=lib', 'require a specific library (not profiled)') do |lib|
+          options.pre_libs << lib
+        end
+
         opts.on('-s sort_mode', '--sort=sort_mode', [:total, :self, :wait, :child],
                 'Select how ruby-prof results should be sorted:',
                 '  total - Total time',
@@ -199,9 +232,8 @@ module RubyProf
                                 end
         end
 
-        opts.on_tail("-h", "--help", "Show help message") do
-          puts opts
-          exit
+        opts.on('--track_allocations', 'Track allocations while profiling') do
+          options.track_allocations = true
         end
 
         opts.on_tail("-v version", "--version", "Show version (#{RubyProf::VERSION})") do
@@ -209,35 +241,9 @@ module RubyProf
           exit
         end
 
-        opts.on('--allow_exceptions', 'Raise exceptions encountered during profiling (true) or suppress them (false)') do
-          options.allow_exceptions = true
-        end
-
-        opts.on('-R lib', '--require-noprof=lib', 'require a specific library (not profiled)') do |lib|
-          options.pre_libs << lib
-        end
-
-        opts.on('-E code', '--eval-noprof=code', 'execute the ruby statements (not profiled)') do |code|
-          options.pre_execs << code
-        end
-
-        opts.on('--exclude=methods', String,
-                'A comma separated list of methods to exclude.',
-                '  Specify instance methods via # (Integer#times)',
-                '  Specify class methods via . (Integer.superclass)') do |exclude_string|
-          exclude_string.split(',').each do |string|
-            match = string.strip.match(/(.*)(#|\.)(.*)/)
-            klass = constantize(match[1])
-            if match[2] == '.'
-              klass = klass.singleton_class
-            end
-            method = match[3].to_sym
-            options.exclude << [klass, method]
-          end
-        end
-
-        opts.on('--exclude-common', 'Remove common methods from the profile') do
-          options.exclude_common = true
+        opts.on_tail("-h", "--help", "Show help message") do
+          puts opts
+          exit
         end
       end
     end
@@ -281,12 +287,18 @@ module RubyProf
     end
 
     def run
-      script = ARGV.shift
-      @profile = Profile.new(options.to_h)
+      profile_options = {:allow_exceptions => options.allow_exceptions,
+                         :exclude_common => options.exclude_common,
+                         :measure_mode => options.measure_mode,
+                         :track_allocations => options.track_allocations}
+
+      @profile = Profile.new(**profile_options)
+
       options.exclude.each do |klass, method|
         @profile.exclude_method!(klass, method)
       end
 
+      script = ARGV.shift
       profile.profile do
        load script
       end
@@ -304,7 +316,8 @@ cmd = RubyProf::Cmd.new
 at_exit {
   # Create a printer
   printer = cmd.options.printer.new(cmd.profile)
-  printer_options = {:min_percent => cmd.options.min_percent, :sort_method => cmd.options.sort_method}
+  printer_options = {:min_percent => cmd.options.min_percent,
+                     :sort_method => cmd.options.sort_method}
 
   # Get output
   if cmd.options.file