ruby-prof 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46257897a9eb100edbd33483a4d9b025754eae985f6c4fd49a4b986f7dbac895
-  data.tar.gz: 043ba8f3fcfec4322f4dde5b2489b4b44ee3fa12e383ba2b89853a47c489772d
+  metadata.gz: 6e62266e388c4742f279cccfd909bc167b83e2b2bc3438b52254855281ec3b56
+  data.tar.gz: 4becfdabd8c0453c433f36fcc767a32e5ac50f295c45deaa9b9ed7e09763b8e2
 SHA512:
-  metadata.gz: c48297977b2cae9ec15a8a8a98f4a3b3ea58006bce7de933d55bea935be10fc03b7d99a93551acfe223d3aa0ad1dad72c53943cfc5a76b5f0f214a555c03518e
-  data.tar.gz: 2fbcfa48dafa4f8d8ee0f53bd474656e360a9255051a60e3afb820aa8389102dbbd38fda2f078858c724fc624a23f21913174425ac807d3991165c382a619f9a
+  metadata.gz: ecdc60504e71f9adc7bcc5df7deb3864e0fad1544cfc57ad225053a205bdb75cad3953a415834761c964e069907e232786f977f667a7492bd7521839a4663bb4
+  data.tar.gz: d524f3cfa338fb190b362e42d29aaa1b60d1011e84945e73dd6bfc7f5979e0d3fe8702f6135f2c5a3f67ae4dddcd1915e7ddd1db7bab70ee00d22447cb02a398

data/CHANGES

@@ -1,3 +1,11 @@
+1.4.2 (2020-11-3)
+=====================
+* Do NOT use Ruby 2.7.0 and 2.7.1 with ruby-prof. A bug in those versions of ruby causes ruby-prof to
+not work. Version 2.7.2 works correctly.
+* Fix crash caused be reallocating an internal stack that keeps tracks of frames *after* getting a reference to the
+top frame in the stack (Charlie Savage).
+* Fix bug where the flat printer did not correctly report the correct measurement mode.
+
 1.4.1 (2020-05-14)
 =====================
 * Fix compiling on older versions of gcc that do not default to c99 (Charlie Savage)

data/Rakefile

@@ -6,13 +6,6 @@ require "rake/testtask"
 require "rdoc/task"
 require "date"
 require "rake/clean"
-begin
-  require "bundler/setup"
-  Bundler::GemHelper.install_tasks
-  [:build, :install, :release].each {|t| Rake::Task[t].enhance [:rdoc] }
-rescue LoadError
-  $stderr.puts "Install bundler to get support for simplified gem publishing"
-end
 
 # To release a version of ruby-prof:
 #   * Update lib/ruby-prof/version.rb
@@ -23,10 +16,6 @@ end
 #   * rake package to create the gems
 #   * Tag the release (git tag 0.10.1)
 #   * Push to ruybgems.org (gem push pkg/<gem files>)
-# For a ruby only release, just run
-#   * rake release
-# it will push changes to github, tag the release, build the package and upload it to rubygems.org
-# and in case you forgot to increment the version number or have uncommitted changes, it will refuse to work
 
 GEM_NAME = 'ruby-prof'
 SO_NAME = 'ruby_prof'

data/ext/ruby_prof/extconf.rb

@@ -4,9 +4,13 @@ require "mkmf"
 have_func('rb_tracearg_callee_id', ["ruby.h"])
 
 # We want to intermix declarations and code (ie, don't define all variables at the top of the method)
-$CFLAGS += ' -std=c99'
+unless RUBY_PLATFORM =~ /mswin/
+  $CFLAGS += ' -std=c99'
+end
 
 # And since we are using C99 we want to disable Ruby sending these warnings to gcc
-CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
+if CONFIG['warnflags']
+  CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
+end
 
 create_makefile("ruby_prof")

data/ext/ruby_prof/rp_stack.c

@@ -22,6 +22,14 @@ void prof_stack_free(prof_stack_t* stack)
     xfree(stack);
 }
 
+prof_frame_t* prof_stack_parent(prof_stack_t* stack)
+{
+    if (stack->ptr == stack->start || stack->ptr - 1 == stack->start)
+        return NULL;
+    else
+        return stack->ptr - 2;
+}
+
 prof_frame_t* prof_stack_last(prof_stack_t* stack)
 {
     if (stack->ptr == stack->start)
@@ -86,8 +94,8 @@ prof_frame_t* prof_frame_current(prof_stack_t* stack)
 
 prof_frame_t* prof_frame_push(prof_stack_t* stack, prof_call_tree_t* call_tree, double measurement, bool paused)
 {
-    prof_frame_t* parent_frame = prof_stack_last(stack);
     prof_frame_t* result = prof_stack_push(stack);
+    prof_frame_t* parent_frame = prof_stack_parent(stack);
 
     result->call_tree = call_tree;
 

data/ext/ruby_prof/vc/ruby_prof.vcxproj

@@ -102,13 +102,13 @@
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <ClCompile>
-      <AdditionalIncludeDirectories>C:\msys64\usr\local\ruby-2.7.1vc\include\ruby-2.7.0\x64-mswin64_140;C:\msys64\usr\local\ruby-2.7.1vc\include\ruby-2.7.0;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\msys64\usr\local\ruby-2.7.2vc\include\ruby-2.7.0\x64-mswin64_140;C:\msys64\usr\local\ruby-2.7.2vc\include\ruby-2.7.0;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <Optimization>Disabled</Optimization>
       <PreprocessorDefinitions>HAVE_RB_TRACEARG_CALLEE_ID;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <WarningLevel>Level3</WarningLevel>
     </ClCompile>
     <Link>
-      <AdditionalLibraryDirectories>C:\msys64\usr\local\ruby-2.7.1vc\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
+      <AdditionalLibraryDirectories>C:\msys64\usr\local\ruby-2.7.2vc\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
       <AdditionalDependencies>x64-vcruntime140-ruby270.lib;%(AdditionalDependencies)</AdditionalDependencies>
       <ModuleDefinitionFile>ruby_prof.def</ModuleDefinitionFile>
       <SubSystem>Console</SubSystem>

data/lib/ruby-prof/compatibility.rb

@@ -81,16 +81,6 @@ module RubyProf
     Profile.profile(options, &block)
   end
 
-  # :nodoc:
-  def self.measure_mode_string
-    case measure_mode
-      when WALL_TIME    then "wall_time"
-      when PROCESS_TIME then "process_time"
-      when ALLOCATIONS  then "allocations"
-      when MEMORY       then "memory"
-    end
-  end
-
   # :nodoc:
   def self.start_script(script)
     start

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

@@ -99,7 +99,7 @@ module RubyProf
     end
 
     def print_header(thread)
-      @output << "Measure Mode: %s\n" % RubyProf.measure_mode_string
+      @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

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

@@ -4,6 +4,7 @@ require 'erb'
 require 'fileutils'
 require 'base64'
 require 'set'
+require 'stringio'
 
 module RubyProf
   # Prints a HTML visualization of the call tree.

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

@@ -25,7 +25,7 @@ module RubyProf
     end
 
     def print_header(thread)
-      @output << "Measure Mode: %s\n" % RubyProf.measure_mode_string
+      @output << "Measure Mode: %s\n" % @result.measure_mode_string
       @output << "Thread ID: #{thread.id}\n"
       @output << "Fiber ID: #{thread.fiber_id}\n"
       @output << "Total Time: #{thread.total_time}\n"

data/lib/ruby-prof/profile.rb

@@ -7,10 +7,14 @@ module RubyProf
     # :nodoc:
     def measure_mode_string
       case self.measure_mode
-        when WALL_TIME    then "wall_time"
-        when PROCESS_TIME then "process_time"
-        when ALLOCATIONS  then "allocations"
-        when MEMORY       then "memory"
+        when WALL_TIME
+          "wall_time"
+        when PROCESS_TIME
+          "process_time"
+        when ALLOCATIONS
+          "allocations"
+        when MEMORY
+          "memory"
       end
     end
 

data/lib/ruby-prof/version.rb

@@ -1,3 +1,3 @@
 module RubyProf
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/test/marshal_test.rb

@@ -2,8 +2,6 @@
 # encoding: UTF-8
 
 require File.expand_path("../test_helper", __FILE__)
-require 'stringio'
-
 class MarshalTest < TestCase
   def verify_profile(profile_1, profile_2)
     verify_threads(profile_1.threads, profile_2.threads)

data/test/printer_call_stack_test.rb

@@ -2,7 +2,6 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
 require 'tmpdir'
 require_relative 'prime'

data/test/printer_call_tree_test.rb

@@ -2,7 +2,6 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
 require 'tmpdir'
 require_relative 'prime'

data/test/printer_flat_test.rb

@@ -2,93 +2,97 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
+require 'stringio'
 require 'tmpdir'
 require_relative 'prime'
 
 # --  Tests ----
 class PrinterFlatTest < TestCase
-  def setup
-    # WALL_TIME so we can use sleep in our test and get same measurements on linux and windows
-    RubyProf::measure_mode = RubyProf::WALL_TIME
-    @result = RubyProf.profile do
+  def run_profile
+    RubyProf.profile(:measure_mode => RubyProf::WALL_TIME) do
       run_primes(1000, 5000)
     end
   end
 
   def flat_output_nth_column_values(output, n)
-    only_method_calls = output.split("\n").select { |line| line =~ /^ +\d+/ }
-    only_method_calls.collect { |line| line.split(/ +/)[n] }
+    only_method_calls = output.split("\n").select { |line| line =~ /^\s+\d+/ }
+    only_method_calls.collect { |line| line.split(/\s+/)[n] }
   end
 
-  def assert_sorted array
-    array = array.map{|n| n.to_f} # allow for > 10s times to sort right, since lexographically 4.0 > 10.0
-    assert_equal array, array.sort.reverse, "Array #{array.inspect} is not sorted"
+  def helper_test_flat_string(klass)
+    output = StringIO.new
+
+    printer = klass.new(self.run_profile)
+    printer.print(output)
+
+    assert_match(/Thread ID: -?\d+/i, output.string)
+    assert_match(/Fiber ID: -?\d+/i, output.string)
+    assert_match(/Total: \d+\.\d+/i, output.string)
+    assert_match(/Object#run_primes/i, output.string)
+    output.string
   end
 
+  def assert_sorted(array)
+    array = array.map(&:to_f) # allow for > 10s times to sort right, since lexographically 4.0 > 10.0
+    assert_equal(array, array.sort.reverse)
+  end
+  
   def test_flat_string
     output = helper_test_flat_string(RubyProf::FlatPrinter)
     assert_match(/prime.rb/, output)
   end
 
-  def helper_test_flat_string(klass)
-    output = ''
-
-    printer = klass.new(@result)
-    printer.print(output)
-
-    assert_match(/Thread ID: -?\d+/i, output)
-    assert_match(/Fiber ID: -?\d+/i, output)
-    assert_match(/Total: \d+\.\d+/i, output)
-    assert_match(/Object#run_primes/i, output)
-    output
-  end
-
   def test_flat_result_sorting_by_self_time_is_default
-    printer = RubyProf::FlatPrinter.new(@result)
+    printer = RubyProf::FlatPrinter.new(self.run_profile)
 
-    printer.print(output = '')
-    self_times = flat_output_nth_column_values(output, 3)
+    output = StringIO.new
+    printer.print(output)
+    self_times = flat_output_nth_column_values(output.string, 3)
 
     assert_sorted self_times
   end
 
   def test_flat_result_sorting
-    printer = RubyProf::FlatPrinter.new(@result)
+    printer = RubyProf::FlatPrinter.new(self.run_profile)
 
     sort_method_with_column_number = {:total_time => 2, :self_time => 3, :wait_time => 4, :children_time => 5}
 
     sort_method_with_column_number.each_pair do |sort_method, n|
-      printer.print(output = '', :sort_method => sort_method)
-      times = flat_output_nth_column_values(output, n)
-      assert_sorted times
+      output = StringIO.new
+      printer.print(output, :sort_method => sort_method)
+
+      times = flat_output_nth_column_values(output.string, n)
+      assert_sorted(times)
     end
   end
 
   def test_flat_result_max_percent
-    printer = RubyProf::FlatPrinter.new(@result)
+    printer = RubyProf::FlatPrinter.new(self.run_profile)
 
-    printer.print(output = '', max_percent: 1)
-    self_percents = flat_output_nth_column_values(output, 1).map(&:to_f)
+    output = StringIO.new
+    printer.print(output, max_percent: 1)
+    self_percents = flat_output_nth_column_values(output.string, 1).map(&:to_f)
 
     assert self_percents.max < 1
   end
 
   def test_flat_result_filter_by_total_time
-    printer = RubyProf::FlatPrinter.new(@result)
+    printer = RubyProf::FlatPrinter.new(self.run_profile)
 
-    printer.print(output = '', filter_by: :total_time, min_percent: 50)
-    total_times = flat_output_nth_column_values(output, 2).map(&:to_f)
+    output = StringIO.new
+    printer.print(output, filter_by: :total_time, min_percent: 50)
+    total_times = flat_output_nth_column_values(output.string, 2).map(&:to_f)
 
     assert (total_times.min / total_times.max) >= 0.5
   end
 
   def test_flat_result_filter_by_self_time
-    printer = RubyProf::FlatPrinter.new(@result)
+    printer = RubyProf::FlatPrinter.new(self.run_profile)
 
-    printer.print(output = '', filter_by: :self_time, min_percent: 0.1)
-    self_percents = flat_output_nth_column_values(output, 1).map(&:to_f)
+    output = StringIO.new
+    printer.print(output, filter_by: :self_time, min_percent: 0.1)
+    self_percents = flat_output_nth_column_values(output.string, 1).map(&:to_f)
 
     assert self_percents.min >= 0.1
   end

data/test/printer_graph_html_test.rb

@@ -2,7 +2,6 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
 require 'tmpdir'
 require_relative 'prime'

data/test/printer_graph_test.rb

@@ -2,7 +2,6 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
 require 'tmpdir'
 require_relative 'prime'
@@ -22,9 +21,9 @@ class PrinterGraphTest < TestCase
     only_root_calls.collect { |line| line.split(/ +/)[n] }
   end
 
-  def assert_sorted array
-    array = array.map{|n| n.to_f} # allow for > 10s times to sort right, since lexographically 4.0 > 10.0
-    assert_equal array, array.sort.reverse, "Array #{array.inspect} is not sorted"
+  def assert_sorted(array)
+    array = array.map {|n| n.to_f} # allow for > 10s times to sort right, since lexographically 4.0 > 10.0
+    assert_equal(array, array.sort.reverse, "Array #{array.inspect} is not sorted")
   end
 
   def test_graph_results_sorting

data/test/printers_test.rb

@@ -2,8 +2,8 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
+require 'stringio'
 require 'tmpdir'
 require_relative 'prime'
 

data/test/printing_recursive_graph_test.rb

@@ -2,8 +2,8 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
-require 'stringio'
 require 'fileutils'
+require 'stringio'
 
 # --- code to be tested ---
 module PRGT

data/test/profile_test.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class ProfileTest < TestCase
+  def test_measure_mode
+    profile = RubyProf::Profile.new(:measure_mode => RubyProf::PROCESS_TIME)
+    assert_equal(RubyProf::PROCESS_TIME, profile.measure_mode)
+  end
+
+  def test_measure_mode_string
+    profile = RubyProf::Profile.new(:measure_mode => RubyProf::PROCESS_TIME)
+    assert_equal("process_time", profile.measure_mode_string)
+  end
+end

data/test/test_helper.rb

@@ -1,8 +1,9 @@
 # encoding: UTF-8
 
-# Disable minitest parallel tests. The problem is the thread switching will cahnge test results
+# Disable minitest parallel tests. The problem is the thread switching will change test results
 # (self vs wait time)
-ENV["N"] = "0"
+ENV["N"] = "0" # Older versions of minitest
+ENV["MT_CPU"] = "0" # Newer versions minitest
 
 require 'bundler/setup'
 require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-prof
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Shugo Maeda, Charlie Savage, Roger Pack, Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -161,6 +161,7 @@ files:
 - 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/singleton_test.rb
@@ -177,7 +178,7 @@ metadata:
   bug_tracker_uri: https://github.com/ruby-prof/ruby-prof/issues
   changelog_uri: https://github.com/ruby-prof/ruby-prof/blob/master/CHANGES
   documentation_uri: https://ruby-prof.github.io/
-  source_code_uri: https://github.com/ruby-prof/ruby-prof/tree/v1.4.1
+  source_code_uri: https://github.com/ruby-prof/ruby-prof/tree/v1.4.2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -193,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fast Ruby profiler