rack_jruby_profiling 0.1.0 → 1.0.0

data/README.rdoc

@@ -1,6 +1,26 @@
 = rack_jruby_profiling
 
-Description goes here.
+To use this in your application you need to have JRubyProf (http://github.com/danlucraft/jruby-prof) installed and available, and your application should be running on the JVM (of course).
+
+This is used like any other Rack middleware:
+
+  require 'rack_jruby_profiling'
+  use Rack::JRubyProfiler
+  
+You can selectively turn off profiling on any request by adding "no_profile=<t,true,y,yes>" to the query parameter list.
+
+The results of the profiling are streamed directly to your client. If you would like to download the file that is generated instead, add a "download=<t,true,y,yes>" parameter to your request.
+
+JRubyProf supports 5 different profile outputs. You can add "profile=<flat,graph,call_tree,graph_html,tree_html>" to specify which you want to use. The default is "tree_html". See http://danlucraft.com/blog/2010/03/jruby-prof/ for more information on these outputs.
+
+* flat => plain text 
+* graph => plain text
+* call_tree => plain text
+* graph_html => HTML
+* tree_html => HTML
+
+== Caveat
+JRubyProf generates files for the profiling information. These files are generated in the current working directory. This middleware doesn't attempt to delete those files after they are generated. That's an exercise left to the user.
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/lib/rack_jruby_profiling.rb

@@ -5,7 +5,11 @@ module Rack
   #
   # Set the profile=call_tree query parameter to view a calltree profile of the request.
   #
-  # Set the download query parameter to download the result locally
+  # Set the download query parameter to download the result locally.
+  #
+  # Set the no_profile query parameter to selectively turn off profiling on certain requests.
+  #
+  # Both the no_profile and download parameters take a tru-ish value, one of [y, yes, t, true]
   #
   class JRubyProfiler
     DEFAULT_CONTENT_TYPE = 'text/html'
@@ -54,16 +58,20 @@ module Rack
       def profile(env)
         request  = Rack::Request.new(env)
         @printer = parse_printer(request.params.delete('profile'))
-        if JRubyProf.running?
+        if JRubyProf.running? || boolean(request['no_profile'])
           @app.call(env)
         else
-          count  = (request.params.delete('times') || @times).to_i
-          result = JRubyProf.profile do
-            count.times { @app.call(env) }
+          begin
+            count  = (request.params.delete('times') || @times).to_i
+            result = JRubyProf.profile do
+              count.times { @app.call(env) }
+            end
+            @uniq_id = Java::java.lang.System.nano_time
+            @profile_file = ::File.expand_path( filename(@printer, env) )
+            [200, headers(@printer, request, env), print(@printer, request, env, result)]
+          ensure
+            JRubyProf.stop
           end
-          @uniq_id = Java::java.lang.System.nano_time
-          @profile_file = ::File.expand_path( filename(@printer, env) )
-          [200, headers(@printer, request, env), print(@printer, request, env, result)]
         end
       end
       

data/rack_jruby_profiling.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack_jruby_profiling}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Rogers"]
+  s.date = %q{2010-04-15}
+  s.description = %q{Rack middleware for running profiling JRuby applications}
+  s.email = %q{jacaetevha@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "VERSION",
+     "lib/rack_jruby_profiling.rb",
+     "rack_jruby_profiling.gemspec",
+     "spec/rack_jruby_profiling_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jacaetevha/rack_jruby_profiling}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Rack middleware for running profiling JRuby applications}
+  s.test_files = [
+    "spec/rack_jruby_profiling_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/rack_jruby_profiling_spec.rb

@@ -5,7 +5,7 @@ module TestHelpers
     Proc.new { |env| 
       500.times {|t| "construct a string for #{t} just so that we have some work to do in this application"}
       500.times {|t| [t, t/4.0].max }
-      [@code, {"Content-Type" => "text/plain", "Content-Length" => "3"}, [@code.to_s]] 
+      [code, {"Content-Type" => "text/plain", "Content-Length" => "3"}, [code.to_s]] 
     }
   end
   
@@ -37,11 +37,17 @@ describe Rack::JRubyProfiler do
   end
   
   after :each do
-    if @profiler
+    if @profiler && @profiler.profile_file
       File.delete @profiler.profile_file
     end
   end
   
+  it "shouldn't profile is the no_profile query parameter is set" do
+    @request = Rack::MockRequest.env_for("/profile_test?no_profile=true")
+    response = response_for( basic_application(200), @request )
+    response.should == basic_application(200).call(nil)
+  end
+  
   [200, 301, 404, 500].each do | code |
     it "should successfully respond with 200 if down-stream app returns #{code}" do
       response = response_for( basic_application(code), @request )
@@ -56,8 +62,8 @@ describe Rack::JRubyProfiler do
   end
   
   it "should NOT mask when a down-stream app throws an error" do
-    @request = Rack::MockRequest.env_for("/profile_test")
-    lambda{ response_for( error_application('ka-boom!'), request ) }.should raise_error
+    request = Rack::MockRequest.env_for("/profile_test")
+    lambda{ response_for( error_application('ka-boom!'), request ) }.should raise_error('ka-boom!')
   end
 
   class Tuple

metadata

@@ -3,10 +3,10 @@ name: rack_jruby_profiling
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jason Rogers
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -04:00
+date: 2010-04-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ files:
 - README.rdoc
 - VERSION
 - lib/rack_jruby_profiling.rb
+- rack_jruby_profiling.gemspec
 - spec/rack_jruby_profiling_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb