ruby-prof 0.16.2 → 1.1.0

data/lib/ruby-prof/rack.rb

@@ -1,95 +1,171 @@
-# encoding: utf-8
-require 'tmpdir'
-
-module Rack
-  class RubyProf
-    def initialize(app, options = {})
-      @app = app
-      @options = options
-      @options[:min_percent] ||= 1
-
-      @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
-          data = ::RubyProf::Profile.profile(profiling_options) do
-            result = @app.call(env)
-          end
-
-          path = request.path.gsub('/', '-')
-          path.slice!(0)
-
-          print(data, 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
-      options = {}
-      options[:measure_mode] = ::RubyProf.measure_mode
-      options[:exclude_threads] =
-        if @options[:ignore_existing_threads]
-          Thread.list.select{|t| t != Thread.current}
-        else
-          ::RubyProf.exclude_threads
-        end
-      if @options[:request_thread_only]
-        options[:include_threads] = [Thread.current]
-      end
-      if @options[:merge_fibers]
-        options[:merge_fibers] = true
-      end
-      options
-    end
-
-    def print(data, path)
-      @printer_klasses.each do |printer_klass, base_name|
-        printer = printer_klass.new(data)
-
-        if base_name.respond_to?(:call)
-          base_name = base_name.call
-        end
-
-        if printer_klass == ::RubyProf::MultiPrinter
-          printer.print(@options.merge(:profile => "#{path}-#{base_name}"))
-        elsif printer_klass == ::RubyProf::CallTreePrinter
-          printer.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, @options)
-          end
-        end
-      end
-    end
-  end
-end
+# encoding: utf-8
+require 'tmpdir'
+
+module Rack
+  class RubyProf
+    def initialize(app, options = {})
+      @app = app
+
+      options[:min_percent] ||= 1
+
+      options[:path] ||= Dir.tmpdir
+      FileUtils.mkdir_p(options[:path])
+
+      @skip_paths = options[:skip_paths] || [%r{^/assets}, %r{\.(css|js|png|jpeg|jpg|gif)$}]
+      @only_paths = options[:only_paths]
+
+      @max_requests = options[:max_requests]
+
+      @options = options
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if should_profile?(request.path)
+        profiler.resume
+        begin
+          result = @app.call(env)
+        ensure
+          profiler.pause
+        end
+
+        if profiler.max_requests_reached?
+          prefix = if aggregate_requests?
+              nil
+            else
+              request.path.gsub('/', '-')[1..-1]
+            end
+
+          profiler.print!(prefix)
+          delete_profiler!
+        end
+
+        result
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    class RackProfiler
+      def initialize(options)
+        @options = options
+
+        @profile = ::RubyProf::Profile.new(profiling_options)
+        @profile.start
+        @profile.pause
+
+        @printer_klasses = options[:printers] || default_printers
+
+        @tmpdir = options[:path]
+
+        @max_requests = options[:max_requests] || 1
+        @requests_count = 0
+
+        @printed = false
+        # if running across multiple requests, we want to make sure that the
+        # ongoing profile is not lost if the process shuts down before the
+        # max request count is reached
+        ObjectSpace.define_finalizer(self, proc { print! })
+      end
+
+      def resume
+        @profile.resume
+      end
+
+      def pause
+        @profile.pause
+        @requests_count += 1
+      end
+
+      def max_requests_reached?
+        @requests_count >= @max_requests
+      end
+
+      def print!(prefix = nil)
+        return false if @printed || @requests_count == 0
+
+        data = @profile.stop
+
+        prefix ||= "multi-requests-#{@requests_count}"
+
+        @printer_klasses.each do |printer_klass, base_name|
+          printer = printer_klass.new(data)
+
+          if base_name.respond_to?(:call)
+            base_name = base_name.call
+          end
+
+          if printer_klass == ::RubyProf::MultiPrinter \
+              || printer_klass == ::RubyProf::CallTreePrinter
+            printer.print(@options.merge(:profile => "#{prefix}-#{base_name}"))
+          else
+            file_name = ::File.join(@tmpdir, "#{prefix}-#{base_name}")
+            ::File.open(file_name, 'wb') do |file|
+              printer.print(file, @options)
+            end
+          end
+        end
+
+        @printed = true
+      end
+
+      private
+
+      def profiling_options
+        options = {}
+        options[:measure_mode] = ::RubyProf.measure_mode
+        options[:exclude_threads] =
+          if @options[:ignore_existing_threads]
+            Thread.list.select{|t| t != Thread.current}
+          else
+            ::RubyProf.exclude_threads
+          end
+        if @options[:request_thread_only]
+          options[:include_threads] = [Thread.current]
+        end
+        options
+      end
+
+      def default_printers
+        {::RubyProf::FlatPrinter => 'flat.txt',
+         ::RubyProf::GraphPrinter => 'graph.txt',
+         ::RubyProf::GraphHtmlPrinter => 'graph.html',
+         ::RubyProf::CallStackPrinter => 'call_stack.html'}
+      end
+    end
+
+    def profiler
+      if aggregate_requests?
+        @@_shared_profiler ||= RackProfiler.new(@options)
+      else
+        @_profiler ||= RackProfiler.new(@options)
+      end
+    end
+
+    def delete_profiler!
+      if aggregate_requests?
+        @@_shared_profiler.print! if @@_shared_profiler
+        @@_shared_profiler = nil
+      else
+        @_profiler = nil
+      end
+    end
+
+    def aggregate_requests?
+      !@max_requests.nil?
+    end
+
+    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
+  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