ruby-prof 1.7.2 → 2.0.0

data/lib/ruby-prof/rack.rb

@@ -1,105 +1,114 @@
-# encoding: utf-8
-require 'tmpdir'
-
-module Rack
-  class RubyProf
-    def initialize(app, options = {})
-      @app = app
-      @options = options
-
-      @tmpdir = options[:path] || Dir.tmpdir
-      FileUtils.mkdir_p(@tmpdir)
-
-      @printer_klasses = @options[:printers]  || {::RubyProf::FlatPrinter => 'flat.txt',
-                                                  ::RubyProf::GraphPrinter => 'graph.txt',
-                                                  ::RubyProf::GraphHtmlPrinter => 'graph.html',
-                                                  ::RubyProf::CallStackPrinter => 'call_stack.html'}
-
-      @skip_paths = options[:skip_paths] || [%r{^/assets}, %r{\.(css|js|png|jpeg|jpg|gif)$}]
-      @only_paths = options[:only_paths]
-    end
-
-    def call(env)
-      request = Rack::Request.new(env)
-
-      if should_profile?(request.path)
-        begin
-          result = nil
-          profile = ::RubyProf::Profile.profile(profiling_options) do
-            result = @app.call(env)
-          end
-
-          if @options[:merge_fibers]
-            profile.merge!
-          end
-
-
-          path = request.path.gsub('/', '-')
-          path.slice!(0)
-
-          print(profile, path)
-          result
-        end
-      else
-        @app.call(env)
-      end
-    end
-
-    private
-
-    def should_profile?(path)
-      return false if paths_match?(path, @skip_paths)
-
-      @only_paths ? paths_match?(path, @only_paths) : true
-    end
-
-    def paths_match?(path, paths)
-      paths.any? { |skip_path| skip_path =~ path }
-    end
-
-    def profiling_options
-      result = {}
-      result[:measure_mode] = @options[:measure_mode] || ::RubyProf::WALL_TIME
-      result[:track_allocations] = @options[:track_allocations] || false
-      result[:exclude_common] = @options[:exclude_common] || false
-
-      if @options[:ignore_existing_threads]
-        result[:exclude_threads] = Thread.list.select {|thread| thread != Thread.current}
-      end
-
-      if @options[:request_thread_only]
-        result[:include_threads] = [Thread.current]
-      end
-
-      result
-    end
-
-    def print_options
-      result = {}
-      result[:min_percent] = @options[:min_percent] || 1
-      result[:sort_method] = @options[:sort_method] || :total_time
-      result
-    end
-
-    def print(profile, path)
-      @printer_klasses.each do |printer_klass, base_name|
-        printer = printer_klass.new(profile)
-
-        if base_name.respond_to?(:call)
-          base_name = base_name.call
-        end
-
-        if printer_klass == ::RubyProf::MultiPrinter
-          printer.print(print_options.merge(:profile => "#{path}-#{base_name}"))
-        elsif printer_klass == ::RubyProf::CallTreePrinter
-          printer.print(print_options.merge(:profile => "#{path}-#{base_name}"))
-        else
-          file_name = ::File.join(@tmpdir, "#{path}-#{base_name}")
-          ::File.open(file_name, 'wb') do |file|
-            printer.print(file, print_options)
-          end
-        end
-      end
-    end
-  end
-end
+# encoding: utf-8
+require 'tmpdir'
+
+module Rack
+  class RubyProf
+    def initialize(app, path: Dir.tmpdir, printers: nil, skip_paths: nil,
+                   only_paths: nil, merge_fibers: false,
+                   measure_mode: ::RubyProf::WALL_TIME, track_allocations: false,
+                   exclude_common: false, ignore_existing_threads: false,
+                   request_thread_only: false, min_percent: 1,
+                   sort_method: :total_time)
+      @app = app
+
+      @tmpdir = path.to_s
+      FileUtils.mkdir_p(@tmpdir)
+
+      @printer_klasses = printers || {::RubyProf::FlatPrinter => 'flat.txt',
+                                      ::RubyProf::GraphPrinter => 'graph.txt',
+                                      ::RubyProf::GraphHtmlPrinter => 'graph.html',
+                                      ::RubyProf::CallStackPrinter => 'call_stack.html'}
+
+      @skip_paths = skip_paths || [%r{^/assets}, %r{\.(css|js|png|jpeg|jpg|gif)$}]
+      @only_paths = only_paths
+      @merge_fibers = merge_fibers
+      @measure_mode = measure_mode
+      @track_allocations = track_allocations
+      @exclude_common = exclude_common
+      @ignore_existing_threads = ignore_existing_threads
+      @request_thread_only = request_thread_only
+      @min_percent = min_percent
+      @sort_method = sort_method
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if should_profile?(request.path)
+        begin
+          result = nil
+          profile = ::RubyProf::Profile.profile(**profiling_options) do
+            result = @app.call(env)
+          end
+
+          if @merge_fibers
+            profile.merge!
+          end
+
+
+          path = request.path.gsub('/', '-')
+          path.slice!(0)
+
+          print(profile, path)
+          result
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def should_profile?(path)
+      return false if paths_match?(path, @skip_paths)
+
+      @only_paths ? paths_match?(path, @only_paths) : true
+    end
+
+    def paths_match?(path, paths)
+      paths.any? { |skip_path| skip_path =~ path }
+    end
+
+    def profiling_options
+      result = {}
+      result[:measure_mode] = @measure_mode
+      result[:track_allocations] = @track_allocations
+      result[:exclude_common] = @exclude_common
+
+      if @ignore_existing_threads
+        result[:exclude_threads] = Thread.list.select {|thread| thread != Thread.current}
+      end
+
+      if @request_thread_only
+        result[:include_threads] = [Thread.current]
+      end
+
+      result
+    end
+
+    def print_options
+      {min_percent: @min_percent, sort_method: @sort_method}
+    end
+
+    def print(profile, path)
+      @printer_klasses.each do |printer_klass, base_name|
+        printer = printer_klass.new(profile)
+
+        if base_name.respond_to?(:call)
+          base_name = base_name.call
+        end
+
+        if printer_klass == ::RubyProf::MultiPrinter
+          printer.print(profile: "#{path}-#{base_name}", **print_options)
+        elsif printer_klass == ::RubyProf::CallTreePrinter
+          printer.print(profile: "#{path}-#{base_name}", **print_options)
+        else
+          file_name = ::File.join(@tmpdir, "#{path}-#{base_name}")
+          ::File.open(file_name, 'wb') do |file|
+            printer.print(file, **print_options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby-prof/task.rb

@@ -1,147 +1,147 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-
-require 'rake'
-require 'rake/testtask'
-require 'fileutils'
-
-module RubyProf
-
-  # Define a task library for profiling unit tests with ruby-prof.
-  #
-  # All of the options provided by
-  # the Rake:TestTask are supported except the loader
-  # which is set to ruby-prof.  For detailed information
-  # please refer to the Rake:TestTask documentation.
-  #
-  # ruby-prof specific options include:
-  #
-  #   output_dir - For each file specified an output
-  #                file with profile information will be
-  #                written to the output directory.
-  #                By default, the output directory is
-  #                called "profile" and is created underneath
-  #                the current working directory.
-  #
-  #   printer - Specifies the output printer.  Valid values include
-  #             :flat, :graph, :graph_html and :call_tree.
-  #
-  #   min_percent - Methods that take less than the specified percent
-  #                 will not be written out.
-  #
-  # Example:
-  #
-  #   require 'ruby-prof/task'
-  #
-  #   RubyProf::ProfileTask.new do |t|
-  #     t.test_files = FileList['test/test*.rb']
-  #     t.output_dir = "c:/temp"
-  #     t.printer = :graph
-  #     t.min_percent = 10
-  #   end
-  #
-  # If rake is invoked with a "TEST=filename" command line option,
-  # then the list of test files will be overridden to include only the
-  # filename specified on the command line.  This provides an easy way
-  # to run just one test.
-  #
-  # If rake is invoked with a "TESTOPTS=options" command line option,
-  # then the given options are passed to the test process after a
-  # '--'.  This allows Test::Unit options to be passed to the test
-  # suite.
-  #
-  # Examples:
-  #
-  #   rake profile                           # run tests normally
-  #   rake profile TEST=just_one_file.rb     # run just one test file.
-  #   rake profile TESTOPTS="-v"             # run in verbose mode
-  #   rake profile TESTOPTS="--runner=fox"   # use the fox test runner
-
-  class ProfileTask < Rake::TestTask
-    attr_accessor :output_dir
-    attr_accessor :min_percent
-    attr_accessor :printer
-
-    def initialize(name = :profile)
-      super(name)
-    end
-
-    # Create the tasks defined by this task lib.
-    def define
-      lib_path = @libs.join(File::PATH_SEPARATOR)
-      desc "Profile" + (@name==:profile ? "" : " for #{@name}")
-
-      task @name do
-        create_output_directory
-
-        @ruby_opts.unshift( "-I#{lib_path}" )
-        @ruby_opts.unshift( "-w" ) if @warning
-        @ruby_opts.push("-S ruby-prof")
-        @ruby_opts.push("--printer #{@printer}")
-        @ruby_opts.push("--min_percent #{@min_percent}")
-
-        file_list.each do |file_path|
-          run_script(file_path)
-        end
-      end
-      self
-    end
-
-    # Run script
-    def run_script(script_path)
-      run_code = ''
-      RakeFileUtils.verbose(@verbose) do
-        file_name = File.basename(script_path, File.extname(script_path))
-        case @printer
-          when :flat, :graph, :call_tree
-            file_name += ".txt"
-          when :graph_html
-            file_name += ".html"
-          else
-            file_name += ".txt"
-        end
-
-        output_file_path = File.join(output_directory, file_name)
-
-        command_line = @ruby_opts.join(" ") +
-                      " --file=" + output_file_path +
-                      " " + script_path
-
-        puts "ruby " + command_line
-        # We have to catch the exeption to continue on.  However,
-        # the error message will have been output to STDERR
-        # already by the time we get here so we don't have to
-        # do that again
-        begin
-          ruby command_line
-        rescue => e
-          STDOUT << e << "\n"
-          STDOUT.flush
-        end
-        puts ""
-        puts ""
-      end
-    end
-
-    def output_directory
-      File.expand_path(@output_dir)
-    end
-
-    def create_output_directory
-      if not File.exist?(output_directory)
-        Dir.mkdir(output_directory)
-      end
-    end
-
-    def clean_output_directory
-      if File.exist?(output_directory)
-        files = Dir.glob(output_directory + '/*')
-        FileUtils.rm(files)
-      end
-    end
-
-    def option_list # :nodoc:
-      ENV['OPTIONS'] || @options.join(" ") || ""
-    end
-  end
-end
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'rake'
+require 'rake/testtask'
+require 'fileutils'
+
+module RubyProf
+
+  # Define a task library for profiling unit tests with ruby-prof.
+  #
+  # All of the options provided by
+  # the Rake:TestTask are supported except the loader
+  # which is set to ruby-prof.  For detailed information
+  # please refer to the Rake:TestTask documentation.
+  #
+  # ruby-prof specific options include:
+  #
+  #   output_dir - For each file specified an output
+  #                file with profile information will be
+  #                written to the output directory.
+  #                By default, the output directory is
+  #                called "profile" and is created underneath
+  #                the current working directory.
+  #
+  #   printer - Specifies the output printer.  Valid values include
+  #             :flat, :graph, :graph_html and :call_tree.
+  #
+  #   min_percent - Methods that take less than the specified percent
+  #                 will not be written out.
+  #
+  # Example:
+  #
+  #   require 'ruby-prof/task'
+  #
+  #   RubyProf::ProfileTask.new do |t|
+  #     t.test_files = FileList['test/test*.rb']
+  #     t.output_dir = "c:/temp"
+  #     t.printer = :graph
+  #     t.min_percent = 10
+  #   end
+  #
+  # If rake is invoked with a "TEST=filename" command line option,
+  # then the list of test files will be overridden to include only the
+  # filename specified on the command line.  This provides an easy way
+  # to run just one test.
+  #
+  # If rake is invoked with a "TESTOPTS=options" command line option,
+  # then the given options are passed to the test process after a
+  # '--'.  This allows Test::Unit options to be passed to the test
+  # suite.
+  #
+  # Examples:
+  #
+  #   rake profile                           # run tests normally
+  #   rake profile TEST=just_one_file.rb     # run just one test file.
+  #   rake profile TESTOPTS="-v"             # run in verbose mode
+  #   rake profile TESTOPTS="--runner=fox"   # use the fox test runner
+
+  class ProfileTask < Rake::TestTask
+    attr_accessor :output_dir
+    attr_accessor :min_percent
+    attr_accessor :printer
+
+    def initialize(name = :profile)
+      super(name)
+    end
+
+    # Create the tasks defined by this task lib.
+    def define
+      lib_path = @libs.join(File::PATH_SEPARATOR)
+      desc "Profile" + (@name==:profile ? "" : " for #{@name}")
+
+      task @name do
+        create_output_directory
+
+        @ruby_opts.unshift( "-I#{lib_path}" )
+        @ruby_opts.unshift( "-w" ) if @warning
+        @ruby_opts.push("-S ruby-prof")
+        @ruby_opts.push("--printer #{@printer}")
+        @ruby_opts.push("--min_percent #{@min_percent}")
+
+        file_list.each do |file_path|
+          run_script(file_path)
+        end
+      end
+      self
+    end
+
+    # Run script
+    def run_script(script_path)
+      run_code = ''
+      RakeFileUtils.verbose(@verbose) do
+        file_name = File.basename(script_path, File.extname(script_path))
+        case @printer
+          when :flat, :graph, :call_tree
+            file_name += ".txt"
+          when :graph_html
+            file_name += ".html"
+          else
+            file_name += ".txt"
+        end
+
+        output_file_path = File.join(output_directory, file_name)
+
+        command_line = @ruby_opts.join(" ") +
+                      " --file=" + output_file_path +
+                      " " + script_path
+
+        puts "ruby " + command_line
+        # We have to catch the exeption to continue on.  However,
+        # the error message will have been output to STDERR
+        # already by the time we get here so we don't have to
+        # do that again
+        begin
+          ruby command_line
+        rescue => e
+          STDOUT << e << "\n"
+          STDOUT.flush
+        end
+        puts ""
+        puts ""
+      end
+    end
+
+    def output_directory
+      File.expand_path(@output_dir)
+    end
+
+    def create_output_directory
+      if not File.exist?(output_directory)
+        Dir.mkdir(output_directory)
+      end
+    end
+
+    def clean_output_directory
+      if File.exist?(output_directory)
+        files = Dir.glob(output_directory + '/*')
+        FileUtils.rm(files)
+      end
+    end
+
+    def option_list # :nodoc:
+      ENV['OPTIONS'] || @options.join(" ") || ""
+    end
+  end
+end

data/lib/ruby-prof/thread.rb

@@ -1,20 +1,20 @@
-module RubyProf
-  class Thread
-    # Returns the total time this thread was executed.
-    def total_time
-      self.call_tree.total_time
-    end
-
-    # Returns the amount of time this thread waited while other thread executed.
-    def wait_time
-      # wait_time, like self:time, is always method local
-      # thus we need to sum over all methods and call infos
-      self.methods.inject(0) do |sum, method_info|
-        method_info.callers.each do |call_tree|
-          sum += call_tree.wait_time
-        end
-        sum
-      end
-    end
-  end
-end
+module RubyProf
+  class Thread
+    # Returns the total time this thread was executed.
+    def total_time
+      self.call_tree.total_time
+    end
+
+    # Returns the amount of time this thread waited while other thread executed.
+    def wait_time
+      # wait_time, like self:time, is always method local
+      # thus we need to sum over all methods and call infos
+      self.methods.inject(0) do |sum, method_info|
+        method_info.callers.each do |call_tree|
+          sum += call_tree.wait_time
+        end
+        sum
+      end
+    end
+  end
+end

data/lib/ruby-prof/version.rb

@@ -1,3 +1,3 @@
 module RubyProf
-  VERSION = "1.7.2"
+  VERSION = "2.0.0"
 end

data/lib/ruby-prof.rb

@@ -1,52 +1,50 @@
-# encoding: utf-8
-require 'rubygems/version'
-
-# Load the C-based binding.
-begin
-  version = Gem::Version.new(RUBY_VERSION)
-  require "#{version.segments[0..1].join('.')}/ruby_prof.so"
-rescue LoadError
-  require "ruby_prof.so"
-end
-
-require 'ruby-prof/version'
-require 'ruby-prof/call_tree'
-require 'ruby-prof/compatibility'
-require 'ruby-prof/measurement'
-require 'ruby-prof/method_info'
-require 'ruby-prof/profile'
-require 'ruby-prof/rack'
-require 'ruby-prof/thread'
-
-module RubyProf
-  autoload :CallTreeVisitor, 'ruby-prof/call_tree_visitor'
-  autoload :AbstractPrinter, 'ruby-prof/printers/abstract_printer'
-  autoload :CallInfoPrinter, 'ruby-prof/printers/call_info_printer'
-  autoload :CallStackPrinter, 'ruby-prof/printers/call_stack_printer'
-  autoload :CallTreePrinter, 'ruby-prof/printers/call_tree_printer'
-  autoload :DotPrinter, 'ruby-prof/printers/dot_printer'
-  autoload :FlatPrinter, 'ruby-prof/printers/flat_printer'
-  autoload :GraphHtmlPrinter, 'ruby-prof/printers/graph_html_printer'
-  autoload :GraphPrinter, 'ruby-prof/printers/graph_printer'
-  autoload :MultiPrinter, 'ruby-prof/printers/multi_printer'
-
-  # :nodoc:
-  # Checks if the user specified the clock mode via
-  # the RUBY_PROF_MEASURE_MODE environment variable
-  def self.figure_measure_mode
-    case ENV["RUBY_PROF_MEASURE_MODE"]
-    when "wall", "wall_time"
-      RubyProf.measure_mode = RubyProf::WALL_TIME
-    when "allocations"
-      RubyProf.measure_mode = RubyProf::ALLOCATIONS
-    when "memory"
-      RubyProf.measure_mode = RubyProf::MEMORY
-    when "process", "process_time"
-      RubyProf.measure_mode = RubyProf::PROCESS_TIME
-    else
-      # the default is defined in the measure_mode reader
-    end
-  end
-end
-
-RubyProf::figure_measure_mode
+# encoding: utf-8
+require 'rubygems/version'
+
+# Load the C-based binding.
+begin
+  version = Gem::Version.new(RUBY_VERSION)
+  require "#{version.segments[0..1].join('.')}/ruby_prof.so"
+rescue LoadError
+  require "ruby_prof.so"
+end
+
+require 'ruby-prof/version'
+require 'ruby-prof/call_tree'
+require 'ruby-prof/measurement'
+require 'ruby-prof/method_info'
+require 'ruby-prof/profile'
+require 'ruby-prof/rack'
+require 'ruby-prof/thread'
+
+module RubyProf
+  autoload :CallTreeVisitor, 'ruby-prof/call_tree_visitor'
+  autoload :AbstractPrinter, 'ruby-prof/printers/abstract_printer'
+  autoload :CallInfoPrinter, 'ruby-prof/printers/call_info_printer'
+  autoload :CallStackPrinter, 'ruby-prof/printers/call_stack_printer'
+  autoload :CallTreePrinter, 'ruby-prof/printers/call_tree_printer'
+  autoload :DotPrinter, 'ruby-prof/printers/dot_printer'
+  autoload :FlameGraphPrinter, 'ruby-prof/printers/flame_graph_printer'
+  autoload :FlatPrinter, 'ruby-prof/printers/flat_printer'
+  autoload :GraphHtmlPrinter, 'ruby-prof/printers/graph_html_printer'
+  autoload :GraphPrinter, 'ruby-prof/printers/graph_printer'
+  autoload :MultiPrinter, 'ruby-prof/printers/multi_printer'
+
+  # :nodoc:
+  # Checks if the user specified the clock mode via
+  # the RUBY_PROF_MEASURE_MODE environment variable
+  def self.figure_measure_mode
+    case ENV["RUBY_PROF_MEASURE_MODE"]
+    when "wall", "wall_time"
+      RubyProf.measure_mode = RubyProf::WALL_TIME
+    when "allocations"
+      RubyProf.measure_mode = RubyProf::ALLOCATIONS
+    when "process", "process_time"
+      RubyProf.measure_mode = RubyProf::PROCESS_TIME
+    else
+      # the default is defined in the measure_mode reader
+    end
+  end
+end
+
+RubyProf::figure_measure_mode