exception_handler 0.7.7.0 → 0.8.0.0

data/app/assets/stylesheets/exception_handler.css.erb

@@ -15,4 +15,9 @@
 */
 /* ---------------------------------------------------- */
 /* ---------------------------------------------------- */
+/*
+  *= link_tree ../images
+*/
+/* ---------------------------------------------------- */
+/* ---------------------------------------------------- */
 /* ---------------------------------------------------- */

data/app/assets/stylesheets/styles/_base.css.erb

@@ -4,19 +4,12 @@
 /* ---------------------------------------------------- */
 /* ---------------------------------------------------- */
 
-/*
-  *= link_tree ../../images
-*/
-
-/* ---------------------------------------------------- */
-/* ---------------------------------------------------- */
-
 *           { margin: 0; }
 html, body  { height: 100%; }
 html        {
 	height:          100%;
   color:           #fff;
-	background:      #010008 url(<%= asset_url("exception_handler/bg.jpg") %>) top left no-repeat;
+	background:      #121212;
 	background-size: 100% 100%;
   box-sizing:      border-box;
 }

data/app/assets/stylesheets/styles/_exception.css.erb

@@ -53,7 +53,8 @@
   border-color:  rgba(255,255,255,0.09);
   border-style:  solid
 }
-.exception:hover { cursor: pointer; }
+.exception:hover       { cursor: pointer; }
+.exception:hover:after { text-decoration: underline; }
 
 .exception span:before {
   display:         block;

data/app/controllers/exception_handler/exceptions_controller.rb

@@ -36,9 +36,11 @@ module ExceptionHandler
     layout :layout
 
     ####################
-    #      Action      #
+    #     Actions      #
     ####################
 
+    # => General Show Functionality
+    # => Introduced new "action" config option in 0.8.0.0
     def show
       respond_with @exception, status: @exception.status
     end
@@ -48,8 +50,13 @@ module ExceptionHandler
 
     private
 
-    def layout
-      ExceptionHandler.config.layouts[@exception.status]
+    # => Pulls from Exception class
+    # => Spanner in the works is nil
+    # => .present? validates against empty strings (IE a string is present)
+    # => .nil? validates to see if the returned data is "nil"
+    # => nil required to facilitate inheritance of the layout w/ ApplicationController
+    def layout option = ExceptionHandler.config.options(@exception.status, :layout)
+      (option.present? || option.nil?) ? option : 'exception'
     end
 
     ##################################

data/app/models/exception_handler/exception.rb

@@ -10,20 +10,13 @@ module ExceptionHandler
     # => Attributes
     # => Determine schema etc
     ATTRS = %i(class_name status message trace target referrer params user_agent)
-  
-    # => Exceptions to be rescued by ExceptionHandler
-    EXCEPTIONS_TO_BE_RESCUED = [ActionController::RoutingError, AbstractController::ActionNotFound].tap do |list|
-      list << ActiveRecord::RecordNotFound if defined?(ActiveRecord)
-      list << Mongoid::Errors::DocumentNotFound if defined?(Mongoid)
-    end
 
   ############################################################
   ############################################################
 
     # => Class (inheritance dependent on whether db option is available)
-    self::Exception = Class.new(
-      (ExceptionHandler.config.try(:db) && defined?(ActiveRecord)) ? ActiveRecord::Base : Object
-    ) do
+    self::Exception =
+      Class.new( (ExceptionHandler.config.try(:db) && defined?(ActiveRecord)) ? ActiveRecord::Base : Object ) do
 
       # => Include individual elements
       # => Only required if no db present (no ActiveRecord)
@@ -97,15 +90,14 @@ module ExceptionHandler
         # => Email
         # => after_initialize invoked after .new method called
         # => Should have been after_create but user may not save
-        after_initialize Proc.new { |e| ExceptionHandler::ExceptionMailer.new_exception(e).deliver } if ExceptionHandler.config.try(:email).try(:is_a?, String)
+        after_initialize -> (e) { ExceptionHandler::ExceptionMailer.new_exception(e).deliver }, if: :email? # => see bottom of file
 
         # => Attributes
         attr_accessor :request, :klass, :exception, :description
         attr_accessor *ATTRS unless ExceptionHandler.config.try(:db)
 
         # => Validations
-        validates :klass, exclusion:    { in: EXCEPTIONS_TO_BE_RESCUED, message: "%{value}" }, if: -> { referer.blank? } # => might need full Proc syntax
-        validates :user_agent, format:  { without: Regexp.new( BOTS.join("|"), Regexp::IGNORECASE ) }
+        validates :user_agent, format: { without: Regexp.new( BOTS.join("|"), Regexp::IGNORECASE ) }
 
       ##################################
       ##################################
@@ -114,21 +106,22 @@ module ExceptionHandler
         # Virtual
         ####################################
 
+          # => Exception (virtual)
+          # => Basis on which all the class is built
+          def exception
+            request.env['action_dispatch.exception']
+          end
+
           # => Klass
           # => Used for validation (needs to be cleaned up in 0.7.0)
           def klass
             exception.class
           end
 
-          # => Exception (virtual)
-          def exception
-            request.env['action_dispatch.exception']
-          end
-
           # => Description
           def description
             I18n.with_options scope: [:exception_handler], message: message, status: status do |i18n|
-              i18n.t response, default: Rack::Utils::HTTP_STATUS_CODES[status] || status
+              i18n.t response, default: Rack::Utils::HTTP_STATUS_CODES[status]
             end
           end
 
@@ -143,7 +136,7 @@ module ExceptionHandler
 
           # => Message
           def message
-            exception.message
+            exception ? exception.message : Rack::Utils::HTTP_STATUS_CODES[status]
           end
 
           # => Trace
@@ -181,7 +174,7 @@ module ExceptionHandler
 
           # => Status code (404, 500 etc)
           def status
-            ActionDispatch::ExceptionWrapper.new(request.env, exception).status_code
+            exception ? ActionDispatch::ExceptionWrapper.new(request.env, exception).try(:status_code) : request.env["PATH_INFO"][1..-1].to_i
           end
 
           # => Server Response ("Not Found" etc)
@@ -192,6 +185,14 @@ module ExceptionHandler
       ##################################
       ##################################
 
+      private
+
+        # => Email
+        # => should be on the same line as after_initialize but too long
+        def email?
+          ExceptionHandler.config.try(:email).try(:is_a?, String) && ExceptionHandler.config.options(status, :notification) != false
+        end
+
     end
   end
 

data/app/views/exception_handler/exceptions/show.html.erb

@@ -1,3 +1,3 @@
-<%= content_tag :div, class: "exception", data: { status: @exception.status, response: @exception.response.to_s.humanize, rails: Rails.version }, onclick: ("location.href=\"#{root_url}\";" if @exception.status == "500" && Rails.application.routes.recognize_path("/")), title: ("Return Home" if @exception.status == "500" && Rails.application.routes.recognize_path("/")) do %>
+<%= content_tag :div, class: "exception", data: { status: @exception.status, response: @exception.response.to_s.humanize, rails: Rails.version }, onclick: ("location.href=\"#{root_url}\";" if @exception.status.to_s.first == "5" && Rails.application.routes.recognize_path("/")) do %>
   <%= content_tag :span, @exception.description.html_safe %>
 <% end %>

data/app/views/layouts/exception.html.erb

@@ -9,6 +9,10 @@
     <%= stylesheet_link_tag :exception_handler %>
     <%= favicon_link_tag "exception_handler/favicon.ico" %>
 
+    <% if x = ExceptionHandler.config.options(@exception.status) %>
+      <style>body { background: url("<%= asset_path x %>") center center no-repeat !important; background-size: cover !important; }</style>
+    <% end %>
+
     <!-- Auth -->
     <%= csrf_meta_tags %>
   </head>
@@ -24,4 +28,5 @@
       <% end %>
     <% end %>
   <% end %>
+
 </html>

data/app/views/layouts/mailer.html.erb

@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html>
+  <head><meta content="text/html; charset=utf-8" http-equiv="Content-Type" /></head>
+  <body><%= yield %></body>
+</html>

data/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/locales/exception_handler.en.yml

@@ -22,7 +22,7 @@
 
 en:
   exception_handler:
-    internal_server_error:  "<strong>%{status} Error</strong>  %{message} <p>Return home</p>"
+    internal_server_error:  "<strong>%{status} Error</strong> %{message}"
 
 #######################################################################################
 #######################################################################################

data/config/routes.rb

@@ -0,0 +1,42 @@
+########################################
+########################################
+##    _____            _              ##
+##   | ___ \          | |             ##
+##   | |_/ /___  _   _| |_ ___  ___   ##
+##   |    // _ \| | | | __/ _ \/ __|  ##
+##   | |\ \ (_) | |_| | ||  __/\__ \  ##
+##   \_| \_\___/ \__,_|\__\___||___/  ##
+##                                    ##
+########################################
+########################################
+
+## Good resource
+## https://gist.github.com/maxivak/5d428ade54828836e6b6#merge-engine-and-app-routes
+
+########################################
+########################################
+
+## Routes ##
+Rails.application.routes.draw do
+
+  ########################################
+  ########################################
+
+    # => ExceptionHandler
+    # => Used to provide error page examples in "dev" mode
+    if Object.const_defined?('ExceptionHandler') && ExceptionHandler.config.try(:dev)
+
+      # => Items
+      Rack::Utils::SYMBOL_TO_STATUS_CODE.select{ |key, value| value.to_s.match('\b(?:4[0-9]{2}|5[0-9]{2}|599)\b') }.each do |code, status|
+        get status.to_s, to: 'exception_handler/exceptions#show', as: code, code: code
+      end
+
+    end
+
+  ########################################
+  ########################################
+
+end
+
+########################################
+########################################

data/exception_handler.gemspec

@@ -11,16 +11,17 @@ require_relative 'lib/exception_handler/version'
 Gem::Specification.new do |s|
 
   ## General ##
-  s.name          = "exception_handler"
-  s.authors       = ["R.Peck"]
-  s.email         = ["rpeck@fl.co.uk"]
-  s.version       = ExceptionHandler::VERSION::STRING
-  s.platform      = Gem::Platform::RUBY
+  s.name                  = "exception_handler"
+  s.authors               = ["R.Peck"]
+  s.email                 = ["rpeck@fl.co.uk"]
+  s.version               = ExceptionHandler::VERSION::STRING
+  s.platform              = Gem::Platform::RUBY
 
   ## Details ##
-  s.summary       = %q{Rails gem to show custom error pages in production. Also logs errors in db & sends notification emails}
-  s.description   = %q{Rails gem to create custom error pages. Captures exceptions using "exception_app" callback, routing to "Exception" controller, rendering the view as required.}
-  s.homepage      = "https://github.com/richpeck/exception_handler"
+  s.summary               = %q{Rails gem to show custom error pages in production. Also logs errors in db & sends notification emails}
+  s.description           = %q{Rails gem to create custom error pages. Captures exceptions using "exception_app" callback, routing to "Exception" controller, rendering the view as required.}
+  s.post_install_message  = %q{ExceptionHandler 0.8.0.0 → New "config" (config.exception_handler = {exceptions: {layout: 'x', notification: true, action: {redirect_to root_path} }} ). https://www.github.com/richpeck/exception_handler#config for more info. }
+  s.homepage              = "https://github.com/richpeck/exception_handler"
 
   ## License ##
   s.license       = "MIT"

data/lib/exception_handler.rb

@@ -37,6 +37,7 @@ module ExceptionHandler
   ##############################
   ##############################
 
+
 end
 
 #########################################################

data/lib/exception_handler/config.rb

@@ -7,7 +7,7 @@
 ##    | \__/\ (_) | | | | | | | (_| |    ##
 ##    \____/\___/|_| |_|_| |_|\__,  |    ##
 ##                             __/  |    ##
-##                             |___/     ##                             
+##                             |___/     ##
 ###########################################
 ###########################################
 
@@ -26,9 +26,10 @@ module ExceptionHandler
     # => ExceptionHandler.config.db
     # => ExceptionHandler.config.email
     # => ExceptionHandler.config.social
-    # => ExceptionHandler.config.layouts
+    # => ExceptionHandler.config.layouts -> will need to be deprecated
+    # => ExceptionHandler.config.exceptions
     # => ExceptionHandler.config.custom_exceptions
-    attr_accessor :dev, :db, :email, :social, :layouts, :custom_exceptions
+    attr_accessor :dev, :db, :email, :social, :layouts, :exceptions, :custom_exceptions
 
     ###########################################
     ###########################################
@@ -39,51 +40,96 @@ module ExceptionHandler
       # => Has to be "errors" because "exceptions" is a reserved word
       TABLE = :errors
 
+    ###########################################
+    ###########################################
+
       # => Social URLs
       # => Extracted from "social" block
-      SOCIAL = {
-        facebook: "https://facebook.com",
-        twitter:  "https://twitter.com",
-        youtube:  "https://youtube.com/user",
-        linkedin: "https://linkedin.com/company",
-        fusion:   "https://frontlinefusion.com"
-      }
+      SOCIAL =
+        ActiveSupport::HashWithIndifferentAccess.new({
+          facebook: "https://www.facebook.com",
+          twitter:  "https://www.twitter.com",
+          youtube:  "https://www.youtube.com/user",
+          linkedin: "https://www.linkedin.com/company",
+          fusion:   "https://www.frontlinefusion.com"
+        })
 
     ###########################################
     ###########################################
 
       # => Defaults
       # => http://stackoverflow.com/a/8917301/1143732
-      DEFAULTS = {
-        dev:    nil, # => defaults to "false" for dev mode
-        db:     nil, # => defaults to :errors if true, else use "table_name" / :table_name
-        email: 	nil, # => requires string email and ActionMailer
-        social: {
-          facebook: nil,
-          twitter:  nil,
-          youtube:  nil,
-          linkedin: nil,
-          fusion:   nil,
-        },
-        layouts: {
-          # => nil inherits from ApplicationController
-          # => 4xx errors should be nil
-          # => 5xx errors should be "exception" but can be nil if explicitly defined
-          500 => "exception",
-          501 => "exception",
-          502 => "exception",
-          503 => "exception",
-          504 => "exception",
-          505 => "exception",
-          507 => "exception",
-          510 => "exception"
-        }
-      }
-
-    ###########################################
-    ###########################################
-
-      # => Init
+      DEFAULTS =
+        ActiveSupport::HashWithIndifferentAccess.new({
+
+          # => General options
+          dev:    nil, # => defaults to "false" for dev mode
+          db:     nil, # => defaults to :errors if true, else use "table_name" / :table_name
+          email: 	nil, # => requires string email and ActionMailer
+
+          # => Used in "exception" layout
+          social: {
+            facebook: nil,
+            twitter:  nil,
+            youtube:  nil,
+            linkedin: nil,
+            fusion:   nil,
+          },
+
+          # => Defaults for exceptions. Override with specific status codes
+          # => Please note these are all STRINGS
+          exceptions: {
+
+            # => 4xx/5xx base standard
+            # => :all provide block customization (overrides 4xx/5xx)
+            # => specific provides individual (overrides all)
+
+            # => 4xx Errors (resource not found)
+            # => https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_Client_errors
+            '4xx' => {
+              layout: nil
+              # notification: true #(this is for emails - it's true by default - only if you have email inputted)
+              # action: ____, (this is general)
+              # background: (can define custom background for exceptions layout if required)
+            },
+
+            # => 5xx Errors (server error)
+            # => https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#5xx_Server_errors
+            '5xx' => {
+              layout: 'exception'
+              # notification: true (this is for emails - it's true by default - only if you have email inputted)
+              # action: _____, (this is general)
+              # background: (can define custom background for exceptions layout if required)
+            }
+          },
+
+          # Deprecated
+          #layouts: {
+            # => nil inherits from ApplicationController
+            # => 4xx errors should be nil
+            # => 5xx errors should be "exception" but can be nil if explicitly defined
+            #500 => 'exception',
+            #501 => 'exception',
+            #502 => 'exception',
+            #503 => 'exception',
+            #504 => 'exception',
+            #505 => 'exception',
+            #507 => 'exception',
+            #510 => 'exception'
+          #},
+
+          # => If you want to map your own classes to HTTP errors
+          # => use this...
+          custom_exceptions: {
+            #'ActionController::RoutingError' => :not_found # => example
+          }
+
+        })
+
+    ###########################################
+    ###########################################
+
+      # => Constructor
       # => Merges DEFAULTS to values, creates instances vars (for attr_accessor)
       def initialize values
 
@@ -107,6 +153,29 @@ module ExceptionHandler
         @db == true ? TABLE : @db.try(:parameterize, separator: "_")
       end
 
+    ###########################################
+    ###########################################
+
+      # => Options
+      # => Requires argument
+      def options status, pluck=nil
+
+        # => Structure from old + new setup
+        # => 1. layouts    => [500, '500']
+        # => 2. exceptions => [500, '500' 'all', '4xx'/'5xx']
+        { layouts:    [status, status.to_s], # old + new
+          exceptions: [status, status.to_s, 'all', status.to_s.first + 'xx'] }.each do |key,array|
+
+          # => Array
+          # => https://stackoverflow.com/a/26877095/1143732
+          array.each do |specific|
+            item = self.send(key).try(:[], specific)
+            return (item.is_a?(Hash) ? ActiveSupport::HashWithIndifferentAccess.new(item)[pluck.try(:to_sym)] : item) if item.present? || (self.send(key).try(:has_key?, specific) && item.nil?) #if result exists and it has a value (including nil)
+          end
+
+        end
+      end
+
     ###########################################
     ###########################################
     ###########################################