rack-perftools_profiler 0.0.2 → 0.1.0

data/README.rdoc

@@ -26,12 +26,22 @@ Include the middleware
 
   require 'rack/perftools_profiler'
 
-For Rails, add the following to config/environment.rb
+For Rails 2, add the following to config/environment.rb
 
- config.gem 'rack-perftools_profiler', :version => '~> 0.0.1', :lib => 'rack/perftools_profiler'
+ config.gem 'rack-perftools_profiler', :version => '~> 0.1', :lib => 'rack/perftools_profiler'
  require 'rack/perftools_profiler'
  config.middleware.use Rack::PerftoolsProfiler, :default_printer => 'gif'
 
+For Rails 3 (or any app using Bundler), add the following to your Gemfile
+
+ gem 'rack-perftools_profiler', '~> 0.1', :require => 'rack/perftools_profiler' 
+
+and make sure you pass the option
+
+  :bundler => true
+
+when configuring the middleware.
+
 For Sinatra, call 'use' inside a configure block, like so:
 
   configure :profiling do
@@ -49,6 +59,8 @@ For Rack::Builder, call 'use' inside the Builder constructor block
 * :default_printer - can be set to 'text', 'gif', or 'pdf'. Default is :text
 * :mode            - can be set to 'cputime' or 'walltime'. Default is :cputime
 * :frequency       - in :cputime mode, the number of times per second the app will be sampled. Default is 100 (times/sec)
+* :bundler         - run the profiler binary using 'bundle' if set to true. Default is false
+* :gemfile_dir     - directory with Gemfile. Default is the current directory.
 
 == Usage 
 
@@ -59,7 +71,7 @@ add the 'profile' and (optionally) the 'times' GET params (which will rerun the
 the specified number of times).
 
 Example: 
-  curl http://localhost:8080/foobar?profile=true&times=3
+  curl http://localhost:3000/foobar?profile=true&times=3
 
 Note that this will change the status, body, and headers of the response (you'll get
 back the profiling data, NOT the original response).
@@ -67,11 +79,11 @@ back the profiling data, NOT the original response).
 The other mode is start/stop mode.
 
 Example:
-  curl http://localhost:8080/__start__
-  curl http://localhost:8080/foobar
-  curl http://localhost:8080/foobaz
-  curl http://localhost:8080/__stop__
-  curl http://localhost:8080/__data__
+  curl http://localhost:3000/__start__
+  curl http://localhost:3000/foobar
+  curl http://localhost:3000/foobaz
+  curl http://localhost:3000/__stop__
+  curl http://localhost:3000/__data__
 
 In this mode, all responses are normal. You must visit \_\_stop\_\_ to complete profiling and
 then you can view the profiling data by visiting \_\_data\_\_

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = 'ben@bbrinck.com'
     gem.homepage = 'http://github.com/bhb/rack-perftools_profiler'
     gem.authors = ['Ben Brinckerhoff']
-    gem.add_dependency 'perftools.rb', '~> 0.4'
+    gem.add_dependency 'perftools.rb', '~> 0.5'
     gem.add_dependency 'rack', '~> 1.0'
     gem.add_dependency('open4', '~> 1.0')
     gem.add_development_dependency 'rack', '~> 1.1'

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/rack/perftools_profiler.rb

@@ -1,90 +1,3 @@
-# REQUIREMENTS
-#
-# You'll need graphviz to generate call graphs using dot (for the GIF printer):
-#
-#    sudo port install graphviz     # osx
-#    sudo apt-get install graphviz  # debian/ubuntu
-
-# You'll need ps2pdf to generate PDFs 
-# On OS X, ps2pdf comes is installed as part of Ghostscript
-# 
-#    sudo port install ghostscript # osx
-#    brew install ghostscript      # homebrew
-#    sudo apt-get install ps2pdf   # debian/ubuntu
-
-# CONFIGURATION
-# 
-# Include the middleware
-#
-#     require 'rack/perftools_profiler'
-#
-# For Rails, add the following to config/environment.rb
-# 
-#    config.middleware.use Rack::PerftoolsProfiler, :default_printer => 'gif'
-#
-# For Sinatra, call 'use' inside a configure block, like so:
-#
-#     configure :profiling do
-#       use Rack::PerftoolsProfiler, :default_printer => 'gif'
-#     end
-#
-# For Rack::Builder, call 'use' inside the Builder constructor block
-#
-#     Rack::Builder.new do
-#       use Rack::PerftoolsProfiler, :default_printer => 'gif'
-#     end
-#       
-#
-# OPTIONS
-#
-# :default_printer - can be set to 'text', 'gif', or 'pdf'. Default is :text
-# :mode            - can be set to 'cputime' or 'walltime'. Default is :cputime
-# :frequency       - in :cputime mode, the number of times per second the app will be sampled.
-#                    Default is 100 (times/sec)
-#
-# USAGE 
-#
-# There are two modes for the profiler
-# 
-# First, you can run in 'simple' mode. Just visit the url you want to profile, but
-# add the 'profile' and (optionally) the 'times' GET params
-# 
-# example: 
-# curl http://localhost:8080/foobar?profile=true&times=3
-#
-# Note that this will change the status, body, and headers of the response (you'll get
-# back the profiling data, NOT the original response.
-#
-#
-# The other mode is start/stop mode.
-# 
-# example:
-# curl http://localhost:8080/__start__
-# curl http://localhost:8080/foobar
-# curl http://localhost:8080/foobaz
-# curl http://localhost:8080/__stop__
-# curl http://localhost:8080/__data__
-#
-# In this mode, all responses are normal. You must visit __stop__ to complete profiling and
-# then you can view the profiling data by visiting __data__
-
-# PROFILING DATA OPTIONS
-#
-# In both simple and start/stop modes, you can add additional params to change how the data
-# is displayed. In simple mode, these params are just added to the URL being profiled. In
-# start/stop mode, they are added to the __data__ URL
-
-# printer - overrides the default_printer option (see above)
-# ignore  - a regular expression of the area of code to ignore 
-# focus   - a regular expression of the area of code to solely focus on.
-
-# (for ignore and focus, please see http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile.html#pprof
-# for more details)
-#
-# ACKNOWLEDGMENTS
-# 
-# The basic idea and initial implementation was heavily influenced by Rack::Profiler from rack-contrib.
-
 require 'rack'
 require 'perftools'
 require 'pstore'

data/lib/rack/perftools_profiler/profiler.rb

@@ -24,12 +24,15 @@ module Rack::PerftoolsProfiler
     DEFAULT_PRINTER = :text
     DEFAULT_MODE = :cputime
     UNSET_FREQUENCY = -1
+    DEFAULT_GEMFILE_DIR = '.'
 
     def initialize(app, options)
-      @printer   = (options.delete(:default_printer) { DEFAULT_PRINTER }).to_sym
+      @printer     = (options.delete(:default_printer) { DEFAULT_PRINTER }).to_sym
+      @frequency   = (options.delete(:frequency) { UNSET_FREQUENCY }).to_s
+      @mode        = (options.delete(:mode) { DEFAULT_MODE }).to_sym
+      @bundler     = (options.delete(:bundler) { false })
+      @gemfile_dir = (options.delete(:gemfile_dir) { DEFAULT_GEMFILE_DIR })
       ProfileDataAction.check_printer(@printer)
-      @frequency = (options.delete(:frequency) { UNSET_FREQUENCY }).to_s
-      @mode      = (options.delete(:mode) { DEFAULT_MODE }).to_sym
       raise ProfilerArgumentError, "Invalid option(s): #{options.keys.join(' ')}" unless options.empty?
     end
     
@@ -43,9 +46,10 @@ module Rack::PerftoolsProfiler
     def self.clear_data
       ::File.delete(PROFILING_DATA_FILE) if ::File.exists?(PROFILING_DATA_FILE)
     end
-
+    
     def start
       set_env_vars
+      PerfTools::CpuProfiler.stop
       PerfTools::CpuProfiler.start(PROFILING_DATA_FILE)
       self.profiling = true
     end
@@ -71,7 +75,8 @@ module Rack::PerftoolsProfiler
         args += " --ignore=#{ignore}" if ignore
         args += " --focus=#{focus}" if focus
         cmd = "pprof.rb #{args} #{PROFILING_DATA_FILE}"
-        stdout, stderr, status = run(cmd)
+        cmd = "bundle exec " + cmd if @bundler
+        stdout, stderr, status = Dir.chdir(@gemfile_dir) { run(cmd) }
         if(status == 0)
           [printer, stdout]
         else

data/test/rack-perftools-profiler_test.rb

@@ -402,6 +402,30 @@ class RackPerftoolsProfilerTest < Test::Unit::TestCase
       end
 
     end
+
+    context "when in bundler mode" do
+      
+      should "call pprof.rb using 'bundle' command if bunder is set" do
+        status = stub_everything(:exitstatus => 0)
+        profiled_app = Rack::PerftoolsProfiler.new(@app, :bundler => true)
+        Open4.expects(:popen4).with(regexp_matches(/^bundle exec pprof\.rb/)).returns(status)
+        profiled_app.call(@profiled_request_env)
+      end
+
+      should "change directory into the current directory if custom Gemfile dir is not provided" do
+        profiled_app = Rack::PerftoolsProfiler.new(@app, :bundler => true, :gemfile_dir => 'bundler')
+        Dir.expects(:chdir).with('bundler').returns(["","",0])
+        profiled_app.call(@profiled_request_env)
+      end
+
+      should "change directory into custom Gemfile dir if provided" do
+        profiled_app = Rack::PerftoolsProfiler.new(@app, :bundler => true)
+        Dir.expects(:chdir).with('.').returns(["","",0])
+        profiled_app.call(@profiled_request_env)
+      end
+    
+    end
+
   end
 
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ben Brinckerhoff
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-23 00:00:00 -06:00
+date: 2010-08-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,8 +26,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 4
-        version: "0.4"
+        - 5
+        version: "0.5"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency