auto_error 0.0.3 → 0.0.4

data/app/assets/javascripts/auto_error/app_errors/views/app_errors.coffee

@@ -6,21 +6,16 @@ class AppError extends App.Views.PolledItem
   render: ->
     json = @model.toJSON()
     json.prettyData = []
+    json.backtrace = @model.get('backtrace').replace( /\n/g, "<br/>" )
     for k, v of json.data
-      json.prettyData.push "#{k}: #{v}"
-    json.prettyData = json.prettyData.join("\n")
+      json.prettyData.push "#{k}: <tt>#{v}</tt>"
+    json.prettyData = json.prettyData.join("<br/>")
     json.timestamp = moment(json.created_at).format( "YYYY-MM-DD[<br/>at] h:mma" )
     @$el.html( @template( json ) )
     return @
   toggleBacktrace: ->
     link = @$('a.show_backtrace')
-    bt = @$('.backtrace')
-    if bt.is(':visible')
-      bt.hide()
-      link.text('show backtrace...')
-    else
-      bt.html( @model.get('backtrace').replace( /\n/g, "<br/>" ) ).show()
-      link.text('hide backtrace...')
+    @$('.backtrace').reveal()
   destroy: ->
     @model.destroy()
     @remove()

data/app/assets/javascripts/auto_error/app_errors/views/base.coffee

@@ -14,7 +14,7 @@ class App.Views.PollingList extends Backbone.View
     @emptyMessage = @body.html().replace(/[\r\n]\s+/g, '')
     @collection.on 'remove', @remove, @
     @collection.on 'add', @render, @
-    @collection.fetch( update: true )
+    @collection.fetch( update: true, success: _.bind(@render, @) )
     @views = {}
   remove: ( m ) ->
     @views[m.id] = null

data/app/assets/javascripts/auto_error/application.js

@@ -3,6 +3,7 @@
 //= require auto_error/moment
 //= require auto_error/underscore-1.4.4
 //= require auto_error/backbone-0.9.10
+//= require auto_error/foundation-reveal
 //= require handlebars.runtime
 //= require_tree ../../templates/auto_error
 //= require ./app_errors

data/app/assets/stylesheets/auto_error/app_errors.css.erb

@@ -1,8 +1,15 @@
+body {
+  background: transparent;
+}
+
 table.polling tr td p.loading_message {
   font-size: 20px;
   margin: 25px 0;
   text-align: center;
 }
+table.polling tbody td small.time {
+  font-size: 12px;
+}
 
 table.polling tbody pre {
   font-size: 13px;
@@ -35,11 +42,30 @@ table.polling tfoot .poller .spinner {
 }
 
 #app_errors table tbody .backtrace {
-  width: 530px;
-  height: 250px;
   overflow: scroll;
   font-family: monospace;
   font-size: 13px;
   line-height: 15px;
   white-space: nowrap;
 }
+#app_errors table tbody .data {
+  font-family: monospace;
+  font-size: 13px;
+  line-height: 15px;
+  white-space: nowrap;
+}
+
+
+.reveal-modal {
+  top: -100px;
+  width: 960px;
+  margin-left: -480px;
+  display: block; /* wat? */
+}
+  .reveal-modal h4 {
+    margin-top: 0;
+  }
+.close-reveal-modal {
+  top: 0;
+  left: 5px;
+}

data/app/assets/templates/auto_error/app_error.hbs

@@ -2,10 +2,14 @@
   <strong>{{message}}</strong>
   <br/>
   <a href="javascript:void(0);" class='show_backtrace'>show backtrace...</a>
-  <div class='backtrace' style='display: none;'></div>
+  <div class='backtrace reveal-modal'>
+    <a class="close-reveal-modal">&#215;</a>
+    <h4>{{message}}</h4>
+    <pre>{{{backtrace}}}</pre>
+  </div>
 </td>
-<td><pre>{{{prettyData}}}</pre></td>
-<td>{{{timestamp}}}</td>
-<td>
+<td><div class='data'>{{{prettyData}}}</div></td>
+<td width='120px'><small class='time'>{{{timestamp}}}</small></td>
+<td width='85px'>
   <a href="javascript:void(0);" class='remove button radius tiny secondary'>resolved</a>
 </td>

data/app/controllers/auto_error/app_errors_controller.rb

@@ -3,7 +3,7 @@ class AutoError::AppErrorsController < AutoError::ApplicationController
 
   def index
     @errors = AutoError::AppError.unresolved
-    render json: @errors.map { |ae| AutoError::AppErrorDecorator.new(ae).as_json }
+    render json: @errors.map { |ae| AutoError::AppErrorDecorator.new(ae).as_json( @h ) }
   end
 
   def destroy

data/app/controllers/auto_error/application_controller.rb

@@ -1,11 +1,16 @@
-class AutoError::ApplicationController < ActionController::Base
+class AutoError::ApplicationController < ::ApplicationController
   include AutoError::ApplicationHelper
   helper :all
 
   protected
 
   def ensure_authenticated
-    context = AutoError::AuthContext.new(env)
-    raise AutoError::Errors::Denied unless AutoError::Config.auth_with.call(context)
+    @h = AutoError::HelperContext.new( env )
+
+    # raise unless the auth_with helper returns a truthy value
+    # this way we can let the user access their own auth logic
+    unless AutoError::Config.auth_with.(@h)
+      raise AutoError::Errors::Denied
+    end
   end
 end

data/app/controllers/auto_error/errors_controller.rb

@@ -1,30 +1,41 @@
 class AutoError::ErrorsController < AutoError::ApplicationController
 
   def show
+    # fix PATH_INFO to be the actual request path, and not /500
+    env['PATH_INFO'] = env['ORIGINAL_FULLPATH']
+
     # reset action_controller.instance to the original controller
     # that caused the exception
     env['action_controller.instance'] = env.delete('auto_error.original_controller.instance')
+    @controller = env['action_controller.instance']
 
     @exception       = env['action_dispatch.exception']
     @status_code     = ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
     @rescue_response = ActionDispatch::ExceptionWrapper.rescue_responses[@exception.class.name]
-    @params          = env['action_dispatch.request.parameters'].symbolize_keys
 
     @status_code = 500 unless [403, 404].include?(@status_code)
 
     if @status_code == 500
+      @request = @controller.request
+      @params = @request.filtered_parameters.symbolize_keys
       controller = "#{@params[:controller].camelize}Controller" rescue 'N/A'
       action = @params[:action] || 'N/A'
       where = { controller: controller, action: action }
       data = {
-        path: env['REQUEST_URI'],
-        method: env['REQUEST_METHOD'],
-        ip: env['REMOTE_ADDR']
+        path: @request.fullpath.split('?').first,
+        method: @request.method,
+        ip: @request.remote_ip,
+        params: @params.except( *(%w{
+          controller action format _method only_path
+        }.map(&:to_sym) ) )
       }
+      # Rails.logger.error [controller,action, where, data].map(&:inspect).join("\n")
       AutoError::AppError.log!( env, @exception, where, data )
     end
 
     AutoError::Config.error_template_renderer.bind(self).( @status_code )
+  rescue => explosion
+    Rails.logger.error "\nAutoError exploded while handling an exception: #{@exception.inspect}\nHere's the error: #{explosion.inspect}\n"
   end
 
 end

data/app/decorators/auto_error/app_error_decorator.rb

@@ -1,13 +1,32 @@
 module AutoError
   class AppErrorDecorator < Draper::Decorator
-    def as_json
+    def as_json( context )
       r = source.attributes
       (r['data']||{}).entries.each do |k, v|
         next if v.nil?
-        handler = AutoError::Config.data_handlers[k.to_sym].bind(ViewContext.new)
-        r['data'][k.to_s] = handler.(v).html_safe
+        k = k.to_sym
+        if k != :params || AutoError::Config.data_handlers.has_key?(k)
+          handler = AutoError::Config.data_handlers[k].bind(context)
+          processed = handler.(v)
+        elsif k == :params
+          processed = handle_params(v)
+        end
+        r['data'][k.to_s] = processed.html_safe
       end
       r
     end
+
+    private
+
+    def handle_params( h )
+      %{
+        <a href='javascript:void(0);' onclick='$(this).siblings(".params").reveal();'>show params...</a>
+        <div class='params reveal-modal'>
+          <a class="close-reveal-modal">&#215;</a>
+          <h4>Params</h4>
+          <pre>#{JSON.pretty_generate(h)}</pre>
+        </div>
+      }
+    end
   end
 end

data/app/models/auto_error/app_error.rb

@@ -1,5 +1,7 @@
 module AutoError
   class AppError < ActiveRecord::Base
+    attr_accessible *%w{ controller action data klass message backtrace }
+
     before_create :generate_group
 
     serialize :data
@@ -12,13 +14,15 @@ module AutoError
       opts.merge!( {
         klass: exception.class.name,
         message: exception.message,
-        backtrace: (exception.backtrace || []).join("\n"),
+        backtrace: (
+          exception.backtrace ? clean_backtrace(exception.backtrace) : []
+        ).join("\n")
       } )
       app_error = create!( opts )
 
       if AutoError::Config.email_on_error.any?
         begin
-          send_email!( env, exception )
+          send_email!( env, exception, opts[:data] )
         rescue
           $stderr.puts "AutoError failed to send exception notification email to #{AutoError::Config.email_on_error.inspect} -- #{$!.inspect}"
         end
@@ -42,11 +46,12 @@ module AutoError
 
     private
 
-    def self.send_email!( env, exception )
+    def self.send_email!( env, exception, data )
       options = env['exception_notifier.options'] || {}
       options[:ignore_exceptions] ||= ExceptionNotifier.default_ignore_exceptions
       options[:email_prefix] ||= "[#{Rails.application.class.name.split('::').first} ERROR] "
       options[:exception_recipients] = AutoError::Config.email_on_error
+      options[:data] = data
 
       unless Array.wrap(options[:ignore_exceptions]).include?( exception.class )
         ExceptionNotifier::Notifier.exception_notification( env, exception, options ).deliver
@@ -54,6 +59,11 @@ module AutoError
       end
     end
 
+    def self.clean_backtrace( backtrace )
+      return backtrace unless Rails.respond_to?( :backtrace_cleaner )
+      Rails.backtrace_cleaner.send( :filter, backtrace )
+    end
+
     def generate_group
       self.group = Digest::SHA1.hexdigest( [
         self.klass.to_s, self.message.to_s,

data/app/views/auto_error/exception_notifier/_request.html.erb

@@ -0,0 +1,5 @@
+* URL       : <%= raw @request.fullpath.split('?').first %>
+* IP address: <%= raw @request.remote_ip %>
+* Parameters: <%= raw @request.filtered_parameters.inspect %>
+* Rails root: <%= raw Rails.root %>
+* Timestamp : <%= raw Time.current %>

data/app/views/auto_error/exception_notifier/_request.text.erb

@@ -0,0 +1,5 @@
+* URL       : <%= raw @request.fullpath.split('?').first %>
+* IP address: <%= raw @request.remote_ip %>
+* Parameters: <%= raw @request.filtered_parameters.inspect %>
+* Rails root: <%= raw Rails.root %>
+* Timestamp : <%= raw Time.current %>

data/lib/auto_error/config.rb

@@ -7,8 +7,8 @@ module AutoError
     mattr_accessor :auth_with
     @@auth_with = nil
 
-    mattr_accessor :auth_helpers
-    @@auth_helpers = nil
+    mattr_accessor :helpers
+    @@helpers = nil
 
     mattr_accessor :email_on_error
     @@email_on_error = nil
@@ -24,15 +24,22 @@ module AutoError
     def self.set_defaults
       self.setup do |config|
         config.error_template_renderer = ->( status ) do
-          render template: "/errors/#{status}", layout: 'errors', status: status
+          render template: "/errors/#{status}",
+                 layout: 'errors',
+                 status: status
         end
 
         config.email_on_error = []
+        ExceptionNotifier::Notifier.prepend_view_path(
+          AutoError::Engine.root.join( *%w{app views auto_error} )
+        )
 
         config.auth_with = ->( c ) { true }
-        config.auth_helpers = [ 'ApplicationHelper' ]
+        config.helpers = [ 'ApplicationHelper' ]
 
-        config.data_handlers = Hash.new { |h, k| h[k] = ->( value ) { "<strong>#{value}</strong>" } }
+        config.data_handlers = Hash.new do |h, k|
+          h[k] = ->( value ) { "<strong>#{value}</strong>" }
+        end
       end
     end
   end

data/lib/auto_error/context_shorthand.rb

@@ -1,5 +1,4 @@
 module AutoError
-
   # Convenience methods added to ApplicationController.
   module ContextShorthand
     def add_error_context( context )
@@ -11,5 +10,4 @@ module AutoError
   end
 
   ActionController::Base.send :include, AutoError::ContextShorthand
-
 end

data/lib/auto_error/helper_context.rb

@@ -0,0 +1,34 @@
+module AutoError
+  class HelperContext
+    attr_accessor :env
+
+    def initialize( env )
+      @env = env
+
+      AutoError::Config.helpers.each do |mod_name|
+        # grab the module by name we were given
+        # it is available in the 'parent' Rails.application
+        mod = Rails.application.class.qualified_const_get(mod_name)
+
+        class_eval do
+          # include that module in this HelperContext
+          send( :include, mod )
+
+          # but go through all of its instance methods
+          # and alias-method-chain style twiddle them so we can bind
+          # them to the correct environment inside auto_error
+          mod.instance_methods.each do |imeth|
+            alias :"#{imeth}_without_env" :"#{imeth}"
+            send( :define_method, :"#{imeth}" ) do |*args|
+              method( :"#{imeth}_without_env" ).to_proc.bind( @env ).call(*args)
+            end
+          end
+
+          # also include rails helpers and ActionView helpers
+          send( :include, ActionView::Helpers )
+          send( :include, Rails.application.routes.url_helpers )
+        end
+      end
+    end
+  end
+end

data/lib/auto_error/version.rb

@@ -1,3 +1,3 @@
 module AutoError
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/auto_error.rb

@@ -16,8 +16,7 @@ require 'auto_error/version'
 require 'auto_error/config'
 require 'auto_error/errors'
 require 'auto_error/context_shorthand'
-require 'auto_error/view_context'
-require 'auto_error/auth_context'
+require 'auto_error/helper_context'
 require 'auto_error/engine'
 
 module AutoError
@@ -28,7 +27,7 @@ module AutoError
 
     original_exceptions_app = app_config.exceptions_app || ActionDispatch::PublicExceptions.new(Rails.public_path)
     app_config.exceptions_app = ->(env) do
-      # puts "Handling exception for #{env['action_controller.instance'].class}"
+      puts "Handling exception for #{env['action_controller.instance'].class}"
       controller_class = env['action_controller.instance'].class
       if controller_class.nil? || AutoError.constants.any? { |c| AutoError.const_get(c) == controller_class }
         # do not log/handle exception at all if the error is actually

data/vendor/assets/javascripts/auto_error/foundation-reveal.js

@@ -0,0 +1,161 @@
+/*
+ * jQuery Reveal Plugin 1.0
+ * www.ZURB.com
+ * Copyright 2010, ZURB
+ * Free to use under the MIT license.
+ * http://www.opensource.org/licenses/mit-license.php
+*/
+
+
+(function($) {
+
+/*---------------------------
+ Defaults for Reveal
+----------------------------*/
+
+/*---------------------------
+ Listener for data-reveal-id attributes
+----------------------------*/
+
+  // How about no, scott?
+  // $('a[data-reveal-id]').live('click', function(e) {
+  //   e.preventDefault();
+  //   var modalLocation = $(this).attr('data-reveal-id');
+  //   $('#'+modalLocation).reveal($(this).data());
+  // });
+
+/*---------------------------
+ Extend and Execute
+----------------------------*/
+
+    $.fn.reveal = function(options) {
+
+
+        var defaults = {
+        animation: 'fadeAndPop', //fade, fadeAndPop, none
+        animationspeed: 300, //how fast animtions are
+        closeonbackgroundclick: true, //if you click background will modal close?
+        dismissmodalclass: 'close-reveal-modal' //the class of a button or element that will close an open modal
+      };
+
+        //Extend dem' options
+        var options = $.extend({}, defaults, options);
+
+        return this.each(function() {
+
+/*---------------------------
+ Global Variables
+----------------------------*/
+          var modal = $(this),
+            topMeasure  = parseInt(modal.css('top')),
+        topOffset = modal.height() + topMeasure,
+              locked = false,
+        modalBG = $('.reveal-modal-bg');
+
+/*---------------------------
+ Create Modal BG
+----------------------------*/
+      if(modalBG.length == 0) {
+        modalBG = $('<div class="reveal-modal-bg" />').insertAfter(modal);
+      }
+
+/*---------------------------
+ Open & Close Animations
+----------------------------*/
+      //Entrance Animations
+      modal.bind('reveal:open', function () {
+        modalBG.unbind('click.modalEvent');
+        $('.' + options.dismissmodalclass).unbind('click.modalEvent');
+        if(!locked) {
+          lockModal();
+          if(options.animation == "fadeAndPop") {
+            modal.css({'top': $(document).scrollTop()-topOffset, 'opacity' : 0, 'visibility' : 'visible'});
+            modalBG.fadeIn(options.animationspeed/2);
+            modal.delay(options.animationspeed/2).animate({
+              "top": $(document).scrollTop()+topMeasure + 'px',
+              "opacity" : 1
+            }, options.animationspeed,unlockModal());
+          }
+          if(options.animation == "fade") {
+            modal.css({'opacity' : 0, 'visibility' : 'visible', 'top': $(document).scrollTop()+topMeasure});
+            modalBG.fadeIn(options.animationspeed/2);
+            modal.delay(options.animationspeed/2).animate({
+              "opacity" : 1
+            }, options.animationspeed,unlockModal());
+          }
+          if(options.animation == "none") {
+            modal.css({'visibility' : 'visible', 'top':$(document).scrollTop()+topMeasure});
+            modalBG.css({"display":"block"});
+            unlockModal()
+          }
+        }
+        modal.unbind('reveal:open');
+      });
+
+      //Closing Animation
+      modal.bind('reveal:close', function () {
+        if(!locked) {
+          lockModal();
+          if(options.animation == "fadeAndPop") {
+            modalBG.delay(options.animationspeed).fadeOut(options.animationspeed);
+            modal.animate({
+              "top":  $(document).scrollTop()-topOffset + 'px',
+              "opacity" : 0
+            }, options.animationspeed/2, function() {
+              modal.css({'top':topMeasure, 'opacity' : 1, 'visibility' : 'hidden'});
+              unlockModal();
+            });
+          }
+          if(options.animation == "fade") {
+            modalBG.delay(options.animationspeed).fadeOut(options.animationspeed);
+            modal.animate({
+              "opacity" : 0
+            }, options.animationspeed, function() {
+              modal.css({'opacity' : 1, 'visibility' : 'hidden', 'top' : topMeasure});
+              unlockModal();
+            });
+          }
+          if(options.animation == "none") {
+            modal.css({'visibility' : 'hidden', 'top' : topMeasure});
+            modalBG.css({'display' : 'none'});
+          }
+        }
+        modal.unbind('reveal:close');
+      });
+
+/*---------------------------
+ Open and add Closing Listeners
+----------------------------*/
+          //Open Modal Immediately
+      modal.trigger('reveal:open')
+
+      //Close Modal Listeners
+      var closeButton = $('.' + options.dismissmodalclass).bind('click.modalEvent', function () {
+        modal.trigger('reveal:close')
+      });
+
+      if(options.closeonbackgroundclick) {
+        modalBG.css({"cursor":"pointer"})
+        modalBG.bind('click.modalEvent', function () {
+          modal.trigger('reveal:close')
+        });
+      }
+      $('body').keyup(function(e) {
+            if(e.which===27){ modal.trigger('reveal:close'); } // 27 is the keycode for the Escape key
+      });
+
+
+/*---------------------------
+ Animations Locks
+----------------------------*/
+      function unlockModal() {
+        locked = false;
+      }
+      function lockModal() {
+        locked = true;
+      }
+
+        });//each call
+    }//orbit plugin call
+})(jQuery);
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auto_error
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -261,6 +261,8 @@ files:
 - app/decorators/auto_error/app_error_decorator.rb
 - app/helpers/auto_error/application_helper.rb
 - app/models/auto_error/app_error.rb
+- app/views/auto_error/exception_notifier/_request.html.erb
+- app/views/auto_error/exception_notifier/_request.text.erb
 - app/views/auto_error/main/index.html.haml
 - app/views/errors/404.html.erb
 - app/views/errors/500.html.erb
@@ -268,18 +270,18 @@ files:
 - app/views/layouts/errors.html.erb
 - config/routes.rb
 - db/migrate/20130128004546_create_auto_error_app_errors.rb
-- lib/auto_error/auth_context.rb
 - lib/auto_error/config.rb
 - lib/auto_error/context_shorthand.rb
 - lib/auto_error/engine.rb
 - lib/auto_error/errors.rb
+- lib/auto_error/helper_context.rb
 - lib/auto_error/version.rb
-- lib/auto_error/view_context.rb
 - lib/auto_error.rb
 - lib/core_ext/proc_ext.rb
 - lib/tasks/auto_error_tasks.rake
 - lib/templates/auto_error.rb
 - vendor/assets/javascripts/auto_error/backbone-0.9.10.js
+- vendor/assets/javascripts/auto_error/foundation-reveal.js
 - vendor/assets/javascripts/auto_error/moment.js
 - vendor/assets/javascripts/auto_error/underscore-1.4.4.js
 - vendor/assets/stylesheets/auto_error/foundation.css

data/lib/auto_error/auth_context.rb

@@ -1,18 +0,0 @@
-module AutoError
-  class AuthContext
-    def initialize( env )
-      AutoError::Config.auth_helpers.each do |mod_name|
-        mod = Rails.application.class.qualified_const_get(mod_name)
-        class_eval do
-          send( :include, mod )
-          mod.instance_methods.each do |imeth|
-            alias :"#{imeth}_without_env" :"#{imeth}"
-            send( :define_method, imeth ) do
-              method( :"#{imeth}_without_env" ).to_proc.bind( env )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/auto_error/view_context.rb

@@ -1,10 +0,0 @@
-module AutoError
-  class ViewContext
-    def initialize
-      class_eval do
-        self.send( :include, ActionView::Helpers )
-        self.send( :include, Rails.application.routes.url_helpers )
-      end
-    end
-  end
-end