rack-insight 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 070825bb2f27f4947924252c50492aebadb203d2
-  data.tar.gz: 3fa8d5e8fdf4a4a10fbc1db449deef7e312676ad
+  metadata.gz: c95e18aa743e605ca426e28e06e93ff8839bc54f
+  data.tar.gz: 62d3ab06a7a6bf73f781d5a7270d2aef3e82c5ea
 SHA512:
-  metadata.gz: ebccd9b683fdccc127585cc48e874c4eed6f85b270c8c0b41f91f206d498ca6b19920a26af0287139858cb3f39be01a1d469671f020e921fb13036fc813d09af
-  data.tar.gz: 94e99ba82b5105be008e8fcc40d595428aee16de061c3834f43515e7939a349d6b890872d09ea17780bbd4f503d67273a7192bc4225ae86a12ff4647f9e0bedd
+  metadata.gz: a418404fb18c97006e60feb72895a0edd99186c65bcd3510770d0bbe6c624225c167e417766c89f18137c5cf0b3380bceb04adca6909a2e903a15448166079c6
+  data.tar.gz: c31266e731789360272ccc3808df18d133dc97cfb2a27de397b8117b16eef1192ad1d213d1a1e33218c0ec414405852f08d1fdec67c64678b696a9c81da2d74b

data/CHANGELOG.md

@@ -1,17 +1,42 @@
+## HEAD
+
+## 0.6.3 / 2015-04-23
+
+  * Bug Fixes
+  
+    * Remove log output when redis isn't loaded by @garethrees
+
+  * Other
+
+    * Fix typo in Readme by @garethrees
+    * Extracted rack-toolbar to a separate gem by @pboling
+    * Implement EnableButton and Toolbar with Rack::Toolbar by @pboling
+      * Extract PathMatchFilters to mixin by @pboling
+      * Add specs for EnableButton and Toolbar by @pboling
+      * Remove specs that are pushed to Rack::Toolbar by @pboling
+
+## 0.6.2 / 2015-03-08
+
+  * Fixed Gemspec
+
+## 0.6.1 / 2015-03-08
+
+  * Broke Gemspec (OOPS!)
+
 ## 0.6 / 2015-03-08
 
   * Bug Fixes
 
-    * Complete rewrite of `EnableButton` to ensure compatibility with all other Rack apps by Peter Boling
-    * Removed duplicate config entry for `:verbosity` by Peter Boling
+    * Complete rewrite of `EnableButton` to ensure compatibility with all other Rack apps by @pboling
+    * Removed duplicate config entry for `:verbosity` by @pboling
 
   * Other
 
-    * Added Sinatra example to Readme by Peter Boling
-    * spec improvements by Peter Boling
-    * upgrade to latest version of Ruby for development by Peter Boling
-    * Fixed Markdown syntax on CHANGELOG => CHANGELOG.md by Peter Boling
-    * added bin scripts, but do not include in gem package by Peter Boling
+    * Added Sinatra example to Readme by @pboling
+    * spec improvements by @pboling
+    * upgrade to latest version of Ruby for development by @pboling
+    * Fixed Markdown syntax on CHANGELOG => CHANGELOG.md by @pboling
+    * added bin scripts, but do not include in gem package by @pboling
 
 ## 0.5.30 / 2015-01-07
 
@@ -34,41 +59,41 @@
 
     * Fixed travis build by @michaelmior
 
-    * Fixed serving of the toolbar by Peter Boling
+    * Fixed serving of the toolbar by @pboling
 
-    * All specs passing by Peter Boling
+    * All specs passing by @pboling
 
   * Other
 
-    * Improved Readme by Peter Boling
+    * Improved Readme by @pboling
 
 ## 0.5.28 / 2014-01-14
 
   * Bug Fixes
 
-    * All specs passing by Peter Boling
+    * All specs passing by @pboling
 
   * Other
 
-    * No reliance on rack's request.media_type by Peter Boling
+    * No reliance on rack's request.media_type by @pboling
 
-    * Update README.md by Peter Boling
+    * Update README.md by @pboling
 
     * Add a Bitdeli badge to README by Bitdeli Chef
 
-    * Quicker access to config by Peter Boling
+    * Quicker access to config by @pboling
 
-    * Respond to requests with text/plain mime type by Peter Boling
+    * Respond to requests with text/plain mime type by @pboling
 
-    * Implement :handle_javascript option (default true) by Peter Boling
+    * Implement :handle_javascript option (default true) by @pboling
 
-    * Remove dependency on git for gemspec by Peter Boling
+    * Remove dependency on git for gemspec by @pboling
 
-    * Fix typo in example code by Peter Boling
+    * Fix typo in example code by @pboling
 
-    * Attributions by Peter Boling
+    * Attributions by @pboling
 
-    * Improved Readme by Peter Boling
+    * Improved Readme by @pboling
 
 
 
@@ -76,23 +101,23 @@
 
   * Other
 
-    * Improved configuration of logging and verbosity by Peter Boling
+    * Improved configuration of logging and verbosity by @pboling
 
       * Moved VERBOSITY from Logging module into Config class
 
-    * gemspec email should reflect who the current contacts are for the gem by Peter Boling
+    * gemspec email should reflect who the current contacts are for the gem by @pboling
 
-    * Removed unused development dependencies by Peter Boling
+    * Removed unused development dependencies by @pboling
 
-    * All specs passing! by Peter Boling
+    * All specs passing! by @pboling
 
-    * Fixing deprecations by Peter Boling
+    * Fixing deprecations by @pboling
 
-    * Require the standard Ruby Logger by Peter Boling
+    * Require the standard Ruby Logger by @pboling
 
-    * Convert to .ruby-version by Peter Boling
+    * Convert to .ruby-version by @pboling
 
-    * Add license and platform to gemspec by Peter Boling
+    * Add license and platform to gemspec by @pboling
 
 ## 0.5.26 / 2013-08-06
 
@@ -264,7 +289,7 @@
 
   * Other
 
-    * Improving documentation by Peter Boling
+    * Improving documentation by @pboling
 
   * New Features
 

data/README.md

@@ -80,8 +80,8 @@ to go somewhere more noticeable.  E.g. "position: absolute; top: 0; left: 0"
 Using with non-Rails Rack apps
 ------------------------------
 
-Just 'use Rack::Insight' as any other middleware.  See the SampleApp in the
-spec/fixtures folder for an example Sinatra app.
+Just `use Rack::Insight::App` as any other middleware.  See the `SampleApp` in the
+`spec/fixtures` folder for an example Sinatra app.
 
 This is a minimal setup:
 
@@ -262,10 +262,10 @@ You can now create a fully functional new panel with a simple class definition:
 
 Setup the probes for the magic panel in a `before_initialize` block in your application.rb as follows:
 
-    # Assuming there is a FooBra class with instance methods: foo, bar, cheese, and ducks
+    # Assuming there is a FooBar class with instance methods: foo, bar, cheese, and ducks
     Rack::Insight::Config.configure do |config|
       # Not :foo_bar_panel or 'FooBarPanel'... :foo_bar
-      config[:panel_configs][:foo_bar] = {:probes => {'FooBra' => [:instance, :foo, :bar, :cheese, :ducks]}}
+      config[:panel_configs][:foo_bar] = {:probes => {'FooBar' => [:instance, :foo, :bar, :cheese, :ducks]}}
     end
 
 Custom Panels

data/lib/rack-insight.rb

@@ -1 +1 @@
-require 'rack/insight'
+require "rack/insight"

data/lib/rack/insight/app.rb

@@ -1,24 +1,26 @@
-require 'rack'
+require "rack"
+require "rack/toolbar"
 require "digest/sha1"
 require "rack/insight/logging"
 require "rack/insight/config"
 require "rack/insight/filtered_backtrace"
 require "rack/insight/options"
-require 'rack/insight/magic_insight'
-require 'rack/insight/default_invocation'
+require "rack/insight/magic_insight"
+require "rack/insight/default_invocation"
 require "rack/insight/panel"
 require "rack/insight/panel_app"
 require "rack/insight/params_signature"
 require "rack/insight/rack_static_bug_avoider"
 require "rack/insight/redirect_interceptor"
 require "rack/insight/render"
+require "rack/insight/path_match_filters"
 require "rack/insight/toolbar"
 require "rack/insight/enable-button"
 require "rack/insight/path-filter"
-require 'rack/insight/request-recorder'
-require 'rack/insight/instrumentation/setup'
-require 'rack/insight/panels-content'
-require 'rack/insight/panels-header'
+require "rack/insight/request-recorder"
+require "rack/insight/instrumentation/setup"
+require "rack/insight/panels-content"
+require "rack/insight/panels-header"
 
 module Rack::Insight
   class App
@@ -86,7 +88,7 @@ module Rack::Insight
 
     def build_normal_stack
       builder = Rack::Builder.new
-      builder.use EnableButton, self
+      builder.use EnableButton
       builder.run Rack::Cascade.new([ asset_mapped(Rack::Builder.new), @base_app ])
       @normal_stack = builder.to_app
     end

data/lib/rack/insight/config.rb

@@ -2,7 +2,7 @@ require 'logger' # Require the standard Ruby Logger
 begin
   require 'redis'
 rescue LoadError
-  warn "Could not load redis ruby gem. Some features are disabled."
+  nil
 end
 
 module Rack::Insight

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

@@ -1,39 +1,11 @@
 module Rack::Insight
-  class EnableButton < Struct.new :app, :insight
+  class EnableButton < Rack::Toolbar
     include Render
+    include PathMatchFilters
 
-    CONTENT_TYPE_REGEX = /text\/(html|plain)|application\/xhtml\+xml/
-
-    def call(env)
-      status, headers, response = app.call(env)
-
-      if okay_to_modify?(env, headers)
-        body = response.inject("") do |memo, part|
-          memo << part
-          memo
-        end
-        index = body.rindex("</body>")
-        if index
-          body.insert(index, render)
-          headers["Content-Length"] = body.bytesize.to_s
-          response = [body]
-        end
-      end
-
-      [status, headers, response]
-    end
-
-    def okay_to_modify?(env, headers)
-      return false unless headers["Content-Type"] =~ CONTENT_TYPE_REGEX
-      return !match_path_filters?(env["rack-insight.path_filters"], env["REQUEST_PATH"])
-    end
-
-    def match_path_filters?(path_filters, path)
-      to_regex(path_filters).find { |filter| path =~ filter }
-    end
-
-    def to_regex(filters)
-      (filters || []).map { |str| %r(^#{str}) }
+    def okay_to_modify?
+      super
+      return !match_path_filters?(@env["rack-insight.path_filters"], @env["REQUEST_PATH"])
     end
 
     def render

data/lib/rack/insight/path_match_filters.rb

@@ -0,0 +1,13 @@
+module Rack::Insight
+  module PathMatchFilters
+
+    def match_path_filters?(path_filters, path)
+      to_regex(path_filters).find { |filter| path =~ filter }
+    end
+
+    def to_regex(filters)
+      (filters || []).map { |str| %r(^#{str}) }
+    end
+
+  end
+end

data/lib/rack/insight/toolbar.rb

@@ -1,60 +1,52 @@
 module Rack::Insight
-  class Toolbar
+  class Toolbar < Rack::Toolbar
     include Render
     include Logging
+    include PathMatchFilters
 
-    MIME_TYPES = ["text/plain", "text/html", "application/xhtml+xml"]
-
-    def initialize(app, insight)
-      @app = app
+    def initialize(app, insight, options = {})
+      super app, options
       @insight = insight
       @request_table = Database::RequestTable.new
     end
 
-    def call(env)
-      @env = env
-      status, headers, body = @app.call(@env)
-
-      response = Rack::Response.new(body, status, headers)
-
-      if okay_to_modify?(env, response)
-        inject_toolbar(response)
-      end
-
-      return response.to_a
+    def okay_to_modify?
+      super
+      return !match_path_filters?(@env["rack-insight.path_filters"], @env["REQUEST_PATH"])
     end
 
-    def okay_to_modify?(env, response)
-      return false unless response.ok?
-      return false unless response.content_type.respond_to?(:split)
-      content_type, charset = response.content_type.split(";")
-      return false unless MIME_TYPES.include?(content_type)
-      req = Rack::Request.new(env)
-      !req.xhr?
+    # Ensure that browser doesn't cache
+    def ensure_no_cache
+      @headers["Etag"] = ""
+      @headers["Cache-Control"] = "no-cache"
     end
 
-    def inject_toolbar(response)
-      full_body = response.body.join
-
-      toolbar = render
-      toolbar.force_encoding('UTF-8') if RUBY_VERSION > '1.9.0'
-
-      full_body.sub! /<\/body>/, toolbar + "</body>"
+    def req_id
+      @req_id ||= (@env['rack-insight.request-id'] || @request_table.last_request_id).to_i
+    end
 
-      response["Content-Length"] = full_body.size.to_s
+    def requests
+      @requests ||= @request_table.to_a.map do |row|
+        { :id => row[0], :method => row[1], :path => row[2] }
+      end
+    end
 
-      # Ensure that browser doesn't cache
-      response["Etag"] = ""
-      response["Cache-Control"] = "no-cache"
+    def headers_fragment
+      render_template("headers_fragment",
+                      :request_id => req_id,
+                      :panels => @insight.panels,
+                      :handle_javascript => @insight.config[:handle_javascript])
+    end
 
-      response.body = [full_body]
+    def current_request_fragment
+      render_template("request_fragment",
+                      :request_id => req_id,
+                      :panels => @insight.panels,
+                      :requests => requests)
     end
 
     def render
-      req_id = (@env['rack-insight.request-id'] || @request_table.last_request_id).to_i
-      requests = @request_table.to_a.map do |row|
-        { :id => row[0], :method => row[1], :path => row[2] }
-      end
+      ensure_no_cache
 
       unless verbose(:silent)
         logger.info do
@@ -62,20 +54,13 @@ module Rack::Insight
         end
       end
 
-      headers_fragment = render_template("headers_fragment",
-                                         :panels => @insight.panels,
-                                         :request_id => req_id,
-                                         :handle_javascript => @insight.config[:handle_javascript])
-
-      current_request_fragment = render_template("request_fragment",
-                                                 :request_id => req_id,
-                                                 :requests => requests,
-                                                 :panels => @insight.panels)
-      render_template("toolbar",
-                      :request_fragment => current_request_fragment,
-                      :headers_fragment => headers_fragment,
-                      :request_id => req_id,
-                      :handle_javascript => Rack::Insight::Config.config[:handle_javascript])
+      html = render_template("toolbar",
+                             :request_id => req_id,
+                             :request_fragment => current_request_fragment,
+                             :headers_fragment => headers_fragment,
+                             :handle_javascript => Rack::Insight::Config.config[:handle_javascript])
+      html.force_encoding('UTF-8') if RUBY_VERSION > '1.9.0'
+      html
     end
   end
 end

data/lib/rack/insight/version.rb

@@ -1,7 +1,7 @@
 module Rack
   module Insight
 
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-insight
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Peter Boling
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-08 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -27,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-toolbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +69,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +181,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.6.3.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: |-
   Debugging toolbar for Rack applications implemented as middleware.
       Based on logical-insight and rack-bug.
@@ -223,6 +265,7 @@ files:
 - lib/rack/insight/panels/timer_panel.rb
 - lib/rack/insight/params_signature.rb
 - lib/rack/insight/path-filter.rb
+- lib/rack/insight/path_match_filters.rb
 - lib/rack/insight/public/__insight__/bookmarklet.html
 - lib/rack/insight/public/__insight__/bookmarklet.js
 - lib/rack/insight/public/__insight__/insight.css