rack-mini-profiler 0.1.29 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca3a413c784a90f894e6ae5b6025f9203d161d1f
-  data.tar.gz: 570faec20b83dc6069a7b91fb065835668093ad9
+  metadata.gz: d38192262a50a132bef944ea6508e5c2edd65d30
+  data.tar.gz: 3f9c5065465f08cdf643b701185b383eaa04b182
 SHA512:
-  metadata.gz: c2c03d9750cfa1411b78993f16303bdb836a81b741cfea22cccc6209df9c506b6cf020cd0c3409fe77c869009fded27316683ded937b02759b990dbc5dde4a27
-  data.tar.gz: ba89510aba2923e06632876f740242325e26ebecd48d231b4fcef03cfe1a1417878eba48c63c0ca7d1e040ba029ff2493afdc0e1ff764be6d91fbb1c2c2abf20
+  metadata.gz: 47dc4effcf2bbd0d46a0be9738e761783a23bb6f2a35778913f02fc01910ee3b143d72b858007ef0e7dcb0e3570f7637b86ef6f1e3d013b7b71715cc6919c5b8
+  data.tar.gz: ac388ffaa4ea593ac4f96dd507d5d638a35bae9e526dffb772bacf0c8afd4f0f8639e8b255ff186e5e358ed921ed8cdce1d6a95fb152271462c97ab31610ae74

data/{Ruby/CHANGELOG → CHANGELOG}

@@ -148,5 +148,34 @@
   * Bugfix: SOLR patching had an incorrect monkey patch
   * Implemented exception tracing using TracePoint see pp=trace-exceptions
 
+30-August-2013
+
+  * 1.30
+  * Feature: Added Rack::MiniProfiler.counter_method(klass,name) for injecting counters
+  * Bug: Counters were not shifting the table correctly
+
+3-September-2013
+
+  * Ripped out flamegraph so it can be isolated into a gem
+  * Flamegraph now has much increased fidelity
+  * Ripped out pp=sample it just was never really used
+
+17-September-2013 - Ross Wilson
+  * Instead of supressing all "/assets/" requests we now check the configured
+  config.assets.prefix path since developers can rename the path to serve Asset Pipeline
+  files from
+
+12-December-2013 - Sam Saffron
+  * Version 0.9.0.pre (bumped up to reflect the stability of the project)
+  * Improved reports for pp=profile-gc
+  * pp=flamegraph&flamegraph_sample_rate=1 , allow you to specify sampling rates
+
+13-March-2013 - Sam Saffron
+  * Version 0.9.1
+  * Added back Ruby 1.8 support (thanks Malet)
+  * Corrected Rails 3.0 support (thanks Zlatko)
+  * Corrected fix possible XSS (admin only)
+  * Amend Railstie so MiniProfiler can be launched with action view or action controller (Thanks Akira)
+  * Corrected Sql patching to avoid setting instance vars on nil which is frozen (thanks Andy, huoxito)
 
 

data/README.md

@@ -0,0 +1,269 @@
+# rack-mini-profiler
+
+[![Code Climate](https://codeclimate.com/github/MiniProfiler/rack-mini-profiler.png)](https://codeclimate.com/github/MiniProfiler/rack-mini-profiler) [![Build Status](https://travis-ci.org/MiniProfiler/rack-mini-profiler.png)](https://travis-ci.org/MiniProfiler/rack-mini-profiler)
+
+Middleware that displays speed badge for every html page. Designed to work both in production and in development.
+
+#### Features
+
+* database profiling. Currently supports Mysql2, Postgres, and Mongoid3 (with fallback support to ActiveRecord)
+
+#### Learn more
+
+* [Visit our community](http://community.miniprofiler.com)
+* [Watch the RailsCast](http://railscasts.com/episodes/368-miniprofiler)
+* [Read about Flame graphs in rack-mini-profiler](http://samsaffron.com/archive/2013/03/19/flame-graphs-in-ruby-miniprofiler)
+* [Read the announcement posts from 2012](http://samsaffron.com/archive/2012/07/12/miniprofiler-ruby-edition)
+
+## rack-mini-profiler needs your help
+
+We have decided to restructure our repository so there is a central UI repo and the various language implementation have their own.
+
+**WE NEED HELP.**
+
+- Setting up a build that reuses https://github.com/MiniProfiler/ui
+- Migrating the internal data structures [per the spec](https://github.com/MiniProfiler/ui)
+- Cleaning up the [horrendous class structure that is using strings as keys and crazy non-objects](https://github.com/MiniProfiler/rack-mini-profiler/blob/master/lib/mini_profiler/sql_timer_struct.rb#L36-L44)
+
+If you feel like taking on any of this start an issue and update us on your progress.
+
+## Installation
+
+Install/add to Gemfile
+
+```ruby
+gem 'rack-mini-profiler'
+```
+
+NOTE: Be sure to require rack_mini_profiler below the `pg` and `mysql` gems in your Gemfile. rack_mini_profiler will identify these gems if they are loaded to insert instrumentation. If included too early no SQL will show up.
+
+#### Rails
+
+All you have to do is include the Gem and you're good to go in development. See notes below for use in production.
+
+#### Rails and manual initialization
+
+In case you need to make sure rack_mini_profiler initialized after all other gems.
+Or you want to execute some code before rack_mini_profiler required.
+
+```ruby
+gem 'rack-mini-profiler', require: false
+```
+
+Then put initialize code in file like `config/initializers/rack_profiler.rb`
+
+```ruby
+if Rails.env == 'development'
+  require 'rack-mini-profiler'
+
+  # initialization is skipped so trigger it
+  Rack::MiniProfilerRails.initialize!(Rails.application)
+end
+```
+
+#### Rack Builder
+
+```ruby
+require 'rack-mini-profiler'
+builder = Rack::Builder.new do
+  use Rack::MiniProfiler
+
+  map('/')    { run get }
+end
+```
+
+#### Sinatra
+
+```ruby
+require 'rack-mini-profiler'
+class MyApp < Sinatra::Base
+  use Rack::MiniProfiler
+end
+```
+
+### Flamegraphs
+
+To generate [flamegraphs](http://samsaffron.com/archive/2013/03/19/flame-graphs-in-ruby-miniprofiler):
+
+* add the **flamegraph** gem to your Gemfile
+* visit a page in your app with `?pp=flamegraph`
+
+Flamegraph generation is supported in MRI 2.0 and 2.1 only.
+
+
+## Access control in production
+
+rack-mini-profiler is designed with production profiling in mind. To enable that just run `Rack::MiniProfiler.authorize_request` once you know a request is allowed to profile.
+
+```ruby
+# A hook in your ApplicationController
+def authorize
+  if current_user.is_admin?
+    Rack::MiniProfiler.authorize_request
+  end
+end
+```
+
+## Configuration
+
+Various aspects of rack-mini-profiler's behavior can be configured when your app boots.
+For example in a Rails app, this should be done in an initializer:
+**config/initializers/mini_profiler.rb**
+
+### Storage
+
+rack-mini-profiler stores its results so they can be shared later and aren't lost at the end of the request.
+
+There are 4 storage options: `MemoryStore`, `RedisStore`, `MemcacheStore`, and `FileStore`.
+
+`FileStore` is the default in Rails environments and will write files to `tmp/miniprofiler/*`.  `MemoryStore` is the default otherwise.
+
+```ruby
+# set MemoryStore
+Rack::MiniProfiler.config.storage = Rack::MiniProfiler::MemoryStore
+
+# set RedisStore
+if Rails.env.production?
+  uri = URI.parse(ENV["REDIS_SERVER_URL"])
+  Rack::MiniProfiler.config.storage_options = { :host => uri.host, :port => uri.port, :password => uri.password }
+  Rack::MiniProfiler.config.storage = Rack::MiniProfiler::RedisStore
+end
+```
+
+MemoryStore stores results in a processes heap - something that does not work well in a multi process environment.
+FileStore stores results in the file system - something that may not work well in a multi machine environment.
+RedisStore/MemcacheStore work in multi process and multi machine environments (RedisStore only saves results for up to 24 hours so it won't continue to fill up Redis).
+
+Additionally you may implement an AbstractStore for your own provider.
+
+### User result segregation
+
+MiniProfiler will attempt to keep all user results isolated, out-of-the-box the user provider uses the ip address:
+
+```ruby
+Rack::MiniProfiler.config.user_provider = Proc.new{|env| Rack::Request.new(env).ip}
+```
+
+You can override (something that is very important in a multi-machine production setup):
+
+```ruby
+Rack::MiniProfiler.config.user_provider = Proc.new{ |env| CurrentUser.get(env) }
+```
+
+The string this function returns should be unique for each user on the system (for anonymous you may need to fall back to ip address)
+
+### Configuration Options
+
+You can set configuration options using the configuration accessor on `Rack::MiniProfiler`.
+For example:
+
+```ruby
+Rack::MiniProfiler.config.position = 'right'
+Rack::MiniProfiler.config.start_hidden = true
+```
+The available configuration options are:
+
+* pre_authorize_cb - A lambda callback you can set to determine whether or not mini_profiler should be visible on a given request. Default in a Rails environment is only on in development mode. If in a Rack app, the default is always on.
+* position - Can either be 'right' or 'left'. Default is 'left'.
+* skip_schema_queries - Whether or not you want to log the queries about the schema of your tables. Default is 'false', 'true' in rails development.
+* auto_inject (default true) - when false the miniprofiler script is not injected in the page
+* backtrace_filter - a regex you can use to filter out unwanted lines from the backtraces
+* toggle_shortcut (default Alt+P) - a jquery.hotkeys.js-style keyboard shortcut, used to toggle the mini_profiler's visibility. See http://code.google.com/p/js-hotkeys/ for more info.
+* start_hidden (default false) - Whether or not you want the mini_profiler to be visible when loading a page
+* backtrace_threshold_ms (default zero) - Minimum SQL query elapsed time before a backtrace is recorded. Backtrace recording can take a couple of milliseconds on rubies earlier than 2.0, impacting performance for very small queries.
+* flamegraph_sample_rate (default 0.5ms) - How often fast_stack should get stack trace info to generate flamegraphs
+
+### Custom middleware ordering (required if using `Rack::Deflate` with Rails)
+
+If you are using `Rack::Deflate` with rails and rack-mini-profiler in its default configuration,
+`Rack::MiniProfiler` will be injected (as always) at position 0 in the middleware stack. This
+will result in it attempting to inject html into the already-compressed response body. To fix this,
+the middleware ordering must be overriden.
+
+To do this, first add `, require: false` to the gemfile entry for rack-mini-profiler.
+This will prevent the railtie from running. Then, customize the initialization
+in the initializer like so:
+
+```ruby
+require 'rack-mini-profiler'
+
+Rack::MiniProfilerRails.initialize!(Rails.application)
+
+Rails.application.middleware.delete(Rack::MiniProfiler)
+Rails.application.middleware.insert_after(Rack::Deflater, Rack::MiniProfiler)
+```
+
+Deleting the middleware and then reinserting it is a bit inelegant, but
+a sufficient and costless solution. It is possible that rack-mini-profiler might
+support this scenario more directly if it is found that
+there is significant need for this confriguration or that
+the above recipe causes problems.
+
+
+## Special query strings
+
+If you include the query string `pp=help` at the end of your request you will see the various options available. You can use these options to extend or contract the amount of diagnostics rack-mini-profiler gathers.
+
+
+## Rails 2.X support
+
+To get MiniProfiler working with Rails 2.3.X you need to do the initialization manually as well as monkey patch away an incompatibility between activesupport and json_pure.
+
+Add the following code to your environment.rb (or just in a specific environment such as development.rb) for initialization and configuration of MiniProfiler.
+
+```ruby
+# configure and initialize MiniProfiler
+require 'rack-mini-profiler'
+c = ::Rack::MiniProfiler.config
+c.pre_authorize_cb = lambda { |env|
+  Rails.env.development? || Rails.env.production?
+}
+tmp = Rails.root.to_s + "/tmp/miniprofiler"
+FileUtils.mkdir_p(tmp) unless File.exists?(tmp)
+c.storage_options = {:path => tmp}
+c.storage = ::Rack::MiniProfiler::FileStore
+config.middleware.use(::Rack::MiniProfiler)
+::Rack::MiniProfiler.profile_method(ActionController::Base, :process) {|action| "Executing action: #{action}"}
+::Rack::MiniProfiler.profile_method(ActionView::Template, :render) {|x,y| "Rendering: #{path_without_format_and_extension}"}
+
+# monkey patch away an activesupport and json_pure incompatability
+# http://pivotallabs.com/users/alex/blog/articles/1332-monkey-patch-of-the-day-activesupport-vs-json-pure-vs-ruby-1-8
+if JSON.const_defined?(:Pure)
+  class JSON::Pure::Generator::State
+    include ActiveSupport::CoreExtensions::Hash::Except
+  end
+end
+```
+
+## Running the Specs
+
+```
+$ rake build
+$ rake spec
+```
+
+Additionally you can also run `autotest` if you like.
+
+## Licence
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Sam Saffron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/{Ruby/lib → lib}/html/includes.js

@@ -1,4 +1,4 @@
-"use strict";
+"use strict";
 var MiniProfiler = (function () {
     var $;
 
@@ -659,6 +659,14 @@ var MiniProfiler = (function () {
                 } else {
                     doInit();
                 }
+
+                // jquery.hotkeys.js
+                // https://github.com/jeresig/jquery.hotkeys/blob/master/jquery.hotkeys.js
+
+                (function(d){function h(g){if("string"===typeof g.data){var h=g.handler,j=g.data.toLowerCase().split(" ");g.handler=function(b){if(!(this!==b.target&&(/textarea|select/i.test(b.target.nodeName)||"text"===b.target.type))){var c="keypress"!==b.type&&d.hotkeys.specialKeys[b.which],e=String.fromCharCode(b.which).toLowerCase(),a="",f={};b.altKey&&"alt"!==c&&(a+="alt+");b.ctrlKey&&"ctrl"!==c&&(a+="ctrl+");b.metaKey&&(!b.ctrlKey&&"meta"!==c)&&(a+="meta+");b.shiftKey&&"shift"!==c&&(a+="shift+");c?f[a+c]=
+                !0:(f[a+e]=!0,f[a+d.hotkeys.shiftNums[e]]=!0,"shift+"===a&&(f[d.hotkeys.shiftNums[e]]=!0));c=0;for(e=j.length;c<e;c++)if(f[j[c]])return h.apply(this,arguments)}}}}d.hotkeys={version:"0.8",specialKeys:{8:"backspace",9:"tab",13:"return",16:"shift",17:"ctrl",18:"alt",19:"pause",20:"capslock",27:"esc",32:"space",33:"pageup",34:"pagedown",35:"end",36:"home",37:"left",38:"up",39:"right",40:"down",45:"insert",46:"del",96:"0",97:"1",98:"2",99:"3",100:"4",101:"5",102:"6",103:"7",104:"8",105:"9",106:"*",107:"+",
+                109:"-",110:".",111:"/",112:"f1",113:"f2",114:"f3",115:"f4",116:"f5",117:"f6",118:"f7",119:"f8",120:"f9",121:"f10",122:"f11",123:"f12",144:"numlock",145:"scroll",191:"/",224:"meta"},shiftNums:{"`":"~",1:"!",2:"@",3:"#",4:"$",5:"%",6:"^",7:"&",8:"*",9:"(","0":")","-":"_","=":"+",";":": ","'":'"',",":"<",".":">","/":"?","\\":"|"}};d.each(["keydown","keyup","keypress"],function(){d.event.special[this]={add:h}})})(MiniProfiler.jQuery);
+
             };
 
             var major, minor;
@@ -901,13 +909,6 @@ var MiniProfiler = (function () {
 
 MiniProfiler.init();
 
-// jquery.hotkeys.js
-// https://github.com/jeresig/jquery.hotkeys/blob/master/jquery.hotkeys.js
-
-(function(d){function h(g){if("string"===typeof g.data){var h=g.handler,j=g.data.toLowerCase().split(" ");g.handler=function(b){if(!(this!==b.target&&(/textarea|select/i.test(b.target.nodeName)||"text"===b.target.type))){var c="keypress"!==b.type&&d.hotkeys.specialKeys[b.which],e=String.fromCharCode(b.which).toLowerCase(),a="",f={};b.altKey&&"alt"!==c&&(a+="alt+");b.ctrlKey&&"ctrl"!==c&&(a+="ctrl+");b.metaKey&&(!b.ctrlKey&&"meta"!==c)&&(a+="meta+");b.shiftKey&&"shift"!==c&&(a+="shift+");c?f[a+c]=
-!0:(f[a+e]=!0,f[a+d.hotkeys.shiftNums[e]]=!0,"shift+"===a&&(f[d.hotkeys.shiftNums[e]]=!0));c=0;for(e=j.length;c<e;c++)if(f[j[c]])return h.apply(this,arguments)}}}}d.hotkeys={version:"0.8",specialKeys:{8:"backspace",9:"tab",13:"return",16:"shift",17:"ctrl",18:"alt",19:"pause",20:"capslock",27:"esc",32:"space",33:"pageup",34:"pagedown",35:"end",36:"home",37:"left",38:"up",39:"right",40:"down",45:"insert",46:"del",96:"0",97:"1",98:"2",99:"3",100:"4",101:"5",102:"6",103:"7",104:"8",105:"9",106:"*",107:"+",
-109:"-",110:".",111:"/",112:"f1",113:"f2",114:"f3",115:"f4",116:"f5",117:"f6",118:"f7",119:"f8",120:"f9",121:"f10",122:"f11",123:"f12",144:"numlock",145:"scroll",191:"/",224:"meta"},shiftNums:{"`":"~",1:"!",2:"@",3:"#",4:"$",5:"%",6:"^",7:"&",8:"*",9:"(","0":")","-":"_","=":"+",";":": ","'":'"',",":"<",".":">","/":"?","\\":"|"}};d.each(["keydown","keyup","keypress"],function(){d.event.special[this]={add:h}})})(jQuery);
-
 if (typeof prettyPrint === "undefined") {
 
     // prettify.js

data/{Ruby/lib → lib}/html/includes.tmpl

@@ -1,4 +1,4 @@
-<script id="profilerTemplate" type="text/x-jquery-tmpl">
+<script id="profilerTemplate" type="text/x-jquery-tmpl">
 
   <div class="profiler-result">
 
@@ -159,6 +159,8 @@
     <td class="profiler-duration" title="aggregate duration of all queries in this step (excludes children)">
       ${MiniProfiler.formatDuration(timing.SqlTimingsDurationMilliseconds)}
     </td>
+  {{else}}
+    <td colspan="2"></td>
   {{/if}}
 
   {{each page.CustomTimingNames}}

data/{Ruby/lib → lib}/html/list.css

@@ -1,4 +1,4 @@
-tbody tr:nth-child(odd)    { background-color:#eee; }
+tbody tr:nth-child(odd)    { background-color:#eee; }
 tbody tr:nth-child(even)    { background-color:#fff; }
 table { border: 0; border-spacing:0;}
 tr {border: 0;}
@@ -6,4 +6,4 @@ tr {border: 0;}
 td {padding: 8px;}
 .time {text-align:center;}
 thead tr {background-color: #bbb; color: #444; font-size: 12px;}
-thead tr th { padding: 5px 15px;}
+thead tr th { padding: 5px 15px;}

data/{Ruby/lib → lib}/html/list.js

@@ -1,4 +1,4 @@
-var MiniProfiler = MiniProfiler || {};
+var MiniProfiler = MiniProfiler || {};
 MiniProfiler.list = {
     init:
         function (options) {

data/{Ruby/lib → lib}/html/list.tmpl

@@ -1,4 +1,4 @@
-<script id="tableTemplate" type="text/x-jquery-tmpl">
+<script id="tableTemplate" type="text/x-jquery-tmpl">
   <table>
     <thead>
       <tr>
@@ -31,4 +31,4 @@
     <td colspan="3"></td>
     {{/if}}
   </tr>
-</script>
+</script>

data/lib/html/profile_handler.js

@@ -0,0 +1 @@
+<script async type="text/javascript" id="mini-profiler" src="{path}includes.js?v={version}" data-version="{version}" data-path="{path}" data-current-id="{currentId}" data-ids="{ids}" data-position="{position}" data-trivial="{showTrivial}" data-children="{showChildren}" data-max-traces="{maxTracesToShow}" data-controls="{showControls}" data-authorized="{authorized}" data-toggle-shortcut="{toggleShortcut}" data-start-hidden="{startHidden}"></script>

data/{Ruby/lib → lib}/html/share.html

@@ -1,4 +1,4 @@
-<html>
+<html>
     <head>
         <title>{name} ({duration} ms) - Profiling Results</title>
         <script type='text/javascript' src='{path}jquery.1.7.1.js?v={version}'></script>
@@ -8,4 +8,4 @@
     <body>
         <div class='profiler-result-full'></div>
     </body>
-</html>
+</html>

data/{Ruby/lib → lib}/mini_profiler/client_settings.rb

@@ -1,20 +1,20 @@
 module Rack
   class MiniProfiler
     class ClientSettings
-      
+
       COOKIE_NAME = "__profilin"
 
       BACKTRACE_DEFAULT = nil
-      BACKTRACE_FULL = 1 
+      BACKTRACE_FULL = 1
       BACKTRACE_NONE = 2
 
       attr_accessor :disable_profiling
       attr_accessor :backtrace_level
 
-      
+
       def initialize(env)
         request = ::Rack::Request.new(env)
-        @cookie = request.cookies[COOKIE_NAME] 
+        @cookie = request.cookies[COOKIE_NAME]
         if @cookie
           @cookie.split(",").map{|pair| pair.split("=")}.each do |k,v|
             @orig_disable_profiling = @disable_profiling = (v=='t') if k == "dp"
@@ -22,7 +22,7 @@ module Rack
           end
         end
 
-        @backtrace_level = nil if !@backtrace_level.nil? && (@backtrace_level == 0 || @backtrace_level > BACKTRACE_NONE) 
+        @backtrace_level = nil if !@backtrace_level.nil? && (@backtrace_level == 0 || @backtrace_level > BACKTRACE_NONE)
         @orig_backtrace_level = @backtrace_level
 
       end
@@ -30,7 +30,7 @@ module Rack
       def write!(headers)
         if @orig_disable_profiling != @disable_profiling || @orig_backtrace_level != @backtrace_level || @cookie.nil?
           settings = {"p" =>  "t" }
-          settings["dp"] = "t" if @disable_profiling 
+          settings["dp"] = "t" if @disable_profiling
           settings["bt"] = @backtrace_level if @backtrace_level
           settings_string = settings.map{|k,v| "#{k}=#{v}"}.join(",")
           Rack::Utils.set_cookie_header!(headers, COOKIE_NAME, :value => settings_string, :path => '/')
@@ -45,19 +45,19 @@ module Rack
         !@cookie.nil?
       end
 
-      def disable_profiling? 
+      def disable_profiling?
         @disable_profiling
       end
 
-      def backtrace_full? 
+      def backtrace_full?
         @backtrace_level == BACKTRACE_FULL
       end
 
-      def backtrace_default? 
+      def backtrace_default?
         @backtrace_level == BACKTRACE_DEFAULT
       end
-      
-      def backtrace_none? 
+
+      def backtrace_none?
         @backtrace_level == BACKTRACE_NONE
       end
     end