rambulance 0.1.1

data/lib/generators/rambulance/templates/views/unprocessable_entity.html.haml

@@ -0,0 +1,55 @@
+:css
+  div.dialog {
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+    margin: 10px 0;
+  }
+
+  div.dialog p {
+    margin: 16px 0;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+/ This file lives in app/views/errors/unprocessable_entity.html.erb
+.dialog
+  %div
+    %h1 The change you wanted was rejected.
+    %p Maybe you tried to change something you didn't have access to.
+  %p If you are the application owner check the logs for more information.

data/lib/generators/rambulance/templates/views/unprocessable_entity.json.jbuilder

@@ -0,0 +1 @@
+json.error_message "The change you wanted was rejected. Maybe you tried to change something you didn't have access to."

data/lib/rambulance.rb

@@ -0,0 +1,26 @@
+require "rambulance/version"
+require "rambulance/railtie"
+
+module Rambulance
+
+  # List of custom pairs of cexception/corresponding http status.
+  mattr_reader :rescue_responses
+  @@rescue_responses = {}
+
+  # The template name for the layout of the error pages.
+  mattr_accessor :layout_name
+  @@layout_name = "error"
+
+  # The directry name to organize error page templates.
+  mattr_accessor :view_path
+  @@view_path = "errors"
+
+  def self.rescue_responses=(rescue_responses)
+    @@rescue_responses = rescue_responses
+    ActionDispatch::ExceptionWrapper.rescue_responses.merge!(rescue_responses)
+  end
+
+  def self.setup
+    yield self
+  end
+end

data/lib/rambulance/exceptions_app.rb

@@ -0,0 +1,56 @@
+module Rambulance
+  ERROR_HTTP_STATUSES = Rack::Utils::SYMBOL_TO_STATUS_CODE.select do |status_in_words, http_status|
+    # Exclude http statuses that:
+    #   * represent a successful status(2xx, 3xx)
+    #   * are unassigned(427, 430, 509)
+    #   * is a joke definition(418)
+    http_status >= 400 && ![418, 427, 430, 509].include?(http_status)
+  end.invert
+
+  class ExceptionsApp < ActionController::Base
+    layout Rambulance.layout_name
+
+    def self.call(env)
+      exception       = env["action_dispatch.exception"]
+      status_in_words = if exception
+        ActionDispatch::ExceptionWrapper.rescue_responses[exception.class.to_s]
+      else
+        env["PATH_INFO"][1..-1].to_sym.tap do |status_in_words|
+          env["PATH_INFO"] = "/#{Rack::Utils::SYMBOL_TO_STATUS_CODE[status_in_words]}"
+        end
+      end
+
+      action(status_in_words).call(env)
+    end
+
+    ERROR_HTTP_STATUSES.values.each do |status_in_words|
+      eval <<-ACTION
+        def #{status_in_words}
+          render(template_exists?(error_path) ? error_path : error_path(:internal_server_error))
+        end
+      ACTION
+    end
+
+    private
+
+    def send_action(name, *args)
+      @_status          = env["PATH_INFO"][1..-1].to_i
+      @_response.status = @_status
+      @_body            = { :status => @_status, :error => Rack::Utils::HTTP_STATUS_CODES.fetch(@_status.to_i, Rack::Utils::HTTP_STATUS_CODES[500]) }
+
+      super
+    end
+
+    def status_in_words
+      ERROR_HTTP_STATUSES[status.to_i]
+    end
+
+    def exception
+      env["action_dispatch.exception"]
+    end
+
+    def error_path(status_in_words = status_in_words())
+      "#{Rambulance.view_path}/#{status_in_words}"
+    end
+  end
+end

data/lib/rambulance/railtie.rb

@@ -0,0 +1,26 @@
+module Rambulance
+  class Railtie < Rails::Railtie
+    initializer "action_controller" do |app|
+      require "rambulance/exceptions_app"
+    end
+
+    initializer "activesupport.dependencies" do |app|
+      begin
+        ActiveSupport::Dependencies.load_missing_constant(Object, :ExceptionsApp)
+        app.config.exceptions_app = ->(env){ ::ExceptionsApp.call(env) }
+      rescue NameError
+        app.config.exceptions_app = ::Rambulance::ExceptionsApp
+      end
+    end
+
+    initializer 'rambulance' do |app|
+      ActiveSupport.on_load(:after_initialize) do
+        if Rails.env.development?
+          Rails.application.routes.append do
+            mount app.config.exceptions_app, at: '/rambulance'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rambulance/version.rb

@@ -0,0 +1,3 @@
+module Rambulance
+  VERSION = "0.1.1"
+end

data/rambulance.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rambulance/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rambulance"
+  spec.version       = Rambulance::VERSION
+  spec.authors       = ["Yuki Nishijima"]
+  spec.email         = ["mail@yukinishijima.net"]
+  spec.summary       = %q{Simple and safe way to dynamically generate error pages}
+  spec.description   = %q{Rambulance provides a simple and safe way to dynamically generate error pages.}
+  spec.homepage      = "http://github.com/yuki24/rambulance"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "actionpack"
+  spec.add_dependency "railties"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "tzinfo"
+  spec.add_development_dependency "jbuilder"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails", '~> 2.14.1'
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "appraisal"
+end

data/spec/fake_app/app/views/errors/internal_server_error.html.erb

@@ -0,0 +1 @@
+Something went wrong.

data/spec/fake_app/app/views/errors/internal_server_error.json.jbuilder

@@ -0,0 +1 @@
+json.message "Something went wrong"

data/spec/fake_app/app/views/errors/not_found.html.erb

@@ -0,0 +1 @@
+Page not found.

data/spec/fake_app/app/views/errors/not_found.json.jbuilder

@@ -0,0 +1 @@
+json.message "Page not found"

data/spec/fake_app/app/views/layouts/error.html.erb

@@ -0,0 +1,10 @@
+<html>
+  <head>
+    <title>Error page</title>
+  </head>
+  <body>
+    <h1>Error page</h1>
+
+    <%= yield %>
+  </body>
+</html>

data/spec/fake_app/lib/exceptions_app.rb

@@ -0,0 +1,12 @@
+class ExceptionsApp < Rambulance::ExceptionsApp
+  def internal_server_error
+    render inline: <<-BODY
+      <html>
+        <body>
+          <h1>Custom error page</h1>
+          <p>Something went wrong!</p>
+        </body>
+      </html>
+    BODY
+  end
+end

data/spec/fake_app/rails_app.rb

@@ -0,0 +1,59 @@
+# require 'rails/all'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'jbuilder'
+
+# config
+app = Class.new(Rails::Application)
+app.config.secret_token = '964ab2f0fbbb68bc36f3cc487ca296bb8555fac50627924024c245a1599e5265'
+app.config.session_store :cookie_store, :key => '_myapp_session'
+app.config.active_support.deprecation = :log
+app.config.eager_load = false
+
+# Rais.root
+app.config.root = File.dirname(__FILE__)
+app.config.autoload_paths += ["#{app.config.root}/lib"] if ENV["CUSTOM_EXCEPTIONS_APP"]
+Rails.backtrace_cleaner.remove_silencers!
+app.initialize!
+
+# routes
+app.routes.draw do
+  resources :users
+end
+
+# custom exception class
+class CustomException < StandardError; end
+
+Rambulance.setup do |config|
+  config.rescue_responses = {
+    'CustomException' => :not_found
+  }
+end
+
+# controllers
+class ApplicationController < ActionController::Base
+  append_view_path "spec/fake_app/views"
+  before_filter :bad_filter
+
+  private
+
+  def bad_filter
+    raise "This is a bad filter."
+  end
+end
+class UsersController < ApplicationController
+  skip_filter :bad_filter, except: :show
+
+  def index
+    raise CustomException
+  end
+
+  def show; end
+
+  def new
+    raise ActionController::InvalidAuthenticityToken
+  end
+end
+
+# helpers
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/requests/error_json_spec.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+feature 'Error json responses', if: !ENV["CUSTOM_EXCEPTIONS_APP"] do
+  def json_response
+    JSON.parse(response.body)
+  end
+
+  def get(path)
+    super(path, nil, "CONTENT_TYPE" => "application/json", "HTTP_ACCEPT" => "application/json")
+  end
+
+  scenario 'Unprocessable entity due to ActionController:InvalidAuthenticityToken but without its template' do
+    get '/users/new'
+
+    response.status.should == 422
+    json_response['message'].should == "Something went wrong"
+  end
+
+  scenario 'Internal server error due to RuntimeError' do
+    get '/users/1.json'
+
+    response.status.should == 500
+    json_response['message'].should == "Something went wrong"
+  end
+
+  scenario 'Not found due to CustomException' do
+    get '/users.json'
+
+    response.status.should == 404
+    json_response['message'].should == "Page not found"
+  end
+
+  scenario 'Not found due to ActinoController::RoutingError' do
+    get '/doesnt_exist.json'
+
+    response.status.should == 404
+    json_response['message'].should == "Page not found"
+  end
+end

data/spec/requests/error_page_spec.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+feature 'Error pages' do
+  shared_examples_for "an action that renders 500 page if the template is missing" do
+    scenario 'Unprocessable entity due to ActionController:InvalidAuthenticityToken but without its template' do
+      visit '/users/new'
+
+      page.status_code.should == 422
+      page.body.should have_content "Error page"
+      page.body.should have_content "Something went wrong."
+    end
+  end
+
+  context 'with the default exceptions app', if: !ENV["CUSTOM_EXCEPTIONS_APP"] do
+    it_behaves_like "an action that renders 500 page if the template is missing"
+
+    scenario 'Internal server error due to RuntimeError' do
+      visit '/users/1'
+
+      page.status_code.should == 500
+      page.body.should have_content "Error page"
+      page.body.should have_content "Something went wrong."
+    end
+
+    scenario 'Not found due to CustomException' do
+      visit '/users'
+
+      page.status_code.should == 404
+      page.body.should have_content "Error page"
+      page.body.should have_content "Page not found."
+    end
+
+    scenario 'Not found due to ActinoController::RoutingError' do
+      visit '/doesnt_exist'
+
+      page.status_code.should == 404
+      page.body.should have_content "Error page"
+      page.body.should have_content "Page not found."
+    end
+  end
+
+  context "With a custom exception app", if: ENV["CUSTOM_EXCEPTIONS_APP"] do
+    it_behaves_like "an action that renders 500 page if the template is missing"
+
+    scenario 'Internal server error due to RuntimeError' do
+      visit '/users/1'
+
+      page.status_code.should == 500
+      page.body.should have_content "Custom error page"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rails'
+
+require 'bundler/setup'
+Bundler.require
+
+require 'capybara/rspec'
+require 'fake_app/rails_app'
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f }
+
+# RSpec.configure do |config|
+#
+# end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: rambulance
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Yuki Nishijima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rambulance provides a simple and safe way to dynamically generate error
+  pages.
+email:
+- mail@yukinishijima.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_32.gemfile
+- gemfiles/rails_40.gemfile
+- gemfiles/rails_41.gemfile
+- gemfiles/rails_edge.gemfile
+- lib/generators/rambulance/exceptions_app_generator.rb
+- lib/generators/rambulance/install_generator.rb
+- lib/generators/rambulance/templates/exceptions_app.rb
+- lib/generators/rambulance/templates/rambulance.rb
+- lib/generators/rambulance/templates/views/bad_request.html.erb
+- lib/generators/rambulance/templates/views/bad_request.html.haml
+- lib/generators/rambulance/templates/views/bad_request.json.jbuilder
+- lib/generators/rambulance/templates/views/forbidden.html.erb
+- lib/generators/rambulance/templates/views/forbidden.html.haml
+- lib/generators/rambulance/templates/views/forbidden.json.jbuilder
+- lib/generators/rambulance/templates/views/internal_server_error.html.erb
+- lib/generators/rambulance/templates/views/internal_server_error.html.haml
+- lib/generators/rambulance/templates/views/internal_server_error.json.jbuilder
+- lib/generators/rambulance/templates/views/not_found.html.erb
+- lib/generators/rambulance/templates/views/not_found.html.haml
+- lib/generators/rambulance/templates/views/not_found.json.jbuilder
+- lib/generators/rambulance/templates/views/unprocessable_entity.html.erb
+- lib/generators/rambulance/templates/views/unprocessable_entity.html.haml
+- lib/generators/rambulance/templates/views/unprocessable_entity.json.jbuilder
+- lib/rambulance.rb
+- lib/rambulance/exceptions_app.rb
+- lib/rambulance/railtie.rb
+- lib/rambulance/version.rb
+- rambulance.gemspec
+- spec/fake_app/app/views/errors/internal_server_error.html.erb
+- spec/fake_app/app/views/errors/internal_server_error.json.jbuilder
+- spec/fake_app/app/views/errors/not_found.html.erb
+- spec/fake_app/app/views/errors/not_found.json.jbuilder
+- spec/fake_app/app/views/layouts/error.html.erb
+- spec/fake_app/lib/exceptions_app.rb
+- spec/fake_app/rails_app.rb
+- spec/requests/error_json_spec.rb
+- spec/requests/error_page_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/yuki24/rambulance
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple and safe way to dynamically generate error pages
+test_files:
+- spec/fake_app/app/views/errors/internal_server_error.html.erb
+- spec/fake_app/app/views/errors/internal_server_error.json.jbuilder
+- spec/fake_app/app/views/errors/not_found.html.erb
+- spec/fake_app/app/views/errors/not_found.json.jbuilder
+- spec/fake_app/app/views/layouts/error.html.erb
+- spec/fake_app/lib/exceptions_app.rb
+- spec/fake_app/rails_app.rb
+- spec/requests/error_json_spec.rb
+- spec/requests/error_page_spec.rb
+- spec/spec_helper.rb