rails_exception_handler 1.0.1 → 1.1.0

data/HISTORY

@@ -1,6 +1,10 @@
 CHANGELOG
 
 
+v1.1.0 - 18. Jul 2011
+ - Better handling of ajax requests
+ - Exceptions can be mapped to specific responses
+
 v1.0.1 - 17. Jul 2011
 - Minor fix for 1.8.7 compatibility
 

data/README.markdown

@@ -23,14 +23,21 @@ RailsExceptionHandler.configure do |config|
   # config.storage_strategies = [:active_record, :rails_log, :remote_url => {:target => 'http://example.com'}] # Defaults to []
   # config.fallback_layout = 'home'                                         # Defaults to 'application'
   # config.store_user_info = {:method => :current_user, :field => :login}   # Defaults to false
-  # config.responses['404'] = "<h1>404</h1><p>Page not found</p>"
-  # config.responses['500'] = "<h1>500</h1><p>Internal server error</p>"
   # config.filters = [                                                      # No filters are  enabled by default
   #   :all_404s,
   #   :no_referer_404s,
   #   {:user_agent_regxp => /\b(ApptusBot|TurnitinBot|DotBot|SiteBot)\b/i},
   #   {:target_url_regxp => /\b(myphpadmin)\b/i}
-  #]
+  # ]
+  # config.responses = {                                                    # There must be a default response. The rest is up to you.
+  #   :default => "<h1>500</h1><p>Internal server error</p>"
+  #   :custom => "<h1>404</h1><p>Page not found</p>",
+  # }
+  # config.response_mapping = {                                             # All errors are mapped to the :default response unless overridden here
+  #  'ActiveRecord::RecordNotFound' => :not_found,
+  #  'ActionController:RoutingError' => :not_found,
+  #  'AbstractController::ActionNotFound' => :not_found,
+  # }
 end
 ```
 
@@ -77,6 +84,24 @@ config.store_user_info = {:method => :current_user, :field => :login}
 Default value: false (no info will be stored)
 If you turn this on and the error is generated by a client that is not logged in, then "Anonymous" will be used.
 
+### responses and response_mapping
+
+Create a set of responses and then map specific exceptions to these responses. There needs to be a response called :default which is used for the exceptions that are not explicity mapped to a response.
+
+```ruby
+config.responses = {
+  :default => "<h1>500</h1><p>Internal server error</p>",
+  :not_found => "<h1>404</h1><p>Page not found</p>",
+  :wrong_token => "<h1>500</h1>There was a problem authenticating the submitted form. Reload the page and try again."
+}
+config.response_mapping = {
+ 'ActiveRecord::RecordNotFound' => :not_found,
+ 'ActionController:RoutingError' => :not_found,
+ 'AbstractController::ActionNotFound' => :not_found,
+ 'ActionController::InvalidAuthenticityToken' => :wrong_token
+}
+```
+
 ### filters
 
 All filters are disabled by default. I recommend you deploy your application this way, and then add filters as they become necessary.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/app/controllers/error_response_controller.rb

@@ -1,6 +1,5 @@
 class ErrorResponseController < ApplicationController
   def index
-    render(:text => RailsExceptionHandler.configuration.responses[@_env['exception_handler.response_code']],
-           :layout => @_env['exception_handler.layout'])
+    render(:text => @_env['exception_handler.response'], :layout => @_env['exception_handler.layout'])
   end
 end

data/lib/rails_exception_handler/configuration.rb

@@ -1,5 +1,5 @@
 class RailsExceptionHandler::Configuration
-  attr_accessor :storage_strategies, :environments, :filters, :responses, :fallback_layout, :store_user_info
+  attr_accessor :storage_strategies, :environments, :filters, :responses, :response_mapping, :fallback_layout, :store_user_info
 
   def initialize
     @environments = [:production]
@@ -7,7 +7,7 @@ class RailsExceptionHandler::Configuration
     @filters = []
     @store_user_info = false
     @fallback_layout = 'application'
-    @responses = { '404' => '<h1>Page not found</h1><p>The page you were looking for could not be found.</p>',
-                   '500' => '<h1>Internal server error</h1><p>The application has encountered an unexpected issue.</p>' }
+    @response_mapping = {}
+    @responses = { :default => '<h1>Internal server error</h1><p>The application has encountered an unexpected issue.</p>' }
   end
 end

data/lib/rails_exception_handler/handler.rb

@@ -62,8 +62,25 @@ class RailsExceptionHandler::Handler
   end
 
   def response
-    @env['exception_handler.layout'] = @controller.send(:_default_layout) || RailsExceptionHandler.configuration.fallback_layout
-    @env['exception_handler.response_code'] = @parsed_error.routing_error? ? '404' : '500'
-    ErrorResponseController.action(:index).call(@env)
+    @env['exception_handler.layout'] = response_layout
+    @env['exception_handler.response'] = response_text
+    response = ErrorResponseController.action(:index).call(@env)
+    response[0] = @parsed_error.routing_error? ? 404 : 500
+    return response
+  end
+
+  def response_layout
+    if(@request.xhr?)
+      false
+    else
+      @controller.send(:_default_layout) || RailsExceptionHandler.configuration.fallback_layout
+    end
+  end
+
+  def response_text
+    config = RailsExceptionHandler.configuration
+    klass = @parsed_error.relevant_info[:class_name]
+    key = config.response_mapping[klass] || :default
+    return config.responses[key]
   end
 end

data/rails_exception_handler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_exception_handler}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sharagoz"]
-  s.date = %q{2011-07-17}
+  s.date = %q{2011-07-18}
   s.description = %q{}
   s.email = %q{contact@sharagoz.com}
   s.extra_rdoc_files = [

data/spec/integration/configuration_spec.rb

@@ -158,4 +158,27 @@ describe RailsExceptionHandler::Configuration do
       ErrorMessage.first.user_info.should == 'matz'
     end
   end
+
+  describe "reponses and response_mapping" do
+    it "should use the default response on non-mapped errors" do
+      RailsExceptionHandler.configure do |config|
+        config.environments = [Rails.env.to_sym]
+        config.storage_strategies = []
+        config.responses = {:default => 'Customized response'}
+      end
+      get('/home/view_error')
+      last_response.body.should match(/Customized response/)
+    end
+
+    it "should use mapped response where they exist" do
+      RailsExceptionHandler.configure do |config|
+        config.environments = [Rails.env.to_sym]
+        config.storage_strategies = []
+        config.responses[:not_found] = 'custom_routing_response_text'
+        config.response_mapping['ActionController::RoutingError'] = :not_found
+      end
+      get('/incorrect_route')
+      last_response.body.should match(/custom_routing_response_text/)
+    end
+  end
 end

data/spec/integration/rails_exception_handler_spec.rb

@@ -25,7 +25,7 @@ describe RailsExceptionHandler do
   it "should catch routing errors"  do
     get "/incorrect_route"
     ErrorMessage.count.should == 1
-    last_response.body.should match(/Page not found/)
+    last_response.body.should match(/Internal server error/)
     ErrorMessage.first.class_name.should == 'ActionController::RoutingError'
   end
 

data/spec/test_macros.rb

@@ -50,6 +50,8 @@ module TestMacros
       config.store_user_info = false
       config.filters = []
       config.fallback_layout = 'fallback'
+      config.response_mapping = {}
+      config.responses = { :default => '<h1>Internal server error</h1><p>The application has encountered an unexpected issue.</p>' }
     end
   end
 

data/spec/unit/configuration_spec.rb

@@ -22,12 +22,12 @@ describe RailsExceptionHandler::Configuration do
       @configuration.filters.should == []
     end
 
-    it "should set the 404 response" do
-      @configuration.responses['404'].should match(/Page not found/)
+    it "should set the default response" do
+      @configuration.responses.should == {:default => '<h1>Internal server error</h1><p>The application has encountered an unexpected issue.</p>' }
     end
 
-    it "should set the 500 response" do
-      @configuration.responses['500'].should match(/Internal server error/)
+    it "should set the reponse_mapping to {}" do
+      @configuration.response_mapping.should == {}
     end
 
     it "should set the fallback layout to 'application'" do

data/spec/unit/handler_spec.rb

@@ -19,10 +19,19 @@ describe RailsExceptionHandler::Handler do
     it "should return a rack tripple" do
       response = @handler.handle_exception
       response.length.should == 3
-      response[0].should == 200 # response code
+      response[0].should == 500 # response code
       response[1].class.should == Hash # headers
       response[2].class.should == ActionDispatch::Response # body
     end
+
+    it "should set the response code to 404 on routing errors" do
+      exception = create_exception
+      exception.stub!(:class => ActionController::RoutingError)
+      handler = RailsExceptionHandler::Handler.new(create_env, exception)
+      response = handler.handle_exception
+      response.length.should == 3
+      response[0].should == 404
+    end
   end
 
   describe ".store_error" do
@@ -98,7 +107,7 @@ describe RailsExceptionHandler::Handler do
 
   describe '.response' do
     it "should call index action on ErrorResponseController" do
-      ErrorResponseController.should_receive(:action).with(:index).and_return(mock(Object, :call => true))
+      ErrorResponseController.should_receive(:action).with(:index).and_return(mock(Object, :call => [500, {}, {}]))
       @handler.handle_exception
     end
 
@@ -107,15 +116,15 @@ describe RailsExceptionHandler::Handler do
       env = create_env
       exception.stub!(:class => ActiveRecord::RecordNotFound)
       handler = RailsExceptionHandler::Handler.new(env, exception)
-      handler.handle_exception
-      env['exception_handler.response_code'].should == '404'
+      response = handler.handle_exception
+      response[0].should == 404
     end
 
     it "should set response_code to '500' on all other errors" do
       env = create_env
       handler = RailsExceptionHandler::Handler.new(env, create_exception)
-      handler.handle_exception
-      env['exception_handler.response_code'].should == '500'
+      response = handler.handle_exception
+      response[0].should == 500
     end
 
     it "should save the layout in env" do
@@ -133,4 +142,59 @@ describe RailsExceptionHandler::Handler do
       env['exception_handler.layout'].should == 'fallback'
     end
   end
+
+  describe '.response_layout' do
+    it "should not set a layout for XHR requests" do
+      handler = RailsExceptionHandler::Handler.new(create_env, create_exception)
+      handler.handle_exception
+      request = handler.instance_variable_get(:@request)
+      request.stub!(:xhr? => true)
+      handler.instance_variable_set(:@request, request)
+      handler.send(:response_layout).should == false
+    end
+
+    it "should use the controllers default layout if it exists" do
+      env = create_env
+      controller = ApplicationController.new
+      controller.stub!(:_default_layout => 'home')
+      env['action_controller.instance'] = controller
+      handler = RailsExceptionHandler::Handler.new(env, create_exception)
+      handler.handle_exception
+      handler.send(:response_layout).should == 'home'
+    end
+
+    it "should use the fallback layout if the controller does not have a default layout" do
+      handler = RailsExceptionHandler::Handler.new(create_env, create_exception)
+      handler.handle_exception
+      handler.send(:response_layout).should == 'fallback'
+    end
+  end
+
+  describe '.response_text' do
+    it "should return the response mapped to the exception class if it exists" do
+      RailsExceptionHandler.configure { |config|
+        config.responses[:not_found] = 'Page not found'
+        config.response_mapping = {'ActiveRecord::RecordNotFound' => :not_found}
+      }
+      env = create_env
+      exception = create_exception
+      exception.stub!(:class => ActiveRecord::RecordNotFound)
+      handler = RailsExceptionHandler::Handler.new(env, exception)
+      handler.handle_exception
+      handler.send(:response_text).should == 'Page not found'
+    end
+
+    it "should return the default response if a mapping does not exist" do
+      RailsExceptionHandler.configure { |config|
+        config.responses[:default] = 'Default response'
+        config.response_mapping = {}
+      }
+      env = create_env
+      exception = create_exception
+      exception.stub!(:class => ActiveRecord::RecordNotFound)
+      handler = RailsExceptionHandler::Handler.new(env, exception)
+      handler.handle_exception
+      handler.send(:response_text).should == 'Default response'
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: rails_exception_handler
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sharagoz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-17 00:00:00 +02:00
+date: 2011-07-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency