gaffe 0.1.2 → 0.2

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/Gemfile.rails-4.0
+  - gemfiles/Gemfile.rails-3.2.x
+
+script: "echo 'DO IT' && bundle exec rake spec"

data/README.md

@@ -1,6 +1,13 @@
 # Gaffe
 
-Gaffe handles Rails error pages in a clean, simple way.
+[![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:
+
+![](http://i.imgur.com/9gPfCOm.png)
+
+You should overwrite it though, it’s very easy to do so.
 
 ## Installation
 
@@ -32,6 +39,22 @@ end
 Gaffe.enable!
 ```
 
+It’s also possible to use a custom controller based on the URL in which the error has occured. This is especially
+useful if you have an application that also serves API requests via JSON. You would probably want to serve API errors
+through JSON and regular errors through HTML pages.
+
+```ruby
+# config/initializers/gaffe.rb
+Gaffe.configure do |config|
+  config.errors_controller = {
+    %r[^/api/] => Api::ErrorsController,
+    %r[^/] => 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.
@@ -54,7 +77,7 @@ end
 
 You can (and should!) also use your own views. You just have to create a layout:
 
-```
+```erb
 <!-- app/views/layouts/error.html.erb -->
 <h1>Error!</h1>
 <%= yield %>
@@ -62,7 +85,7 @@ You can (and should!) also use your own views. You just have to create a layout:
 
 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:
 
-```
+```erb
 <!-- app/views/errors/not_found.html.erb -->
 <p>This page does not exist.</p>
 ```
@@ -85,4 +108,6 @@ config.action_dispatch.rescue_responses.merge!('MyCustomException' => :not_accep
 
 ## 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 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").
+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.
+
+We also love [open-source software](http://open.mirego.com/) and we try to extract as much code as possible from our projects to give back to the community.

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/gaffe.gemspec

@@ -20,6 +20,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_dependency 'rails', '>= 3.2.0'
 end

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 3.2.0'

data/gemfiles/Gemfile.rails-4.0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'rails', '~> 4.0.0'

data/lib/gaffe.rb

@@ -1,4 +1,6 @@
 require 'gaffe/version'
+
+require 'ostruct'
 require 'gaffe/errors'
 
 module Gaffe
@@ -12,11 +14,6 @@ module Gaffe
     @configuration ||= OpenStruct.new
   end
 
-  # Return either the user-defined controller or our default controller
-  def self.errors_controller
-    @errors_controller ||= (configuration.errors_controller || builtin_errors_controller)
-  end
-
   # Return our default controller
   def self.builtin_errors_controller
     require 'gaffe/errors_controller'
@@ -26,8 +23,20 @@ module Gaffe
   # Configure Rails to use our code when encountering exceptions
   def self.enable!
     Rails.application.config.exceptions_app = lambda do |env|
-      Gaffe.errors_controller.action(:show).call(env)
+      Gaffe.errors_controller_for_request(env).action(:show).call(env)
+    end
+  end
+
+  # Return the right errors controller to use for the request that
+  # triggered the error
+  def self.errors_controller_for_request(env)
+    controller = configuration.errors_controller
+
+    if controller.is_a?(Hash)
+      controller = controller.detect { |pattern, _| env["REQUEST_URI"] =~ pattern }.try(:last)
     end
+
+    controller || builtin_errors_controller
   end
 
   # Return the root path of the gem

data/lib/gaffe/version.rb

@@ -1,3 +1,3 @@
 module Gaffe
-  VERSION = '0.1.2'
+  VERSION = '0.2'
 end

data/spec/gaffe/errors_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Gaffe::Errors do
+  describe :Actions do
+    describe :show do
+      let(:request) { ActionDispatch::TestRequest.new }
+      let(:env) { request.env.merge 'action_dispatch.exception' => exception }
+      let(:exception) { ActionController::RoutingError.new(:foo) }
+
+      let(:response) { Gaffe.errors_controller_for_request(env).action(:show).call(env) }
+      subject { response.last }
+
+      its(:status) { should eql 404 }
+      its(:body) { should match /Not Found/ }
+    end
+  end
+end

data/spec/gaffe/gaffe_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Gaffe do
+  describe :ClassMethods do
+    before do
+      # 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)
+      end
+    end
+
+    describe :configure do
+      subject { Gaffe.configuration }
+      before do
+        Gaffe.configure do |config|
+          config.foo = :bar
+          config.bar = :foo
+        end
+      end
+
+      its(:foo) { should eql :bar }
+      its(:bar) { should eql :foo }
+    end
+
+    describe :errors_controller_for_request do
+      let(:controller) { Gaffe.errors_controller_for_request(env) }
+      let(:request) { ActionDispatch::TestRequest.new }
+      let(:env) { request.env }
+
+      context 'with custom-defined controller' do
+        before do
+          Gaffe.configure do |config|
+            config.errors_controller = :foo
+          end
+        end
+
+        it { expect(controller).to eql :foo }
+      end
+
+      context 'with multiple custom-defined controllers' do
+        before do
+          Gaffe.configure do |config|
+            config.errors_controller = {
+              %r[^/web/] => :web_controller,
+              %r[^/api/] => :api_controller
+            }
+          end
+        end
+
+        context 'with error coming from matching URL' do
+          let(:env) { request.env.merge 'REQUEST_URI' => '/api/users' }
+          it { expect(controller).to eql :api_controller }
+        end
+
+        context 'with errors coming from non-matching URL' do
+          let(:env) { request.env.merge 'REQUEST_URI' => '/what' }
+          it { expect(controller).to eql Gaffe::ErrorsController }
+        end
+      end
+
+      context 'without custom-defined controller' do
+        it { expect(controller).to eql Gaffe::ErrorsController }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require "action_controller/railtie"
+require 'gaffe'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Rails.stub(:root).and_return(RAILS_ROOT)
+  end
+end
+
+# We need a fake "ApplicationController" because Gaffe's default controller inherits from it
+class ApplicationController < ActionController::Base
+end
+
+# We need Rails.root
+RAILS_ROOT = Pathname.new(File.expand_path('../../', __FILE__))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gaffe
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,6 +44,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +85,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
@@ -80,10 +98,15 @@ files:
 - app/views/errors/unauthorized.html.erb
 - app/views/layouts/error.html.erb
 - gaffe.gemspec
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0
 - lib/gaffe.rb
 - lib/gaffe/errors.rb
 - lib/gaffe/errors_controller.rb
 - lib/gaffe/version.rb
+- spec/gaffe/errors_spec.rb
+- spec/gaffe/gaffe_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mirego/gaffe
 licenses:
 - BSD 3-Clause
@@ -99,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3771495489662381768
+      hash: -2535410059027227615
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,11 +131,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3771495489662381768
+      hash: -2535410059027227615
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Gaffe handles Rails error pages in a clean, simple way.
-test_files: []
+test_files:
+- spec/gaffe/errors_spec.rb
+- spec/gaffe/gaffe_spec.rb
+- spec/spec_helper.rb