wvanbergen-http_status_exceptions 0.1.7 → 0.2.0

data/MIT-LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2008 Willem van Bergen
- 
+Copyright (c) 2008-2009 Willem van Bergen
+
 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
@@ -7,14 +7,14 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,3 +1,7 @@
+<b>WARNING:</b> the gem version that Github currently serves is faulty. The issue
+is already fixed in the repository, but Github will not build new gems anymore. Make
+sure to install the latest version from the gemcutter repository (see below)
+
 = HTTP status exception
 
 This simple plugin will register exception classes for all HTTP status. These exceptions can then be raised from your controllers, after
@@ -10,11 +14,11 @@ See the project wiki (http://github.com/wvanbergen/http_status_exceptions/wikis)
 
 == Installation
 
-Installation is simple. Simply add the gem in your <tt>environment.rb</tt>:
+Installation is simple. Simply add the gem to the configuration in your <tt>environment.rb</tt>:
 
   Rails::Initializer.run do |config|
     ...
-    config.gem 'wvanbergen-http_status_exceptions', :lib => 'http_status_exceptions', :source => 'http://gems.github.com'
+    config.gem 'http_status_exceptions', :source => 'http://gemcutter.org'
   end
 
 Run <tt>rake gems:install</tt> to install the gem if needed.
@@ -40,7 +44,7 @@ If you don't set a template_layout the current layout for the requested action w
 == Usage
 
   class BlogController < ApplicationController
-    
+
     def destroy
       raise HTTPStatus::Forbidden, 'You cannot delete blogs!' unless current_user.can_delete_blogs?
       @blog.destroy

data/http_status_exceptions.gemspec

@@ -1,18 +1,23 @@
 Gem::Specification.new do |s|
-  s.name    = 'http_status_exceptions'
-  s.version = "0.1.7"
-  s.date    = "2009-09-26"
+  s.name    = 'wvanbergen-http_status_exceptions'
+
+  # Do not update the version and date values by hand.
+  # This will be done automatically by the gem release script.
+  s.version = "0.2.0"
+  s.date    = "2009-10-07"
 
   s.summary     = "A Rails plugin to use exceptions for generating HTTP status responses"
   s.description = "Clean up your controller code by raising exceptions that generate responses with different HTTP status codes."
 
-  s.add_runtime_dependency('action_controller')
+  s.add_runtime_dependency('actionpack', '>= 2.1.0')
   s.add_development_dependency('rspec')
 
   s.authors  = ['Willem van Bergen']
   s.email    = ['willem@vanbergen.org']
   s.homepage = 'http://github.com/wvanbergen/http_status_exceptions/wikis'
 
+  # Do not update the files and test_files values by hand.
+  # This will be done automatically by the gem release script.
   s.files      = %w(spec/spec_helper.rb http_status_exceptions.gemspec .gitignore init.rb lib/http_status_exceptions.rb Rakefile MIT-LICENSE tasks/github-gem.rake README.rdoc spec/http_status_exception_spec.rb)
   s.test_files = %w(spec/http_status_exception_spec.rb)
 end

data/lib/http_status_exceptions.rb

@@ -1,8 +1,34 @@
+# The HTTPStatus module is the core of the http_status_exceptions gem and
+# contains all functionality.
+#
+# The module contains <tt>HTTPStatus::Base</tt> class, which is used as a
+# superclass for every HTTPStatus exception. Subclasses, like
+# <tt>HTTPStatus::Forbidden</tt> or <tt>HTTPStatus::NotFound</tt> will be
+# generated on demand by the <tt>HTTPStatus.const_missing</tt> method.
+#
+# Moreover, it contains methods to handle these exceptions and integrate this
+# functionality into <tt>ActionController::Base</tt>. When this module is in
+# included in the <tt>ActionController::Base</tt> class, it will call
+# <tt>rescue_from</tt> on it to handle all <tt>HTTPStatus::Base</tt>
+# exceptions with the <tt>HTTPStatus#http_status_exceptions</tt> method.
+#
+# The exception handler will try to render a response with the correct
+# HTTPStatus. When no suitable template is found to render the exception with,
+# it will simply respond with an empty HTTP status code.
 module HTTPStatus
 
+  # The current gem release version. Do not set this value by hand, it will
+  # be done automatically by them gem release script.
+  VERSION = "0.2.0"
+
   # The Base HTTP status exception class is used as superclass for every
-  # exception class that is constructed. It implements some shared functionality
-  # for finding the status code and determining the template path to render.
+  # exception class that is constructed. It implements some shared
+  # functionality for finding the status code and determining the template
+  # path to render.
+  #
+  # Subclasses of this class will be generated on demand when a non-exisiting
+  # constant of the <tt>HTTPStatus</tt> module is requested. This is
+  # implemented in the <tt>HTTPStatus.const_missing</tt> method.
   class Base < StandardError
 
     # The path from which the error documents are loaded.
@@ -11,59 +37,82 @@ module HTTPStatus
 
     # The layout in which the error documents are rendered
     cattr_accessor :template_layout
-    @@template_path = nil # Use the standard layout template setting by default.
+    @@template_layout = nil # Use the standard layout template setting by default.
 
     attr_reader :details
 
-    # Creates the exception with a message and some optional other info.
+    # Initializes the exception instance.
+    # <tt>message</tt>:: The exception message.
+    # <tt>details</tt>:: An object with details about the exception.
     def initialize(message = nil, details = nil)
       @details = details
       super(message)
     end
 
-    # Returns the HTTP status symbol (as defined by Rails) corresponding to this class.
-    # This method should be overridden by subclasses
+    # Returns the HTTP status symbol corresponding to this class. This is one
+    # of the symbols that can be found in the map that can be found in
+    # <tt>ActionController::StatusCodes</tt>.
+    #
+    # This method should be overridden by subclasses, as it returns
+    # <tt>:internal_server_error</tt> by default. This is done automatically
+    # when a new exception class is being generated by
+    # <tt>HTTPStatus.const_missing</tt>.
     def self.status
       :internal_server_error
     end
 
-    # Returns the HTTP status symbol (as defined by Rails) corresponding to this instance.
-    # By default, it calls the class method of the same name.
+    # Returns the HTTP status symbol (as defined by Rails) corresponding to
+    # this instance. By default, it calls the class method of the same name.
     def status
       self.class.status
     end
 
-    # The numeric status code corresponding to this exception class.
-    # Uses the status code map provided by Rails.
+    # The numeric status code corresponding to this exception class. Uses the
+    # status symbol to code map in <tt>ActionController::StatusCodes</tt>.
     def self.status_code
       ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE[self.status]
     end
 
-    # The numeric status code corresponding to this exception.
-    # By default, it calls the class method of the same name.
+    # The numeric status code corresponding to this exception. By default, it
+    # calls the class method of the same name.
     def status_code
       self.class.status_code
     end
 
-    # The name of the template that should be used as error page for this exception class.
+    # The name of the template that should be used as error page for this
+    # exception class.
     def self.template
       "#{template_path}/#{status}"
     end
 
-    # The name of the template that should be used as error page for this exception.
-    # By default, it calls the class method of the same name.
+    # The name of the template that should be used as error page for this
+    # exception. By default, it calls the class method of the same name.
     def template
       self.class.template
     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.
+  # This function will install a rescue_from handler for HTTPStatus::Base
+  # exceptions in the class in which this module is included.
+  #
+  # <tt>base</tt>:: The class in which the module is included. Should be
+  # <tt>ActionController::Base</tt> during the initialization of the gem.
   def self.included(base)
     base.send(:rescue_from, HTTPStatus::Base, :with => :http_status_exception)
   end
 
-  # Generates a HTTPStatus::Base subclass for every subclass that is found
+  # Generates a <tt>HTTPStatus::Base</tt> subclass on demand based on the
+  # constant name. The constant name should correspond to one of the status
+  # symbols defined in <tt>ActionController::StatusCodes</tt>. The function
+  # will raise an exception if the constant name cannot be mapped onto one of
+  # the status symbols.
+  #
+  # This method will create a new subclass of <tt>HTTPStatus::Base</tt> and
+  # overrides the status class method of the class to return the correct
+  # status symbol.
+  #
+  # <tt>const</tt>:: The name of the missing constant, for which an exception
+  # class should be generated.
   def self.const_missing(const)
     status_symbol = const.to_s.underscore.to_sym
     raise "Unrecognized HTTP Status name!" unless ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE.has_key?(status_symbol)
@@ -74,9 +123,14 @@ module HTTPStatus
     return const_get(const)
   end
 
-  # 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.
+  # 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 corresponding to the exception.
+  #
+  # You can override this method in your <tt>ApplicationController</tt> to
+  # handle the exceptions yourself.
+  #
+  # <tt>exception</tt>:: The HTTP status exception to handle.
   def http_status_exception(exception)
     @exception = exception
     render_options = {:template => exception.template, :status => exception.status}
@@ -87,5 +141,6 @@ module HTTPStatus
   end
 end
 
-# Include the HTTPStatus module into ActionController to enable its functionality
-ActionController::Base.send(:include, HTTPStatus)
+# Include the HTTPStatus module into <tt>ActionController::Base</tt> to enable
+# the <tt>http_status_exception</tt> exception handler.
+ActionController::Base.send(:include, HTTPStatus)

data/spec/http_status_exception_spec.rb

@@ -1,12 +1,12 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe HTTPStatus::Base do
-  before(:each) do
+describe HTTPStatus::Base, 'class inheritance' do
+  before(:all) do
     ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE.stub!(:has_key?).with(:testing_status).and_return(true)
     @status_exception_class = HTTPStatus::TestingStatus
   end
 
-  after(:each) do
+  after(:all) do
     HTTPStatus::Base.template_path = 'shared/http_status'
     HTTPStatus.send :remove_const, 'TestingStatus'
   end
@@ -15,6 +15,10 @@ describe HTTPStatus::Base do
     @status_exception_class.status.should == :testing_status
   end
 
+  it "should use 'shared/http_status' as default view path" do
+    @status_exception_class.template.should == 'shared/http_status/testing_status'
+  end
+
   it "should check ActionController's status code list for the status code based on the class name" do
     ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE.should_receive(:[]).with(:testing_status)
     @status_exception_class.status_code
@@ -24,7 +28,7 @@ describe HTTPStatus::Base do
     HTTPStatus::Base.template_path = 'testing'
     @status_exception_class.template.should == 'testing/testing_status'
   end
-  
+
   it "should raise an exception when the class name does not correspond to a HTTP status code" do
     lambda { HTTPStatus::Nonsense }.should raise_error
   end
@@ -45,10 +49,10 @@ end
     it "should return the correct status code (#{status_code}) when using the class" do
       HTTPStatus.const_get(status_class).status_code.should == status_code
     end
-    
+
     it "should return the correct status code (#{status_code}) when using the instance" do
       HTTPStatus.const_get(status_class).new.status_code.should == status_code
-    end    
+    end
   end
 end
 
@@ -84,9 +88,9 @@ describe 'HTTPStatus#http_status_exception' do
     HTTPStatus::Base.template_layout = 'testing'
     @controller.http_status_exception(HTTPStatus::Base.new('test'))
   end
-  
+
   it "should call head with the correct status code if render cannot found a template" do
-    @controller.stub!(:render).and_raise(ActionView::MissingTemplate.new([], 'template.htm.erb'))
+    @controller.stub!(:render).and_raise(ActionView::MissingTemplate.new([], 'template.html.erb'))
     @controller.should_receive(:head).with(:internal_server_error)
     @controller.http_status_exception(HTTPStatus::Base.new('test'))
   end

data/tasks/github-gem.rake

@@ -179,7 +179,7 @@ module GithubGem
 
     # Checks whether the current branch is not diverged from the remote branch
     def check_not_diverged_task
-      raise "The current branch is diverged from the remote branch!" if git.log.between('HEAD', git.branches["#{remote}/#{remote_branch}"].gcommit).any?
+      raise "The current branch is diverged from the remote branch!" if git.log.between('HEAD', git.remote(remote).branch(remote_branch).gcommit).any?
     end
 
     # Checks whether the repository status ic clean
@@ -308,7 +308,15 @@ module GithubGem
         response = http.get(path)
         open(__FILE__, "w") { |file| file.write(response.body) }
       end
-      puts "Updated gem release tasks file with latest version."
+
+      relative_file = File.expand_path(__FILE__).sub(%r[^#{git.dir.path}/], '')
+      if git.status[relative_file] && git.status[relative_file].type == 'M'
+        git.add(relative_file)
+        git.commit("Updated to latest gem release management tasks.")
+        puts "Updated to latest version of gem release management tasks."
+      else
+        puts "Release managament tasks already are at the latest version."
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wvanbergen-http_status_exceptions
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-26 00:00:00 -07:00
+date: 2009-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: action_controller
+  name: actionpack
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.1.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -52,9 +52,10 @@ files:
 - tasks/github-gem.rake
 - README.rdoc
 - spec/http_status_exception_spec.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/wvanbergen/http_status_exceptions/wikis
-licenses: 
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -77,7 +78,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A Rails plugin to use exceptions for generating HTTP status responses
 test_files: 
 - spec/http_status_exception_spec.rb