gaffe 0.0.1 → 0.1

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in gaffe.gemspec
 gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2013, Mirego
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the Mirego nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,29 +1,88 @@
 # Gaffe
 
-TODO: Write a gem description
+Gaffe handles Rails error pages in a clean, simple way.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
-    gem 'gaffe'
+```ruby
+gem 'gaffe'
+```
 
-And then execute:
+## Usage
 
-    $ bundle
+The easiest way to use Gaffe is with an initializer:
 
-Or install it yourself as:
+```ruby
+# config/initializers/gaffe.rb
+Gaffe.enable!
+```
 
-    $ gem install gaffe
+### Custom controller
 
-## Usage
+However, if you want to use your own controller:
+
+```ruby
+# config/initializers/gaffe.rb
+Gaffe.configure do |config|
+  config.errors_controller = ErrorsController
+end
+
+Gaffe.enable!
+```
+
+The only required thing to do in your custom controller is to include the `Gaffe::Errors` module.
+
+Only `show` will be called so you might want to overwrite it. You might also want to get rid of filters and other stuff.
+
+```ruby
+class ErrorsController < ApplicationController
+  include Gaffe::Errors
+  skip_before_filter :ensure_current_user
+
+  def show
+    # The following variables are available:
+    @exception # The encountered exception (Eg. `#<ActiveRecord::NotFound …>`)
+    @status_code # The status code we should return (Eg. `404`)
+    @rescue_response # The "standard" name for the status code (Eg. `:not_found`)
+  end
+end
+```
+
+### Custom views
+
+You can (and should!) also use your own views. You just have to create a layout:
+
+```
+<!-- app/views/layouts/error.html.erb -->
+<h1>Error!</h1>
+<%= yield %>
+```
+
+And create a different view for [each possible error rescue response](https://github.com/rails/rails/blob/f9ceefd3b9c3cea2460a89799156f2c532c4491c/actionpack/lib/action_dispatch/middleware/exception_wrapper.rb). For example, for `404` errors:
+
+```
+<!-- app/views/errors/not_found.html.erb -->
+<p>This page does not exist.</p>
+```
+
+### Custom exceptions
+
+If your application is raising custom exceptions (through gems or your code)
+and you want to render specific views when it happens, you can map them to
+specific rescue responses.
+
+```ruby
+# config/application.rb
+config.action_dispatch.rescue_responses.merge!('CanCan::AccessDenied' => :forbidden)
+config.action_dispatch.rescue_responses.merge!('MyCustomException' => :not_acceptable)
+```
+
+## License
 
-TODO: Write usage instructions here
+`Gaffe` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/gaffe/blob/master/LICENSE.md) file.
 
-## Contributing
+## About Mirego
 
-1. Fork it
-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 new Pull Request
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly built mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development").

data/app/views/errors/forbidden.html.erb

@@ -0,0 +1 @@
+Forbidden

data/app/views/errors/internal_server_error.html.erb

@@ -0,0 +1 @@
+Internal Server Error

data/app/views/errors/not_found.html.erb

@@ -0,0 +1 @@
+Not Found

data/app/views/errors/unauthorized.html.erb

@@ -0,0 +1 @@
+Unauthorized

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

@@ -0,0 +1,16 @@
+<h1>Error!</h1>
+
+<p>This is an error page brought to you by <strong>Gaffe</strong>.</p>
+
+<hr>
+
+<%= yield %>
+
+<hr>
+
+<p>You can overwrite this page by creating these files:</p>
+
+<pre>
+  <code><%= Rails.root.join('app', 'views', 'layouts', "error.html.[handler]") %></code>
+  <code><%= Rails.root.join('app', 'views', 'errors', "#{@rescue_response.to_s}.html.[handler]") %></code>
+</pre>

data/gaffe.gemspec

@@ -4,20 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gaffe/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gaffe"
+  spec.name          = 'gaffe'
   spec.version       = Gaffe::VERSION
-  spec.authors       = ["Rémi Prévost"]
-  spec.email         = ["rprevost@mirego.com"]
-  spec.description   = ""
-  spec.summary       = ""
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Rémi Prévost', 'Simon Prévost']
+  spec.email         = ['rprevost@mirego.com', 'sprevost@mirego.com']
+  spec.description   = 'Gaffe handles Rails error pages in a clean, simple way.'
+  spec.summary       = 'Gaffe handles Rails error pages in a clean, simple way.'
+  spec.homepage      = 'https://github.com/mirego/gaffe'
+  spec.license       = "BSD 3-Clause"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'actionpack', '>= 3.0.0'
 end

data/lib/gaffe/errors.rb

@@ -0,0 +1,29 @@
+module Gaffe
+  module Errors
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :fetch_exception, only: %w(show)
+      before_filter :append_view_paths
+      layout 'error'
+    end
+
+    def show
+      render "errors/#{@rescue_response}", status: @status_code
+    end
+
+  protected
+
+    def fetch_exception
+      @exception = env['action_dispatch.exception']
+      @status_code = ActionDispatch::ExceptionWrapper.new(env, @exception).status_code
+      @rescue_response = ActionDispatch::ExceptionWrapper.rescue_responses[@exception.class.name]
+    end
+
+  private
+
+    def append_view_paths
+      append_view_path File.expand_path('../../../app/views', __FILE__)
+    end
+  end
+end

data/lib/gaffe/errors_controller.rb

@@ -0,0 +1,5 @@
+module Gaffe
+  class ErrorsController < ::ApplicationController
+    include Errors
+  end
+end

data/lib/gaffe/version.rb

@@ -1,3 +1,3 @@
 module Gaffe
-  VERSION = "0.0.1"
+  VERSION = '0.1'
 end

data/lib/gaffe.rb

@@ -1,5 +1,27 @@
-require "gaffe/version"
+require 'gaffe/version'
+require 'gaffe/errors'
 
 module Gaffe
-  # Your code goes here...
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= OpenStruct.new
+  end
+
+  def self.errors_controller
+    @errors_controller ||= (configuration.errors_controller || builtin_errors_controller)
+  end
+
+  def self.builtin_errors_controller
+    require 'gaffe/errors_controller'
+    Gaffe::ErrorsController
+  end
+
+  def self.enable!
+    Rails.application.config.exceptions_app = lambda do |env|
+      Gaffe.errors_controller.action(:show).call(env)
+    end
+  end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: gaffe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
 - Rémi Prévost
+- Simon Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,24 +44,48 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Gaffe handles Rails error pages in a clean, simple way.
 email:
 - rprevost@mirego.com
+- sprevost@mirego.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
+- app/views/errors/forbidden.html.erb
+- app/views/errors/internal_server_error.html.erb
+- app/views/errors/not_found.html.erb
+- app/views/errors/unauthorized.html.erb
+- app/views/layouts/error.html.erb
 - gaffe.gemspec
 - lib/gaffe.rb
+- lib/gaffe/errors.rb
+- lib/gaffe/errors_controller.rb
 - lib/gaffe/version.rb
-homepage: ''
+homepage: https://github.com/mirego/gaffe
 licenses:
-- MIT
+- BSD 3-Clause
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -71,16 +96,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 39176632371721851
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 39176632371721851
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: ''
+summary: Gaffe handles Rails error pages in a clean, simple way.
 test_files: []

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Rémi Prévost
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.