exception_handler 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71ba86443d6a75a89c634f589fa699e7da9b3d1f
-  data.tar.gz: 09d0e90fa92c55f15571be63bd00dd0274eccfac
+  metadata.gz: 11013db45b531b62683007e0106bd99cbd127e87
+  data.tar.gz: 7ff985c6b94846376adf94e66d52bb9778683969
 SHA512:
-  metadata.gz: 801a42bd1b0fb5effcd6ff29830c9c29f52cb8f65950e0c2a2b4d42c1dbbc2e9eff30742c1439fa576ad74cb9df663e17fdbebccdd29d95b077c80da8e894b44
-  data.tar.gz: d677c62c7d0887a93582b9d21a715a3798ec3e157073a437ce2f811c20b81117c3d4de378ebd289c62b80cb9446a13f15abfd75ed812b64cc0af5269b18ef6c9
+  metadata.gz: bbe185c0ef99ad271803055c4469fc118251413d9918b80778479ec11b84f7acfa8e0ec5e679bda9e521fb83d6f096240d751e4db81482052376ee98d6d9bd73
+  data.tar.gz: 2a585fe7364b3962341450dda80b6086942d46718cbb15ba12311606c6c9b88930bc581d9dd6cbf30819a118941c5f4be021feb132ee3c304b9f7b3ec0292a19

data/README.md

@@ -1,35 +1,26 @@
-![Exception Handler](/readme/title.png "Exception Handler Logo")
-
-[![Gem Version](https://badge.fury.io/rb/exception_handler.svg)](http://badge.fury.io/rb/exception_handler)
-[![Code Climate](https://codeclimate.com/github/richpeck/exception_handler.png)](https://codeclimate.com/github/richpeck/exception_handler)
-[![Dependency Status](https://gemnasium.com/richpeck/exception_handler.svg)](https://gemnasium.com/richpeck/exception_handler)
-[![Coverage Status](https://coveralls.io/repos/richpeck/exception_handler/badge.png)](https://coveralls.io/r/richpeck/exception_handler)
-[![Build Status](https://travis-ci.org/richpeck/exception_handler.svg?branch=master)](https://travis-ci.org/richpeck/exception_handler)
+![Exception Handler](/readme/title.jpg "Exception Handler Logo")
 
+<p align="center">
+  <a href="http://badge.fury.io/rb/exception_handler"><img src="https://badge.fury.io/rb/exception_handler.svg"></a>
+  <a href="https://codeclimate.com/github/richpeck/exception_handler"><img src="https://codeclimate.com/github/richpeck/exception_handler.png"></a>
+  <a href="https://gemnasium.com/richpeck/exception_handler"><img src="https://gemnasium.com/richpeck/exception_handler.svg"></a>
+  <a href="https://coveralls.io/r/richpeck/exception_handler"><img src="https://coveralls.io/repos/richpeck/exception_handler/badge.png"></a>
+  <a href="https://travis-ci.org/richpeck/exception_handler"><img src="https://travis-ci.org/richpeck/exception_handler.svg?branch=master"></a>
+</p>
 
 ----------
 
-Sick of the standard Rails error pages?
-
-Need a custom layout to show professional-looking errors in production?
-
-`exception_handler` is exactly what you need!
-
-----------
-
-**ExceptionHandler** provides error handling for Rails 4+ apps *(adapted from [**1**](https://gist.github.com/wojtha/8433843) & [**2**](http://www.sharagoz.com/posts/1-rolling-your-own-exception-handler-in-rails-3))*.
-
-It hooks into the **[`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration)** middleware:
-
-![Exceptions_App middleware](/readme/exceptions_app.png)
-
-With **ExceptionHandler**, you can create custom **404 & 500 production error pages**:
+**ExceptionHandler** helps you can create custom **404 & 500 production error pages** *(adapted from [**1**](https://gist.github.com/wojtha/8433843) & [**2**](http://www.sharagoz.com/posts/1-rolling-your-own-exception-handler-in-rails-3))*:
 
 ![Exceptions_App middleware](/readme/subtitle.jpg)
 
+<p align="center">
+  <img src="/readme/titles/custom_error_pages.png" title="Exceptions_App middleware" />
+</p>
+
 ---
 
-**ExceptionHandler** catches errors in the middleware hook (`config.exceptions_app`), channeling the users to our [custom `exceptions` controller](blob/master/app/controllers/exception_handler/exception_controller.rb). It then dissects data such as the `message`, `details`, `user agent`, etc, redirect the user to a `custom view`, storing it in the db:
+**ExceptionHandler** uses the `config.exceptions_app` to catch errors & send them to our [`exceptions` controller](app/controllers/exception_handler/exception_controller.rb). It then extracts data such as `message`, `details`, `user agent`, & populates our `custom view`, storing it in the db:
 
 **40x Errors** | **50x Errors**
 --- | ---
@@ -37,77 +28,88 @@ With **ExceptionHandler**, you can create custom **404 & 500 production error pa
 **layouts/application.html.erb** | **layouts/errors.html.erb** 
 
 
-All exceptions in Rails are handled by the [`ActiveDispatch::ShowExceptions`](https://github.com/rails/rails/blob/4-0-stable/actionpack/lib/action_dispatch/middleware/show_exceptions.rb) middleware. 
+All exceptions in Rails are handled by the [**`ActiveDispatch::ShowExceptions`**](https://github.com/rails/rails/blob/4-0-stable/actionpack/lib/action_dispatch/middleware/show_exceptions.rb) middleware. 
 
-This is invoked through a hook called `config.exceptions_app`, accessed through the `environment` files of rails `application.rb`, `environments/development.rb`, `environments/production.rb` etc.
+This is invoked through a hook called **`config.exceptions_app`**, accessed through the `environment` files of rails `application.rb`, `environments/development.rb`, `environments/production.rb` etc.
 
-Whilst it's common practice to use `config.exceptions_app = self.routes` to send exceptions to your routes, `ExceptionHandler` hooks directly into the middleware, giving us access to all the data:
+Simply, it gives you a concise, robust way to access all the data of an exception, pushing your app to the next level in branding and usability. There is no other system like this for Rails. `ExceptionHandler` is the *only* Rails production exception handling solution, giving you complete control over the feel of your application, even when it fails:
 
 ![Parse](/readme/parser.jpg "Parser")
 
 ----------
 
+<img src="/readme/titles/contents.png" title="Contents" />
+
+- [**Installation**](https://github.com/richpeck/exception_handler#installation)
+  - [Config](https://github.com/richpeck/exception_handler#config)
+  - [DB](https://github.com/richpeck/exception_handler#db)
+  - [Views](https://github.com/richpeck/exception_handler#views)
+  - [Layout](https://github.com/richpeck/exception_handler#layout)
+- [**Testing**](https://github.com/richpeck/exception_handler#testing)
+- [**Bugs**](https://github.com/richpeck/exception_handler#bugs)
+- [**Support**](https://github.com/richpeck/exception_handler#support)
+- [**Contribution**](https://github.com/richpeck/exception_handler#contribution)
+
+----------
+
 ## Installation
 
      gem install 'exception_handler'
  
 or 
 
-    gem 'exception_handler', '~> 0.4.5' # Gemfile
+    gem 'exception_handler', '~> 0.4.6' # Gemfile
 
-    $ bundle
+<a href="https://rubygems.org/gems/exception_handler" style="text-align: center">
+  You can see `ExceptionHandler` on RubyGems
+  <br />
+  <img src="/readme/rubygems.jpg" />
+</a>
 
-You can see [`ExceptionHandler` on RubyGems](https://rubygems.org/gems/exception_handler)
-
---
+----------
 
 ##### Config
 
-*Optional*
+If you wish to change any of the default settings (below), you should now add `config.exception_handler` to your `config/application.rb` or `config/production.rb` file:
 
-If you wish to change any of the default settings (listed below), you can now add `config.exception_handler` to your `config/application.rb` file:
+![Config Options](/readme/config.jpg)
 
-    $ rails g exception_handler:install
 
-![Creates config/initializers/exception_handler.rb](/readme/config.jpg)
+**IMPORTANT**
 
-This will deploy a file to `config/initializers/exception_handler.rb`, which you'll be able to edit as required.
+If you're upgrading to `0.4.6`, you need to remove your `exception_handler` initializer.
 
-You can run `ExceptionHandler` just from the `gem` if you wish.
+We've changed the load process to use Rails app `config` - **you don't need the `exception_handler` initializer any more**
 
---
+----------
 
 ##### DB
 
-*Optional*
-
-If you want to set up database support (IE have exceptions saved to a table), you need to create a migration:
+If you want to store exceptions in the db, you will need to set up a `migration`:
 
     $ rails generate exception_handler:migration
     $ rake db:migrate
 
 ![Database](/readme/db.jpg "Database")
 
-This is an optional step. If you want to save the data, you will also need to ensure your `config.db` option is correct:
+You will also need to ensure your config `db` option is either `true` || `:table_name`:
 
 ![Database Edit](/readme/db_edit.jpg "Database Edit")
 
---
+----------
 
 ##### Views
 
-*Optional*
-
 If you want to change the views, you can have them put into your app:
 
-    $ rails generate exception_handler:views #-> controller, models, views & assets
-	$ rails generate exception_handler:views -v views controllers models assets #-> remove as appropriate to install individual assets
+    $ rails generate exception_handler:views #-> controller, models, helpers, views & assets
+	$ rails generate exception_handler:views -v views controllers models helpers assets #-> remove as appropriate to install individual assets
 
 The views will be appended to your app, and you'll be able to edit them as required.
 
 ---
 
-###### Show
+##### Show
 
 ![View](/readme/view.jpg "View")
 
@@ -117,11 +119,11 @@ By default, it is split for use with different layouts, data being available to
 
 This works exactly the same as the other views in your app (IE the `exceptions` controller invokes the `show` action)
 
----
+----------
 
-###### Layout
+##### Layout
 
-One of the most critial aspects of **ExceptionHandler** is the custom `Error` layout.
+One of the most critial aspects of **ExceptionHandler** is the [custom `Exception` layout](/app/controllers/exception_handler/exception_controller.rb).
 
 If you want to change the layout (for 500 error pages), you need to use the following:
 
@@ -129,7 +131,7 @@ If you want to change the layout (for 500 error pages), you need to use the foll
 
 ----------
 
-### Development
+<img src="/readme/titles/testing.png" id="testing" />
 
 `config.exceptions_app` is only used in Rails' **production** environment.
 
@@ -139,11 +141,9 @@ If you wish to test the gem in dev, you'll need to make your app process request
 
 You should change this setting if you wish to test your styling in development mode. It should be temporary (you need to change it back once you have it looking how you like)
 
-### Usable_Type & Usable_ID
-
 ----------
 
-## Bugs
+<img src="readme/titles/bugs.png" id="bugs" />
 
 1. `ApplicationController`
 
@@ -159,14 +159,18 @@ You should change this setting if you wish to test your styling in development m
    an exception loop, leading to catastrophic failure.
 
 
-## Support
+----------
+
+<img src="readme/titles/support.png" id="support" />
 
  - Watch the video tutorial (soon)
  - [Create an "issue"](https://github.com/richpeck/exception_handler/issues) 
  - Contact support (soon)
  - [Ask on StackOverflow](http://stackoverflow.com/questions/ask?tags=exception_handler&ruby_on_rails) 
 
-## Contribution
+----------
+
+<img src="readme/titles/contribution.png" id="contribution" />
 
 1. Fork it ( https://github.com/richpeck/exception_handler/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/app/controllers/exception_handler/exception_controller.rb

@@ -24,8 +24,8 @@ module ExceptionHandler
       @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["404"] #-> http://www.justskins.com/forums/ruby-s-regexp-is-52846.html
-        eval ExceptionHandler.config["404"]
+      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
@@ -66,9 +66,9 @@ module ExceptionHandler
     def layout_status
       case  @status
         when 404
-          ExceptionHandler.config[:layouts]["400"] || nil #-> inherits ApplicationController layout
+          ExceptionHandler.config.layouts["400"] || nil #-> inherits ApplicationController layout
         else
-          ExceptionHandler.config[:layouts]["500"] #-> should pull default if none sepecified
+          ExceptionHandler.config.layouts["500"] #-> should pull default if none sepecified
       end     
     end
 

data/app/helpers/exception_handler/application_helper.rb

@@ -9,10 +9,10 @@ module ExceptionHandler
 		#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 arrays
+			# options = args.extract_options! http://simonecarletti.com/blog/2009/09/inside-ruby-on-rails-extract_options-from-arrays/ - args for hash
 
-			services = ExceptionHandler.config[:social] unless services.any?
-			services.except(:url).each do |service,username| #-> except http://stackoverflow.com/a/11105831/1143732
+			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
 
@@ -23,8 +23,8 @@ module ExceptionHandler
 
 		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.push ExceptionHandler.config.social[:url][service]
+			url.push ExceptionHandler.config.social[service]
 			url.join("/")
 		end
 

data/app/models/exception_handler/error.rb

@@ -3,7 +3,7 @@ module ExceptionHandler
 		#Table is called "errors"
 		#Dev needs to use migration to create db
 		def self.table_name
-			ExceptionHandler.config[:db]
+			ExceptionHandler.config.db
 		end
 
 		#Associations

data/lib/exception_handler.rb

@@ -17,9 +17,8 @@ module ExceptionHandler
 	autoload :VERSION, 'exception_handler/version'
 
 	#Config
-	#https://github.com/thoughtbot/paperclip/blob/523bd46c768226893f23889079a7aa9c73b57d68/lib/paperclip/railtie.rb#L13
+	#Invoke instance of config -- loads defaults
 	mattr_accessor :config
-	@@config = ExceptionHandler::Config.defaults #-> instance of defaults invoked with @@config, merged with deep_merge
 
 	# Don't have prefix method return anything.
     # This will keep Rails Engine from generating all table prefixes with the engines name
@@ -39,18 +38,14 @@ module ExceptionHandler
 		#Stylesheet
 		config.assets.precompile += %w(exception_handler/error.css) 
 
-		#Config
-		@@config = ExceptionHandler.config
-
 		#Hook
 		initializer "exception_handler.configure_rails_initialization" do |app|
 			
 			#Options
-			@@config.deep_merge! app.config.exception_handler if app.config.respond_to? :exception_handler
-			@@config[:db] = ExceptionHandler::Config::TABLE_NAME if @@config[:db] == true
+			ExceptionHandler.config = ExceptionHandler::Config.new(app.config.respond_to?(:exception_handler) ? app.config.exception_handler : nil)
 
 			#Middleware
-			app.config.middleware.use ExceptionHandler::Parse if @@config[:db] # && ActiveRecord::Base.connection.table_exists?(:errors unless @@config[:db].blank?)  #DB
+			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
 

data/lib/exception_handler/config.rb

@@ -8,46 +8,58 @@
 
 module ExceptionHandler
 	class Config
-  		mattr_accessor :db, :email, :table, :social, :layouts
-
-  		#Default Table Name
-  		# Has to be "errors" because "exceptions" is a reserved word
-  		TABLE_NAME = :errors
-
-  		# Defaults
-  		# Merged with Rails options with @@config in engine
-		def self.defaults
-			{
-				db:   	false, #-> defaults to :errors if true, else use :table_name
-				email: 	false, #-> need to integrate
-				social: {
-				    :facebook 	=> 	'frontline.utilities',
-				    :twitter 	=> 	'frontlineutils',
-				    :youtube 	=>	'frontlineutils',
-				    :linkedin 	=> 	'frontline-utilities',
-				    :fusion 	=> 	'frontlineutils',
-				    :url => {
-					    :facebook 	=> 	'https://facebook.com',
-					    :twitter 	=> 	'http://twitter.com',
-					    :youtube 	=>	'https://youtube.com/user',
-					    :linkedin 	=> 	'https://linkedin.com/company',
-					    :fusion 	=> 	'https://frontlinefusion.com',				    	
-				    },
-				},
-				layouts: {
-				    '400' => nil,
-				    '500' => 'exception'
-				},
-			}
+
+		#Instace Objects
+		attr_accessor :db, :email, :social, :layouts
+
+	###########################################
+
+		#Init
+		def initialize values
+			defaults = values.present? ? Config::DEFAULTS.deep_merge!(values) : Config::DEFAULTS
+			defaults.each do |k,v|
+				instance_variable_set("@#{k}",v) #-> http://apidock.com/ruby/Object/instance_variable_set	
+			end
 		end
 
-		#404 Callback (needs improving big time)
-		#Use the following:
+		# INSTANCE METHODS #
 
-		#'404' => <<-EOF
-        #    redirect_to root_url, notice: "Hello"
-        #EOF
+		#DB
+		def db
+			@db == true ? Config::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 = {
+			db:   	false, #-> defaults to :errors if true, else use :table_name
+			email: 	false, #-> need to integrate
+			social: {
+				:facebook 	=> 	'frontline.utilities',
+				:twitter 	=> 	'frontlineutils',
+				:youtube 	=>	'frontlineutils',
+				:linkedin 	=> 	'frontline-utilities',
+				:fusion 	=> 	'frontlineutils',
+				:url => {
+					:facebook 	=> 	'https://facebook.com',
+					:twitter 	=> 	'http://twitter.com',
+					:youtube 	=>	'https://youtube.com/user',
+					:linkedin 	=> 	'https://linkedin.com/company',
+					:fusion 	=> 	'https://frontlinefusion.com',				    	
+				},
+			},
+			layouts: {
+			    '400' => nil,
+			    '404' => nil, #-> 404 Callback (needs improving big time) Use the following: '404' => <<-EOF redirect_to root_url, notice: "Hello" EOF
+			    '500' => 'exception'
+			},
+		}
 
-        #This will invoke specifics for the 
 	end
-end
+end

data/lib/exception_handler/parser/ignore.rb

@@ -19,7 +19,7 @@ module ExceptionHandler
 
 			#Errors
 			def errors #-> http://ruby-doc.org/core-2.2.0/Array.html#class-Array-label-Creating+Arrays
-				Array(ActionController::RoutingError, AbstractController::ActionNotFound, ActiveRecord::RecordNotFound)
+				[ActionController::RoutingError, AbstractController::ActionNotFound, ActiveRecord::RecordNotFound]
 			end
 
 			#Bots

data/lib/exception_handler/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHandler
- 	VERSION = "0.4.6"
+ 	VERSION = "0.4.7"
 end

data/lib/generators/exception_handler/migration_generator.rb

@@ -21,7 +21,7 @@ module ExceptionHandler
 		#Table Name - false = off, true = errors, value = value
 		#Always outputs string for some reason...
 		def table_name
-    		ExceptionHandler.config[:db]
+    		ExceptionHandler.config.db
 		end
 
 		###########################################

data/post_install_message.md

@@ -10,7 +10,7 @@
 ########################################################################################
 
 IMPORTANT -
-**IF UPGRADING EXCEPTION HANDLER (to 0.4.5)***
+**IF UPGRADING EXCEPTION HANDLER (to 0.4.7)***
 **DELETE INITIALIZER (config/initializers/exception_handler.rb)**
 
 We've changed the initialization process for ExceptionHandler.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_handler
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Richard Peck
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,10 +152,19 @@ files:
 - readme/exceptions_app.png
 - readme/layout.jpg
 - readme/parser.jpg
+- readme/rubygems.jpg
 - readme/source/screen.psd
+- readme/source/subtitle.psd
 - readme/source/title.psd
 - readme/subtitle.jpg
-- readme/title.png
+- readme/title.jpg
+- readme/titles/bugs.png
+- readme/titles/contents.png
+- readme/titles/contribution.png
+- readme/titles/custom_error_pages.png
+- readme/titles/support.png
+- readme/titles/testing.png
+- readme/titles/title.psd
 - readme/view.jpg
 - spec/spec_helper.rb
 homepage: http://frontlineutilities.co.uk/ror/custom_error_pages
@@ -171,7 +180,7 @@ post_install_message: "#########################################################
   (_| | | | | (_| | |  __/ |     ##\n## \\____/_/\\_\\___\\___| .__/ \\__|_|\\___/|_|
   |_| \\_| |_/\\__,_|_| |_|\\__,_|_|\\___|_|     ## \n##                   | |                                                              ##\n##
   \                 |_|                                                               ##\n########################################################################################\n\nIMPORTANT
-  -\n**IF UPGRADING EXCEPTION HANDLER (to 0.4.5)***\n**DELETE INITIALIZER (config/initializers/exception_handler.rb)**\n\nWe've
+  -\n**IF UPGRADING EXCEPTION HANDLER (to 0.4.7)***\n**DELETE INITIALIZER (config/initializers/exception_handler.rb)**\n\nWe've
   changed the initialization process for ExceptionHandler.\n\nThe initializer has
   been replaced with /config/application.rb\noptions:\n\n#config/application.rb\nconfig.exception_handler
   = {\n\tdb:   \tfalse, #-> defaults to :errors if true, else use :table_name\n\temail: