http_status_exceptions 0.1.9

data/.gitignore

@@ -0,0 +1,6 @@
+http_status_exceptions-*.gem
+/tmp
+/doc
+/pkg
+/coverage
+.DS_Store

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 20082-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
+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/README.rdoc

@@ -0,0 +1,68 @@
+<b>WARNING:</b> the gem version that Github currently serves is faulty. The issue
+is already fixes in the repository, but Github is not yet building new gem
+versions. As soon as this is fixed, I will release a new version that resolves
+the issue. For now, install version 0.1.5 which is unaffected:
+
+  sudo gem install wvanbergen-http_status_exceptions \
+      --source http://gems.github.com --version "= 0.1.5"
+
+= HTTP status exception
+
+This simple plugin will register exception classes for all HTTP status. These exceptions can then be raised from your controllers, after
+which a response will be send back to the client with the desired HTTP status, possible with some other content.
+
+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>:
+
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'wvanbergen-http_status_exceptions', :lib => 'http_status_exceptions', :source => 'http://gems.github.com'
+  end
+
+Run <tt>rake gems:install</tt> to install the gem if needed.
+
+== Configuration
+
+You can modify where HTTP status exception looks for its template files like so:
+
+  class ApplicationController < ActionController::Base
+    ...
+    HTTPStatus::Base.template_path = 'path_to/http_status_templates'
+  end
+
+You can also modify which layout is used when rendering a template by setting the <tt>template_layout</tt>:
+
+  class ApplicationController < ActionController::Base
+    ...
+    HTTPStatus::Base.template_layout = 'exception'
+  end
+
+If you don't set a template_layout the current layout for the requested action will be used.
+
+== Usage
+
+  class BlogController < ApplicationController
+
+    def destroy
+      raise HTTPStatus::Forbidden, 'You cannot delete blogs!' unless current_user.can_delete_blogs?
+      @blog.destroy
+    end
+  end
+
+By default, this will return an empty response with the "forbidden" status code (403). If you want to add content
+to the response as well, create the following view: <tt>shared/http_status/forbidden.html.erb</tt>. You can use the
+<tt>@exception</tt>-object in your view:
+
+  <h1>Forbidden</h1>
+  <p> <%= h(@exception.message) %> </p>
+  <hr />
+  <p>HTTP status code <small> <%= @exception.status_code %>: <%= @exception.status.to_s.humanize %></small></p>
+
+The response will only be sent if the request format is HTML because of the name of the view file. In theory you
+could make a response for XML requests as well by using <tt>shared/http_status/forbidden.xml.builder</tt> as filename

data/Rakefile

@@ -0,0 +1,5 @@
+Dir[File.dirname(__FILE__) + "/tasks/*.rake"].each { |file| load(file) }
+
+GithubGem::RakeTasks.new(:gem)
+
+task :default => :spec

data/http_status_exceptions.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name    = '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.1.9"
+  s.date    = "2009-10-01"
+
+  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('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/init.rb

@@ -0,0 +1 @@
+require 'http_status_exceptions.rb'

data/lib/http_status_exceptions.rb

@@ -0,0 +1,146 @@
+# 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.1.9"
+
+  # 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.
+  #
+  # 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.
+    cattr_accessor :template_path
+    @@template_path = 'shared/http_status'
+
+    # The layout in which the error documents are rendered
+    cattr_accessor :template_layout
+    @@template_layout = nil # Use the standard layout template setting by default.
+
+    attr_reader :details
+
+    # 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 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.
+    def status
+      self.class.status
+    end
+
+    # 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.
+    def status_code
+      self.class.status_code
+    end
+
+    # 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.
+    def template
+      self.class.template
+    end
+  end
+
+  # 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 <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)
+    klass = Class.new(HTTPStatus::Base)
+    klass.cattr_accessor(:status)
+    klass.status = status_symbol
+    const_set(const, klass)
+    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 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}
+    render_options[:layout] = exception.template_layout if exception.template_layout
+    render(render_options)
+  rescue ActionView::MissingTemplate
+    head(exception.status)
+  end
+end
+
+# 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

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+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(:all) do
+    HTTPStatus::Base.template_path = 'shared/http_status'
+    HTTPStatus.send :remove_const, 'TestingStatus'
+  end
+
+  it "should set the status symbol based on the class name" 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
+  end
+
+  it "should use the HTTPStatus::Base.template_path setting to determine the error template" 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
+end
+
+# Run some tests for different valid subclasses.
+{ 'NotFound' => 404, 'Forbidden' => 403, 'PaymentRequired' => 402, 'InternalServerError' => 500}.each do |status_class, status_code|
+
+  describe "HTTPStatus::#{status_class}" do
+    it "should generate the HTTPStatus::#{status_class} class successfully" do
+      lambda { HTTPStatus.const_get(status_class) }.should_not raise_error
+    end
+
+    it "should create a subclass of HTTPStatus::Base for the #{status_class.underscore.humanize.downcase} status" do
+      HTTPStatus.const_get(status_class).ancestors.should include(HTTPStatus::Base)
+    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
+
+describe 'HTTPStatus#http_status_exception' do
+  before(:each) { @controller = Class.new(ActionController::Base).new }
+  after(:each)  { HTTPStatus::Base.template_layout = nil}
+
+  it "should create the :http_status_exception method in ActionController" do
+    @controller.should respond_to(:http_status_exception)
+  end
+
+  it "should call :http_status_exception when an exception is raised when handling the action" do
+    exception = HTTPStatus::Base.new('test')
+    @controller.stub!(:perform_action_without_rescue).and_raise(exception)
+    @controller.should_receive(:http_status_exception).with(exception)
+    @controller.send(:perform_action)
+  end
+
+  it "should call render with the correct view and correct HTTP status" do
+    @controller.should_receive(:render).with(hash_including(
+          :status => :internal_server_error, :template => "shared/http_status/internal_server_error"))
+
+    @controller.http_status_exception(HTTPStatus::Base.new('test'))
+  end
+
+  it "should not call render with a layout by default" do
+    @controller.should_not_receive(:render).with(hash_including(:layout => 'testing'))
+    @controller.http_status_exception(HTTPStatus::Base.new('test'))
+  end
+
+  it "should call render with a layout set when this property is set on the exception class" do
+    @controller.should_receive(:render).with(hash_including(:layout => 'testing'))
+    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.html.erb'))
+    @controller.should_receive(:head).with(:internal_server_error)
+    @controller.http_status_exception(HTTPStatus::Base.new('test'))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'spec/autorun'
+
+require 'action_controller'
+
+require 'http_status_exceptions'
+
+# Include all files in the spec_helper directory
+Dir[File.dirname(__FILE__) + "/lib/**/*.rb"].each do |file|
+  require file
+end
+
+Spec::Runner.configure do |config|
+  # nothing special
+end

data/tasks/github-gem.rake

@@ -0,0 +1,323 @@
+require 'rubygems'
+require 'rake'
+require 'rake/tasklib'
+require 'date'
+require 'git'
+
+module GithubGem
+
+  # Detects the gemspc file of this project using heuristics.
+  def self.detect_gemspec_file
+    FileList['*.gemspec'].first
+  end
+
+  # Detects the main include file of this project using heuristics
+  def self.detect_main_include
+    if detect_gemspec_file =~ /^(\.*)\.gemspec$/ && File.exist?("lib/#{$1}.rb")
+      "lib/#{$1}.rb"
+    elsif FileList['lib/*.rb'].length == 1
+      FileList['lib/*.rb'].first
+    else
+      nil
+    end
+  end
+
+  class RakeTasks
+
+    attr_reader   :gemspec, :modified_files, :git
+    attr_accessor :gemspec_file, :task_namespace, :main_include, :root_dir, :spec_pattern, :test_pattern, :remote, :remote_branch, :local_branch
+
+    # Initializes the settings, yields itself for configuration
+    # and defines the rake tasks based on the gemspec file.
+    def initialize(task_namespace = :gem)
+      @gemspec_file   = GithubGem.detect_gemspec_file
+      @task_namespace = task_namespace
+      @main_include   = GithubGem.detect_main_include
+      @modified_files = []
+      @root_dir       = Dir.pwd
+      @test_pattern   = 'test/**/*_test.rb'
+      @spec_pattern   = 'spec/**/*_spec.rb'
+      @local_branch   = 'master'
+      @remote         = 'origin'
+      @remote_branch  = 'master'
+
+      yield(self) if block_given?
+
+      @git = Git.open(@root_dir)
+      load_gemspec!
+      define_tasks!
+    end
+
+    protected
+
+    # Define Unit test tasks
+    def define_test_tasks!
+      require 'rake/testtask'
+
+      namespace(:test) do
+        Rake::TestTask.new(:basic) do |t|
+          t.pattern = test_pattern
+          t.verbose = true
+          t.libs << 'test'
+        end
+      end
+
+      desc "Run all unit tests for #{gemspec.name}"
+      task(:test => ['test:basic'])
+    end
+
+    # Defines RSpec tasks
+    def define_rspec_tasks!
+      require 'spec/rake/spectask'
+
+      namespace(:spec) do
+        desc "Verify all RSpec examples for #{gemspec.name}"
+        Spec::Rake::SpecTask.new(:basic) do |t|
+          t.spec_files = FileList[spec_pattern]
+        end
+
+        desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+        Spec::Rake::SpecTask.new(:specdoc) do |t|
+          t.spec_files = FileList[spec_pattern]
+          t.spec_opts << '--format' << 'specdoc' << '--color'
+        end
+
+        desc "Run RCov on specs for #{gemspec.name}"
+        Spec::Rake::SpecTask.new(:rcov) do |t|
+          t.spec_files = FileList[spec_pattern]
+          t.rcov = true
+          t.rcov_opts = ['--exclude', '"spec/*,gems/*"', '--rails']
+        end
+      end
+
+      desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+      task(:spec => ['spec:specdoc'])
+    end
+
+    # Defines the rake tasks
+    def define_tasks!
+
+      define_test_tasks!  if has_tests?
+      define_rspec_tasks! if has_specs?
+
+      namespace(@task_namespace) do
+        desc "Updates the filelist in the gemspec file"
+        task(:manifest) { manifest_task }
+
+        desc "Builds the .gem package"
+        task(:build => :manifest) { build_task }
+
+        desc "Sets the version of the gem in the gemspec"
+        task(:set_version => [:check_version, :check_current_branch]) { version_task }
+        task(:check_version => :fetch_origin) { check_version_task }
+
+        task(:fetch_origin) { fetch_origin_task }
+        task(:check_current_branch) { check_current_branch_task }
+        task(:check_clean_status) { check_clean_status_task }
+        task(:check_not_diverged => :fetch_origin) { check_not_diverged_task }
+
+        checks = [:check_current_branch, :check_clean_status, :check_not_diverged, :check_version]
+        checks.unshift('spec:basic') if has_specs?
+        checks.unshift('test:basic') if has_tests?
+        checks.push << [:check_rubyforge] if gemspec.rubyforge_project
+
+        desc "Perform all checks that would occur before a release"
+        task(:release_checks => checks)
+
+        release_tasks = [:release_checks, :set_version, :build, :github_release]
+        release_tasks << [:rubyforge_release] if gemspec.rubyforge_project
+
+        desc "Release a new verison of the gem"
+        task(:release => release_tasks) { release_task }
+
+        task(:check_rubyforge)   { check_rubyforge_task }
+        task(:rubyforge_release) { rubyforge_release_task }
+        task(:github_release => [:commit_modified_files, :tag_version]) { github_release_task }
+        task(:tag_version) { tag_version_task }
+        task(:commit_modified_files) { commit_modified_files_task }
+
+        desc "Updates the gem release tasks with the latest version on Github"
+        task(:update_tasks) { update_tasks_task }
+      end
+    end
+
+    # Updates the files list and test_files list in the gemspec file using the list of files
+    # in the repository and the spec/test file pattern.
+    def manifest_task
+      # Load all the gem's files using "git ls-files"
+      repository_files = git.ls_files.keys
+      test_files       = Dir[test_pattern] + Dir[spec_pattern]
+
+      update_gemspec(:files, repository_files)
+      update_gemspec(:test_files, repository_files & test_files)
+    end
+
+    # Builds the gem
+    def build_task
+      sh "gem build -q #{gemspec_file}"
+      Dir.mkdir('pkg') unless File.exist?('pkg')
+      sh "mv #{gemspec.name}-#{gemspec.version}.gem pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    # Updates the version number in the gemspec file, the VERSION constant in the main
+    # include file and the contents of the VERSION file.
+    def version_task
+      update_gemspec(:version, ENV['VERSION']) if ENV['VERSION']
+      update_gemspec(:date, Date.today)
+
+      update_version_file(gemspec.version)
+      update_version_constant(gemspec.version)
+    end
+
+    def check_version_task
+      raise "#{ENV['VERSION']} is not a valid version number!" if ENV['VERSION'] && !Gem::Version.correct?(ENV['VERSION'])
+      proposed_version = Gem::Version.new(ENV['VERSION'] || gemspec.version)
+      # Loads the latest version number using the created tags
+      newest_version   = git.tags.map { |tag| tag.name.split('-').last }.compact.map { |v| Gem::Version.new(v) }.max
+      raise "This version (#{proposed_version}) is not higher than the highest tagged version (#{newest_version})" if newest_version && newest_version >= proposed_version
+    end
+
+    # 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.remote(remote).branch(remote_branch).gcommit).any?
+    end
+
+    # Checks whether the repository status ic clean
+    def check_clean_status_task
+      raise "The current working copy contains modifications" if git.status.changed.any?
+    end
+
+    # Checks whether the current branch is correct
+    def check_current_branch_task
+      raise "Currently not on #{local_branch} branch!" unless git.branch.name == local_branch.to_s
+    end
+
+    # Fetches the latest updates from Github
+    def fetch_origin_task
+      git.fetch('origin')
+    end
+
+    # Commits every file that has been changed by the release task.
+    def commit_modified_files_task
+      if modified_files.any?
+        modified_files.each { |file| git.add(file) }
+        git.commit("Released #{gemspec.name} gem version #{gemspec.version}")
+      end
+    end
+
+    # Adds a tag for the released version
+    def tag_version_task
+      git.add_tag("#{gemspec.name}-#{gemspec.version}")
+    end
+
+    # Pushes the changes and tag to github
+    def github_release_task
+      git.push(remote, remote_branch, true)
+    end
+
+    # Checks whether Rubyforge is configured properly
+    def check_rubyforge_task
+      # Login no longer necessary when using rubyforge 2.0.0 gem
+      # raise "Could not login on rubyforge!" unless `rubyforge login 2>&1`.strip.empty?
+      output = `rubyforge names`.split("\n")
+      raise "Rubyforge group not found!"   unless output.any? { |line| %r[^groups\s*\:.*\b#{Regexp.quote(gemspec.rubyforge_project)}\b.*] =~ line }
+      raise "Rubyforge package not found!" unless output.any? { |line| %r[^packages\s*\:.*\b#{Regexp.quote(gemspec.name)}\b.*] =~ line }
+    end
+
+    # Task to release the .gem file toRubyforge.
+    def rubyforge_release_task
+      sh 'rubyforge', 'add_release', gemspec.rubyforge_project, gemspec.name, gemspec.version.to_s, "pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    # Gem release task.
+    # All work is done by the task's dependencies, so just display a release completed message.
+    def release_task
+      puts
+      puts '------------------------------------------------------------'
+      puts "Released #{gemspec.name} version #{gemspec.version}"
+    end
+
+    private
+
+    # Checks whether this project has any RSpec files
+    def has_specs?
+      FileList[spec_pattern].any?
+    end
+
+    # Checks whether this project has any unit test files
+    def has_tests?
+      FileList[test_pattern].any?
+    end
+
+    # Loads the gemspec file
+    def load_gemspec!
+      @gemspec = eval(File.read(@gemspec_file))
+    end
+
+    # Updates the VERSION file with the new version
+    def update_version_file(version)
+      if File.exists?('VERSION')
+        File.open('VERSION', 'w') { |f| f << version.to_s }
+        modified_files << 'VERSION'
+      end
+    end
+
+    # Updates the VERSION constant in the main include file if it exists
+    def update_version_constant(version)
+      if main_include && File.exist?(main_include)
+        file_contents = File.read(main_include)
+        if file_contents.sub!(/^(\s+VERSION\s*=\s*)[^\s].*$/) { $1 + version.to_s.inspect }
+          File.open(main_include, 'w') { |f| f << file_contents }
+          modified_files << main_include
+        end
+      end
+    end
+
+    # Updates an attribute of the gemspec file.
+    # This function will open the file, and search/replace the attribute using a regular expression.
+    def update_gemspec(attribute, new_value, literal = false)
+
+      unless literal
+        new_value = case new_value
+          when Array        then "%w(#{new_value.join(' ')})"
+          when Hash, String then new_value.inspect
+          when Date         then new_value.strftime('%Y-%m-%d').inspect
+          else              raise "Cannot write value #{new_value.inspect} to gemspec file!"
+        end
+      end
+
+      spec   = File.read(gemspec_file)
+      regexp = Regexp.new('^(\s+\w+\.' + Regexp.quote(attribute.to_s) + '\s*=\s*)[^\s].*$')
+      if spec.sub!(regexp) { $1 + new_value }
+        File.open(gemspec_file, 'w') { |f| f << spec }
+        modified_files << gemspec_file
+
+        # Reload the gemspec so the changes are incorporated
+        load_gemspec!
+      end
+    end
+
+    # Updates the tasks file using the latest file found on Github
+    def update_tasks_task
+      require 'net/http'
+
+      server = 'github.com'
+      path   = '/wvanbergen/github-gem/raw/master/tasks/github-gem.rake'
+
+      Net::HTTP.start(server) do |http|
+        response = http.get(path)
+        open(__FILE__, "w") { |file| file.write(response.body) }
+      end
+
+      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
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: http_status_exceptions
+version: !ruby/object:Gem::Version 
+  version: 0.1.9
+platform: ruby
+authors: 
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Clean up your controller code by raising exceptions that generate responses with different HTTP status codes.
+email: 
+- willem@vanbergen.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- 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
+has_rdoc: true
+homepage: http://github.com/wvanbergen/http_status_exceptions/wikis
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails plugin to use exceptions for generating HTTP status responses
+test_files: 
+- spec/http_status_exception_spec.rb