vidibus-routing_error 0.2.1 → 0.2.2

data/README.md

@@ -0,0 +1,143 @@
+# Vidibus::RoutingError
+
+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 [Vidibus](http://vidibus.org), an open source toolset 
+for building distributed (video) applications.
+
+
+## Please Read This
+
+In most cases it will be sufficient to add a catch-all route. But don't put 
+it just at the end of `routes.rb` because that will disable all routes defined
+by gems your application uses. Instead, append the route in `application.rb`:
+
+```ruby
+module PutYourApplicationNameHere
+  class Application < Rails::Application
+    # Catch 404s
+    config.after_initialize do |app|
+      app.routes.append{match '*path', :to => 'application#rescue_404'}
+    end
+  end
+end
+```
+
+If that won't work for any reason, you may still use this gem. :)
+
+
+## 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).
+
+
+## Installation
+
+Add the dependency to the Gemfile of your application:
+
+```ruby
+gem 'vidibus-routing_error'
+```
+
+Then call bundle install on your console.
+
+
+## Usage
+
+With this gem installed, you are able to handle errors like in past versions
+of Rails:
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from ActionController::RoutingError, :with => :rescue_404
+
+  def rescue_404
+    # do something
+    # IMPORTANT: If you modify this method, you have to restart the server.
+  end
+end
+```
+
+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
+an `ActionController::RoutingError` on application level so you can rescue this error.
+
+
+### Custom controller for error handling
+
+If you want to handle the error in a specific controller, you can also route the path
+`'/routing_error'` in `routes.rb` to it:
+
+```ruby
+match 'routing_error' => 'my_controller#rescue_404'
+```
+
+The failing URI will be available in the environment variable:
+
+```ruby
+env['vidibus-routing_error.request_uri']
+```
+
+
+## Possible Issues
+
+### Catch-all Route
+
+If your application has a catch-route in `routes.rb`, this gem won't work, because 
+routes provided by engines will be added after any existing routes. If you don't 
+need a catch-all route for other purposes than rescuing from routing errors, you can 
+savely remove it.
+
+
+### Class Caching
+
+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 provided by some engine. You should be able to get rid of
+the error above by turning on class caching. Try it (and restart the server afterwards):
+
+```ruby
+# 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:
+
+```ruby
+# top of development.rb
+require 'app/models/user'
+```
+
+## Copyright
+
+&copy; 2010-2012 Andre Pankratz. See LICENSE for details.
+
+
+## Thank you!
+
+The development of this gem was sponsored by Käuferportal: http://www.kaeuferportal.de

data/Rakefile

@@ -1,47 +1,17 @@
-require "rubygems"
-require "rake"
+require 'bundler'
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
 
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gem|
-    gem.name = "vidibus-routing_error"
-    gem.summary = %Q{Catches ActionController::RoutingError in Rails 3.}
-    gem.description = %Q{Catches ActionController::RoutingError and sends it to a custom method.}
-    gem.email = "andre@vidibus.com"
-    gem.homepage = "http://github.com/vidibus/vidibus-routing_error"
-    gem.authors = ["Andre Pankratz"]
-    gem.add_development_dependency "rspec"
-    gem.add_development_dependency "relevance-rcov"
-    gem.add_development_dependency "rr"
-    gem.add_dependency "rails", "~> 3.0.0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require "spec/rake/spectask"
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << "lib" << "spec"
-  spec.spec_files = FileList["spec/**/*_spec.rb"]
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |t|
-  t.spec_files = FileList["spec/vidibus/**/*_spec.rb"]
-  t.rcov = true
-  t.rcov_opts = ["--exclude", "^spec,/gems/"]
-end
+Bundler::GemHelper.install_tasks
 
-task :spec => :check_dependencies
-task :default => :spec
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'vidibus/routing_error/version'
 
-require "rake/rdoctask"
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?("VERSION") ? File.read("VERSION") : ""
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "vidibus-routing_error #{version}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-  rdoc.options << "--charset=utf-8"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vidibus-routing_error #{Vidibus::RoutingError::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--charset=utf-8'
 end

data/app/controllers/routing_error_controller.rb

@@ -9,7 +9,7 @@ class RoutingErrorController < ApplicationController
   #   end
   #
   def rescue
-    env["REQUEST_URI"] = env["vidibus-routing_error.request_uri"]
-    raise ActionController::RoutingError, "No route matches #{env["REQUEST_URI"].inspect}"
+    env['REQUEST_URI'] = env['vidibus-routing_error.request_uri']
+    raise ActionController::RoutingError, "No route matches #{env['REQUEST_URI'].inspect}"
   end
 end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  match "routing_error" => "routing_error#rescue"
+  match 'routing_error' => 'routing_error#rescue'
 end

data/lib/vidibus-routing_error.rb

@@ -1,10 +1,9 @@
-$:.unshift(File.join(File.dirname(__FILE__), "..", "lib", "vidibus"))
-require "routing_error/rack"
+require 'vidibus/routing_error/rack'
 
 module Vidibus::RoutingError
   class Engine < ::Rails::Engine
     unless Rails.env.test?
-      config.app_middleware.insert_after("ActionDispatch::ShowExceptions", "Vidibus::RoutingError::Rack")
+      config.app_middleware.insert_after('ActionDispatch::ShowExceptions', 'Vidibus::RoutingError::Rack')
     end
   end
-end
+end

data/lib/vidibus/routing_error/rack.rb

@@ -8,8 +8,8 @@ module Vidibus
       def call(env)
         response = @app.call(env)
         if response[0] == 404
-          env["vidibus-routing_error.request_uri"] = env["REQUEST_URI"]
-          env["PATH_INFO"] = env["REQUEST_URI"] = "/routing_error"
+          env['vidibus-routing_error.request_uri'] = env['REQUEST_URI']
+          env['PATH_INFO'] = env['REQUEST_URI'] = '/routing_error'
           @app.call(env)
         else
           response

data/lib/vidibus/routing_error/version.rb

@@ -0,0 +1,5 @@
+module Vidibus
+  module RoutingError
+    VERSION = '0.2.2'
+  end
+end

metadata

@@ -1,136 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vidibus-routing_error
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Andre Pankratz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-04 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153329160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: relevance-rcov
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153329160
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153328620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rr
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153328620
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2153327940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
-  type: :runtime
-  version_requirements: *id004
+  version_requirements: *2153327940
 description: Catches ActionController::RoutingError and sends it to a custom method.
 email: andre@vidibus.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+extra_rdoc_files: []
+files:
+- lib/vidibus/routing_error/rack.rb
+- lib/vidibus/routing_error/version.rb
+- lib/vidibus-routing_error.rb
 - 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
-has_rdoc: true
-homepage: http://github.com/vidibus/vidibus-routing_error
+- LICENSE
+- README.md
+- Rakefile
+homepage: https://github.com/vidibus/vidibus-routing_error
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.6.2
+rubyforge_project: vidibus-routing_error
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Catches ActionController::RoutingError in Rails 3.
-test_files: 
-- spec/spec_helper.rb
+summary: Catches ActionController::RoutingError in Rails 3
+test_files: []

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/README.rdoc

@@ -1,108 +0,0 @@
-= Vidibus::RoutingError
-
-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 "*path" => "application#rescue_404"
-
-<b>But beware of the major drawback!</b> 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
-
-Add the dependency to the Gemfile of your application:
-
-  gem "vidibus-routing_error"
-
-Then call bundle install on your console.
-
-
-== Usage
-
-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
-
-    def rescue_404
-      # do something
-      # IMPORTANT: If you modify this method, you have to restart the server.
-    end
-  end
-
-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
-
-=== Catch-all Route
-
-If your application has a catch-route, this gem won't work, because routes provided by
-engines will be added after any existing routes. If you don't need a catch-all route for
-other purposes than rescuing from routing errors, you can savely remove it.
-
-
-=== Class Caching
-
-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 provided by some engine. 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.
-
-
-== Thank you!
-
-The development of this gem was sponsored by Käuferportal: http://www.kaeuferportal.de

data/VERSION

@@ -1 +0,0 @@
-0.2.1

data/spec/spec.opts

@@ -1,2 +0,0 @@
---color
---format nested

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
-
-require "rubygems"
-require "active_support/core_ext"
-require "spec"
-require "rr"
-require "vidibus-routing_error"
-
-Spec::Runner.configure do |config|
-  config.mock_with RR::Adapters::Rspec
-end

data/vidibus-routing_error.gemspec

@@ -1,62 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# 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.2.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andre Pankratz"]
-  s.date = %q{2011-05-04}
-  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"
-  ]
-  s.files = [
-    ".document",
-    "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.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Catches ActionController::RoutingError in Rails 3.}
-  s.test_files = [
-    "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<relevance-rcov>, [">= 0"])
-      s.add_development_dependency(%q<rr>, [">= 0"])
-      s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<relevance-rcov>, [">= 0"])
-      s.add_dependency(%q<rr>, [">= 0"])
-      s.add_dependency(%q<rails>, ["~> 3.0.0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<relevance-rcov>, [">= 0"])
-    s.add_dependency(%q<rr>, [">= 0"])
-    s.add_dependency(%q<rails>, ["~> 3.0.0"])
-  end
-end
-