RubyGems - peek - Versions diffs - 0.0.5 → 0.1.0 - Mend

peek 0.0.5 → 0.1.0

Files changed (56) hide show

data/.gitignore +1 -0
data/CHANGELOG.md +12 -0
data/Gemfile +21 -0
data/README.md +75 -54
data/app/assets/javascripts/peek.coffee +29 -10
data/app/controllers/peek/results_controller.rb +22 -0
data/app/views/peek/_bar.html.erb +1 -1
data/app/views/peek/_results.html.erb +0 -16
data/config/routes.rb +3 -0
data/lib/peek/adapters/base.rb +17 -0
data/lib/peek/adapters/memcached.rb +21 -0
data/lib/peek/adapters/memory.rb +25 -0
data/lib/peek/adapters/redis.rb +21 -0
data/lib/peek/controller_helpers.rb +6 -1
data/lib/peek/railtie.rb +20 -4
data/lib/peek/version.rb +1 -1
data/lib/peek/views/view.rb +15 -5
data/lib/peek.rb +74 -3
data/peek.gemspec +3 -1
data/test/controllers/requests_test.rb +14 -0
data/test/dummy/README.rdoc +28 -0
data/test/dummy/Rakefile +6 -0
data/test/dummy/app/assets/javascripts/application.js +14 -0
data/test/dummy/app/assets/stylesheets/application.css +14 -0
data/test/dummy/app/controllers/application_controller.rb +9 -0
data/test/dummy/app/controllers/home_controller.rb +4 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/home/show.html.erb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/bin/bundle +3 -0
data/test/dummy/bin/rails +4 -0
data/test/dummy/bin/rake +4 -0
data/test/dummy/config/application.rb +25 -0
data/test/dummy/config/boot.rb +5 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +23 -0
data/test/dummy/config/environments/test.rb +36 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/test/dummy/config/initializers/inflections.rb +16 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +12 -0
data/test/dummy/config/initializers/session_store.rb +3 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +23 -0
data/test/dummy/config/routes.rb +3 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/log/.keep +0 -0
data/test/dummy/public/404.html +58 -0
data/test/dummy/public/422.html +58 -0
data/test/dummy/public/500.html +57 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/{glimpse → peek}/views/view_test.rb +5 -5
data/test/{glimpse_test.rb → peek_test.rb} +0 -0
data/test/test_helper.rb +13 -2
metadata +112 -8

data/.gitignore CHANGED Viewed

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+test/dummy/log
 test/tmp
 test/version_tmp
 tmp

data/CHANGELOG.md CHANGED Viewed

@@ -18,3 +18,15 @@
 # 0.0.5
 - Namespace the tooltips to the `.glimpse-tooltip` class name to not conflict with any application styles for `.tooltip`. (#18)
+# 0.0.6
+- Added Peek::Views::View#parse_options that gets called within initialize for subclasses to use to parse their options.
+# 0.1.0
+- Introduced a new JS event `peek:render` that includes the request id and request payload data that is used to update the information in the bar.
+- Request information has moved from the `peek/results` partial to an AJAX request that happens on page load, and when PJAX/Turbolinks change pages.
+- Removed the need for `peek/results` partial.
+- Introduced a Redis and Memcache adapter for multi-server environments to store request payloads.
+- Tooltips automatically repositions depending on where the Peek bar is.

data/Gemfile CHANGED Viewed

@@ -4,3 +4,24 @@ source 'https://rubygems.org'
 gemspec
 gem 'rake'
+gem 'json', '~> 1.7.7'
+gem 'rails', '~> 4.0.0.rc1'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0.rc1'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'

data/README.md CHANGED Viewed

@@ -25,8 +25,18 @@ Or install it yourself as:
 ## Usage
+Now that Peek is installed, you'll need to mount the engine within your `config/routes.rb`
+file:
+```ruby
+Some::Application.routes.draw do
+  mount Peek::Engine => '/peek'
+  root :to => 'home#show'
+end
+```
 To pick which views you want to see in your Peek bar, just create a file at
-`config/initializers/peek.rb` that has a list of the views you'd like to see:
+`config/initializers/peek.rb` that has a list of the views you'd like to include:
 ```ruby
 Peek.into Peek::Views::Git, :nwo => 'github/janky'
@@ -59,27 +69,9 @@ It will look like:
 </html>
 ```
-Some Peek views require the view to render before data is collected and can
-be presented, ie: the number of MySQL queries ran on the page and how
-long it took.
-For this to work, you need to include the `peek/results` partial at the end of your
-application layout.
-It will look like:
-```erb
-<html>
-  <head>
-    <title>Application</title>
-  </head>
-  <body>
-    <%= render 'peek/bar' %>
-    <%= yield %>
-    <%= render 'peek/results' %>
-  </body>
-</html>
-```
+Peek fetches the data collected throughout your requests by using the unique request id
+that was assigned to the request by Rails. It will call out to its own controller at
+[Peek::ResultsController](https://github.com/peek/peek/blob/master/app/assets/controllers/peek/results_controller.rb) which will render the data and be inserted into the bar.
 Now that you have the partials in your application, you will need to include the
 CSS and JS that help make Peek :sparkles:
@@ -101,43 +93,79 @@ In `app/assets/javascripts/application.coffee`:
 Note: Each additional view my have their own CSS and JS you need to require
 which should be stated in their usage documentation.
-## Using Peek with PJAX
+### Configuring the default adapter
-When using [PJAX](https://github.com/defunkt/jquery-pjax) in your application, by default requests won't render the
-application layout which ends up not including the required results partial.
-It's fairly simple to get this working with PJAX if you're using the
-[pjax_rails](https://github.com/rails/pjax_rails) gem.
+For Peek to work, it keeps track of all requests made in your application
+so it can report back and display that information in the Peek bar. By default
+it stores this information in memory, which is not recommended for production environments.
-Create a new layout at `app/views/layouts/peek.html.erb`:
+In production environments you may have application servers on multiple hosts,
+at which Peek will not be able to access the request data if it was saved in memory on
+another host. Peek provides 2 additional adapters for multi server environments.
-```erb
-<%= yield %>
-<%= render 'peek/results' %>
-```
+You can configure which adapter Peek uses by updating your application
+config or an individual environment config file. We'll use production as an example.
+Note: Peek does not provide the dependencies for each of these adapters. If you use these
+adapters be sure to include their dependencies in your application.
-Now you'll just need use the PJAX layout:
+- Redis - The [redis](https://github.com/redis/redis-rb) gem
+- Dalli - The [dalli](https://github.com/mperham/dalli) gem
 ```ruby
-class ApplicationController < ActionController::Base
-  def pjax_layout
-    'peek'
-  end
+Peeked::Application.configure do
+  # ...
+  # Redis with no options
+  config.peek.adapter = :redis
+  # Redis with options
+  config.peek.adapter = :redis, {
+    :client => Redis.new,
+    :expires_in => 60 * 30 # => 30 minutes in seconds
+  }
+  # Memcache with no options
+  config.peek.adapter = :memcache
+  # Memcache with options
+  config.peek.adapter = :memcache, {
+    :client => Dalli::Client.new,
+    :expires_in => 60 * 30 # => 30 minutes in seconds
+  }
+  # ...
 end
 ```
-You're done! Now every time a PJAX request is made, the Peek bar will update
-with the Peek results of the PJAX request.
+Peek doesn't persist the request data forever. It uses a safe 30 minute
+cache length that way data will be available if you'd like to aggregate it or
+use it for other Peek views. You can update this to be 30 seconds if you don't
+want the data to be available to stick around.
+## Using Peek with PJAX
+It just works.
 ## Using Peek with Turbolinks
 It just works.
+### Using Peek with Spork
+For best results with Spork, add this to your `prefork` block
+anytime before your environment is loaded:
+```ruby
+require 'peek'
+Spork.trap_class_method(Peek, :setup)
+```
 ## Access Control
-You probably don't want to give this data to ALL your users. So by default Peek
-only shows up in development or staging environments. If you'd like to restrict Peek
-to a select few users, you can do so by overriding the `peek_enabled?` guard in
-ApplicationController.
+Peek will only render in development and staging environments. If you'd
+like to whitelist a select number of users to view Peek in production you
+can override the `peek_enabled?` guard in `ApplicationController`:
 ```ruby
 class ApplicationController < ActionController::Base
@@ -147,7 +175,7 @@ class ApplicationController < ActionController::Base
 end
 ```
-## Available Peek items
+## Available Peek views
 - [peek-dalli](https://github.com/peek/peek-dalli)
 - [peek-git](https://github.com/peek/peek-git)
@@ -155,9 +183,11 @@ end
 - [peek-mysql2](https://github.com/peek/peek-mysql2)
 - [peek-performance_bar](https://github.com/peek/peek-performance_bar)
 - [peek-pg](https://github.com/peek/peek-pg)
+- [peek-rblineprof](https://github.com/peek/peek-rblineprof)
 - [peek-redis](https://github.com/peek/peek-redis)
 - [peek-resque](https://github.com/peek/peek-resque)
-- [glimpse-sidekiq](https://github.com/suranyami/glimpse-sidekiq)
+- [peek-sidekiq](https://github.com/suranyami/peek-sidekiq)
+- [peek-faraday](https://github.com/grk/peek-faraday)
 - [glimpse-svn](https://github.com/neilco/glimpse-svn)
 - Unicorn :soon:
@@ -175,15 +205,6 @@ There are still some docs to be written, but if you'd like to checkout a simple
 example of how to create your own, just checkout [peek-git](https://github.com/peek/peek-git).
 To just look at an example view, there is [Peek::Views::Git](https://github.com/peek/peek-git/blob/master/lib/peek/views/git.rb).
-### Using Peek with Spork
-For best results with Spork, add this to your `prefork` block
-anytime before your environment is loaded:
-```ruby
-Spork.trap_class_method(Peek, :setup)
-```
 ## Contributing
 1. Fork it

data/app/assets/javascripts/peek.coffee CHANGED Viewed

@@ -1,18 +1,27 @@
 #= require peek/vendor/jquery.tipsy
-updatePerformanceBar = ->
+requestId = null
+getRequestId = ->
+  if requestId? then requestId else $('#peek').data('request-id')
+updatePerformanceBar = (results) ->
   peekResults = $('#peek-results')
-  $('#peek [data-defer-to]').each ->
-    deferKey = $(this).data 'defer-to'
-    data = peekResults.data deferKey
-    $(this).text data
+  for key of results.data
+    for label of results.data[key]
+      $("[data-defer-to=#{key}-#{label}]").text results.data[key][label]
+  $(document).trigger 'peek:render', getRequestId(), results
 initializeTipsy = ->
   $('#peek .peek-tooltip, #peek .tooltip').each ->
     el = $(this)
-    gravity = if el.hasClass('rightwards') then 'w' else 'n'
-    gravity = if el.hasClass('leftwards') then 'e' else gravity
-    el.tipsy { gravity }
+    gravity = if el.hasClass('rightwards') || el.hasClass('leftwards')
+      $.fn.tipsy.autoWE
+    else
+      $.fn.tipsy.autoNS
+    el.tipsy
+      gravity: gravity
 toggleBar = (event) ->
   return if $(event.target).is ':input'
@@ -26,13 +35,23 @@ toggleBar = (event) ->
       wrapper.addClass 'disabled'
       document.cookie = "peek=false; path=/";
+fetchRequestResults = ->
+  $.ajax '/peek/results',
+    data:
+      request_id: getRequestId()
+    success: (data, textStatus, xhr) ->
+      updatePerformanceBar data
+    error: (xhr, textStatus, error) ->
+      # Swallow the error
 $(document).on 'keypress', toggleBar
-$(document).on 'peek:update', updatePerformanceBar
 $(document).on 'peek:update', initializeTipsy
+$(document).on 'peek:update', fetchRequestResults
 # Fire the event for our own listeners.
-$(document).on 'pjax:end', ->
+$(document).on 'pjax:end', (event, xhr, options) ->
+  requestId = xhr.getResponseHeader('X-Request-Id')
   $(this).trigger 'peek:update'
 # Also listen to turbolinks page change event

data/app/controllers/peek/results_controller.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Peek
+  class ResultsController < ApplicationController
+    before_filter :restrict_non_access
+    respond_to :json
+    def show
+      if request.xhr?
+        render :json => Peek.adapter.get(params[:request_id])
+      else
+        render :nothing => true, :status => :not_found
+      end
+    end
+    private
+    def restrict_non_access
+      unless peek_enabled?
+        raise ActionController::RoutingError.new('Not Found')
+      end
+    end
+  end
+end

data/app/views/peek/_bar.html.erb CHANGED Viewed

@@ -1,5 +1,5 @@
 <% if peek_enabled? %>
-<div id="peek" class="<%= Peek.env %><%= ' disabled' if cookies[:peek] == 'false' %>">
+<div id="peek" class="<%= Peek.env %><%= ' disabled' if cookies[:peek] == 'false' %>" data-request-id="<%= Peek.request_id %>">
   <div class="wrapper">
     <% Peek.views.each do |view| %>
       <div id="<%= view.dom_id %>" class="view">

data/app/views/peek/_results.html.erb CHANGED Viewed

@@ -1,16 +0,0 @@
-<% if peek_enabled? %>
-<span id="peek-results" class="hidden"
-  <% Peek.views.each do |view| %>
-    <% view.results.each do |key, value| %>
-    data-<%= view.defer_key %>-<%= key %>="<%= value %>"
-    <% end %>
-  <% end %>
->
-</span>
-<% Peek.views.each do |view| %>
-  <% if view.context? %>
-    <span id="<%= view.context_dom_id %>" data-context='<%= raw(view.context.to_json) %>'></span>
-  <% end %>
-<% end %>
-<% end %>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Peek::Railtie.routes.draw do
+  get '/results' => 'results#show', :as => :results
+end

data/lib/peek/adapters/base.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Peek
+  module Adapters
+    class Base
+      def initialize(options = {})
+      end
+      def get(request_id)
+        raise "#{self.class}#get(request_id) is not yet implemented"
+      end
+      def save
+        raise "#{self.class}#save is not yet implemented"
+      end
+    end
+  end
+end

data/lib/peek/adapters/memcached.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'peek/adapters/base'
+require 'dalli'
+module Peek
+  module Adapters
+    class Memcache < Base
+      def initialize(options = {})
+        @client = options.fetch(:client, Dalli::Client.new)
+        @expires_in = options.fetch(:expires_in, 60 * 30)
+      end
+      def get(request_id)
+        @client.get("peek:requests:#{request_id}")
+      end
+      def save
+        @client.add("peek:requests:#{Peek.request_id}", Peek.results.to_json, @expires_in)
+      end
+    end
+  end
+end

data/lib/peek/adapters/memory.rb ADDED Viewed

@@ -0,0 +1,25 @@
+require 'peek/adapters/base'
+module Peek
+  module Adapters
+    class Memory < Base
+      attr_accessor :requests
+      def initialize(options = {})
+        @requests = {}
+      end
+      def get(request_id)
+        @requests[request_id]
+      end
+      def save
+        @requests[Peek.request_id] = Peek.results
+      end
+      def reset
+        @requests.clear
+      end
+    end
+  end
+end

data/lib/peek/adapters/redis.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'peek/adapters/base'
+require 'redis'
+module Peek
+  module Adapters
+    class Redis < Base
+      def initialize(options = {})
+        @client = options.fetch(:client, ::Redis.new)
+        @expires_in = Integer(options.fetch(:expires_in, 60 * 30))
+      end
+      def get(request_id)
+        @client.get("peek:requests:#{request_id}")
+      end
+      def save
+        @client.setex("peek:requests:#{Peek.request_id}", @expires_in, Peek.results.to_json)
+      end
+    end
+  end
+end

data/lib/peek/controller_helpers.rb CHANGED Viewed

@@ -3,13 +3,18 @@ module Peek
     extend ActiveSupport::Concern
     included do
+      prepend_before_filter :set_peek_request_id, :if => :peek_enabled?
       helper_method :peek_enabled?
     end
     protected
+    def set_peek_request_id
+      Peek.request_id = request.uuid
+    end
     def peek_enabled?
-      Peek.enabled?
+      Peek.enabled?
     end
   end
 end

data/lib/peek/railtie.rb CHANGED Viewed

@@ -2,17 +2,33 @@ require 'peek/controller_helpers'
 module Peek
   class Railtie < ::Rails::Engine
-    config.peek = Peek
+    isolate_namespace Peek
+    engine_name :peek
-    initializer 'peek.setup_subscribers' do
-      ActiveSupport.on_load(:after_initialize) do
-        Peek.views
+    config.peek = ActiveSupport::OrderedOptions.new
+    # Default adapter
+    config.peek.adapter = :memory
+    initializer 'peek.set_configs' do |app|
+      ActiveSupport.on_load(:peek) do
+        app.config.peek.each do |k,v|
+          send "#{k}=", v
+        end
+      end
+    end
+    initializer 'peek.persist_request_data' do
+      ActiveSupport::Notifications.subscribe('process_action.action_controller') do
+        Peek.adapter.save
+        Peek.clear
       end
     end
     initializer 'peek.include_controller_helpers' do
       config.to_prepare do
         Peek.setup
+        Peek.views
       end
     end
   end

data/lib/peek/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Peek
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lib/peek/views/view.rb CHANGED Viewed

@@ -4,9 +4,18 @@ module Peek
       def initialize(options = {})
         @options = options
+        parse_options
         setup_subscribers
       end
+      # Where any subclasses should pick and pull from @options to set any and
+      # all instance variables they like.
+      #
+      # Returns nothing.
+      def parse_options
+        # pass
+      end
       # Conditionally enable views based on any gathered data. Helpful
       # if you don't want views to show up when they return 0 or are
       # touched during the request.
@@ -36,11 +45,12 @@ module Peek
       #   Peek::Views::Resque => "resque"
       #
       # Returns String.
-      def defer_key
+      def key
         self.class.to_s.split('::').last.underscore.gsub(/\_/, '-')
       end
+      alias defer_key key
-      # The context dom id that is derived from the classname.
+      # The context id that is derived from the classname.
       #
       # Examples:
       #
@@ -48,15 +58,15 @@ module Peek
       #   Peek::Views::Resque => "peek-context-resque"
       #
       # Returns String.
-      def context_dom_id
-        "peek-context-#{defer_key}"
+      def context_id
+        "peek-context-#{key}"
       end
       # The wrapper ID for the individual view in the Peek bar.
       #
       # Returns String.
       def dom_id
-        "peek-view-#{defer_key}"
+        "peek-view-#{key}"
       end
       # Additional context for any view to render tooltips for.

data/lib/peek.rb CHANGED Viewed

@@ -1,12 +1,51 @@
 require 'peek/version'
 require 'rails'
+require 'atomic'
+require 'peek/adapters/memory'
 require 'peek/views/view'
-Dir[File.join(File.dirname(__FILE__), 'peek', 'views', '*.rb')].each do |view|
-  require view
-end
 module Peek
+  def self._request_id
+    @_request_id ||= Atomic.new
+  end
+  def self.request_id
+    _request_id.get
+  end
+  def self.request_id=(id)
+    _request_id.update { id }
+  end
+  def self.adapter
+    @adapter
+  end
+  def self.adapter=(*adapter_options)
+    adapter, *parameters = *Array.wrap(adapter_options).flatten
+    @adapter = case adapter
+    when Symbol
+      adapter_class_name = adapter.to_s.camelize
+      adapter_class =
+        begin
+          require "peek/adapters/#{adapter}"
+        rescue LoadError => e
+          raise "Could not find adapter for #{adapter} (#{e})"
+        else
+          Peek::Adapters.const_get(adapter_class_name)
+        end
+      adapter_class.new(*parameters)
+    when nil
+      Peek::Adapters::Memory.new
+    else
+      adapter
+    end
+    @adapter
+  end
   def self.enabled?
     ['development', 'staging'].include?(env)
   end
@@ -23,19 +62,51 @@ module Peek
     end
   end
+  def self.results
+    results = {
+      :context => {},
+      :data => Hash.new { |h, k| h[k] = {} }
+    }
+    views.each do |view|
+      if view.context?
+        results[:context][view.key] = view.context
+      end
+      view.results.each do |key, value|
+        results[:data][view.key][key] = value
+      end
+    end
+    results
+  end
   def self.into(klass, options = {})
     @views ||= []
     @views << [klass, options]
   end
+  # Clears out any and all views.
+  #
+  # Returns nothing.
   def self.reset
     @views = nil
     @cached_views = nil
   end
+  # Hook that happens after every request. It is expected to reset
+  # any state that Peek managed throughout the requests lifecycle.
+  #
+  # Returns nothing.
+  def self.clear
+    _request_id.update { '' }
+  end
   def self.setup
     ApplicationController.send(:include, Peek::ControllerHelpers)
   end
 end
 require 'peek/railtie'
+ActiveSupport.run_load_hooks(:peek, Peek)

data/peek.gemspec CHANGED Viewed

@@ -18,5 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
-  gem.add_dependency 'rails', '>= 3'
+  gem.add_dependency 'rails',  '>= 3.0.0'
+  gem.add_dependency 'atomic', '>= 1.0.0'
+  gem.add_dependency 'redis',  '>= 3.0.0'
 end