exception_handler 0.4.7 → 0.5.1

data/app/controllers/exception_handler/exception_controller.rb

@@ -2,34 +2,26 @@ module ExceptionHandler
   class ExceptionController < ApplicationController
 
     #Response
+    #http://www.justinweiss.com/articles/respond-to-without-all-the-pain/
     respond_to :html, :xml, :json
 
-  	#Dependencies
-  	before_action :status, :app_details
-
     #Layout
-    layout :layout_status
+    layout :layout
 
     #Helpers
-    helper ExceptionHandler::ApplicationHelper   #-> HELPERS http://stackoverflow.com/questions/9809787/why-is-my-rails-mountable-engine-not-loading-helper-methods-correctly
+    helper ExceptionHandler::Engine.helpers      #-> HELPERS http://stackoverflow.com/questions/9809787/why-is-my-rails-mountable-engine-not-loading-helper-methods-correctly
     include Rails.application.routes.url_helpers #-> ROUTES http://stackoverflow.com/a/6074911/1143732
 
     ####################
     #      Action      #
     ####################
 
-  	#Show
+    #Show
+    #Amend responses in tests
+    #Need to test validity of JSON responses etc
     def show
-      @layout = self.send(:_layout)
-      @message = (/^(5[0-9]{2})$/ !~ @status.to_s) ? "Sorry, this page is missing" : details[:message]
-
-      ## Config "404 block" handler ##
-      if /^(5[0-9]{2})$/ !~ @status.to_s && ExceptionHandler.config.layouts["404"] #-> http://www.justskins.com/forums/ruby-s-regexp-is-52846.html
-        eval ExceptionHandler.config.layouts["404"]
-      else
-        ## Render (if eval do anything) ##
-        render status: @status
-      end
+      @exception = ExceptionHandler::Exception.new request #-> Service Object
+      render status: @exception.status #-> Show apppropriate response
     end
 
     ####################
@@ -38,23 +30,8 @@ module ExceptionHandler
 
     protected
 
-    #Info
-    def status
-      @exception  = env['action_dispatch.exception']
-      @status     = ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
-      @response   = ActionDispatch::ExceptionWrapper.rescue_responses[@exception.class.name]
-    end
-
-    #Format
-    def details
-      @details ||= {}.tap do |h|
-        I18n.with_options scope: [:exception, :show, @response], exception_name: @exception.class.name, exception_message: @exception.message do |i18n|
-          h[:name]    = i18n.t "#{@exception.class.name.underscore}.title", default: i18n.t(:title, default: @exception.class.name)
-          h[:message] = i18n.t "#{@exception.class.name.underscore}.description", default: i18n.t(:description, default: @exception.message)
-        end
-      end
-    end
-    helper_method :details
+    # Status declarations moved to "show" w/ service object
+    # Details moved to "View Helper"
 
     ####################
     #      Layout      #
@@ -63,19 +40,11 @@ module ExceptionHandler
     private
 
     #Layout
-    def layout_status
-      case  @status
-        when 404
-          ExceptionHandler.config.layouts["400"] || nil #-> inherits ApplicationController layout
-        else
-          ExceptionHandler.config.layouts["500"] #-> should pull default if none sepecified
-      end     
+    def layout
+      (/^(5[0-9]{2})$/ !~ @exception.code.to_s) ? (ExceptionHandler.config.layouts["400"] || nil) : ExceptionHandler.config.layouts["500"] #-> if not 500, use predefined layout
     end
 
-    #App
-    def app_details
-      @app_name = Rails.application.class.parent_name
-    end
+    ####################
 
   end
 end

data/app/helpers/exception_handler/application_helper.rb

@@ -1,32 +1,56 @@
 module ExceptionHandler
-	module ApplicationHelper
+  module ApplicationHelper
 
-		#Refs
-		#http://stackoverflow.com/a/5795683/1143732
-		#http://stackoverflow.com/questions/8028021/helpers-in-rails-engine
-		#ActiveSupport.on_load( :action_view ){ include ExceptionHandler::ViewHelpers }
+    ##################
 
-		#Social
-		def social *services
-			output = []
-			# options = args.extract_options! http://simonecarletti.com/blog/2009/09/inside-ruby-on-rails-extract_options-from-arrays/ - args for hash
+    #Refs
+    #http://stackoverflow.com/a/5795683/1143732
+    #http://stackoverflow.com/questions/8028021/helpers-in-rails-engine
+    #ActiveSupport.on_load( :action_view ){ include ExceptionHandler::ViewHelpers }
 
-			services = ExceptionHandler.config.social unless services.any? #-> http://api.rubyonrails.org/classes/Hash.html#method-i-compact
-			services.except(:url).compact.each do |service,username| #-> except http://stackoverflow.com/a/11105831/1143732
-    			output.push link_to(image_tag("exception_handler/connect/#{service}.png", title: "Find us on " + service.to_s.titleize), link(service), target: :blank, class: service.to_s)
-    		end
+    ##################
 
-    		output.join("").html_safe #-> ruby returns last line
-		end
+      #App (Application name)
+      def app
+        Rails.application.class.parent_name
+      end
 
-		private
+      #Details
+      def details
+        @details ||= {}.tap do |h|
+          I18n.with_options scope: [:exception, :show, @exception.response], message: @exception.message do |i18n|
+            h[:name]        = i18n.t "#{@exception.class.name.underscore}.title",       default: i18n.t(:title,       default: @exception.class.name)
+            h[:description] = i18n.t "#{@exception.class.name.underscore}.description", default: i18n.t(:description, default: @exception.message)
+          end
+        end
+      end
 
-		def link service #-> bloated way to allow single references in config
-			url = []
-			url.push ExceptionHandler.config.social[:url][service]
-			url.push ExceptionHandler.config.social[service]
-			url.join("/")
-		end
+      #Social
+      def social *services
+        output = []
+        # options = args.extract_options! http://simonecarletti.com/blog/2009/09/inside-ruby-on-rails-extract_options-from-arrays/ - args for hash
 
-	end
+        services = ExceptionHandler.config.social unless services.any? #-> http://api.rubyonrails.org/classes/Hash.html#method-i-compact
+        services.except(:url).compact.each do |service,username| #-> except http://stackoverflow.com/a/11105831/1143732
+          output.push link_to(image_tag("exception_handler/connect/#{service}.png", title: "Find us on " + service.to_s.titleize), link(service), target: :blank, class: service.to_s)
+        end
+
+        output.join("").html_safe #-> ruby returns last line
+      end
+
+
+    ##################
+
+      private
+
+      def link service #-> bloated way to allow single references in config
+        url = []
+        url.push ExceptionHandler.config.social[:url][service]
+        url.push ExceptionHandler.config.social[service]
+        url.join("/")
+      end
+
+    ##################
+
+  end
 end

data/app/models/exception_handler/error.rb

@@ -1,13 +1,14 @@
 module ExceptionHandler
-	class Error < ActiveRecord::Base
-		#Table is called "errors"
-		#Dev needs to use migration to create db
-		def self.table_name
-			ExceptionHandler.config.db
-		end
+  class Error < ActiveRecord::Base
 
-		#Associations
-		belongs_to :usable, polymorphic: true
+    #Table is called "errors"
+    #Dev needs to use migration to create db
+    def self.table_name
+      ExceptionHandler.config.db
+    end
 
-	end
+    #Associations
+    belongs_to :usable, polymorphic: true
+
+  end
 end

data/app/services/exception_handler/exception.rb

@@ -0,0 +1,34 @@
+module ExceptionHandler
+  class Exception #-> https://www.netguru.co/blog/service-objects-in-rails-will-help
+    attr_reader :exception, :request, :class, :message
+
+    ######################
+
+    def initialize request
+      @request   = request
+      @exception = request.env['action_dispatch.exception']
+
+      @class     = @exception.class
+      @message   = @exception.message
+    end
+
+    ######################
+
+    # Status code (404, 500 etc)
+    def code
+      ActionDispatch::ExceptionWrapper.new(@request.env, @exception).status_code
+    end
+
+    # Server Response ("Not Found" etc)
+    def response
+      ActionDispatch::ExceptionWrapper.rescue_responses[@exception.class.name]
+    end
+
+    ######################
+
+    alias_method :status, :code #-> http://stackoverflow.com/a/11848832/1143732 (has to be below methods)
+
+    ######################
+
+  end
+end

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

@@ -1,29 +1,32 @@
 <div class="error">
-	<% if /^(5[0-9]{2})$/ =~ @status.to_s %>
+	<% if /^(5[0-9]{2})$/ =~ @exception.status.to_s %>
 
 		<!--Message -->
 		<%= content_tag :div, class: "message" do %>
 			<%= content_tag :div, class: "title" do %>
-				<span><%= "#{@status} Error - #{details[:name]}" %></span>
+				<span><%= "#{@exception.status} Error - #{details[:name]}" %></span>
 				<%= link_to image_tag("exception_handler/close.png"), main_app.root_url, title: "Close (Go back home)", class: "close" %>
 			<% end %>
+
 			<%= content_tag :div, class: "details" do %>
-				<%= image_tag "exception_handler/alert.png", title: "#{@status} Error" %>
-				<div class="status"><%= @status %> Error</div>
+				<%= image_tag "exception_handler/alert.png", title: "#{@exception.status} Error" %>
+				<div class="status"><%= @exception.status %> Error</div>
 			<% end %>
+
 			<%= content_tag :div, class: "info" do %>
-				<span><%= @message %></span>
+				<span><%= details[:description] %></span>
 				<div class="notification">
 					<%= link_to image_tag("exception_handler/home.png", title: "Go Back Home"), main_app.root_url, class: "home" %>
 					<div class="version">v<%= Rails.version %></div>
 					<strong>Our developers have been notified - we're working on it!</strong>
 				</div>
 			<% end %>
+			
 		<% end %>
 
 	<% else %>
 
-		<%= content_tag :div, @message, class: "message" %>
+		<%= content_tag :div, details[:description], class: "message" %>
 			
 	<% end %>
 </div>

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

@@ -3,7 +3,7 @@
   <head>
 
     <!--Info -->
-    <title><%= "Code #{@status} (#{details[:name]}) | #{@app_name.upcase}" %></title>
+    <title><%= "Error - #{@exception.status} Error (#{details[:name]})" %></title>
     <%= stylesheet_link_tag "exception_handler/error" %>
 
   </head>
@@ -20,8 +20,8 @@
     		<%= social %>
     	</div>
     	<div class="app">
-    		<strong><%= link_to @app_name, main_app.root_url, title: "Go to index" %></strong>
-    		<span> - <%= @status %> Error</span>
+    		<strong><%= link_to app, main_app.root_url, title: "Go to index" %></strong>
+    		<span> - <%= @exception.status %> Error</span>
     	</div>
     </footer>
 

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  exception:
+    show:
+      not_found:
+        title:       "Not Found"
+        description: "Sorry, this page is missing."
+      internal_server_error:
+        title:       "Internal Server Error"
+        description: "Sorry, the server failed with the error: %{message}"

data/exception_handler.gemspec

@@ -4,26 +4,36 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'exception_handler/version'
 
 Gem::Specification.new do |s|
+
+  # General
   s.name          = "exception_handler"
   s.version       = ExceptionHandler::VERSION
-  s.authors       = ["Richard Peck", "Joe Hilton"]
-  s.email         = ["rpeck@frontlineutilities.co.uk", "jhilton@frontlineutilities.co.uk"]
-  s.summary       = %q{Rails gem to show custom error pages in production. Also logs errors in "errors" db if required}
+  s.authors       = ["Richard Peck"]
+  s.email         = ["rpeck@frontlineutilities.co.uk"]
+  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://frontlineutilities.co.uk/ror/custom_error_pages"
+  s.homepage      = "http://github.com/richpeck/exception_handler"
   s.license       = "MIT"
 
+  # Files
   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)/})
+  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"]
 
+  # Options
   s.post_install_message = File.read(File.join(File.dirname(__FILE__), 'post_install_message.md')) #-> https://github.com/jarrett/ichiban/blob/master/ichiban.gemspec#L35
 
+  # dev Dependencies
   s.add_development_dependency "bundler", "~> 1.6"
   s.add_development_dependency "rails", "~> 4.0.0"
   s.add_development_dependency "activerecord"
   s.add_development_dependency "activesupport"  
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", "~> 3.3"
+  s.add_development_dependency "rspec-rails", "~> 3.3"
+  s.add_development_dependency "sqlite3", "~> 1.3.10"
+
 end

data/lib/exception_handler.rb

@@ -13,41 +13,76 @@ Dir.glob(File.join(File.dirname(__FILE__), "exception_handler", '**/*.rb'), &met
 
 module ExceptionHandler
 
-	#Version
-	autoload :VERSION, 'exception_handler/version'
+  #Config
+  #Invoke instance of config (ExceptionHandler.config) -- loads defaults -- can merge through class
+  mattr_accessor :config
 
-	#Config
-	#Invoke instance of config -- loads defaults
-	mattr_accessor :config
+  #Default (has to init so is available in all areas)
+  @@config = "" #-> should initialize class & then append in initializer
 
-	# Don't have prefix method return anything.
+  # Class methods
+  class << self
+    # Don't have prefix method return anything.
     # This will keep 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
+    def table_name_prefix
+      #No prefix
     end
+  end
 
-	#Exception Handler
-	class Exceptions < Rails::Engine
-		#Keep helpers in your engine
-		#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
-		#use main_app to call "main app" helpers etc http://stackoverflow.com/a/9178022/1143732 + http://edgeapi.rubyonrails.org/classes/Rails/Engine.html#class-Rails::Engine-label-Using+Engine-27s+routes+outside+Engine
-		isolate_namespace ExceptionHandler
-
-		#Stylesheet
-		config.assets.precompile += %w(exception_handler/error.css) 
-
-		#Hook
-		initializer "exception_handler.configure_rails_initialization" do |app|
-			
-			#Options
-			ExceptionHandler.config = ExceptionHandler::Config.new(app.config.respond_to?(:exception_handler) ? app.config.exception_handler : nil)
-
-			#Middleware
-			app.config.middleware.use ExceptionHandler::Parse if ExceptionHandler.config.db # && ActiveRecord::Base.connection.table_exists?(:errors unless @@config[:db].blank?)  #DB
-			app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) } #Controller	
-		end
-
-	end
-end
+  #########################
+
+  #Exception Handler
+  class Engine < Rails::Engine
+    #Keep helpers in your engine
+    #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
+    #use main_app to call "main app" helpers etc http://stackoverflow.com/a/9178022/1143732 + http://edgeapi.rubyonrails.org/classes/Rails/Engine.html#class-Rails::Engine-label-Using+Engine-27s+routes+outside+Engine
+    isolate_namespace ExceptionHandler
+
+    #Tests (generates dummy Rails app)
+    #http://stackoverflow.com/q/32082637/1143732 (ref in question)
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    #Assets
+    config.assets.precompile << %w(exception_handler/**)
+
+    #Config
+    config.before_initialize do |app|
+      ExceptionHandler.config = ExceptionHandler::Config.new app.config.try(:exception_handler) #-> Var
+    end
+
+    #Boot order:
+    #http://api.rubyonrails.org/classes/Rails/Application.html#class-Rails::Application-label-Booting+process
+    #1)  require "config/boot.rb" to setup load paths
+    #2)  require railties and engines
+    #3)  Define Rails.application as "class MyApp::Application < Rails::Application"
+    #4)  Run config.before_configuration callbacks
+    #5)  Load config/environments/ENV.rb
+    #6)  Run config.before_initialize callbacks
+    #7)  Run Railtie#initializer defined by railties, engines and application.
+    #    One by one, each engine sets up its load paths, routes and runs its config/initializers/* files.
+    #8)  Custom Railtie#initializers added by railties, engines and applications are executed
+    #9)  Build the middleware stack and run to_prepare callbacks
+    #10) Run config.before_eager_load and eager_load! if eager_load is true
+    #11) Run config.after_initialize callbacks
+
+    #Hook
+    #Needs to fire before better_errors (for dev)
+    initializer :exception_handler, before: "better_errors.configure_rails_initialization" do |app| #-> "before" ref - http://blog.carbonfive.com/2011/02/25/configure-your-gem-the-rails-way-with-railtie/ && http://apidock.com/rails/Rails/Initializable/Initializer/before - should degrade gracefully
+
+      #Action
+      app.config.middleware.use ExceptionHandler::Parse if ExceptionHandler.config.try(:db) #-> DB
+      app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionController.action(:show).call(env) } #-> Controller
+
+      #Dev
+      #Logic needed after initialize (app data)
+      app.config.consider_all_requests_local = false if Rails.env.development? and ExceptionHandler.config.try(:dev)
+    end
+
+  end
+end
+
+###########################################