exception_handler 0.6.5 → 0.7.0

data/config/locales/exception_handler.en.yml

@@ -1,13 +1,13 @@
-##################################
-##################################
-# Have to use strings rather than integers
-##################################
-##################################
-
-en:
-  exception:
-    not_found:              "Page missing"
-    internal_server_error:  "<strong>Our server experienced an error. Our developers have been notified and are resolving it:</strong>  %{message}"
-
-##################################
-##################################
+##################################
+##################################
+# Have to use strings rather than integers
+##################################
+##################################
+
+en:
+  exception:
+    not_found:              "Page missing"
+    internal_server_error:  "<strong>%{status} Error</strong>  %{message} <p>Return home</p>"
+
+##################################
+##################################

data/exception_handler.gemspec

@@ -1,84 +1,80 @@
-# Dependencies
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-##############################################################
-##############################################################
-
-# => Version
-# => https://github.com/rails/rails/blob/master/version.rb
-module ExceptionHandler
-  module VERSION
-    MAJOR = 0
-    MINOR = 6
-    TINY  = 5
-    PRE   = nil # "alpha"
-
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
-  end
-end
-
-# => Declaration
-# => https://github.com/rails/rails/blob/master/rails.gemspec#L1
-version = ExceptionHandler::VERSION::STRING
-
-##############################################################
-##############################################################
-
-# => Gem
-Gem::Specification.new do |s|
-
-  ##############################################################
-
-  # => General
-  s.platform      = Gem::Platform::RUBY
-  s.name          = "exception_handler"
-  s.version       = version
-
-  # => Author
-  s.authors       = ["Richard Peck"]
-  s.email         = ["rpeck@frontlineutilities.co.uk"]
-
-  # => 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      = "http://github.com/richpeck/exception_handler"
-
-  # => License
-  s.license       = "MIT"
-
-  ##############################################################
-
-  # => Files
-  # => Remove "readme" dir from gem
-  s.files         = `git ls-files -z`.split("\x0")
-  s.files.reject! { |fn| fn.include? "readme" } #-> https://github.com/gauntlt/gauntlt/blob/master/gauntlt.gemspec#L16
-
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/}) unless RUBY_VERSION >= "2.2.0" #-> deprecated in Ruby 2.2.0
-  s.require_paths = ["lib"]
-
-  ##############################################################
-
-  # => Ruby
-  s.required_ruby_version = ">= 2.1.0"
-
-  # => Runtime
-  s.add_dependency "bundler",    "~> 1.6"
-  s.add_dependency "rails",      ">= 4.2.0"
-  s.add_dependency "responders", "~> 2.3"
-
-  # => Extras
-  s.add_development_dependency "autoprefixer-rails"
-
-  # => Dev
-  # => For testing etc
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "sqlite3",     ">= 1.3.10"
-
-##############################################################
-##############################################################
-
-end
+# Dependencies
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+##############################################################
+##############################################################
+
+# => Version
+# => https://github.com/rails/rails/blob/master/version.rb
+module ExceptionHandler
+  module VERSION
+    MAJOR = 0
+    MINOR = 7
+    TINY  = 0
+    PRE   = nil # "alpha"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end
+
+##############################################################
+##############################################################
+
+# => Gem
+Gem::Specification.new do |s|
+
+  ##############################################################
+
+  # => General
+  s.platform      = Gem::Platform::RUBY
+  s.name          = "exception_handler"
+  s.version       = ExceptionHandler::VERSION::STRING
+
+  # => Author
+  s.authors       = ["Richard Peck"]
+  s.email         = ["rpeck@frontlineutilities.co.uk"]
+
+  # => 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      = "http://github.com/richpeck/exception_handler"
+
+  # => License
+  s.license       = "MIT"
+
+  ##############################################################
+
+  # => Files
+  # => Remove "readme" dir from gem
+  s.files         = `git ls-files -z`.split("\x0")
+  s.files.reject! { |fn| fn.include? "readme" } #-> https://github.com/gauntlt/gauntlt/blob/master/gauntlt.gemspec#L16
+
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/}) unless RUBY_VERSION >= "2.2.0" #-> deprecated in Ruby 2.2.0
+  s.require_paths = ["lib"]
+
+  ##############################################################
+
+  # => Ruby
+  s.required_ruby_version = ">= 2.1.0"
+
+  # => Runtime
+  s.add_dependency "bundler",    "~> 1.6"
+  s.add_dependency "rails",      ">= 4.2.0"
+  s.add_dependency "responders"
+
+  # => Extras
+  s.add_development_dependency "autoprefixer-rails"
+
+  # => Dev
+  # => For testing etc
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3", ">= 1.3.10"
+
+##############################################################
+##############################################################
+
+end

data/lib/exception_handler.rb

@@ -1,29 +1,32 @@
-#########################################################
-#########################################################
-
-module ExceptionHandler
-
-  # => Table Prefix
-  # => Keeps Rails Engine from generating all table prefixes with the engines name
-  # => http://stackoverflow.com/questions/19435214/rails-mountable-engine-with-isolate-namespace-but-without-prefixed-namespace-on
-  def self.table_name_prefix
-    # => No prefix
-  end
-
-  # => Config
-  # => Invoke instance of config (ExceptionHandler.config)
-  mattr_accessor :config
-
-end
-
-#########################################################
-#########################################################
-
-# => Libs
-# => http://stackoverflow.com/a/4528011/1143732
-# => http://stackoverflow.com/a/21693468/1143732
-# => https://github.com/jekyll/jekyll/blob/master/lib/jekyll.rb#L8
-Dir.glob(File.join(File.dirname(__FILE__), 'exception_handler', '**/*.rb'), &method(:require))
-
-#########################################################
-#########################################################
+#########################################################
+#########################################################
+
+module ExceptionHandler
+
+  # => Table Prefix
+  # => Keeps Rails Engine from generating all table prefixes with the engines name
+  # => http://stackoverflow.com/questions/19435214/rails-mountable-engine-with-isolate-namespace-but-without-prefixed-namespace-on
+  def self.table_name_prefix
+    # => No prefix
+  end
+
+  # => Config
+  # => Invoke instance of config (ExceptionHandler.config)
+  mattr_accessor :config
+
+end
+
+#########################################################
+#########################################################
+
+# => Libs
+# => http://stackoverflow.com/a/4528011/1143732
+# => http://stackoverflow.com/a/21693468/1143732
+# => https://github.com/jekyll/jekyll/blob/master/lib/jekyll.rb#L8
+Dir.glob(File.join(File.dirname(__FILE__), 'exception_handler', '**/*.rb'), &method(:require))
+
+# => External Dependencies
+require 'responders'
+
+#########################################################
+#########################################################

data/lib/exception_handler/config.rb

@@ -1,66 +1,80 @@
-###########################################
-
-# 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
-    attr_accessor :dev, :db, :email, :social, :layouts
-
-    ###########################################
-
-      #Init
-      def initialize values=nil
-        defaults = values.present? ? Config::DEFAULTS.deep_merge!(values) : DEFAULTS
-        defaults.each do |k,v|
-          instance_variable_set("@#{k}",v) #-> http://apidock.com/ruby/Object/instance_variable_set
-        end
-
-        # => Errors
-        raise(Exception, "ExceptionHandler :: Valid Email Required") if @email && !@email.is_a?(String)
-        #raise(Exception, "ExceptionHandler :: Migration Required → Table \"#{db}\" doesn't exist") if @db && !ActiveRecord::Base.connection.table_exists?(db)
-      end
-
-    ###########################################
-
-      # Public (Instance) Methods #
-
-      #DB
-      def db
-        @db == true ? TABLE_NAME : @db
-      end
-
-    ###########################################
-
-      #Default Table Name
-      # Has to be "errors" because "exceptions" is a reserved word
-      TABLE_NAME = :errors
-
-      # Defaults
-      # http://stackoverflow.com/a/8917301/1143732
-      DEFAULTS = {
-        dev:    false, #-> defaults to "false" for dev mode
-        db:     false, #-> defaults to :errors if true, else use "table_name" / :table_name
-        email: 	false, #-> requires string email and ActionMailer
-        social: {
-          facebook: { name: "frontline.utilities", url: "https://facebook.com" },
-          twitter:  { name: "frontlineutils",      url: "http://twitter.com" },
-          youtube:  { name: "frontlineutils",      url: "https://youtube.com/user" },
-          linkedin: { name: "frontline-utilities", url: "https://linkedin.com/company" },
-          fusion:   { name: "flutils",             url: "https://frontlinefusion.com" }
-        },
-        layouts: {
-          "400" => nil, # => inherits from "ApplicationController" layout
-          "500" => "exception"
-        },
-      }
-
-    ###########################################
-
-  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
+    attr_accessor :dev, :db, :email, :social, :layouts
+
+    ###########################################
+    ###########################################
+
+    # 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:  "http://twitter.com",
+      youtube:  "https://youtube.com/user",
+      linkedin: "https://linkedin.com/company",
+      fusion:   "http://frontlinefusion.com"
+    }
+
+    ###########################################
+    ###########################################
+
+    # Defaults
+    # http://stackoverflow.com/a/8917301/1143732
+    DEFAULTS = {
+      dev:    false, #-> defaults to "false" for dev mode
+      db:     false, #-> defaults to :errors if true, else use "table_name" / :table_name
+      email: 	false, #-> requires string email and ActionMailer
+      social: {
+        facebook: nil,
+        twitter:  nil,
+        youtube:  nil,
+        linkedin: nil,
+        fusion:   nil,
+      },
+      layouts: {
+        "400" => nil, # => inherits from "ApplicationController" layout
+        "500" => "exception"
+      },
+    }
+
+    ###########################################
+    ###########################################
+
+      #Init
+      def initialize values
+        # => Vars
+        DEFAULTS.deep_merge!(values || {}).each do |k,v|
+          instance_variable_set("@#{k}",v)
+        end
+
+        # => Errors
+        raise(Exception, "ExceptionHandler :: Valid Email Required") if @email && !@email.is_a?(String)
+        #raise(Exception, "ExceptionHandler :: Migration Required → Table \"#{db}\" doesn't exist") if @db && !ActiveRecord::Base.connection.table_exists?(db)
+      end
+
+    ###########################################
+    ###########################################
+
+      def db
+        @db == true ? TABLE : @db
+      end
+
+    ###########################################
+    ###########################################
+
+  end
+end

data/lib/exception_handler/engine.rb

@@ -1,36 +1,44 @@
-module ExceptionHandler
-  class Engine < Rails::Engine
-
-    #########################################################
-    #########################################################
-
-      # => 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 << %w(exception_handler.css)
-
-    #########################################################
-    #########################################################
-
-      # => Hooks
-      # => 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|
-        ExceptionHandler.config ||= ExceptionHandler::Config.new config.try(:exception_handler)                       # => Vars
-        app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) }         # => Rails
-        app.config.consider_all_requests_local = false if Rails.env.development? && ExceptionHandler.config.try(:dev) # => Dev
-      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 << %w(exception_handler.css)
+
+    #########################################################
+    #########################################################
+
+      # => Hooks
+      # => 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|
+
+        # => Vars
+        ExceptionHandler.config ||= ExceptionHandler::Config.new config.try(:exception_handler)
+
+        # => Middleware
+        app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) }
+        app.config.consider_all_requests_local = !ExceptionHandler.config.try(:dev) if Rails.env.development?
+
+      end
+
+    #########################################################
+    #########################################################
+
+  end
+end