rack-mini-profiler 0.1.18 → 0.1.23

data/{CHANGELOG → Ruby/CHANGELOG}

@@ -1,83 +1,107 @@
-28-June-2012 - Sam  
- 
-  * Started change log
-  * Corrected profiler so it properly captures POST requests (was supressing non 200s)
-  * Amended Rack.MiniProfiler.config[:user_provider] to use ip addres for identity 
-  * Fixed bug where unviewed missing ids never got cleared
-  * Supress all '/assets/' in the rails tie (makes debugging easier)
-  * record_sql was mega buggy
-
-9-July-2012 - Sam 
-
-  * Cleaned up mechanism for profiling in production, all you need to do now
-	is call Rack::MiniProfiler.authorize_request to get profiling working in
-	production 
-	* Added option to display full backtraces pp=full-backtrace
-	* Cleaned up railties, got rid of the post authorize callback
-	* Version 0.1.3
-
-12-July-2012 - Sam 
-
-  * Fixed incorrect profiling steps (was not indenting or measuring start time right
-	* Implemented native PG and MySql2 interceptors, this gives way more accurate times
-	* Refactored context so its a proper class and not a hash 
-	* Added some more client probing built in to rails
-	* More tests
-
-18-July-2012 - Sam 
-  
-  * Added First Paint time for chrome
-  * Bug fix to ensure non Rails installs have mini profiler
-  * Version 0.1.7
-
-30-July-2012 - Sam 
-  
-  * Made compliant with ancient versions of Rack (including Rack used by Rails2)
-  * Fixed broken share link 
-  * Fixed crashes on startup (in MemoryStore and FileStore)
-  * Version 0.1.8
-  * Unicode fix 
-  * Version 0.1.9
-
-7-August-2012 - Sam
-
-  * Added option to disable profiler for the current session (pp=disable / pp=enable)
-  * yajl compatability contributed by Sven Riedel 
-
-10-August-2012 - Sam 
-
-  * Added basic prepared statement profiling for postgres 
-
-20-August-2012 - Sam 
-  
-  * 1.12.pre 
-  * Cap X-MiniProfiler-Ids at 10, otherwise the header can get killed
-
-3-September-2012 - Sam
-
-  * 1.13.pre
-  * pg gem prepared statements were not being logged correctly 
-  * added setting config.backtrace_ignores = [] - an array of regexes that match on caller lines that get ignored
-  * added setting config.backtrace_includes = [] - an array of regexes that get included in the trace by default 
-  * cleaned up the way client settings are stored
-  * made pp=full-backtrace "sticky"
-  * added pp=normal-backtrace to clear the "sticky" state
-  * change "pp=sample" to work with "caller" no need for stack trace gem
-
-4-September-2012 - Sam 
-
-  * 1.15.pre
-  * fixed annoying bug where client settings were not sticking 
-  * fixed long standing issue with Rack::ConditionalGet stopping MiniProfiler from working properly
-
-5-September-2012 - Sam 
-
-  * 1.16
-  * fixed long standing problem specs (issue with memory store)
-  * fixed issue where profiler would be dumped when you got a 404 in production (and any time rails is bypassed)
-  * implemented stacktrace properly
-
-9-September-2012 - Sam
-
-  * 1.17
-  * pp=sample was bust unless stacktrace was installed
+28-June-2012 - Sam  
+ 
+  * Started change log
+  * Corrected profiler so it properly captures POST requests (was supressing non 200s)
+  * Amended Rack.MiniProfiler.config[:user_provider] to use ip addres for identity 
+  * Fixed bug where unviewed missing ids never got cleared
+  * Supress all '/assets/' in the rails tie (makes debugging easier)
+  * record_sql was mega buggy
+  * added MemcacheStore
+
+9-July-2012 - Sam 
+
+  * Cleaned up mechanism for profiling in production, all you need to do now
+	is call Rack::MiniProfiler.authorize_request to get profiling working in
+	production 
+	* Added option to display full backtraces pp=full-backtrace
+	* Cleaned up railties, got rid of the post authorize callback
+	* Version 0.1.3
+
+12-July-2012 - Sam 
+
+  * Fixed incorrect profiling steps (was not indenting or measuring start time right
+	* Implemented native PG and MySql2 interceptors, this gives way more accurate times
+	* Refactored context so its a proper class and not a hash 
+	* Added some more client probing built in to rails
+	* More tests
+
+18-July-2012 - Sam 
+  
+  * Added First Paint time for chrome
+  * Bug fix to ensure non Rails installs have mini profiler
+  * Version 0.1.7
+
+30-July-2012 - Sam 
+  
+  * Made compliant with ancient versions of Rack (including Rack used by Rails2)
+  * Fixed broken share link 
+  * Fixed crashes on startup (in MemoryStore and FileStore)
+  * Version 0.1.8
+  * Unicode fix 
+  * Version 0.1.9
+
+7-August-2012 - Sam
+
+  * Added option to disable profiler for the current session (pp=disable / pp=enable)
+  * yajl compatability contributed by Sven Riedel 
+
+10-August-2012 - Sam 
+
+  * Added basic prepared statement profiling for postgres 
+
+20-August-2012 - Sam 
+  
+  * 1.12.pre 
+  * Cap X-MiniProfiler-Ids at 10, otherwise the header can get killed
+
+3-September-2012 - Sam
+
+  * 1.13.pre
+  * pg gem prepared statements were not being logged correctly 
+  * added setting config.backtrace_ignores = [] - an array of regexes that match on caller lines that get ignored
+  * added setting config.backtrace_includes = [] - an array of regexes that get included in the trace by default 
+  * cleaned up the way client settings are stored
+  * made pp=full-backtrace "sticky"
+  * added pp=normal-backtrace to clear the "sticky" state
+  * change "pp=sample" to work with "caller" no need for stack trace gem
+
+4-September-2012 - Sam 
+
+  * 1.15.pre
+  * fixed annoying bug where client settings were not sticking 
+  * fixed long standing issue with Rack::ConditionalGet stopping MiniProfiler from working properly
+
+5-September-2012 - Sam 
+
+  * 1.16
+  * fixed long standing problem specs (issue with memory store)
+  * fixed issue where profiler would be dumped when you got a 404 in production (and any time rails is bypassed)
+  * implemented stacktrace properly
+
+9-September-2012 - Sam
+
+  * 1.17
+  * pp=sample was bust unless stacktrace was installed
+
+10-September-2012 - Sam 
+
+  * 1.19
+  * fix compat issue with 1.8.7
+
+12-September-2012 - Sam
+  
+  * 1.20
+  * Added pp=profile-gc , it allows you to profile the GC in Ruby 1.9.3
+
+17-September-2012
+  * 1.21
+  * New MemchacedStore 
+  * Rails 4 support
+
+17-September-2012
+  * Allow rack-mini-profiler to be sourced from github
+  * Extracted the pp=profile-gc-time out, the object space profiler needs to disable gc
+
+20-September-2010
+  * 1.22
+  * Fix permission issue in the gem

data/{README.md → Ruby/README.md}

@@ -15,7 +15,7 @@ All you have to do is include the Gem and you're good to go in development.
 
 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.
 
-For example: 
+Using Rails:
 
 ```ruby
 # A hook in your ApplicationController
@@ -47,24 +47,38 @@ class MyApp < Sinatra::Base
 end
 ```
 
+## Database profiling
+
+Currently supports Mysql2, Postgres, and Mongoid3 (with fallback support to ActiveRecord)
+
 ## Storage
 
-By default, rack-mini-profiler stores its results in a memory store: 
+rack-mini-profiler stores it's 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.
+
+To change the default you can create a file in `config/initializers/mini_profiler.rb`
 
 ```ruby 
-# our default
+# set MemoryStore
 Rack::MiniProfiler.config.storage = Rack::MiniProfiler::MemoryStore
-```
 
-There are 2 other available storage engines, `RedisStore` and `FileStore`. 
+# 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 is stores results in a processes heap - something that does not work well in a multi process environment. 
+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. 
 
-Rails hooks up a FileStore for all environments. 
-
 ## Running the Specs
 
 ```
@@ -120,7 +134,6 @@ end
 * 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.
-* use_existing_jquery - Use the version of jQuery on the page as opposed to the self contained one
 * 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
 

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

@@ -1,5 +1,6 @@
 "use strict";
-var MiniProfiler = (function ($) {
+var MiniProfiler = (function () {
+    var $;
 
     var options,
         container,
@@ -449,11 +450,12 @@ var MiniProfiler = (function ($) {
         };
 
         // fetch profile results for any ajax calls
+        // note, this does not use $ cause we want to hook into the main jQuery
         if (jQuery && jQuery(document) && jQuery(document).ajaxComplete) {
             jQuery(document).ajaxComplete(jQueryAjaxComplete);
         }
 
-        if (jQuery(document).ajaxStart)
+        if (jQuery && jQuery(document).ajaxStart)
             jQuery(document).ajaxStart(function () { ajaxStartTime = new Date(); });
         
         // fetch results after ASP Ajax calls
@@ -512,9 +514,42 @@ var MiniProfiler = (function ($) {
 
     return {
 
-        init: function (opt) {
+        init: function () {
+            var script = document.getElementById('mini-profiler');
+            if (!script || !script.getAttribute) return;
 
-            options = opt || {};
+            options = (function () {
+                var version = script.getAttribute('data-version');
+                var path = script.getAttribute('data-path');
+
+                var currentId = script.getAttribute('data-current-id');
+
+                var ids = script.getAttribute('data-ids');
+                if (ids)  ids = ids.split(',');
+
+                var position = script.getAttribute('data-position');
+
+                if (script.getAttribute('data-max-traces'))
+                    var maxTraces = parseInt(script.getAttribute('data-max-traces'));
+
+                if (script.getAttribute('data-trivial') === 'true') var trivial = true;
+                if (script.getAttribute('data-children') == 'true') var children = true;
+                if (script.getAttribute('data-controls') == 'true') var controls = true;
+                if (script.getAttribute('data-authorized') == 'true') var authorized = true;
+
+                return {
+                    ids: ids,
+                    path: path,
+                    version: version,
+                    renderPosition: position,
+                    showTrivial: trivial,
+                    showChildrenTime: children,
+                    maxTracesToShow: maxTraces,
+                    showControls: controls,
+                    currentId: currentId,
+                    authorized: authorized
+                }
+            })();
 
             var doInit = function () {
                 // when rendering a shared, full page, this div will exist
@@ -546,24 +581,50 @@ var MiniProfiler = (function ($) {
                 document.getElementsByTagName('head')[0].appendChild(sc);
             };
 
-            if (options.authorized) {
-                var url = options.path + "includes.css?v=" + options.version;
-                if (document.createStyleSheet) {
-                    document.createStyleSheet(url);
+            var wait = 0;
+            var finish = false;
+            var deferInit = function() {
+                if (finish) return;
+                if (window.performance && window.performance.timing && window.performance.timing.loadEventEnd == 0 && wait < 10000) {
+                    setTimeout(deferInit, 100);
+                    wait += 100;
                 } else {
-                    $('head').append($('<link rel="stylesheet" type="text/css" href="' + url + '" />'));
+                    finish = true;
+                    init();
                 }
+            };
 
-                if (!$.tmpl) {
-                    load(options.path + 'jquery.tmpl.js?v=' + options.version, doInit);
-                } else {
+            var init = function() {
+                if (options.authorized) {
+                    var url = options.path + "includes.css?v=" + options.version;
+                    if (document.createStyleSheet) {
+                        document.createStyleSheet(url);
+                    } else {
+                        $('head').append($('<link rel="stylesheet" type="text/css" href="' + url + '" />'));
+                    }
+                    if (!$.tmpl) {
+                        load(options.path + 'jquery.tmpl.js?v=' + options.version, doInit);
+                    } else {
+                        doInit();
+                    }
+                }
+                else {
                     doInit();
                 }
             }
-            else {
-                doInit();
-            }
 
+            if (typeof(jQuery) == 'function') {
+                var jQueryVersion = jQuery.fn.jquery.split('.');
+            }
+            if (jQueryVersion && parseInt(jQueryVersion[0]) < 2 && parseInt(jQueryVersion[1]) >= 7) {
+                MiniProfiler.jQuery = $ = jQuery;
+                $(deferInit);
+            } else {
+                load(options.path + "jquery.1.7.1.js?v=" + options.version, function() {
+                    MiniProfiler.jQuery = $ = jQuery.noConflict(true);
+                    $(deferInit);
+                });
+            }
         },
 
         getClientTimingByName: function (clientTiming, name) {
@@ -783,7 +844,10 @@ var MiniProfiler = (function ($) {
             return (duration || 0).toFixed(1);
         }
     };
-})(jQueryMP);
+})();
+
+MiniProfiler.init();
+
 
 // prettify.js
 // http://code.google.com/p/google-code-prettify/

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

@@ -27,10 +27,13 @@
             {{if HasSqlTimings}}
               <th colspan="2">query time (ms)</th>
             {{/if}}
+            {{each CustomTimingNames}}
+              <th colspan="2">${$value.toLowerCase()} (ms)</th>
+            {{/each}}
             </tr>
           </thead>
           <tbody>
-            {{tmpl(Root) "#timingTemplate"}}
+            {{tmpl({timing:Root, page:this.data}) "#timingTemplate"}}
           </tbody>
           <tfoot>
             <tr>
@@ -46,6 +49,12 @@
                 <span class="profiler-unit">% in sql</span>
               </td>
             {{/if}}
+            {{each CustomTimingNames}}
+              <td colspan="2" class="profiler-number profiler-percentage-in-sql" title="${CustomTimingStats[$value].Count} ${$value.toLowerCase()} invocations spent ${MiniProfiler.formatDuration(CustomTimingStats[$value].Duration)} ms of total request time">
+                ${MiniProfiler.formatDuration(CustomTimingStats[$value].Duration / DurationMilliseconds * 100)}
+                <span class="profiler-unit">% in ${$value.toLowerCase()}</span>
+              </td>
+            {{/each}}
             </tr>
           </tfoot>
         </table>
@@ -123,37 +132,52 @@
 
 <script id="timingTemplate" type="text/x-jquery-tmpl">
 
-  <tr class="{{if IsTrivial }}profiler-trivial{{/if}}" data-timing-id="${Id}">
-    <td class="profiler-label" title="{{if Name && Name.length > 45 }}${Name}{{/if}}">
-      <span class="profiler-indent">${MiniProfiler.renderIndent(Depth)}</span> ${Name.slice(0,45)}{{if Name && Name.length > 45 }}...{{/if}}
+  <tr class="{{if timing.IsTrivial }}profiler-trivial{{/if}}" data-timing-id="${timing.Id}">
+    <td class="profiler-label" title="{{if timing.Name && timing.Name.length > 45 }}${timing.Name}{{/if}}">
+      <span class="profiler-indent">${MiniProfiler.renderIndent(timing.Depth)}</span> ${timing.Name.slice(0,45)}{{if timing.Name && timing.Name.length > 45 }}...{{/if}}
     </td>
     <td class="profiler-duration" title="duration of this step without any children's durations">
-      ${MiniProfiler.formatDuration(DurationWithoutChildrenMilliseconds)}
+      ${MiniProfiler.formatDuration(timing.DurationWithoutChildrenMilliseconds)}
     </td>
     <td class="profiler-duration profiler-duration-with-children" title="duration of this step and its children">
-      ${MiniProfiler.formatDuration(DurationMilliseconds)}
+      ${MiniProfiler.formatDuration(timing.DurationMilliseconds)}
     </td>
     <td class="profiler-duration time-from-start" title="time elapsed since profiling started">
-      <span class="profiler-unit">+</span>${MiniProfiler.formatDuration(StartMilliseconds)}
+      <span class="profiler-unit">+</span>${MiniProfiler.formatDuration(timing.StartMilliseconds)}
     </td>
 
-  {{if HasSqlTimings}}
-    <td class="profiler-duration {{if HasDuplicateSqlTimings}}profiler-warning{{/if}}" title="{{if HasDuplicateSqlTimings}}duplicate queries detected - {{/if}}{{if ExecutedReaders > 0 || ExecutedScalars > 0 || ExecutedNonQueries > 0}}${ExecutedReaders} reader, ${ExecutedScalars} scalar, ${ExecutedNonQueries} non-query statements executed{{/if}}">
+  {{if timing.HasSqlTimings}}
+    <td class="profiler-duration {{if timing.HasDuplicateSqlTimings}}profiler-warning{{/if}}" title="{{if timing.HasDuplicateSqlTimings}}duplicate queries detected - {{/if}}{{if timing.ExecutedReaders > 0 || timing.ExecutedScalars > 0 || timing.ExecutedNonQueries > 0}}${timing.ExecutedReaders} reader, ${timing.ExecutedScalars} scalar, ${timing.ExecutedNonQueries} non-query statements executed{{/if}}">
       <a class="profiler-queries-show">
-        {{if HasDuplicateSqlTimings}}<span class="profiler-nuclear">!</span>{{/if}}
-        ${SqlTimings.length} <span class="profiler-unit">sql</span>
+        {{if timing.HasDuplicateSqlTimings}}<span class="profiler-nuclear">!</span>{{/if}}
+        ${timing.SqlTimings.length} <span class="profiler-unit">sql</span>
       </a>
     </td>
     <td class="profiler-duration" title="aggregate duration of all queries in this step (excludes children)">
-      ${MiniProfiler.formatDuration(SqlTimingsDurationMilliseconds)}
+      ${MiniProfiler.formatDuration(timing.SqlTimingsDurationMilliseconds)}
     </td>
+  {{else}}
+    <td colspan='2'></td>
   {{/if}}
 
+  {{each page.CustomTimingNames}}
+    {{if timing.CustomTimings[$value]}}
+      <td class="profiler-duration" title="aggregate number of all ${$value.toLowerCase()} invocations in this step (excludes children)">
+        ${timing.CustomTimings[$value].length} ${$value.toLowerCase()}
+      </td>
+      <td class="profiler-duration" title="aggregate duration of all ${$value.toLowerCase()} invocations in this step (excludes children)">
+        ${MiniProfiler.formatDuration(timing.CustomTimingStats[$value].Duration)}
+      </td>
+    {{else}}
+      <td colspan="2"></td>
+    {{/if}}
+  {{/each}}
+
   </tr>
 
-  {{if HasChildren}}
-    {{each Children}}
-      {{tmpl($value) "#timingTemplate"}}
+  {{if timing.HasChildren}}
+    {{each timing.Children}}
+      {{tmpl({timing: $value, page: page}) "#timingTemplate"}}
     {{/each}}
   {{/if}}