ruby-prof 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382fb19115df1fa6e8ac2da32cea739768fceba7228e04cd3e72009185954545
-  data.tar.gz: 4047e3e6f69c7a8b2750346837e264ae786185f07bd1aec666ecf6cd84a08c0f
+  metadata.gz: fc5b4b0b4220c987ae0168f276545ade540de7ec54965edafdb528b0c83cc208
+  data.tar.gz: 4b7d92a744ccf7f545d5c19c73dbc8a9294465a261512bc7b9578dccde3194e5
 SHA512:
-  metadata.gz: 41057a0f80b47b0477cd394c26bc693e6574e496b8d607004cbc0523f89f45b247569fe9af66e54c236ebc6025ff7636188b6314298db995c6d70ecda3ff5a5b
-  data.tar.gz: 8df4a3e9dbc3fd82f65892e63a0c41f124d0c749e12b4fd120fb4bca42a4f09a5aac689f9906161e024aca9f495e75d47bf8d9fe7a9088fb1e7df5e305eb9e3f
+  metadata.gz: 7891771f81dfc0b4b377ff008b645ba63e5ce3b75901b5b497a6c6c8a5ed2b87eea6a201f155ab6ad646440d6d1bd3ed982acdf872a17d8486c9b5eb665741ff
+  data.tar.gz: a364fa0592341790d49c6c9649498a2dee553cbc4a2c6971d464b3aed350515adf84a479cd93aa925763d783e5d648528a2ad6f293628f00dd9466ac80463fef

data/CHANGES

@@ -1,3 +1,9 @@
+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)

data/bin/ruby-prof

@@ -1,5 +1,10 @@
 #! /usr/bin/env ruby
 
+# To make testing/debugging easier test within this source tree versus an installed gem
+require 'bundler/setup'
+ext_path = File.expand_path(File.join(__dir__, '..', 'ext', 'ruby_prof'))
+$LOAD_PATH.unshift(File.expand_path(ext_path))
+
 # First require ruby-prof
 require 'ruby-prof'
 
@@ -16,37 +21,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 +69,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 +125,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 +158,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 +185,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 +237,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 +246,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 +292,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 +321,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