wvanbergen-http_status_exceptions 0.1.1 → 0.1.2

data/README.rdoc

@@ -6,6 +6,8 @@ which a response will be send back to the client with the desired HTTP status, p
 You can use this plugin to access control mechanisms. You can simply raise a HTTPStatus::Forbidden if a user is not allowed to
 perform a certain action. A nice looking error page will be the result. See the example below 
 
+See the project wiki (http://github.com/wvanbergen/http_status_exceptions/wikis) for additional documentation.
+
 == Installation
 
 Installation is simple. Simply add the gem in your <tt>environment.rb</tt>:

data/lib/http_status_exceptions.rb

@@ -1,27 +1,34 @@
 module HTTPStatus
   
   class Base < Exception
-    attr_accessor :status
-    
-    cattr_reader :template_path
+
+    # The path from which the error documents are loaded.
+    cattr_accessor :template_path
     @@template_path = 'shared/http_status'
+
+    attr_reader :status, :details
     
-    def initialize(message)
+    # Creates the exception with a message and some optional other info.
+    def initialize(message, details = nil)
       @status = self.class.to_s.split("::").last.underscore.to_sym
+      @details = details
       super(message)
     end
     
+    # The numeric status code corresponding to this exception
     def status_code
       ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE[@status]
     end
     
+    # The name of the template that should be used as error page for this exception
     def template
       "#{@@template_path}/#{@status}"
     end
   end
-  
+
+  # Creates all the exception classes based on Rails's list of available status code and
+  # registers the exception handler using the rescue_from method.
   def self.included(base)
-    # create all the classed
     ActionController::StatusCodes::STATUS_CODES.each do |code, name|
       const_set("#{name.to_s.gsub(/[^A-z]/, '').camelize}", Class.new(HTTPStatus::Base))
     end
@@ -29,14 +36,14 @@ module HTTPStatus
     base.send(:rescue_from, HTTPStatus::Base, :with => :http_status_exception)
   end
 
-  # The default handler for raised HTTP status exceptions
+  # The default handler for raised HTTP status exceptions. 
+  # It will render a template if available, or respond with an empty response
+  # with the HTTP status correspodning to the exception.
   def http_status_exception(exception)
     @exception = exception
-    begin
-      render(:template => exception.template, :status => exception.status)
-    rescue ActionView::MissingTemplate
-      head(exception.status)
-    end
+    render(:template => exception.template, :status => exception.status)
+  rescue ActionView::MissingTemplate
+    head(exception.status)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wvanbergen-http_status_exceptions
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-20 00:00:00 -07:00
+date: 2008-09-21 00:00:00 -07:00
 default_executable: 
 dependencies: []