errship 1.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Logan Koester
+
+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,117 @@
+= => errship
+
+The static error pages Rails comes with are nice for getting started - you can't
+break them, no matter what. But without your layout and navigation wrapped around
+them, they create a frustrating trap for your users.
+
+The obvious solution is to render your layout into the static file, but what happens
+when you make a change?
+
+Worse, what if you run a network of many Rails applications? Should they share one
+error page style? Should they all have their own?
+
+You could hire your nephew to keep them all up to date... or you can use Errship.
+
+Errship is a Rails 3.1 engine for rendering error pages inside your layout. It supports
+i18n, custom exceptions, and Airbrake (Hoptoad) error tracking.
+
+You can also use the flashback method to set an error message and redirect :back safely - if
+a RedirectBackError is raised, the user is dropped off at the nearest error page and given 
+the flash message anyway.
+
+== Installation
+
+Add this to your Gemfile
+    gem 'errship', '1.0.0'
+
+Add this to your ApplicationController
+    class ApplicationController < ActionController::Base
+      include Errship::Rescuers
+
+Errship is ready to go! To test it out in development, you'll need to set
+
+    config.consider_all_requests_local = false
+
+in your config/environments/development.rb file. Just don't forget to change it back
+when you want useful debugging output again instead!
+
+Alternatively, simply point your browser to /error or /not_found to get a taste.
+
+== I18n
+
+If you want to edit the text that is rendered, add the following to your config/locales/*.yml
+
+    en:
+      errship:
+        '404':
+          title: 'This page does not exist.'
+          description: 'It could have moved, or someone (maybe you!) mistyped the URL.'
+        '500':
+          title: 'An error has occurred.'
+          description: 'This has been reported to our development team. Thank you!'
+
+...and so forth, for any error code you like.
+
+== Custom Rescuers
+
+If you want errship to rescue errors from your own custom exception class, you need
+to add a custom rescuer in your ApplicationController, like so:
+
+    # Render the 404 page
+    rescue_from MyException::SomethingMissing, :with => :render_404_error
+
+    # Render the 500 page
+    rescue_from MyException::SomethingWentWrong, :with => :render_error
+
+To customize the error for a particular controller or exception class, add a rescuer
+like this one:
+
+    rescue_from ActiveRecord::RecordNotFound, :with => ->(e){ render_404_error e, 'monkeys' }
+
+and then add your text for that scope to config/locales/*.yml
+
+    en:
+      errship:
+        '404':
+          title: 'This page does not exist.'
+          description: 'It could have moved, or someone (maybe you!) mistyped the URL.'
+          monkeys:
+            title: 'They must have escaped'
+            description: 'This is now a monkey free zone.'
+            
+
+The following methods are provided:
+
+* render_error(exception, errship_scope = false) # Render the 500 page
+* render_404_error(exception = nil, errship_scope = false) # Render the 404 page
+* flashback(error_message) # Set the flash and redirect back (RedirectBackError-safe)
+
+If Airbrake is installed, every rescuer will report the exception, except for 404.
+
+== Changelog
+1.1.0
+  - Adds option to specify a custom errship_scope to use with I18n, allowing each 
+    rescuer to customize the messages displayed.
+
+1.0.0
+  - Upgrade to Rails 3.1 to share error page assets between applications on the asset pipeline.
+  - Supports Airbrake as well as HoptoadNotifier
+  - Errors are rendered directly into your layout
+  - i18n support
+  - No default styles - blends seamlessly into its host layout.
+
+== Contributing to errship
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Logan Koester. See LICENSE.txt for
+further details.
+

data/app/assets/javascripts/application.js

@@ -0,0 +1,7 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require_tree .

data/app/assets/stylesheets/errship.css

@@ -0,0 +1,2 @@
+.errship {
+}

data/app/views/errship/standard.html.haml

@@ -0,0 +1,11 @@
+- content_for :head do
+  = stylesheet_link_tag 'errship', :media => 'screen, projection'
+
+.errship
+  %h1.error_code #{status_code}
+  - if errship_scope
+    %h2= t "errship.#{status_code}.#{errship_scope}.title" 
+    %p= t  "errship.#{status_code}.#{errship_scope}.description"
+  - else
+    %h2= t "errship.#{status_code}.title" 
+    %p= t  "errship.#{status_code}.description"

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  errship:
+    '404':
+      title: 'This page does not exist.'
+      description: 'It could have moved, or someone (maybe you!) mistyped the URL.'
+    '500':
+      title: 'An error has occurred.'
+      description: 'This has been reported to our development team. Thank you!'

data/config/routes.rb

@@ -0,0 +1,10 @@
+if defined?(Rails::Application)
+  Rails.application.routes.draw do
+    # Unrecoverable error
+    match '/error' => "application#errship_standard", :as => :error
+    match '/not_found' => "application#render_404_error", :as => 'not_found'
+
+    # Rails currently (until 3.1) ignores rescue_from ActionController::RoutingError, so render 404 manually
+    match '*address' => 'application#render_404_error' unless Rails.application.config.consider_all_requests_local
+  end
+end

data/lib/errship.rb

@@ -0,0 +1,60 @@
+require 'haml'
+
+module Errship
+  class Engine < ::Rails::Engine
+    paths['app/routes']      = 'config/routes.rb'
+    paths['app/views']      << 'app/views'
+    paths['config/locales'] << 'config/locales'
+  end
+
+  module Rescuers
+    def self.included(base)
+      unless Rails.application.config.consider_all_requests_local
+        base.rescue_from Exception, :with => :render_error
+        base.rescue_from ActiveRecord::RecordNotFound, :with => :render_404_error
+        base.rescue_from ActionController::RoutingError, :with => :render_404_error
+        base.rescue_from ActionController::UnknownController, :with => :render_404_error
+        base.rescue_from ActionController::UnknownAction, :with => :render_404_error
+      end
+    end
+
+    def render_error(exception, errship_scope = false)
+      airbrake_class.send(:notify, exception) if airbrake_class
+      render :template => '/errship/standard', :locals => { 
+        :status_code => 500, :errship_scope => errship_scope }
+    end
+
+    def render_404_error(exception = nil, errship_scope = false)
+      render :template => '/errship/standard', :locals => { 
+        :status_code => 404, :errship_scope => errship_scope }
+    end
+
+    # A blank page with just the layout and flash message, which can be redirected to when
+    # all else fails.
+    def errship_standard(errship_scope = false)
+      flash[:error] ||= 'An unknown error has occurred, or you have reached this page by mistake.'
+      render :template => '/errship/standard', :locals => { 
+        :status_code => 500, :errship_scope => errship_scope }
+    end
+
+    # Set the error flash and attempt to redirect back. If RedirectBackError is raised,
+    # redirect to error_path instead.
+    def flashback(error_message, exception = nil)
+      airbrake_class.send(:notify, exception) if airbrake_class
+      flash[:error] = error_message
+      begin
+        redirect_to :back
+      rescue ActionController::RedirectBackError
+        redirect_to error_path
+      end
+    end
+
+  private
+    def airbrake_class
+      return Airbrake if defined?(Airbrake)
+      return HoptoadNotifier if defined?(HoptoadNotifier)
+      return false
+    end
+
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: errship
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-01 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &25882600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *25882600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &25881980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *25881980
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &25881360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25881360
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &25880620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *25880620
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &25880080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *25880080
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &25879560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25879560
+description: Errship is a Rails 3.1 engine for rendering error pages inside your layout.
+  It supports i18n, custom exceptions, and Airbrake (Hoptoad) error tracking.
+email: lkoester@agoragames.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- app/assets/javascripts/application.js
+- app/assets/stylesheets/errship.css
+- app/views/errship/standard.html.haml
+- config/locales/en.yml
+- config/routes.rb
+- lib/errship.rb
+- LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/logankoester/errship
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1469100541760002467
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Errship is a Rails 3.1 engine for rendering error pages inside your layout.
+test_files: []