exception_handler 0.7.5 → 0.8.0.1

data/lib/exception_handler/config.rb

@@ -1,103 +1,185 @@
-###########################################
-
-# Refs
-# http://stackoverflow.com/questions/10584638/setting-up-configuration-settings-when-writing-a-gem
-# http://robots.thoughtbot.com/mygem-configure-block
-
-###########################################
-
-module ExceptionHandler
-  class Config
-
-    # => Instace Objects
-    # => ExceptionHandler.config.dev
-    # => ExceptionHandler.config.db
-    # => ExceptionHandler.config.email
-    # => ExceptionHandler.config.social
-    # => ExceptionHandler.config.layouts
-    # => ExceptionHandler.config.custom_exceptions
-    attr_accessor :dev, :db, :email, :social, :layouts, :custom_exceptions
-
-    ###########################################
-    ###########################################
-    ###########################################
-    ###########################################
-
-      # => Table Name
-      # => 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"
-      }
-
-    ###########################################
-    ###########################################
-
-      # => 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
-      # => Merges DEFAULTS to values, creates instances vars (for attr_accessor)
-      def initialize values
-
-        # => Vars
-        DEFAULTS.deep_merge!(values || {}).each do |k,v|
-          instance_variable_set("@#{k}",v)
-        end
-
-        # => Validation
-        raise ExceptionHandler::Error, "Email Not Valid" if @email && !@email.nil? && !@email.is_a?(String)
-        raise ExceptionHandler::Error, "Migration Required → \"#{db}\" doesn't exist" if @db && !ActiveRecord::Base.connection.table_exists?(db)
-      end
-
-    ###########################################
-    ###########################################
-
-      # => DB
-      # => If config db = "true", use TABLE constant
-      def db
-        @db == true ? TABLE : @db.try(:parameterize, separator: "_")
-      end
-
-    ###########################################
-    ###########################################
-    ###########################################
-    ###########################################
-
-  end
-end
+###########################################
+###########################################
+##     _____              __ _           ##
+##    /  __ \            / _(_)          ##
+##    | /  \/ ___  _ __ | |_ _  __ _     ##
+##    | |    / _ \| '_ \|  _| |/ _` |    ##
+##    | \__/\ (_) | | | | | | | (_| |    ##
+##    \____/\___/|_| |_|_| |_|\__,  |    ##
+##                             __/  |    ##
+##                             |___/     ##
+###########################################
+###########################################
+
+# Refs
+# http://stackoverflow.com/questions/10584638/setting-up-configuration-settings-when-writing-a-gem
+# http://robots.thoughtbot.com/mygem-configure-block
+
+###########################################
+###########################################
+
+module ExceptionHandler
+  class Config
+
+    # => Instace Objects
+    # => ExceptionHandler.config.dev
+    # => ExceptionHandler.config.db
+    # => ExceptionHandler.config.email
+    # => ExceptionHandler.config.social
+    # => ExceptionHandler.config.layouts -> will need to be deprecated
+    # => ExceptionHandler.config.exceptions
+    # => ExceptionHandler.config.custom_exceptions
+    attr_accessor :dev, :db, :email, :social, :layouts, :exceptions, :custom_exceptions
+
+    ###########################################
+    ###########################################
+    ###########################################
+    ###########################################
+
+      # => Table Name
+      # => Has to be "errors" because "exceptions" is a reserved word
+      TABLE = :errors
+
+    ###########################################
+    ###########################################
+
+      # => Social URLs
+      # => Extracted from "social" block
+      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 =
+        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
+
+        # => Vars
+        DEFAULTS.deep_merge!(values || {}).each do |k,v|
+          instance_variable_set("@#{k}",v)
+        end
+
+        # => Validation
+        raise ExceptionHandler::Error, "Email Not Valid" if @email && !@email.nil? && !@email.is_a?(String)
+        raise ExceptionHandler::Error, "Migration Required → \"#{db}\" doesn't exist" if @db && !ActiveRecord::Base.connection.table_exists?(db) && (File.basename($0) != "rake" && !ARGV.include?("db:migrate"))
+
+      end
+
+    ###########################################
+    ###########################################
+
+      # => DB
+      # => If config db = "true", use TABLE constant
+      def db
+        @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
+
+    ###########################################
+    ###########################################
+    ###########################################
+    ###########################################
+
+  end
+end

data/lib/exception_handler/engine.rb

@@ -1,60 +1,78 @@
-module ExceptionHandler
-  class Engine < Rails::Engine
-
-    # => Rails default MIME types:
-    # => http://apidock.com/rails/ActionController/MimeResponds/InstanceMethods/respond_to#14-Rails-defined-Mime-Types
-
-    #########################################################
-    #########################################################
-    #########################################################
-    #########################################################
-
-      # => Wraps helpers in ExceptionHandler module
-      # => http://guides.rubyonrails.org/engines.html#inside-an-engine
-      # => http://stackoverflow.com/questions/31877839/accessing-helpers-from-the-parent-app-in-an-isolated-rails-engine
-      isolate_namespace ExceptionHandler
-
-      # => Tests
-      config.generators do |g|
-        g.test_framework :rspec
-      end
-
-      # => Assets
-      # => For Sprockets 4, had to include link_tree in exception_handler.css
-      config.assets.precompile << "exception_handler.css"
-
-    #########################################################
-    #########################################################
-
-      # => Config
-      # => Builds lib/exception_handler/config.rb
-      config.before_initialize do |app|
-        ExceptionHandler.config ||= ExceptionHandler::Config.new config.try(:exception_handler)
-      end
-
-    #########################################################
-    #########################################################
-
-      # => Middleware
-      # => This should be config.before_initialize but because ActiveRecord is not initialized, cannot check for table
-      initializer :exception_handler, before: "better_errors.configure_rails_initialization" do |app|
-        app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionsController.action(:show).call(env) }
-        app.config.consider_all_requests_local = !ExceptionHandler.config.try(:dev) if Rails.env.development?
-      end
-
-      # => Migrations
-      # => This has to be kept in an initializer (to access app)
-      # => https://blog.pivotal.io/labs/labs/leave-your-migrations-in-your-rails-engines
-      initializer :migration_paths do |app|
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path if ExceptionHandler.config.try(:db)
-        end
-      end
-
-    #########################################################
-    #########################################################
-    #########################################################
-    #########################################################
-
-  end
-end
+###########################################
+###########################################
+##     _____            _                ##
+##    |  ___|          (_)               ##
+##    | |__ _ __   __ _ _ _ __   ___     ##
+##    |  __| '_ \ / _` | | '_ \ / _ \    ##
+##    | |__| | | | (_| | | | | |  __/    ##
+##    \____/_| |_|\__, |_|_| |_|\___|    ##
+##                 __/ |                 ##
+##                |___/                  ##
+###########################################
+###########################################
+
+module ExceptionHandler
+  class Engine < Rails::Engine
+
+    # => Rails default MIME types:
+    # => http://apidock.com/rails/ActionController/MimeResponds/InstanceMethods/respond_to#14-Rails-defined-Mime-Types
+
+    #########################################################
+    #########################################################
+
+      # => Wraps helpers in ExceptionHandler module
+      # => http://guides.rubyonrails.org/engines.html#inside-an-engine
+      # => http://stackoverflow.com/questions/31877839/accessing-helpers-from-the-parent-app-in-an-isolated-rails-engine
+      isolate_namespace ExceptionHandler
+
+      # => Tests
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+
+      # => Assets
+      # => For Sprockets 4, had to include link_tree in exception_handler.css
+      config.assets.precompile << "exception_handler.css"
+
+    #########################################################
+    #########################################################
+
+      # => Config
+      # => Builds lib/exception_handler/config.rb
+      # => config.before_initialize do |app| => Needs to be fixed for ActiveRecord::Base
+      # => to support later version of config, "with_indifferent_access" used in config.rb
+      initializer :exception_handler_config, before: "better_errors.configure_rails_initialization" do |app|
+        ExceptionHandler.config ||= ExceptionHandler::Config.new config.try(:exception_handler)
+      end
+
+    #########################################################
+    #########################################################
+
+      # => Middleware
+      # => This should be config.before_initialize but because ActiveRecord is not initialized, cannot check for table
+      initializer :exception_handler, before: "better_errors.configure_rails_initialization" do |app|
+        app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionsController.action(:show).call(env) }
+        app.config.consider_all_requests_local = !ExceptionHandler.config.try(:dev) if Rails.env.development? || Rails.env.test?
+      end
+
+      # => Custom Exceptions
+      # => This just mimicks standard Rails behaviour
+      # => Look for "config.action_dispatch.rescue_responses" for more info)
+      initializer :exception_handler_custom_exceptions do |app|
+        app.config.action_dispatch.rescue_responses.merge! ExceptionHandler.config.custom_exceptions if ExceptionHandler.config.custom_exceptions
+      end
+
+      # => Migrations
+      # => This has to be kept in an initializer (to access app)
+      # => https://blog.pivotal.io/labs/labs/leave-your-migrations-in-your-rails-engines
+      initializer :migration_paths do |app|
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path if ExceptionHandler.config.try(:db)
+        end
+      end
+
+    #########################################################
+    #########################################################
+
+  end
+end

data/lib/exception_handler/version.rb

@@ -0,0 +1,25 @@
+###########################################
+###########################################
+##   _   _               _               ##
+##  | | | |             (_)              ##
+##  | | | | ___ _ __ ___ _  ___  _ __    ##
+##  | | | |/ _ \ '__/ __| |/ _ \| '_ \   ##
+##  \ \_/ /  __/ |  \__ \ | (_) | | | |  ##
+##   \___/ \___|_|  |___/_|\___/|_| |_|  ##
+##                                       ##
+###########################################
+###########################################
+
+module ExceptionHandler
+  module VERSION
+    MAJOR = 0
+    MINOR = 8
+    TINY  = 0
+    PRE   = 1 # "alpha"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end
+
+###########################################
+###########################################