rack-insight 0.5.27 → 0.5.28

data/CHANGELOG

@@ -1,3 +1,33 @@
+== 0.5.28 / 2014-01-14
+
+  * Bug Fixes
+
+    * All specs passing by Peter Boling
+
+  * Other
+
+    * No reliance on rack's request.media_type by Peter Boling
+
+    * Update README.md by Peter Boling
+
+    * Add a Bitdeli badge to README by Bitdeli Chef
+
+    * Quicker access to config by Peter Boling
+
+    * Respond to requests with text/plain mime type by Peter Boling
+
+    * Implement :handle_javascript option (default true) by Peter Boling
+
+    * Remove dependency on git for gemspec by Peter Boling
+
+    * Fix typo in example code by Peter Boling
+
+    * Attributions by Peter Boling
+
+    * Improved Readme by Peter Boling
+
+
+
 == 0.5.27 / 2013-09-03
 
   * Other
@@ -25,7 +55,9 @@
   * Bug Fixes
 
     * Dont reload page, just close panel by Harry Walter
+
     * Allow panels to scroll when fixed to bottom by Harry Walter
+
     * Set position to fixed to keep toolbar at bottom by Harry Walter
 
   * Other

data/README.md

@@ -1,16 +1,35 @@
-Rack::Insight [![Maintainer Status](http://stillmaintained.com/pboling/rack-insight.png)](http://stillmaintained.com/pboling/rack-insight) [![Dependency Status](https://gemnasium.com/pboling/rack-insight.png)](https://gemnasium.com/pboling/rack-insight) [![Code Climate](https://codeclimate.com/github/pboling/rack-insight.png)](https://codeclimate.com/github/pboling/rack-insight) [![Build Status](https://secure.travis-ci.org/pboling/rack-insight.png?branch=master)](https://travis-ci.org/pboling/rack-insight) [![Endorse Me](http://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling)
-=============
+rack-insight will be merging back home into Rack Bug.
 
+@brynary and I have discussed it, and I will do the work to re-namespace Rack Insight.  Rack Insight, née Rack Bug, will be the basis of the next major release of Rack Bug.
 
+I will be the new maintainer of the project.
 
+Rack::Insight
+=============
 
-Description
+Summary
 -----------
 
 Rack::Insight adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
 allowing exploration of logging, database queries, template rendering times, etc.  Rack::Insight
 stores debugging info over many requests, incuding AJAX requests.
 
+
+| Project                 |  Rack Insight   |
+|------------------------ | ----------------- |
+| gem name                |  rack-insight   |
+| license                 |  MIT              |
+| moldiness               |  [![Maintainer Status](http://stillmaintained.com/pboling/rack-insight.png)](http://stillmaintained.com/pboling/rack-insight) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/rack-insight.png)](http://badge.fury.io/rb/rack-insight) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/rack-insight.png)](https://gemnasium.com/pboling/rack-insight) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/rack-insight.png)](https://codeclimate.com/github/pboling/rack-insight) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/rack-insight.png?branch=master)](https://travis-ci.org/pboling/rack-insight) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/rack-insight/badge.png)](https://coveralls.io/r/pboling/rack-insight) |
+| homepage                |  [https://github.com/pboling/rack-insight][homepage] |
+| documentation           |  [http://rdoc.info/github/pboling/rack-insight/frames][documentation] |
+| author                  |  [Peter Boling](https://coderbits.com/pboling) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
+
 Features
 --------
 
@@ -198,7 +217,7 @@ Restrict access using a password:
 
     ActionController::Dispatcher.middleware.use "Rack::Insight::App",
       :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
-      :ip_masks   => false # Default is 127.0.0.1
+      :ip_masks   => false, # Default is 127.0.0.1
       :password   => "yourpassword"
 
 #### custom file path for the request recording database ####
@@ -297,9 +316,6 @@ For example:
 
     spec.add_dependency 'rack-insight', '~> 0.5'
 
-[semver]: http://semver.org/
-[pvc]: http://docs.rubygems.org/read/chapter/16#page74
-
 Thanks
 ------
 
@@ -327,3 +343,12 @@ Legacy files: would like to re-include them, but they need work
 
 This one is mostly just a curiosity
     lib/rack/insight/panels/speedtracer_panel/profiling.rb
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[documentation]: http://rdoc.info/github/pboling/rack-insight/frames
+[homepage]: https://github.com/pboling/rack-insight
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/pboling/rack-insight/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/lib/rack/insight/app.rb

@@ -45,6 +45,11 @@ module Rack::Insight
     end
     attr_accessor :panels
 
+    # allow access to configuration settings directly through the app object!
+    def config
+      Rack::Insight::Config.config
+    end
+
     def call(env)
       @original_request = Rack::Request.new(env)
       if insight_active?

data/lib/rack/insight/config.rb

@@ -16,7 +16,7 @@ module Rack::Insight
     class << self
       attr_reader :config, :verbosity, :log_file, :log_level, :rails_log_copy,
                   :filtered_backtrace, :panel_configs, :silence_magic_insight_warnings,
-                  :database
+                  :database, :handle_javascript
     end
     @log_file = STDOUT
     @log_level = ::Logger::DEBUG
@@ -48,6 +48,7 @@ module Rack::Insight
       :raise_encoding_errors => false,  # Either way will be logged
       :raise_decoding_errors => true,   # Either way will be logged
     }
+    @handle_javascript = true # Set false if you want to handle the javascript yourself.
 
     DEFAULTS = {
       # You can augment or replace the default set of panel load paths.
@@ -69,7 +70,7 @@ module Rack::Insight
       :filtered_backtrace => @filtered_backtrace, # Full back-traces, or filtered ones?
       :panel_configs => @panel_configs, # Allow specific panels to have their own configurations, and make it extensible
       :silence_magic_insight_warnings => @silence_magic_insight_warnings, # Should Rack::Insight warn when the MagicInsight is used?
-      :database => @database # a hash.  Keys :raise_encoding_errors, and :raise_decoding_errors are self explanatory
+      :database => @database, # a hash.  Keys :raise_encoding_errors, and :raise_decoding_errors are self explanatory
                              # :raise_encoding_errors
                              #    When set to true, if there is an encoding error (unlikely)
                              #    it will cause a 500 error on your site.  !!!WARNING!!!
@@ -78,6 +79,8 @@ module Rack::Insight
                              #    but custom panel implementations may prefer one over the other
                              #    The bundled panels will capture these errors and perform admirably.
                              #    Site won't go down unless a custom panel is not handling the errors well.
+      :handle_javascript => @handle_javascript # If Your setup is AMD, and you are handling your javascript module loading,
+                             # including that of jQuery, then you will need to set this to false.
     }
 
     @config ||= DEFAULTS
@@ -98,6 +101,7 @@ module Rack::Insight
       @filtered_backtrace = config[:filtered_backtrace]
       @silence_magic_insight_warnings = config[:silence_magic_insight_warnings]
       @database = config[:database]
+      @handle_javascript = !!config[:handle_javascript] # Cast to boolean
 
       config[:panel_configs].each do |panel_name_sym, config|
         set_panel_config(panel_name_sym, config)

data/lib/rack/insight/enable-button.rb

@@ -2,7 +2,7 @@ module Rack::Insight
   class EnableButton
     include Render
 
-    MIME_TYPES = ["text/html", "application/xhtml+xml"]
+    MIME_TYPES = ["text/plain", "text/html", "application/xhtml+xml"]
 
     def initialize(app, insight)
       @app = app
@@ -21,10 +21,9 @@ module Rack::Insight
     end
 
     def okay_to_modify?(env, response)
+      return false unless response.ok?
       req = Rack::Request.new(env)
-      content_type, charset = response.content_type.split(";")
-
-      response.ok? && MIME_TYPES.include?(content_type) && !req.xhr?
+      return MIME_TYPES.include?(req.media_type) && !req.xhr?
     end
 
     def inject_button(response)

data/lib/rack/insight/panels/request_variables_panel.rb

@@ -5,7 +5,10 @@ module Rack::Insight
       sections = {}
       sections["GET"] = sort(@request.GET) if @request.GET.any?
       sections["POST"] = sort(@request.POST) if @request.POST.any?
-      sections["Session"] = sort(@request.env["rack.session"]) if @request.env["rack.session"] && @request.env["rack.session"].any?
+      # TODO: Fix for Rails 4 (as part of splitting panels into separate gems)
+      unless defined?(ActionDispatch::Request::Session)
+        sections["Session"] = sort(@request.env["rack.session"]) if @request.env["rack.session"] && @request.env["rack.session"].any?
+      end
       sections["Cookies"] = sort(@request.env["rack.request.cookie_hash"]) if @request.env["rack.request.cookie_hash"] && @request.env["rack.request.cookie_hash"].any?
       server, rack = split_and_filter_env(@env)
       sections["SERVER VARIABLES"] = sort(server)

data/lib/rack/insight/public/__insight__/insight.js

@@ -1,136 +1,142 @@
-var _$ = window.$;
-jQuery.noConflict();
-jQuery(function($) {
-    function Insight() {
-      this.current = null
-      this.request_id = null
-      this.panel_id = null
-    }
+(function (factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as anonymous module.
+    define(['jquery'], factory);
+  } else {
+    // Browser globals.
+    factory(jQuery);
+  }
+}(function ($) {
 
-    Insight.prototype = {
-      switchCurrentPanel: function() {
-        console.log(this.panel_id);
-        if(this.request_id && this.panel_id) {
-          this.current = $('#rack-insight #request_' + this.request_id + ' #' + this.panel_id)
-        }
-      },
-      getPanelContent: function() {
-        $.get("/__insight__/panels_content?request_id=" + this.request_id, function(data) {
-            $('#rack-insight').append(data)
-            $.insight.switchCurrentPanel()
-            $.insight.openCurrent()
-          })
-      },
-      toggleCurrent: function() {
-        if(this.current) {
-          if (this.current.is(':visible')) {
-            $(document).trigger('close.insight');
-          } else {
-            this.openCurrent()
-          }
-        }
-      },
-      changeRequest: function(req_number) {
-        $(document).trigger('close.insight')
-        this.request_id = req_number
-        this.switchCurrentPanel()
-        if(this.current.length <= 0) {
-          this.getPanelContent()
+  function Insight() {
+    this.current = null
+    this.request_id = null
+    this.panel_id = null
+  }
+
+  Insight.prototype = {
+    switchCurrentPanel: function() {
+      console.log(this.panel_id);
+      if(this.request_id && this.panel_id) {
+        this.current = $('#rack-insight #request_' + this.request_id + ' #' + this.panel_id)
+      }
+    },
+    getPanelContent: function() {
+      $.get("/__insight__/panels_content?request_id=" + this.request_id, function(data) {
+          $('#rack-insight').append(data)
+          $.insight.switchCurrentPanel()
+          $.insight.openCurrent()
+        })
+    },
+    toggleCurrent: function() {
+      if(this.current) {
+        if (this.current.is(':visible')) {
+          $(document).trigger('close.insight');
         } else {
           this.openCurrent()
         }
-        $.get("/__insight__/panels_header?request_id=" + this.request_id, function(data) {
-            $('ul.panels').html(data)
-          })
-      },
-      openCurrent: function() {
-        $('#rack-insight .panel_content').hide();
-        this.current.show();
-        this.open();
-      },
-      open: function() {
-        $(document).bind('keydown.insight', function(e) {
-            if (e.keyCode == 27) {
-              $.insight.close();
-            }
-          });
-        $('table.sortable').tablesorter();
-      },
-      toggle_content: function(elem) {
-        if (elem.is(':visible')) {
-          elem.hide();
-        } else {
-          elem.show();
-        }
-      },
-      close: function() {
-        $(document).trigger('close.insight');
-        return false;
       }
+    },
+    changeRequest: function(req_number) {
+      $(document).trigger('close.insight')
+      this.request_id = req_number
+      this.switchCurrentPanel()
+      if(this.current.length <= 0) {
+        this.getPanelContent()
+      } else {
+        this.openCurrent()
+      }
+      $.get("/__insight__/panels_header?request_id=" + this.request_id, function(data) {
+          $('ul.panels').html(data)
+        })
+    },
+    openCurrent: function() {
+      $('#rack-insight .panel_content').hide();
+      this.current.show();
+      this.open();
+    },
+    open: function() {
+      $(document).bind('keydown.insight', function(e) {
+          if (e.keyCode == 27) {
+            $.insight.close();
+          }
+        });
+      $('table.sortable').tablesorter();
+    },
+    toggle_content: function(elem) {
+      if (elem.is(':visible')) {
+        elem.hide();
+      } else {
+        elem.show();
+      }
+    },
+    close: function() {
+      $(document).trigger('close.insight');
+      return false;
     }
+  }
 
-    $.insight = new Insight
+  $.insight = new Insight
 
-    $(document).bind('close.insight', function() {
-        $(document).unbind('keydown.insight');
-        $('.panel_content').hide();
-      });
-    $('#rack-insight ul.panels li a').on('click', function() {
-        $.insight.panel_id = this.className
-        $.insight.switchCurrentPanel()
-        $.insight.toggleCurrent()
-        return false;
-      });
-    $('#rack-insight .panel_content .rack-insight_close').on('click', function() {
-        $.insight.panel_id = this.id
-        $.insight.switchCurrentPanel()
-        $.insight.toggleCurrent()
-        return false;
-      });
-    $('#rack-insight_debug_window a.back').on('click',function() {
-        $(this).parent().hide();
-        return false;
-      });
-    $('#rack-insight a.remote_call').on('click',function() {
-        $('#rack-insight_debug_window').load(this.href, null, function() {
-            $('#rack-insight_debug_window').show();
-          })
-        return false;
-      });
-    $('#rack-insight a.reveal_backtrace').on('click',function() {
-        $(this).parents("tr").next().toggle();
-        return false;
-      });
-    $('#rack-insight a.reveal_response').on('click',function() {
-        $(this).parents("tr").next().next().toggle();
-        return false;
-      });
-    $('#rack-insight a.insight_close').on('click',function() {
-        $(document).trigger('close.insight');
-        return false;
-      });
-    $('#request_id_menu').on('change', function(){
-        $.insight.changeRequest($(this).val())
-      });
-    $('#rack-insight_debug_button').on('click',function(){
-        new_position = ($('#rack-insight').attr('class')== 'rack-insight_top') ? 'bottom' : 'top';
-        document.createCookie('rack-insight_position', new_position);
-        $('#rack-insight').removeClass('rack-insight_top rack-insight_bottom').addClass('rack-insight_' + new_position);
-        return false;
-      });
-    $('#rack-insight_disable_button').on('click',function(){
-        document.insightDisable();
-        return false;
-      });
-    $.tablesorter.addParser({
-        id: 'ms',
-        is: function(s) {
-          return /ms$/.test(s);
-        },
-        format: function(s) {
-          return $.tablesorter.formatFloat(s.replace(new RegExp(/[^0-9.]/g),""));
-        },
-        type: "numeric"
-      });
-  });
-$ = _$;
+  $(document).bind('close.insight', function() {
+      $(document).unbind('keydown.insight');
+      $('.panel_content').hide();
+    });
+  $('#rack-insight ul.panels li a').on('click', function() {
+      $.insight.panel_id = this.className
+      $.insight.switchCurrentPanel()
+      $.insight.toggleCurrent()
+      return false;
+    });
+  $('#rack-insight .panel_content .rack-insight_close').on('click', function() {
+      $.insight.panel_id = this.id
+      $.insight.switchCurrentPanel()
+      $.insight.toggleCurrent()
+      return false;
+    });
+  $('#rack-insight_debug_window a.back').on('click',function() {
+      $(this).parent().hide();
+      return false;
+    });
+  $('#rack-insight a.remote_call').on('click',function() {
+      $('#rack-insight_debug_window').load(this.href, null, function() {
+          $('#rack-insight_debug_window').show();
+        })
+      return false;
+    });
+  $('#rack-insight a.reveal_backtrace').on('click',function() {
+      $(this).parents("tr").next().toggle();
+      return false;
+    });
+  $('#rack-insight a.reveal_response').on('click',function() {
+      $(this).parents("tr").next().next().toggle();
+      return false;
+    });
+  $('#rack-insight a.insight_close').on('click',function() {
+      $(document).trigger('close.insight');
+      return false;
+    });
+  $('#request_id_menu').on('change', function(){
+      $.insight.changeRequest($(this).val())
+    });
+  $('#rack-insight_debug_button').on('click',function(){
+      new_position = ($('#rack-insight').attr('class')== 'rack-insight_top') ? 'bottom' : 'top';
+      document.createCookie('rack-insight_position', new_position);
+      $('#rack-insight').removeClass('rack-insight_top rack-insight_bottom').addClass('rack-insight_' + new_position);
+      return false;
+    });
+  $('#rack-insight_disable_button').on('click',function(){
+      document.insightDisable();
+      return false;
+    });
+  $.tablesorter.addParser({
+      id: 'ms',
+      is: function(s) {
+        return /ms$/.test(s);
+      },
+      format: function(s) {
+        return $.tablesorter.formatFloat(s.replace(new RegExp(/[^0-9.]/g),""));
+      },
+      type: "numeric"
+    });
+}));