gaffe 0.2.1 → 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ce01c4c09894fecd78f12031f46135cbc4c8abf
+  data.tar.gz: 60960d0ee25ed32565227492b3014d491c45571a
+SHA512:
+  metadata.gz: db16c3dc353687abeadccf095aa5b6000d94f9f68938e3106b19528a9f14a322f06f1d389fa5edef8c6cafd6a6f9f6f33e779eee8d0ef1f450bba99c4b147dd5
+  data.tar.gz: 7083bbd24ada18edd68684b8d544e9ee22446f9bd0161721990a4437f04d39773bcdac294efe07a50cff5b77511c5812470abac52672a9478e8f5719d2e6394f

data/README.md

@@ -1,14 +1,23 @@
-# Gaffe
-
-[![Gem Version](https://badge.fury.io/rb/gaffe.png)](https://rubygems.org/gems/gaffe)
-[![Build Status](https://travis-ci.org/mirego/gaffe.png?branch=master)](https://travis-ci.org/mirego/gaffe)
-
-Gaffe handles Rails error pages in a clean, simple way. The default error page looks like this:
+<p align="center">
+  <a href="https://github.com/mirego/gaffe">
+    <img src="http://i.imgur.com/k9Vo08q.png" alt="gaffe" />
+  </a>
+  <br />
+  Gaffe makes having customized error pages in Rails applications an easy thing.<br /> It takes advantage of a feature present in Rails 3.2+ called <code>exceptions_app</code>.
+  <br /><br />
+  <a href="https://rubygems.org/gems/gaffe"><img src="https://badge.fury.io/rb/gaffe.png" /></a>
+  <a href="https://codeclimate.com/github/mirego/gaffe"><img src="https://codeclimate.com/github/mirego/gaffe.png" /></a>
+  <a href='https://coveralls.io/r/mirego/gaffe?branch=master'><img src='https://coveralls.io/repos/mirego/gaffe/badge.png?branch=master' /></a>
+  <a href='https://gemnasium.com/mirego/gaffe'><img src="https://gemnasium.com/mirego/gaffe.png" /></a>
+  <a href="https://travis-ci.org/mirego/gaffe"><img src="https://travis-ci.org/mirego/gaffe.png?branch=master" /></a>
+</p>
+
+---
+
+It comes with default error pages but makes it very easy to override them (which you should do). The default error pages look like this:
 
 ![](http://i.imgur.com/9gPfCOm.png)
 
-You should overwrite it though, it’s very easy to do so.
-
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -57,7 +66,11 @@ 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.
+Only `show` will be called so you might want to override it. If you don’t override it, Gaffe will
+try to render the view `"errors/#{@rescue_response}"` within your application (or use its default
+error page if the view doesn’t exist).
+
+You might also want to get rid of filters and other stuff to make sure that error pages are always accessible.
 
 ```ruby
 class ErrorsController < ApplicationController
@@ -73,6 +86,19 @@ class ErrorsController < ApplicationController
 end
 ```
 
+For example, you might want your `Api::ErrorsController` to return a standard JSON response:
+
+```ruby
+class Api::ErrorsController < Api::ApplicationController
+  include Gaffe::Errors
+  skip_before_filter :ensure_current_user
+
+  def show
+    render json: { error: @rescue_response }, status: @status_code
+  end
+end
+```
+
 ### Custom views
 
 You can (and should!) also use your own views. You just have to create a layout:
@@ -98,14 +124,27 @@ 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)
+config.action_dispatch.rescue_responses.merge! 'CanCan::AccessDenied' => :forbidden
+config.action_dispatch.rescue_responses.merge! 'MyCustomException' => :not_acceptable
+```
+
+### Rails development mode
+
+Rails prefers to render its own debug-friendly errors in the `development` environment,
+which is totally understandable. However, if you want to test Gaffe’s behavior in development
+you’ll have to edit the `config/environments/development.rb` file.
+
+```ruby
+# Make Rails use `exceptions_app` in development
+config.consider_all_requests_local = false
 ```
 
 ## License
 
 `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.
 
+The mushroom cloud logo is based on [this lovely icon](http://thenounproject.com/noun/mushroom-cloud/#icon-No18596) by [Gokce Ozan](http://thenounproject.com/occultsearcher), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.
+
 ## About Mirego
 
 Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly build 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") in beautiful Quebec City.

data/gaffe.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'coveralls'
 
   spec.add_dependency 'rails', '>= 3.2.0'
 end

data/lib/gaffe/version.rb

@@ -1,3 +1,3 @@
 module Gaffe
-  VERSION = '0.2.1'
+  VERSION = '1.0' # Woo-hoo
 end

data/spec/gaffe/gaffe_spec.rb

@@ -55,5 +55,21 @@ describe Gaffe do
         it { expect(controller).to eql Gaffe::ErrorsController }
       end
     end
+
+    describe :enable! do
+      let(:env) { ActionDispatch::TestRequest.new.env }
+      let(:action_double) { double(call: lambda { |env| [400, {}, 'SOMETHING WENT WRONG.'] }) }
+      before { Gaffe.enable! }
+
+      specify do
+        expect(Gaffe).to receive(:errors_controller_for_request).with(env).and_call_original
+        expect(Gaffe::ErrorsController).to receive(:action).with(:show).and_return(action_double)
+        expect(action_double).to receive(:call).with(env)
+
+        # This is the line Rails itself calls
+        # https://github.com/rails/rails/blob/fee49a10492efc99409c03f7096d5bd3377b0bbc/actionpack/lib/action_dispatch/middleware/show_exceptions.rb#L43
+        Rails.application.config.exceptions_app.call(env)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'rspec'
 require "action_controller/railtie"
 require 'gaffe'
@@ -9,6 +12,9 @@ RSpec.configure do |config|
     # Fake Rails.root
     Rails.stub(:root).and_return(RAILS_ROOT)
 
+    # Fake Rails.application
+    Rails.stub(:application).and_return OpenStruct.new(config: OpenStruct.new, env_config: {})
+
     # Make sure we clear memoized variables before each test
     [:@configuration].each do |variable|
       Gaffe.send :remove_instance_variable, variable if Gaffe.instance_variable_defined?(variable)

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gaffe
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: '1.0'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,23 +28,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,25 +49,36 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
 description: Gaffe handles Rails error pages in a clean, simple way.
@@ -115,33 +120,26 @@ files:
 homepage: https://github.com/mirego/gaffe
 licenses:
 - BSD 3-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 843740072442851156
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 843740072442851156
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gaffe handles Rails error pages in a clean, simple way.
 test_files:
 - spec/gaffe/errors_spec.rb