rack-rescue 0.1.0

data/Users/dneighman/Projects/rack-rescue/Gemfile

@@ -0,0 +1,15 @@
+# A sample Gemfile
+source :rubygems
+
+  gem 'rake'
+  gem 'rack'
+  gem 'extlib'
+  gem 'hashie'
+  gem 'dirge'
+  gem 'any_view', '>=0.2'
+  gem 'tilt',     '>=0.10'
+  gem 'pancake',  '>=0.2'
+
+group(:test) do
+  gem 'rspec'
+end

data/Users/dneighman/Projects/rack-rescue/Gemfile.lock

@@ -0,0 +1,93 @@
+--- 
+dependencies: 
+  pancake: 
+    group: 
+    - :default
+    version: ">= 0.2"
+  rake: 
+    group: 
+    - :default
+    version: ">= 0"
+  any_view: 
+    group: 
+    - :default
+    version: ">= 0.2"
+  hashie: 
+    group: 
+    - :default
+    version: ">= 0"
+  rspec: 
+    group: 
+    - :test
+    version: ">= 0"
+  dirge: 
+    group: 
+    - :default
+    version: ">= 0"
+  rack: 
+    group: 
+    - :default
+    version: ">= 0"
+  extlib: 
+    group: 
+    - :default
+    version: ">= 0"
+  tilt: 
+    group: 
+    - :default
+    version: ">= 0.10"
+specs: 
+- rake: 
+    version: 0.8.7
+- builder: 
+    version: 2.1.2
+- i18n: 
+    version: 0.3.7
+- memcache-client: 
+    version: 1.8.3
+- tzinfo: 
+    version: 0.3.22
+- activesupport: 
+    version: 3.0.0.beta3
+- columnize: 
+    version: 0.3.1
+- linecache: 
+    version: "0.43"
+- ruby-debug-base: 
+    version: 0.10.3
+- ruby-debug: 
+    version: 0.10.3
+- tilt: 
+    version: "0.10"
+- any_view: 
+    version: 0.2.2
+- dirge: 
+    version: 0.0.4
+- extlib: 
+    version: 0.9.15
+- fuzzyhash: 
+    version: 0.0.11
+- hashie: 
+    version: 0.2.0
+- json: 
+    version: 1.4.3
+- rack: 
+    version: 1.1.0
+- rack-accept-media-types: 
+    version: "0.9"
+- rack-test: 
+    version: 0.5.4
+- thor: 
+    version: 0.13.6
+- usher: 
+    version: 0.7.1
+- wrapt: 
+    version: 0.1.5
+- pancake: 
+    version: 0.2.0
+- rspec: 
+    version: 1.3.0
+hash: 5cef1217c6aaf844669831ef4a76bb2057a382b7
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/Users/dneighman/Projects/rack-rescue/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Neighman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Users/dneighman/Projects/rack-rescue/README.textile

@@ -0,0 +1,80 @@
+h1. Rack::Rescue
+
+Rack Rescue is a middleware for handling exceptions in your rack application.
+
+Rack::Rescue will set the correct status, render a template, and optionally run any number of callbacks when an exception is experienced.
+
+Just insert the middleware in your stack, and any unhandled exception will trigger the handling.  Unknown exceptions trigger a basic error page, with a 500 status.
+
+Rather than launch into a long-winded chat about what it can do, I'll suffice with a list.
+
+* Per exception status codes
+* Per exception templates (with a fallback template)
+* Content type negotiation (:html, :xml, :js etc)
+* cascading tempate locations
+* template naming of the usual <name>.<format>.<(erb|haml|other tilt template)>
+* template naming including the RACK_ENV
+** <name>.<RACK_ENV>.<format>.<(tilt template engine ext)>
+** If the more specific template is not found, it will fall back to just name, format and ext
+* template inheritance
+* Arbitrary exception hooks
+
+h2. Adding Exceptions
+
+<pre><code>
+  # Add to the default list
+  Rack::Rescue::Exceptions.add_defaults("MyException", "AnotherException", :status => 404)
+  Rack::Rescue::Exceptions.add_defaults("DifferetOne", :status => 455, :template => "different")
+
+  # Add to a specific Rack::Rescue
+  use Rack::Rescue do |rr|
+    rr.add("SomeException", :status => 478, :template => "something")
+  end
+</code></pre>
+
+h2. Add a template location
+
+By default templates should be located in
+
+&lt;handler root&gt;/rack_rescue_templates/**/*
+
+To add a new handler root
+
+<pre><code>
+  Rack::Rescue::Handler.roots << File.join(Dir.pwd, "views")
+</pre></code>
+
+This will then look in "./views/rack_rescue_template" directory for you templates.  If it doesn't find them in there it will fall back to the templates located in any other roots, or finall to the default templates it ships with.
+
+h2. Template Naming
+
+Templates are named with the following form, in the following preference:
+
+1. name.env.format.ext # error.development.html.erb
+2. name.format.ext     # error.html.erb
+
+If the first is not matched, the second will be also checked
+
+h2. Arbitrary Exception hooks
+
+When an exception is detected, any exception hooks that have been declared are executed before the template is rendered and the response returned to the client.
+
+<pre><code>
+  Rack::Rescue.add_handler do |exception, env, options|
+    # email me the exception!
+  end
+</code></pre>
+
+h1. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2010 Daniel Neighman. See LICENSE for details.

data/Users/dneighman/Projects/rack-rescue/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+
+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 |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-rescue #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Users/dneighman/Projects/rack-rescue/TODO.textile

@@ -0,0 +1,7 @@
+h1. TODO
+
+* Add simple helpers for the view
+* Add default templates for differnt formats (content negotiation)
+* Make the default handler inheritance safe (DEFAULT_HANLDERS)
+* Provide a format check to use in preference to the normal content_negotiation
+* Make it layout aware

data/Users/dneighman/Projects/rack-rescue/lib/rack-rescue.rb

@@ -0,0 +1 @@
+require 'rack/rescue'

data/Users/dneighman/Projects/rack-rescue/lib/rack/rescue.rb

@@ -0,0 +1,93 @@
+require 'pancake'
+module Rack
+  # Rack Middleware for rescuing exceptions and responding to the client
+  # With a page that is descriptive
+  class Rescue
+    autoload :Exceptions, 'rack/rescue/default_exceptions'
+    autoload :Handler,    'rack/rescue/handler'
+    autoload :Responder,  'rack/rescue/responder'
+
+    inheritable_inner_classes "Exceptions", "Handler", "Responder"
+    class_inheritable_accessor :error_handlers
+    self.error_handlers = []
+
+    # Make sure there are a minimum set of formats available
+    [:html, :xml, :text, :js, :json].each do |f|
+      ::Pancake::MimeTypes.group(f)
+    end
+
+    def self.default_formats
+      return @default_formats if @default_formats
+
+      if ENV['RACK_ENV'] == 'production'
+        @default_formats = Pancake::MimeTypes.groups.keys.map(&:to_sym)
+      else
+        Pancake::MimeTypes.groups.keys.map(&:to_sym)
+      end
+    end
+
+    def self.add_handler(&blk)
+      error_handlers << blk
+    end
+
+    def initialize(app, options = {})
+      @app = app
+      load_defaults = options.fetch(:load_default_exceptions, true)
+      @exceptions_map = Exceptions.new(load_defaults)
+      @formats        = options[:formats]
+      yield @exceptions_map if block_given?
+    end
+
+    def formats
+      @formats || self.class.default_formats
+    end
+
+    def formats=(fmts)
+      @formats = fmts
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => e
+      handle_exception(env, e)
+    end
+
+    private
+    # Apply the layout if it exists
+    # @api private
+    def apply_layout(env, content, opts)
+      if layout = env['layout']
+        layout.format = opts[:format]
+        layout.content = content
+        layout.template_name = opts[:layout] if layout.template_name?(opts[:layout], opts)
+        layout
+      else
+        content
+      end
+    end
+
+    def handle_exception(env, e)
+      # negotiate the content
+      request = Rack::Request.new(env)
+      responder = Responder.new(env, self)
+      opts = {}
+      if request.path =~ /\.(.\w)$/
+        opts[:format] = $1
+      end
+      responder.negotiate! opts
+
+      opts[:format] = responder.content_type
+      opts[:layout] ||= 'error'
+
+      self.class.error_handlers.each{|blk| blk.call(e, env, opts)}
+
+      handler = @exceptions_map[e].nil? ? @exceptions_map[RuntimeError] : @exceptions_map[e]
+
+      resp, status = handler.render_error(e, opts), handler.status
+
+      response = apply_layout(env, resp, opts)
+
+      Rack::Response.new(response, status, responder.headers).finish
+    end
+  end
+end

data/Users/dneighman/Projects/rack-rescue/lib/rack/rescue/default_exceptions.rb

@@ -0,0 +1,16 @@
+require 'rack/rescue/exceptions'
+
+class Rack::Rescue::Exceptions
+  DEFAULT_HANDLERS = [
+   ["RuntimeError",                            {:status => 500}],
+   ["DataMapper::ObjectNotFoundError",         {:status => 404}],
+   ["ActiveRecord::RecordNotFound",            {:status => 404}],
+   ["Pancake::Errors::NotFound",               {:status => 404, :template => :not_found}],
+   ["Pancake::Errors::UnknownRouter",          {:status => 500}],
+   ["Pancake::Errors::UnknownConfiguration",   {:status => 500}],
+   ["Pancake::Errors::Unauthorized",           {:status => 401}],
+   ["Pancake::Errors::Forbidden",              {:status => 403}],
+   ["Pancake::Errors::Server",                 {:status => 500}],
+   ["Pancake::Errors::NotAcceptable",          {:status => 406}]
+  ].map{|(name, opts)| Rack::Rescue::Handler.new(name, opts)}
+end

data/Users/dneighman/Projects/rack-rescue/lib/rack/rescue/exceptions.rb

@@ -0,0 +1,107 @@
+module Rack
+  class Rescue
+    class Exceptions
+
+      # Add default exceptions to handle.
+      #
+      # @example
+      #   Rack::Rescue::Exceptions.add_defaults("MyException", "AnotherException", :status => 404)
+      #
+      # @api public
+      # @see Rack::Rescue::Exceptions::Handler
+      # @see Rack::Rescue::Exceptions#add
+      def self.add_defaults(*exceptions)
+        opts = Hash === exceptions.last ? exceptions.pop : {}
+        exceptions.each do |e|
+          DEFAULT_HANDLERS << Handler.new(e, opts)
+        end
+      end
+
+      # Remove a deafult exception from the list
+      #
+      # @example
+      #   Rack::Rescue::Exceptions.remove_defaults("MyException", "AnotherException")
+      #   Rack::Rescue::Exceptions.remove_defaults(/MyKindOfException/)
+      #
+      # @api public
+      # @see Rack::Rescue::Exceptions.add_defaults
+      def self.remove_defaults(*exceptions)
+        removed = []
+        exceptions.each do |e|
+          DEFAULT_HANDLERS.each do |h|
+            match = case  e
+            when String
+              h.name == e
+            when Regexp
+              h.name =~ e
+            end
+            removed << h if match
+          end
+        end
+        removed.each{|r| DEFAULT_HANDLERS.delete(r) }
+      end
+
+      # @param load_defaults Load the default list of exceptions into this instance
+      def initialize(load_defaults = true)
+        @exception_handlers = {}
+        load_defaults! if load_defaults
+      end
+
+      # Loads the default list of exceptions defined in
+      # Rack::Rescue::Exceptions::DEFAULT_HANDLERS
+      # @api public
+      def load_defaults!
+        DEFAULT_HANDLERS.each do |handler|
+          exception_handlers[handler.name] = handler
+        end
+      end
+
+      # Add an exception handler to Rack::Rescue.
+      # Whenever Rack::Rescue rescues an exception, it will check it's list to see what to do with it.
+      #
+      # @param exceptions a list of exceptions with an optional options hash on the end
+      #
+      # @option :status [Integer] An integer representing the http response code that should be associated with this exception
+      #
+      # @api public
+      # @see Rack::Rescue::Exceptions.add_defaults
+      # @see Rack::Rescue::Exceptions::Handler
+      def add(*exceptions)
+        opts = Hash === exceptions.last ? exceptions.pop : {}
+        exceptions.each do |e|
+          name = exception_name(e)
+          exception_handlers[name] = Handler.new(e, opts)
+        end
+      end
+
+      # Remove an exception handler from this instance of Rack::Rescue::Exceptions
+      # This will not remove a default handler
+      def delete(e)
+        exception_handlers.delete(exception_name(e))
+      end
+
+      def exception_handlers
+        @exception_handlers
+      end
+
+      def [](exception)
+        exception_handlers[exception_name(exception)]
+      end
+
+      def self.exception_name(e)
+        case e
+        when String
+          e
+        when Class
+          e.name
+        else
+          e.class.name
+        end
+      end
+
+      def exception_name(e)
+        self.class.exception_name(e)
+      end
+    end
+  end
+end