vidibus-routing_error 0.1.5 → 0.2.0

data/README.rdoc

@@ -1,8 +1,29 @@
 = vidibus-routing_error
 
-This gem is part of the open source SOA framework Vidibus: http://www.vidibus.org
+Catches ActionController::RoutingError which does not work with Rails 3
+out of the box. It basically catches the exception on Rack-level and
+re-raises it on application-level.
 
-Catches ActionController::RoutingError which does not work with Rails 3 out of the box. It basically catches the exception on Rack-level and re-raises it on application-level.
+This gem is part of the open source service-oriented {video
+framework}[http://vidibus.org] Vidibus.
+
+
+== Addressed Problem
+
+Since Rails 3 is based on Rack, catching a 404 error in your Application
+controller does not work as expected. The underlying problem is discussed
+{here}[https://rails.lighthouseapp.com/projects/8994/tickets/4444-can-no-longer-rescue_from-actioncontrollerroutingerror].
+
+An easy but insufficient fix for this issue is to define a catch-all route
+at the end of your routes.rb:
+
+  match "*a", :to => "application#rescue_404"
+
+*But beware of the major drawback!* If your application relies on engines that
+extend your app with their own routes, things will break because those
+routes will never get fired.
+
+With this gem, all your routing problems should be gone.
 
 
 == Installation
@@ -16,7 +37,8 @@ Then call bundle install on your console.
 
 == Usage
 
-With this gem installed, you are able to handle errors like in past versions of Rails:
+With this gem installed, you are able to handle errors like in past versions
+of Rails:
 
   class ApplicationController < ActionController::Base
     rescue_from ActionController::RoutingError, :with => :rescue_404
@@ -30,6 +52,36 @@ With this gem installed, you are able to handle errors like in past versions of
 Keep in mind that you have to restart your server when changing the rescue-method!
 
 
+== Underlying Mechanics
+
+This gem implants the middleware Vidibus::RoutingError::Rack into your Rails stack
+right after ActionDispatch::ShowExceptions which returns a 404 response if no
+matching route was found for the current request.
+
+Vidibus::RoutingError::Rack catches the 404 status and redirects internally to the route
+/routing_error which is provided by this gem.
+
+Through this route the method RoutingErrorController#rescue gets called which then raises
+a ActionController::RoutingError on application level so you can rescue this error.
+
+
+== Possible Issues
+
+Depending on the structure of your application, you might get an error in development like this:
+
+  TypeError (User can't be referred)
+
+This error is caused by some caching-reloading madness: The middleware implanted by this gem is cached. But in development, your classes usually aren't. Thus some classes may not be available under certain circumstances, e.g. if you are using before filters for user authentication. You should be able to get rid of the error above by turning on class caching. Try it (and restart the server afterwards):
+
+  # development.rb
+  config.cache_classes = true
+
+If the error is gone, you're lucky as I am. But since it is not feasible to cache classes in development, turn off class caching again and explicitly require the class that couldn't be referred. In my case, it's the user class:
+
+  # top of development.rb
+  require "app/models/user"
+
+
 == Copyright
 
 Copyright (c) 2010 Andre Pankratz. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0

data/app/controllers/routing_error_controller.rb

@@ -3,13 +3,13 @@ class RoutingErrorController < ApplicationController
   # Re-raise routing_error that has been catched in rack app.
   # To rescue this error, use default actions:
   #
-  #   rescue_from ActionController::RoutingError, :with => :my_404_rescue
-  #   def my_404_rescue
+  #   rescue_from ActionController::RoutingError, :with => :rescue_404
+  #   def rescue_404
   #     # do something
   #   end
   #
   def rescue
     env["REQUEST_URI"] = env["vidibus-routing_error.request_uri"]
-    raise env["vidibus-routing_error.exception"]
+    raise ActionController::RoutingError, "No route matches #{env["REQUEST_URI"].inspect}"
   end
 end

data/lib/vidibus-routing_error.rb

@@ -4,7 +4,7 @@ require "routing_error/rack"
 module Vidibus::RoutingError
   class Engine < ::Rails::Engine
     unless Rails.env.test?
-      config.app_middleware.insert_before("ActionDispatch::ShowExceptions", "Vidibus::RoutingError::Rack")
+      config.app_middleware.insert_after("ActionDispatch::ShowExceptions", "Vidibus::RoutingError::Rack")
     end
   end
 end

data/lib/vidibus/routing_error/rack.rb

@@ -6,18 +6,14 @@ module Vidibus
       end
 
       def call(env)
-        env["action_dispatch.show_exceptions"] = false 
-        @app.call(env)
-      rescue => exception
-        if exception.kind_of?(ActionController::RoutingError)
-          env["vidibus-routing_error.exception"] = exception
+        response = @app.call(env)
+        if response[0] == 404
           env["vidibus-routing_error.request_uri"] = env["REQUEST_URI"]
-          
-          # set routing_error path internally to catch route
           env["PATH_INFO"] = env["REQUEST_URI"] = "/routing_error"
+          @app.call(env)
+        else
+          response
         end
-        env["action_dispatch.show_exceptions"] = true
-        return @app.call(env)
       end
     end
   end

data/vidibus-routing_error.gemspec

@@ -1,38 +1,36 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{vidibus-routing_error}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andre Pankratz"]
-  s.date = %q{2010-09-09}
+  s.date = %q{2011-03-18}
   s.description = %q{Catches ActionController::RoutingError and sends it to a custom method.}
   s.email = %q{andre@vidibus.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "app/controllers/routing_error_controller.rb",
-     "config/routes.rb",
-     "lib/vidibus-routing_error.rb",
-     "lib/vidibus/routing_error/rack.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "vidibus-routing_error.gemspec"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/routing_error_controller.rb",
+    "config/routes.rb",
+    "lib/vidibus-routing_error.rb",
+    "lib/vidibus/routing_error/rack.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "vidibus-routing_error.gemspec"
   ]
   s.homepage = %q{http://github.com/vidibus/vidibus-routing_error}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Catches ActionController::RoutingError in Rails 3.}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vidibus-routing_error
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Andre Pankratz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-09 00:00:00 +02:00
+date: 2011-03-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -105,8 +104,8 @@ homepage: http://github.com/vidibus/vidibus-routing_error
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC