panjiva-rack-mini-profiler 0.10.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 476b39e5f201ca78a3971e6b532e80a5ca2ed7a2
+  data.tar.gz: c4e35f88f2ce7f19188b3597d0e9648f6d0f7769
+SHA512:
+  metadata.gz: 364b42648ba1823f776c580f704cbbe4b511d5b39e5e928b456d09ab553864e498399953b186238f4280aa8e358632f1180ab28cd790d9bdf284313910aebb54
+  data.tar.gz: 22d10558c3fb72ec23a9e8d46da92dbc6994241e3970b843ca85743f70631dcae0cb8ee94dda05b242e0d1d9d731a552786d42b096c17ca4f9b745a52fb49ed4

data/CHANGELOG.md

@@ -0,0 +1,228 @@
+# CHANGELOG
+
+## ?
+
+- [FEATURE] Support for vertical positions (top/bottom)
+
+## 0.10.5 2017-05-22
+
+- [FIX] revert PG bind sniffing until it is properly tested
+
+## 0.10.4 2017-05-17
+
+- [FEATURE] log binds for pg @neznauy
+- [FIX] use async exec pg monkey patch instead of exec
+- [FEATURE] nuke less css and use sass instead
+- [FIX] use jQuery on instead of bind
+- [FIX] ensure redis get_unviewed_ids returns only ids that exist
+- [FIX] correctly respect SCRIPT in env if it is sniffed by middleware
+
+## 0.10.2 2017-02-08
+
+- [FIX] improve turbolinks support
+- [FEATURE] make location of mini_profiler injection customizable
+
+## 0.10.1 2016-05-18
+
+- [FEATURE] push forward the security checks so no work is ever done if a valid production
+    cookie is not available (@sam)
+
+## 0.9.9.2 2016-03-06
+
+- [FEATURE] on pageTransition collapse previously expanded timings
+
+## 0.9.9.1 2016-03-06
+
+- [FEATURE] expost MiniProfiler.pageTransition() for use by SPA web apps (@sam)
+
+## 0.9.9 2016-03-06
+
+- [FIX] removes alias_method_chain in favor of alias_method until Ruby 1.9.3 (@ayfredlund)
+- [FIX] Dont block mongo when already patched for another db (@rrooding @kbrock)
+- [FIX] get_profile_script when running under passenger configured with RailsBaseURI (@nspring)
+- [FEATURE] Add support for neo4j (@ProGM)
+- [FIX] ArgumentError: comparison of String with 200 failed (@paweljw)
+- [FEATURE] Add support for Riak (@janx)
+- [PERF] GC profiler much faster (@dgynn)
+- [FIX] If local storage is disabled don't bomb out (@elia)
+- [FIX] Create tmp directory when actually using it (@kbrock)
+- [ADDED] Default collapse_results setting that collapses multiple timings on same page to a single one (@sam)
+- [ADDED] Rack::MiniProfiler.profile_singleton_method (@kbrock)
+- [CHANGE] Added Rack 2.0 support (and dropped support for Rack 1.1) (@dgynn)
+
+## 0.9.8 - 2015-11-27 (Sam Saffron)
+
+- [FEATURE] disable_env_dump config setting (@mathias)
+- [FEATURE] set X-MiniProfiler-Ids for all 2XX reqs (@tymagu2)
+- [FEATURE] add support for NoBrainer (rethinkdb) profiling (@niv)
+- [FEATURE] add oracle enhanced adapter profiling (@rrooding)
+- [FEATURE] pp=profile-memory can now parse query params (@dgynn)
+
+
+## 0.9.7 - 2015-08-03 (Sam Saffron)
+
+- [FEATURE] remove confusing pp=profile-gc-time (Nate Berkopec)
+- [FEATURE] truncate strings in pp=analyze-memory (Nate Berkopec)
+- [FEATURE] rename pp=profile-gc-ruby-head to pp=profile-memory (Nate Berkopec)
+
+## 0.9.6 - 2015-07-08 (Sam Saffron)
+
+- [FIX] incorrect truncation in pp=analyze-memory
+
+## 0.9.5 - 2015-07-08 (Sam Saffron)
+
+- [FEATURE] improve pp=analyze-memory
+
+## 0.9.4 - 2015-07-08 (Sam Saffron)
+- [UX] added a link to "more" actions in profiler
+- [FEATURE] pp=help now displays links
+- [FEATURE] simple memory report with pp=analyze-memory
+
+## 0.9.2 - 2014-06-26 (Sam Saffron)
+- [CHANGE] staging and other environments behave like production (Cedric Felizard)
+- [DOC] CHANGELOG reorg (Olivier Lacan)
+- [FIXED] Double calls to Rack::MiniProfilerRails.initialize! now raise an exception (Julik Tarkhanov)
+- [FIXED] Add no-store header (George Mendoza)
+
+## 0.9.1 - 2014-03-13 (Sam Saffron)
+- [ADDED] Added back Ruby 1.8 support (thanks Malet)
+- [IMPROVED] Amended Railstie so MiniProfiler can be launched with action view or action controller (Thanks Akira)
+- [FIXED] Rails 3.0 support (thanks Zlatko)
+- [FIXED] Possible XSS (admin only)
+- [FIXED] Corrected Sql patching to avoid setting instance vars on nil which is frozen (thanks Andy, huoxito)
+
+## 0.9.0.pre - 2013-12-12 (Sam Saffron)
+- Bumped up version to reflect the stability of the project
+- [IMPROVED] Reports for pp=profile-gc
+- [IMPROVED] pp=flamegraph&flamegraph_sample_rate=1 , allow you to specify sampling rates
+
+## 2013-09-17 (Ross Wilson)
+- [IMPROVED] 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
+
+## 2013-09-03
+- [IMPROVED] Flamegraph now has much increased fidelity
+- [REMOVED] Ripped out flamegraph so it can be isolated into a gem
+- [REMOVED] Ripped out pp=sample it just was never really used
+
+## 0.1.30 - 2013-08-30
+- [ADDED] Rack::MiniProfiler.counter_method(klass,name) for injecting counters
+- [FIXED] Counters were not shifting the table correctly
+
+## 0.1.29 - 2013-08-20
+- [ADDED] Implemented exception tracing using TracePoint see pp=trace-exceptions
+- [FIXED] SOLR patching had an incorrect monkey patch
+
+## 0.1.28 - 2013-07-30
+- [FIXED] Diagnostics in abstract storage was raising not implemented killing
+  ?pp=env and others
+- [FIXED] SOLR xml unescaped by mistake
+
+## 0.1.27 - 2013-06-26
+- [ADDED] Rack::MiniProfiler.config.backtrace_threshold_ms
+- [ADDED] jQuery 2.0 support
+- [FIXED] Disabled global ajax handlers on MP requests @JP
+
+## 0.1.26 - 2013-04-11
+- [IMPROVED] Allow Rack::MiniProfilerRails.initialize!(Rails.application), for post config intialization
+
+## 0.1.25 - 2013-04-08
+- [FIXED] Missed flamegraph.html from build
+
+## 0.1.24 - 2013-04-08
+- [ADDED] Flame Graph Support see: http://samsaffron.com/archive/2013/03/19/flame-graphs-in-ruby-miniprofiler
+- [ADDED] New toggle_shortcut and start_hidden options
+- [ADDED] Mongoid support
+- [ADDED] Rack::MiniProfiler.counter counter_name {}
+- [ADDED] Net:HTTP profiling
+- [ADDED] Ruby 1.8.7 support ... grrr
+- [IMPROVED] More robust gc profiling
+- [IMPROVED] Script tag initialized via data-attributes
+- [IMPROVED] Allow usage of existing jQuery if its already loaded
+- [IMPROVED] Pre-authorize to run in all non development? and production? modes
+- [FIXED] AngularJS support and MooTools
+- [FIXED] File retention leak in file_store
+- [FIXED] HTML5 implicit <body> tags
+- [FIXED] pp=enable
+
+## 0.1.22 - 2012-09-20
+- [FIXED] Permission issue in the gem
+
+## 2012-09-17
+- [IMPROVED] Allow rack-mini-profiler to be sourced from github
+- [IMPROVED] Extracted the pp=profile-gc-time out, the object space profiler needs to disable gc
+
+## 0.1.21 - 2012-09-17
+- [ADDED] New MemchacedStore
+- [ADDED] Rails 4 support
+
+## 2012-09-12 (Sam Saffron)
+- [ADDED] pp=profile-gc: allows you to profile the GC in Ruby 1.9.3
+
+## 0.1.19 - 2012-09-10 (Sam Saffron)
+- [FIXED] Compatibility issue with Ruby 1.8.7
+
+## 0.1.17 - 2012-09-09 (Sam Saffron)
+- [FIXED] pp=sample was bust unless stacktrace was installed
+
+## 0.1.16 - 2012-09-05 (Sam Saffron)
+- [IMPROVED] Implemented stacktrace properly
+- [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)
+
+## 0.1.15.pre - 2012-09-04 (Sam Saffron)
+- [FIXED] Annoying bug where client settings were not sticking
+- [FIXED] Long standing issue with Rack::ConditionalGet stopping MiniProfiler from working properly
+
+## 0.1.13.pre - 2012-09-03 (Sam Saffron)
+- [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
+- [ADDED] pp=normal-backtrace to clear the "sticky" state
+- [IMPROVED] Cleaned up the way client settings are stored
+- [IMPROVED] Made pp=full-backtrace "sticky"
+- [IMPROVED] Changed "pp=sample" to work with "caller" no need for stack trace gem
+- [FIXED] pg gem prepared statements were not being logged correctly
+
+## 0.1.12.pre - 2012-08-20 (Sam Saffron)
+- [IMPROVED] Cap X-MiniProfiler-Ids at 10, otherwise the header can get killed
+
+## 2012-08-10 (Sam Saffron)
+- [ADDED] Basic prepared statement profiling for Postgres
+
+## 2012-08-07 (Sam Saffron)
+- [ADDED] Option to disable profiler for the current session (pp=disable / pp=enable)
+- [ADDED] yajl compatability contributed by Sven Riedel
+
+## 0.1.9 - 2012-07-30 (Sam Saffron)
+- [IMPROVED] Made compliant with ancient versions of Rack (including Rack used by Rails2)
+- [FIXED] Broken share link
+- [FIXED] Crashes on startup (in MemoryStore and FileStore)
+- [FIXED] Unicode issue
+
+## 0.1.7 - 2012-07-18 (Sam Saffron)
+- [ADDED] First Paint time for Google Chrome
+- [FIXED] Ensure non Rails installs have mini profiler
+
+## 2012-07-12 (Sam Saffron)
+- [ADDED] Native PG and MySql2 interceptors, this gives way more accurate times
+- [ADDED] some more client probing built in to rails
+- [IMPROVED] Refactored context so its a proper class and not a hash
+- [IMPROVED] More tests
+- [FIXED] Incorrect profiling steps (was not indenting or measuring start time right
+
+## 0.1.3 - 2012-07-09 (Sam Saffron)
+- [ADDED] New option to display full backtraces pp=full-backtrace
+- [IMPROVED] 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
+- [IMPROVED] Cleaned up railties, got rid of the post authorize callback
+
+## 2012-06-28 (Sam Saffron)
+- [ADDED] Started change log
+- [ADDED] added MemcacheStore
+- [IMPROVED] Corrected profiler so it properly captures POST requests (was supressing non 200s)
+- [IMPROVED] Amended Rack.MiniProfiler.config[:user_provider] to use ip addres for identity
+- [IMPROVED] Supress all '/assets/' in the rails tie (makes debugging easier)
+- [FIXED] Issue where unviewed missing ids never got cleared
+- [FIXED] record_sql was mega buggy

data/README.md

@@ -0,0 +1,422 @@
+# rack-mini-profiler
+
+[![Code Climate](https://codeclimate.com/github/MiniProfiler/rack-mini-profiler/badges/gpa.svg)](https://codeclimate.com/github/MiniProfiler/rack-mini-profiler) [![Build Status](https://travis-ci.org/MiniProfiler/rack-mini-profiler.svg)](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, Oracle (oracle_enhanced ~> 1.5.0) and Mongoid3 (with fallback support to ActiveRecord)
+* Call-stack profiling - Flame graphs showing time spent by gem
+* Memory profiling - Per-request memory usage, GC stats, and global allocation metrics
+
+#### 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)
+
+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.
+
+You can also include optional libraries to enable additional features.
+```ruby
+# For memory profiling (requires Ruby MRI 2.1+)
+gem 'memory_profiler'
+
+# For call-stack profiling flamegraphs (requires Ruby MRI 2.0.0+)
+gem 'flamegraph'
+gem 'stackprof'     # For Ruby MRI 2.1+
+gem 'fast_stack'    # For Ruby MRI 2.0
+```
+
+#### Rails
+
+All you have to do is to 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 is after all other gems, or you want to execute some code before rack_mini_profiler required:
+
+```ruby
+gem 'rack-mini-profiler', require: false
+```
+Note the `require: false` part - if omitted, it will cause the Railtie for the mini-profiler to
+be loaded outright, and an attempt to re-initialize it manually will raise an exception.
+
+Then run the generator which will set up rack-mini-profiler in development:
+
+```bash
+bundle exec rails g rack_profiler:install
+```
+
+#### Rack Builder
+
+```ruby
+require 'rack-mini-profiler'
+
+home = lambda { |env|
+  [200, {'Content-Type' => 'text/html'}, ["<html><body>hello!</body></html>"]]
+}
+
+builder = Rack::Builder.new do
+  use Rack::MiniProfiler
+  map('/') { run home }
+end
+
+run builder
+```
+
+#### Sinatra
+
+```ruby
+require 'rack-mini-profiler'
+class MyApp < Sinatra::Base
+  use Rack::MiniProfiler
+end
+```
+
+#### Hanami
+For working with hanami, you need to use rack integration. Also, you need to add `Hanami::View::Rendering::Partial#render` method for profile:
+
+```ruby
+# config.ru
+require 'rack-mini-profiler'
+Rack::MiniProfiler.profile_method(Hanami::View::Rendering::Partial, :render) { "Render partial #{@options[:partial]}" }
+
+use Rack::MiniProfiler
+```
+
+#### Patching ActiveRecord
+
+A typical web application spends a lot of time querying the database. rack_mini_profiler will detect the ORM that is available
+and apply patches to properly collect query statistics.
+
+To make this work, declare the orm's gem before declaring `rack-mini-profiler` in the `Gemfile`:
+
+```ruby
+gem 'pg'
+gem 'mongoid'
+gem 'rack-mini-profiler'
+
+```
+
+If you wish to override this behavior, the environment variable `RACK_MINI_PROFILER_PATCH` is available.
+
+```bash
+export RACK_MINI_PROFILER_PATCH="pg,mongoid"
+# or
+export RACK_MINI_PROFILER_PATCH="false"
+# initializers/rack_profiler.rb: SqlPatches.patch %w(mongo)
+```
+
+### Flamegraphs
+
+To generate [flamegraphs](http://samsaffron.com/archive/2013/03/19/flame-graphs-in-ruby-miniprofiler):
+
+* add the [**flamegraph**](https://github.com/SamSaffron/flamegraph) gem to your Gemfile
+* visit a page in your app with `?pp=flamegraph`
+
+Flamegraph generation is supported in Ruby MRI 2.0+
+
+### Memory Profiling
+
+Memory allocations can be measured (using the [memory_profiler](https://github.com/SamSaffron/memory_profiler) gem)
+which will show allocations broken down by gem, file location, and class and will also highlight `String` allocations.
+(Requires Ruby MRI 2.1.0+)
+
+Add `?pp=profile-memory` to the URL of any request while Rack::MiniProfiler is enabled to generate the report.
+
+Additional query parameters can be used to filter the results.
+
+* `memory_profiler_allow_files` - filename pattern to include (default is all files)
+* `memory_profiler_ignore_files` - filename pattern to exclude (default is no exclusions)
+* `memory_profiler_top` - number of results per section (defaults to 50)
+
+The allow/ignore patterns will be treated as regular expressions.
+
+Example: `?pp=profile-memory&memory_profiler_allow_files=active_record|app`
+
+There are two additional `pp` options that can be used to analyze memory which do not require the `memory_profiler` gem
+
+* Use `?pp=profile-gc` to report on Garbage Collection statistics (requires Ruby MRI 1.9.3+)
+* Use `?pp=analyze-memory` to report on ObjectSpace statistics (requires Ruby 2.0.0+)
+
+## Access control in non-development environments
+
+rack-mini-profiler is designed with production profiling in mind. To enable that run `Rack::MiniProfiler.authorize_request` once you know a request is allowed to profile.
+
+```ruby
+  # inside your ApplicationController
+
+  before_action do
+    if current_user && current_user.is_admin?
+      Rack::MiniProfiler.authorize_request
+    end
+  end
+```
+
+> If your production application is running on more than one server (or more than one dyno) you will need to configure rack mini profiler's storage to use Redis or Memcache. See [storage](#storage) for information on changing the storage backend.
+
+Note:
+
+Out-of-the-box we will initialize the `autorization_mode` to `:whitelist` in production. However, in some cases we may not be able to do it:
+
+- If you are running in development or test we will not enable whitelist mode
+- If you use `require: false` on rack_mini_profiler we are unlikely to be able to run the railtie
+- If you are running outside of rails we will not run the railtie
+
+In those cases use:
+
+```ruby
+Rack::MiniProfiler.config.authorization_mode = :whitelist
+```
+
+## 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**
+
+### Caching behavior
+
+To fix some nasty bugs with rack-mini-profiler showing the wrong data, the middleware
+will remove headers relating to caching (Date & Etag on responses, If-Modified-Since & If-None-Match on requests).
+This probably won't ever break your application, but it can cause some unexpected behavior. For
+example, in a Rails app, calls to `stale?` will always return true.
+
+To disable this behavior, use the following config setting:
+
+```ruby
+# Do not let rack-mini-profiler disable caching
+Rack::MiniProfiler.config.disable_caching = false # defaults to true
+```
+
+### 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). You will need to add `gem redis`/`gem dalli` respectively to your `Gemfile` to use these stores.
+
+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)
+
+### Profiling specific methods
+
+You can increase the granularity of profiling by measuring the performance of specific methods. Add methods of interest to an initializer.
+
+```ruby
+Rails.application.config.to_prepare do
+  ::Rack::MiniProfiler.profile_singleton_method(User, :non_admins) { |a| "executing all_non_admins" }
+  ::Rack::MiniProfiler.profile_method(User, :favorite_post) { |a| "executing favorite_post" }
+end
+```
+
+### Profiling arbitrary block of code
+
+It is also possible to profile any arbitrary block of code by passing a block to `Rack::MiniProfiler.step(name, opts=nil)`.
+
+```ruby
+Rack::MiniProfiler.step('Adding two elements') do
+  result = 1 + 2
+end
+```
+
+### Using in SPA applications
+
+Single page applications built using Ember, Angular or other frameworks need some special care, as routes often change without a full page load.
+
+On route transition always call:
+
+```
+window.MiniProfiler.pageTransition();
+```
+
+This method will remove profiling information that was related to previous page and clear aggregate statistics.
+
+#### MiniProfiler's speed badge on pages that are not generated via Rails
+You need to inject the following in your SPA to load MiniProfiler's speed badge ([extra details surrounding this script](https://github.com/MiniProfiler/rack-mini-profiler/issues/139#issuecomment-192880706)):
+
+```html
+ <script async type="text/javascript" id="mini-profiler" src="/mini-profiler-resources/includes.js?v=12b4b45a3c42e6e15503d7a03810ff33" data-version="12b4b45a3c42e6e15503d7a03810ff33" data-path="/mini-profiler-resources/" data-current-id="redo66j4g1077kto8uh3" data-ids="redo66j4g1077kto8uh3" data-horizontal-position="left" data-vertical-position="top" data-trivial="false" data-children="false" data-max-traces="10" data-controls="false" data-authorized="true" data-toggle-shortcut="Alt+P" data-start-hidden="false" data-collapse-results="true"></script>
+```
+
+_Note:_ The GUID (`data-version` and the `?v=` parameter on the `src`) will change with each release of `rack_mini_profiler`. The MiniProfiler's speed badge will continue to work, although you will have to change the GUID to expire the script to fetch the most recent version.
+
+### Configuration Options
+
+You can set configuration options using the configuration accessor on `Rack::MiniProfiler`.
+For example:
+
+```ruby
+Rack::MiniProfiler.config.position = 'bottom-right'
+Rack::MiniProfiler.config.start_hidden = true
+```
+The available configuration options are:
+
+Option|Default|Description
+-------|---|--------
+pre_authorize_cb|Rails: dev only<br>Rack: always on|A lambda callback that returns true to make mini_profiler visible on a given request.
+position|`'top-left'`|Display mini_profiler on `'top-right'`, `'top-left'`, `'bottom-right'` or `'bottom-left'`.
+skip_paths|`[]`|Paths that skip profiling.
+skip_schema_queries|Rails dev: `'true'`<br>Othwerwise: `'false'`|`'true'` to log schema queries.
+auto_inject|`true`|`true` to inject the miniprofiler script in the page.
+backtrace_ignores|`[]`|Regexes of lines to be removed from backtraces.
+backtrace_includes|Rails: `[/^\/?(app|config|lib|test)/]`<br>Rack: `[]`|Regexes of lines to keep in backtraces.
+backtrace_remove|rails: `Rails.root`<br>Rack: `nil`|A string or regex to remove part of each line in the backtrace.
+toggle_shortcut|Alt+P|Keyboard shortcut to toggle the mini_profiler's visibility. See [jquery.hotkeys](https://github.com/jeresig/jquery.hotkeys).
+start_hidden|`false`|`false` to make mini_profiler visible on page load.
+backtrace_threshold_ms|`0`|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|`0.5`|How often to capture stack traces for flamegraphs in milliseconds.
+disable_env_dump|`false`|`true` disables `?pp=env`, which prevents sending ENV vars over HTTP.
+base_url_path|`'/mini-profiler-resources/'`|Path for assets; added as a prefix when naming assets and sought when responding to requests.
+collapse_results|`true`|If multiple timing results exist in a single page, collapse them till clicked.
+max_traces_to_show|20|Maximum number of mini profiler timing blocks to show on one page
+html_container|`body`|The HTML container (as a jQuery selector) to inject the mini_profiler UI into
+
+### 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.exist?(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/lib/generators/rack_profiler/USAGE

@@ -0,0 +1,2 @@
+description:
+    Enable rack-mini-profiler in development for your application.

data/lib/generators/rack_profiler/install_generator.rb

@@ -0,0 +1,11 @@
+module RackProfiler
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_initializer_file
+        copy_file "rack_profiler.rb", "config/initializers/rack_profiler.rb"
+      end
+    end
+  end
+end

data/lib/generators/rack_profiler/templates/rack_profiler.rb

@@ -0,0 +1,6 @@
+if Rails.env.development?
+  require "rack-mini-profiler"
+
+  # initialization is skipped so trigger it
+  Rack::MiniProfilerRails.initialize!(Rails.application)
+end