err_merchant 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Fabian Schwahn
+
+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,32 @@
+= err_merchant
+This is a very simple Rails Engine for replacing the standard (ugly) Rails exception pages, with pages which are rendered in your layout. There are several gems out there that do the same, but this one takes the approach proposed by AccUser[http://accuser.cc/posts/1-rails-3-0-exception-handling]. I just made a gem out of it because I use it in every project.
+
+== Installation
+Add the gem to your Gemfile, run +bundle install+ and restart your server:
+
+  gem 'err_merchant'
+
+This is it. If you want to check the error pages in development mode, make sure to set +config.consider_all_requests_local+ to +false+ and restart your development server.
+
+== I18n
+You can translate the error messages, by default they are the same as the standard Rails errors:
+
+  err_merchant:
+    '404':
+      title: "The page you were looking for doesn't exist."
+      description: "You may have mistyped the address or the page may have moved."
+    '422':
+      title: "The change you wanted was rejected."
+      description: "Maybe you tried to change something you didn't have access to."
+    '500':
+      title: "We're sorry, but something went wrong."
+      description: "We've been notified about this issue and we'll take a look at it shortly."
+
+Please note that there are +translation missing+-errors in development mode if you don't supply translations for your locale. In production however, +config.i18n.fallbacks+ is usually set to +true+, so the english error message will be shown if the lookup is unsuccessful.
+
+== Changelog
+=== 0.1.0
+* Initial release
+
+== License
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ErrMerchant'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/err_merchant/engine.rb

@@ -0,0 +1,10 @@
+require 'rails/engine'
+require 'err_merchant/show_exceptions_patch'
+
+module ErrMerchant
+  class Engine < ::Rails::Engine
+    initializer "err_merchant.show_exceptions_patch" do
+      ActionDispatch::ShowExceptions.send(:include, ShowExceptionsPatch)
+    end
+  end
+end

data/lib/err_merchant/show_exceptions_patch.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module ErrMerchant
+  module ShowExceptionsPatch
+    extend ActiveSupport::Concern
+
+    included { alias_method_chain :render_exception, :template unless Rails.application.config.consider_all_requests_local }
+
+    private
+      def render_exception_with_template(env, exception)
+        body = ErrMerchant::ErrorsController.action(rescue_responses[exception.class.name]).call(env)
+        log_error(exception)
+        body
+      rescue
+        render_exception_without_template(env, exception)
+      end
+  end
+end

data/lib/err_merchant/version.rb

@@ -0,0 +1,3 @@
+module ErrMerchant
+  VERSION = "0.1.0"
+end

data/lib/err_merchant.rb

@@ -0,0 +1 @@
+require 'err_merchant/engine'

data/spec/err_merchant_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'ErrMerchant' do
+  it 'shows a 500 when an exception is raised' do
+    visit '/failures/wild_error'
+
+    page.should have_content("We're sorry, but something went wrong.")
+    page.status_code.should == 500
+  end
+  
+  it 'shows a 404 when record not found' do
+    visit '/failures/where_is_it'
+    
+    page.should have_content("The page you were looking for doesn't exist.")
+    page.status_code.should == 404
+  end
+
+  it 'shows a 422 when an unprocessable entity is encountered' do
+    visit '/failures/dont_process_this'
+
+    page.should have_content("The change you wanted was rejected.")
+    page.status_code.should == 422
+  end
+
+  it 'shows the error in the application layout' do
+    visit '/failures/wild_error'
+
+    page.should have_content("ErrMerchant Test Application")
+  end
+
+  it 'does not kick in if there are no errors' do
+    visit '/failures/usual_action'
+
+    page.should have_content("This is a usual action.")
+    page.status_code.should == 200
+  end
+  
+  it 'shows english error message when no translation available' do
+    I18n.locale = :de
+    visit '/failures/wild_error'
+
+    page.should have_content("We're sorry, but something went wrong.")
+  end
+
+end

data/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/internal/app/controllers/failures_controller.rb

@@ -0,0 +1,16 @@
+class FailuresController < ApplicationController
+  def usual_action
+  end
+  
+  def wild_error
+    raise
+  end
+  
+  def where_is_it
+    raise ActiveRecord::RecordNotFound
+  end
+
+  def dont_process_this
+    raise ActiveRecord::RecordNotSaved
+  end
+end

data/spec/internal/app/views/failures/usual_action.html.erb

@@ -0,0 +1 @@
+<p>This is a usual action.</p>

data/spec/internal/app/views/layouts/application.html.erb

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+<body>
+  <h1>ErrMerchant Test Application</h1>
+  <%= yield %>
+</body>
+</html>

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match ':controller(/:action(/:id(.:format)))'
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end