exception_handler 0.4.7 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11013db45b531b62683007e0106bd99cbd127e87
-  data.tar.gz: 7ff985c6b94846376adf94e66d52bb9778683969
+  metadata.gz: 8c229b37921ac22e8324f72d64e9e3b5278057f3
+  data.tar.gz: 5e858de7ce25556d18bb5abba14864193e0d1d7b
 SHA512:
-  metadata.gz: bbe185c0ef99ad271803055c4469fc118251413d9918b80778479ec11b84f7acfa8e0ec5e679bda9e521fb83d6f096240d751e4db81482052376ee98d6d9bd73
-  data.tar.gz: 2a585fe7364b3962341450dda80b6086942d46718cbb15ba12311606c6c9b88930bc581d9dd6cbf30819a118941c5f4be021feb132ee3c304b9f7b3ec0292a19
+  metadata.gz: af0923ee9aff4299876616cbd7dfda47669b91e77073e80182bc617c86949332229ac152d98ee7604a63f8827df19db216c5851ac8b346a8a280bdb26cd27a4a
+  data.tar.gz: 6df51af9f68cfaece304c42327487119fe1e4c966e1e7867e2c95c623e1dcf4e2945c627d316b01ec5f679b760b48096b1472b92eddd937bd4d61309a7fe086f

data/.gitignore

@@ -20,3 +20,14 @@ tmp
 *.o
 *.a
 mkmf.log
+*.tmp
+
+# http://stackoverflow.com/questions/8865848/comments-in-gitignore
+# https://gist.github.com/danielpcox/4636520
+
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache  

data/.rspec

@@ -1,2 +1,4 @@
 --color
---format progress
+--format progress
+--require spec_helper
+--format documentation

data/Gemfile

@@ -8,7 +8,7 @@ gemspec
 #For Testing
 group :test do
 	gem 'rspec-rails'
-	gem 'rails', '~> 4.1.1'
+	gem 'rails'
 	gem 'coveralls', require: false
 end
 

data/README.md

@@ -1,5 +1,9 @@
 ![Exception Handler](/readme/title.jpg "Exception Handler Logo")
 
+<p align="center">
+  <strong><a href="#user-content-install">Install</a></strong> - <strong><a href="#user-content-config">Config</a></strong> - <strong><a href="#user-content-support">Support</a></strong>
+</p>
+
 <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>
@@ -10,170 +14,315 @@
 
 ----------
 
-**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))*:
+**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)
 
+**ExceptionHandler** is the *only* production-ready custom error page solution for Rails 4 & 5. 
+
+---
+
 <p align="center">
-  <img src="/readme/titles/custom_error_pages.png" title="Exceptions_App middleware" />
+  <br /><img src="/readme/05_title.png" width="450" /><br/>
+  <strong>Customize <i>404</i> and <i>500</i> error pages to be branded to your application in production:</strong>
 </p>
 
+<p align="center">
+  <img src="/readme/check.png" height="22" title="Fully Responsive"               align="absmiddle" />&nbsp; <strong>Responsive</strong> &nbsp;
+  <img src="/readme/check.png" height="22" title="Branded Error Pages"            align="absmiddle" />&nbsp; <strong>Branded Error Pages</strong> &nbsp;
+  <img src="/readme/check.png" height="22" title="Middleware Exception Handling"  align="absmiddle" />&nbsp; <strong>Middleware Exception Handling</strong> &nbsp;
+  <img src="/readme/check.png" height="22" title="Keep Users Informed"            align="absmiddle" />&nbsp; <strong>Fully Customizable</strong> &nbsp;
+</p>
+
+<p align="center">
+  <img src="/readme/branded/1.jpg" width="425" title="Fully Branded Error Pages" /> <img src="/readme/branded/2.jpg" width="425" title="Fully Branded Error Pages" />
+  <img src="/readme/branded/3.jpg" width="425" title="Fully Branded Error Pages" /> <img src="/readme/branded/4.jpg" width="425" title="Fully Branded Error Pages" />
+</p>
+
+The most feature-rich, stable & effective solution for **custom error pages** in Rails 4 & 5.
+
 ---
 
-**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:
+<p align="center">
+  <img src="readme/05.jpg" title="Reworked for Rails 5" />
+</p>
 
-**40x Errors** | **50x Errors**
---- | ---
-![404 Error Page](/readme/400.jpg "404 Error Page (Uses Application Layout)") | ![500 Error Page](/readme/500.jpg "500 Error Page (Uses Error Layout)") 
-**layouts/application.html.erb** | **layouts/errors.html.erb** 
+<p align="center">
+  <img src="readme/titles/reworked.jpg" title="Reworked for Rails 5" width="450" />
+</p>
 
+<p align="center">
+  <img src="/readme/check_02.png" height="22" title="New Controller"           align="absmiddle" />&nbsp; <strong>New Controller</strong> &nbsp;
+  <img src="/readme/check_02.png" height="22" title="New Middleware"           align="absmiddle" />&nbsp; <strong>New Middleware</strong> &nbsp;
+  <img src="/readme/check_02.png" height="22" title="Full Test Suite"          align="absmiddle" />&nbsp; <strong>Full Test Suite</strong> &nbsp;
+  <img src="/readme/check_02.png" height="22" title="Rails 4 & 5 Compatible"   align="absmiddle" />&nbsp; <strong>FULLY Rails 4 & 5 Compatible</strong> &nbsp;
+</p>
 
-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. 
+Brand new `controller`, `middleware` & options have made **`ExceptionHandler`** even more powerful & efficient. Now you can use `ExceptionHandler` directly with a single click -- **plug and play** custom exception pages:
 
-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.
+<div align="center">
+  <img src="/readme/400.jpg" title="400 Errors" width="435" />
+  <img src="/readme/500.jpg" title="500 Errors" width="435" />
+</div>
 
-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:
+**ExceptionHandler** uses `config.exceptions_app` to catch & send errors to the [`exceptions` controller](app/controllers/exception_handler/exception_controller.rb).
 
-![Parse](/readme/parser.jpg "Parser")
+It uses data stored in `Rack` (`message`, `details`, `user agent`) to populate its `custom view`. This gives you the ability to **maintain your branding** *even* when your app experiences an exception.
 
-----------
+----
 
-<img src="/readme/titles/contents.png" title="Contents" />
+<p align="center">
+  <br />
+  <img src="/readme/titles/middleware.jpg" title="Middleware Powered Exceptions" width="300" />
+  <br />
+</p>
+
+The power of **`ExceptionHandler`** lies in its capacity to access the [**`ActiveDispatch::ShowExceptions`**](https://github.com/rails/rails/blob/4-0-stable/actionpack/lib/action_dispatch/middleware/show_exceptions.rb) middleware:
+
+<p align="center">
+  <img src="/readme/middleware.jpg" title="Exceptions handled by the ActiveDispatch::ShowExceptions Middleware" />
+</p>
+
+Rails invokes [`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration) whenever an exception is raised.
+
+**ExceptionHandler** injects our `ExceptionController` into this hook to provide the most efficient response:
+
+> **`config.exceptions_app`** sets the exceptions application invoked by the **`ShowException`** middleware when an exception happens. Defaults to **`ActionDispatch::PublicExceptions.new(Rails.public_path)`**.
 
-- [**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)
+<p align="center">
+  <img src="readme/exceptions_app.jpg" title="Exceptions App" />
+</p>
+
+As opposed to other exception suites (which use the `routes`), this gives you DIRECT access to the exception through the middleware stack, straight to the [`ExceptionController`](/app/controllers/exception_handler/exception_controller.rb):
+
+<p align="center">
+  <img src="readme/controller_middleware.jpg" title="ExceptionsController compiles the exception & delivers to the front-end" />
+</p>
+
+**ExceptionHandler** uses [custom middleware](https://github.com/richpeck/exception_handler/blob/0.5/lib/exception_handler/parse.rb) to extract *all* the exception data for the request. Not only is this the most succinct, efficient way to do this, it also allows you to customize the *entire* fault-recovery process.
+
+It's completely unique - the **only** professional solution to catch, process & handle exceptions in Rails.
 
 ----------
 
-## Installation
+<p align="center" id="install">
+  <br />
+  <img src="readme/titles/install.jpg" title="1 Click Install for ExceptionHandler 5 on Rails 5" width="350" />
+  <br />
+  <strong>You Don't Need <i>Any</i> Configuration To Run ExceptionHandler</strong>
+</p>
+
+    gem install "exception_handler"
+
+or
 
-     gem install 'exception_handler'
- 
-or 
+    gem 'exception_handler', '~> 0.5.0' #-> Gemfile
 
-    gem 'exception_handler', '~> 0.4.6' # Gemfile
+`ExceptionHandler`'s new **config** system (introduced in [`0.4.7`](https://github.com/richpeck/exception_handler/wiki/Setup)) stores all the [defaults](#user-content-defaults) - you just need to install the gem & let it run.
 
-<a href="https://rubygems.org/gems/exception_handler" style="text-align: center">
-  You can see `ExceptionHandler` on RubyGems
+If you want to change *any* settings (detailed [below](#user-content-config)), you **simply** need to change `config/application.rb` / `config/environments/your_env.rb`. The ***POWER*** of this *new config system* means you're able to deploy `ExceptionHandler` in the most unobtrusive, versatile way possible.
+
+<p align="center">
+  <a href="http://rubygems.org/gems/exception_handler" target="_blank">
+    <img src="/readme/rubygems.jpg" title="30,000+ Downloads Through RubyGems" />
+    <br />
+  </a>
+</p>
+
+----
+
+<p align="center" id="config">
   <br />
-  <img src="/readme/rubygems.jpg" />
-</a>
+  <img src="readme/titles/config.jpg" title="Instant Custom Error Pages For Rails 4 & 5" width="325" />
+</p>
 
-----------
+**`ExceptionHandler 0.5`** has the SIMPLEST config possible...
 
-##### Config
+<p align="center">
+  <img src="/readme/config_defaults.jpg" title="ExceptionHandler Default Configuration Options">
+</p>
 
-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:
+The MAGIC is that it uses [`environment files`](http://guides.rubyonrails.org/configuring.html#creating-rails-environments).
 
-![Config Options](/readme/config.jpg)
+You can apply the above options to any of Rails' environment files, allowing you to customize the `ExceptionHandler` gem without inducing ANY overhead. `Initializer` files just get in the way. 
 
+> **IMPORTANT**
+>
+> If you're upgrading from >= `0.4.7`, you need to **remove your `exception_handler` initializer**.
+> 
+> We've changed the load process to use Rails app config - **you don't need the `exception_handler` initializer any more**
 
-**IMPORTANT**
+----
 
-If you're upgrading to `0.4.6`, you need to remove your `exception_handler` initializer.
+<br />
+<img src="readme/titles/defaults.jpg" title="Defaults" id="defaults" />
 
-We've changed the load process to use Rails app `config` - **you don't need the `exception_handler` initializer any more**
+As can be seen in the [`config class`](/lib/exception_handler/config.rb), the following are all the options `exception_handler` accepts:
 
-----------
+<p align="center">
+  <img src="/readme/defaults.jpg" title="ExceptionHandler Default Configuration Options">
+</p>
 
-##### DB
+    # config.rb
+    DEFAULTS = {
+      dev:    false, #-> defaults to "false" for dev mode
+      db:     false, #-> defaults to :errors if true, else input "table_name" as string
+      email:  false, #-> need to integrate
+      social: {
+        :facebook   =>  'frontline.utilities', #-> Facebook handle
+        :twitter    =>  'frontlineutils',      #-> Twitter handle
+        :youtube    =>  'frontlineutils',      #-> YouTube handle
+        :linkedin   =>  'frontline-utilities', #-> LinkedIn handle
+        :fusion     =>   'frontlineutils',     #-> Fusion handle
+        :url => {                             
+          :facebook   =>  'https://facebook.com',          #-> no need to edit
+          :twitter    =>  'http://twitter.com',            #-> no need to edit
+          :youtube    =>  'https://youtube.com/user',      #-> no need to edit
+          :linkedin   =>  'https://linkedin.com/company',  #-> no need to edit
+          :fusion     =>  'https://frontlinefusion.com',   #-> no need to edit              
+        },
+      },
+      layouts: {
+        '404' => nil, #-> 404 Callback (needs improving big time) Use the following: '404' => <<-EOF redirect_to root_url, notice: "Hello" EOF
+        '400' => nil, #-> layout for 400 error code (404 should only be used as response)
+        '500' => 'exception'
+      },
+    }
 
-If you want to store exceptions in the db, you will need to set up a `migration`:
+The above are ***defaults***.
 
-    $ rails generate exception_handler:migration
-    $ rake db:migrate
+You can change the options for each [`environment file`](http://guides.rubyonrails.org/configuring.html#creating-rails-environments): 
 
-![Database](/readme/db.jpg "Database")
+- `config/application.rb`
+- `config/environments/development.rb`
+- `config/environments/production.rb`
+- `config/environments/staging.rb`
 
-You will also need to ensure your config `db` option is either `true` || `:table_name`:
+The benefit of this is that it gives you the ability to customize `ExceptionHandler` for any of your environments. Contrary to a shitty `initializer`, you're able to sculpt the gem to work FOR YOU. 
 
-![Database Edit](/readme/db_edit.jpg "Database Edit")
+----
 
-----------
+<br />
+<img src="readme/titles/dev.jpg" title="Development Mode (New!!!)" id="dev" />
 
-##### Views
+Want to test in the `dev` environment?
 
-If you want to change the views, you can have them put into your app:
+    #config/application.rb
+    config.exception_handler = {
+      dev: true # -> Runs in development mode WITHOUT changing the app environment files
+    }
 
-    $ 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
+<img src="/readme/dev.jpg" title="ExceptionHandler Dev Mode - NEW!!!!!">
 
-The views will be appended to your app, and you'll be able to edit them as required.
+[`config.exceptions_app`](http://guides.rubyonrails.org/configuring.html#rails-general-configuration) *only* works when you have [`config.consider_all_requests_local = true`](http://blog.bigbinary.com/2009/02/05/rescue_action_in_public-local_request-and-how-to-configure-local_request.html), which is `true` in `development`:
 
----
+> **`config.consider_all_requests_local`** is a flag. If true then any error will cause detailed debugging information to be dumped in the `HTTP` response, and the `Rails::Info controller` will show the application runtime context in `/rails/info/properties`. `True` by default in development and test environments, and false in production mode. For finer-grained control, set this to false and implement `local_request?` in controllers to specify which requests should provide debugging information on errors.
+
+
+If you wish to test **`ExceptionHandler`** in `development`, you'll have to use the `dev: true` option in your `exception_handler` config, *or* change `config.consider_all_requests_local = true` in `config/development.rb`.
 
-##### Show
+----
 
-![View](/readme/view.jpg "View")
+<br />
+<img src="readme/titles/layout.jpg" title="Layout" id="layout" />
 
-The view is located in `app/views/exception_handler/show.html.erb` designed to work for all exceptions.
+One of the most critial aspects of **`ExceptionHandler`** is the custom `Exception` layout.
+
+If you want to change the layout (for `500` error pages), you need to use the following:
+
+<img src="readme/layout.jpg" title="Custom Exceptions Layout For ExceptionHandler" />
+
+You'll need to [generate](#user-content-view) it into your application before being able to edit:
+
+----
+
+<br />
+<img src="readme/titles/view.jpg" title="Views" id="view" />
+
+**`ExceptionHandler`** comes with its own inbuilt views & controller.
+
+If you want to change it, you need to add the views into your app with the [`generator`](/lib/generators/exception_handler/views_generator.rb)
+
+    $ 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
+
+--
+
+<img src="readme/show.jpg" title="ExceptionHandler Show view" />
+
+`ExceptionHandler` uses `exceptions#show` -- located in **`app/views/exception_handler/show.html.erb`** designed to work for all exceptions.
 
 By default, it is split for use with different layouts, data being available to both.
 
-This works exactly the same as the other views in your app (IE the `exceptions` controller invokes the `show` action)
+This works exactly the same as the other views in your app (IE the `exceptions controller` invokes the `show` action)
 
-----------
+----
 
-##### Layout
+<br />
+<img src="readme/titles/db.jpg" title="Database" id="db" />
 
-One of the most critial aspects of **ExceptionHandler** is the [custom `Exception` layout](/app/controllers/exception_handler/exception_controller.rb).
+If you want to store exceptions in your `db`, you will need to set up a **migration**:
 
-If you want to change the layout (for 500 error pages), you need to use the following:
+    $ rails generate exception_handler:migration
+    $ rake db:migrate
 
-![Layout](/readme/layout.jpg "Layout")
+You will also need to ensure your config db option is either `true` or `"table_name"`:
 
-----------
+<img src="/readme/db.jpg" title="ExceptionHandler DB Config">
 
-<img src="/readme/titles/testing.png" id="testing" />
+<img src="/readme/db_screenshot.jpg" title="ExceptionHandler Database">
 
-`config.exceptions_app` is only used in Rails' **production** environment.
+> **IMPORTANT**
+> 
+> `ExceptionHandler`'s [new config system](https://github.com/richpeck/exception_handler/wiki/Setup) is `environment` agnostic. 
+> 
+> **Where you declare your `db` setting will change depending on your environment**
+> 
+> If you declare `db` in `application.rb`, it will be applicable for all `environments`; only declaring in `production.rb` will set it for production *only*.
 
-If you wish to test the gem in dev, you'll need to make your app process requests as production for now. This is a temporary step, and will be resolved in a new version:
+----
 
-![#config/environments/development.rb](/readme/dev.jpg "Developer Testing")
+<p align="center" id="support">
+  <br />
+  <img src="readme/titles/support.jpg" title="1hr & 24 hr Support" width="225" />
+</p>
 
-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)
+Github Issue (1hr) | Stackoverflow (24hrs)
+:----: | :----:
+[![StackOverflow](/readme/github.jpg)](https://github.com/richpeck/exception_handler/issues) | [![StackOverflow](/readme/stackoverflow.jpg)](http://stackoverflow.com/questions/ask?tags=ruby-on-rails+exception-handler)
 
-----------
+We use **`ExceptionHandler`** in production, so we have a vested interest in keeping it running smoothly.
 
-<img src="readme/titles/bugs.png" id="bugs" />
+Asking in either of the above services will give you a response. Don't be shy, we want to make this the best `exception handling` middleware for Rails.
 
-1. `ApplicationController`
+--
 
-   ![ApplicationController](/readme/application_controller.jpg "Application Controller")
-   
-   A significant issue exists in respect to the inheritance of `exceptions_controller`.
-   Our current version (`0.4`) inherits from the `ApplicationController`. This causes a problem for many applications.
+<br />
+<img src="readme/titles/changelog.jpg" title="Changelog" id="changelog" />
 
-   If you use any sort of `before_action` callback in your controller, especially to populate variables, this
-   will cause untold problems in your `exceptions_controller`. 
+#### 0.5.1
+ - Next release
 
-   `500` errors are server faults; trying to get the server to call more data will simply not work. It causes
-   an exception loop, leading to catastrophic failure.
+#### 0.5.0
+ - Added locales
+ - Email notifications
+ - Full test suite (finally)
+ - Rails 4.2 & Rails 5.0 native ([`request.env`](https://github.com/rails/rails/commit/05934d24aff62d66fc62621aa38dae6456e276be) fix)
+ - Controller fixed
+ - `DB` fixed
+ - Legacy initializer support ([more](https://github.com/richpeck/exception_handler/wiki/Setup))
+ - Rails asset management improvement
+ - Cut out most dev files from gem (drastic reduction in gem size)
 
 
-----------
+#### 0.4.7
 
-<img src="readme/titles/support.png" id="support" />
+ - New config system ([more](https://github.com/richpeck/exception_handler/wiki/Setup))
+ - Fixed controller layout issues
+ - Streamlined middleware
+ - New layout & interface implementation
 
- - 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) 
 
 ----------
 
-<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`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+&copy; 2016 [**R Peck**](http://stackoverflow.com/users/1143732/richard-peck) for [**FL**](http://frontlineutilities.co.uk)