rails_dynamic_errors 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16b89e0d32d1bf5e55c35f732034a97bc4443d4b
+  data.tar.gz: d552978f2ca013a1ca79bddce0bf6fd227beb0e3
+SHA512:
+  metadata.gz: c01f9844d85c46762d7a00e14ef1c34ced628defe8c1219684134978ff4ab67a5d9045ab51d052fd90e500c38c5b38436439a9708bbbb71153a2277bae2888d9
+  data.tar.gz: 64c7b2eff6e5eacbb1aadae09ca1494775debe001b836048269b6be0784708496bf95739534de49483aa6a4a95356ba1522f38d69569d74ae1ae6dadb040c559

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsDynamicErrors'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/rails_dynamic_errors/errors_controller.rb

@@ -0,0 +1,52 @@
+require 'action_dispatch/middleware/exception_wrapper'
+
+module RailsDynamicErrors
+  class ErrorsController < ::ApplicationController
+    helper_method :error_code
+    helper_method :error_name
+    helper_method :error_message
+  
+    def show
+      render template, layout: layout, status: status_code
+    end
+  
+    private
+      def error_code
+        # The route that leads to this controller is set up with a glob that
+        # maps to params[:code]. Unfortunately, because Rails memoizes request
+        # parameters, this mapped data is not available if we arrive in this
+        # controller after processing a request to a valid route but with a
+        # non-existent resource. Thankfully we can just take the same steps
+        # here as the glob anyway - extract the code from the path.
+        @error_code ||= env['PATH_INFO'][1..-1]
+      end
+
+      def error_name
+        @error_name ||= Rack::Utils::HTTP_STATUS_CODES.fetch(status_code.to_i, 'Internal Server Error')
+      end
+  
+      def error_message
+        if exception && exception.message && exception.class.name != exception.message
+          @message ||= exception.message
+        else
+          @message ||= "An error has occurred. This site administrator has been notified of this issue. We apologise for any inconvenience."
+        end
+      end
+  
+      def exception
+        @exception ||= env['action_dispatch.exception']
+      end
+
+      def status_code
+        @status_code ||= (exception) ? ActionDispatch::ExceptionWrapper.new(env, exception).status_code.to_s : '500'
+      end
+
+      def layout
+        template_exists?('errors', 'layouts') ? 'errors' : 'application'
+      end
+  
+      def template
+        template_exists?(error_code, 'rails_dynamic_errors/errors') ? error_code : 'show'
+      end
+  end
+end

data/app/views/rails_dynamic_errors/errors/show.html.erb

@@ -0,0 +1,4 @@
+<h2><%= "#{error_code} #{error_name}" %></h2>
+<p>
+  <%= error_message %>
+</p>

data/config/routes.rb

@@ -0,0 +1,3 @@
+RailsDynamicErrors::Engine.routes.draw do
+  match '*code', to: 'rails_dynamic_errors/errors#show', via: :all
+end

data/lib/engine_helper.rb

@@ -0,0 +1,15 @@
+# This module contains utility methods designed for inclusion within Rails
+# engines.
+module EngineHelper
+  module ClassMethods
+    # Identifies the absolute path (i.e. '/' prefixed) at which an engine is
+    # mounted within its parent Rails application.
+    # @return [String] the mount path, or nil if not mounted
+    def mounted_at
+      route = Rails.application.routes.routes.detect do |route|
+        route.app == self
+      end
+      route && route.path.spec.to_s
+    end
+  end
+end

data/lib/generators/rails_dynamic_errors/install_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+
+module RailsDynamicErrors
+  # This is a generator that is used to install rails_dynamic_errors into a
+  # Rails application. It runs all of the methods below.
+  class InstallGenerator < Rails::Generators::Base
+    # Add the gem configuration options to the Rails application's
+    # config/application.rb file. These are all disabled by default so as to
+    # cause minimum intrusion upon install.
+    def configure_application
+      application <<-APP
+    # This option is used to set the HTTP error codes for which
+    # rails_dynamic_errors will generate dynamic error pages. A good default
+    # setup is [404, 422], which will catch the two main errors (excluding the
+    # dreaded 500 Internal Server Error) for which Rails provides static HTML
+    # error pages.
+    # config.rails_dynamic_errors.http_error_status_codes_to_handle = [404, 422]
+      APP
+    end
+
+    # Add mounting of the gem's engine to the the Rails application's
+    # config/routes.rb file. The default mount path can be found in the
+    # documentation for the RailsDynamicErrors module.
+    def notify_about_routes
+      insert_into_file File.join('config', 'routes.rb'), :before => /^end/ do
+        %Q{
+  # This line mounts RailDynamicErrors' routes on the '/errors' path of your
+  # application. This means that any requests to URLs with this prefix in their
+  # path will go to RailsDynamicErrors for processing.
+  #
+  # If you would like to change where this engine is mounted, simply change the
+  # :at option to something different.
+  mount RailsDynamicErrors::Engine, at: '#{RailsDynamicErrors::DEFAULT_MOUNT_PATH}'
+        }
+      end
+    end
+  end
+end

data/lib/rails_dynamic_errors/engine.rb

@@ -0,0 +1,32 @@
+require 'engine_helper'
+
+module RailsDynamicErrors
+  # This is the engine that provides dynamic error page generation for
+  # rails_dynamic_errors. It is designed to be mounted at an appropriate route
+  # within the main application, permitting the handling of generic error URLs
+  # that map to this base route.
+  #
+  # It also adds a namespace for rails_dynamic_errors configuration options
+  # within the parent application. These are accessible as per standard Rails
+  # application configuration options via:
+  #
+  # Rails.application.config.rails_dynamic_errors
+  #
+  # End users should never use this engine directly. It is created automatically
+  # when the main application is run. An install generator is included which
+  # updates the config/routes.rb file of the main application to include the
+  # necessary code to mount the engine at a default route.
+  #
+  # Note: the engine is namespaced to 'RailsDynamicErrors'.
+  class Engine < ::Rails::Engine
+    extend EngineHelper::ClassMethods
+
+    # Add configuration options within namespace in the main application
+    config.rails_dynamic_errors = ActiveSupport::OrderedOptions.new
+
+    initializer "rails_dynamic_errors.install_middleware" do |app|
+      # Avoid inserting if already inserted?
+      app.middleware.use RailsDynamicErrors::DynamicErrors
+    end
+  end
+end

data/lib/rails_dynamic_errors/middleware/dynamic_errors.rb

@@ -0,0 +1,98 @@
+require 'action_dispatch/middleware/exception_wrapper'
+
+module RailsDynamicErrors
+  # This is a Rack compatible middleware that implements the key functionality
+  # of the rails_dynamic_errors gem. It serves two roles:
+  # * intercept unhandled exceptions and error conditions from the Rail application it is inserted into
+  # * generate dynamic error pages for the exceptions and error conditions it is configured to
+  #
+  # The middleware is inserted into the Rails application's middleware stack
+  # automatically. As such, the end user should never need to use it directly.
+  #
+  # In order to avoid disrupting standard Rails functionality, this middleware
+  # respects the Rails exception handling related configuration options. As
+  # such, it will only process exceptions and error conditions if:
+  # * the request is not local (action_dispatch.show_detailed_exceptions is false)
+  # * the environment is set to display exceptions (rather than raise them)
+  # 
+  # Configuration of which exceptions and error conditions to catch is done
+  # within the main Rails application's configuration, using an option set
+  # namespaced to rails_dynamic_errors. Specifically:
+  #
+  # Rails.application.config.rails_dynamic_errors.http_error_status_codes_to_handle
+  #
+  # This option must be an array of integer HTTP error status codes (404, etc.)
+  class DynamicErrors
+    # Initialize the middleware (standard Rack method)
+    def initialize(app)
+      @app = app
+    end
+
+    # Call the middleware (standard Rack method)
+    def call(env)
+      response = @app.call(env)
+      # 404 errors for unmatched routes aren't actually raised until
+      # ActionDispatch::DebugExceptions. If we're supposed to catch 404s and
+      # the application indicates there was no matching route, throw and
+      # handle a 404 generating exception
+      if can_process_exceptions?(env) && catch_not_found_error? && request_unhandled?(response)
+        raise ActionController::RoutingError.new("No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}")
+      else
+        response
+      end
+    rescue Exception => exception
+      if can_process_exceptions?(env)
+        process_exception(env, exception)
+      else
+        raise exception
+      end
+    end
+
+    private
+      def can_process_exceptions?(env)
+        ! env['action_dispatch.show_detailed_exceptions'] && env['action_dispatch.show_exceptions']
+      end
+
+      def catch_not_found_error?
+        can_handle_http_error_status_code?(404)
+      end
+
+      def can_handle_http_error_status_code?(status_code)
+        http_error_status_codes_to_handle.include?(status_code)
+      end
+
+      def http_error_status_codes_to_handle
+        Rails.application.config.rails_dynamic_errors.http_error_status_codes_to_handle || []
+      end
+
+      def request_unhandled?(response)
+        # Returned by Rails when no matching route was found
+        [404, {'X-Cascade' => 'pass'}, ['Not Found']] == response
+      end
+
+      def process_exception(env, exception)
+        status_code = exception_http_error_status_code(env, exception)
+        if can_handle_http_error_status_code?(status_code)
+          generate_dynamic_error_page(env, exception, status_code)
+        else
+          raise exception
+        end
+      end
+
+      def exception_http_error_status_code(env, exception)
+        wrapper = ActionDispatch::ExceptionWrapper.new(env, exception)
+        wrapper.status_code
+      end
+
+      def generate_dynamic_error_page(env, exception, status_code)
+        env['PATH_INFO'] = dynamic_error_path(status_code)
+        env['action_dispatch.exception'] = exception
+        Rails.application.routes.call(env)
+      end
+
+      def dynamic_error_path(status_code)
+        # Error page routes need to reflect where the engine has been mounted
+        "#{RailsDynamicErrors::Engine.mounted_at}/#{status_code}"
+      end
+  end
+end

data/lib/rails_dynamic_errors/version.rb

@@ -0,0 +1,4 @@
+module RailsDynamicErrors
+  # The current version of rails_dynamic_errors
+  VERSION = '0.0.9'
+end

data/lib/rails_dynamic_errors.rb

@@ -0,0 +1,11 @@
+require 'rails_dynamic_errors/middleware/dynamic_errors'
+require 'generators/rails_dynamic_errors/install_generator'
+
+# +RailsDynamicErrors+ is the root module for the rails_dynamic_errors gem. See
+# the README for more information.
+module RailsDynamicErrors
+  # The default mount point for the gem's engine
+  DEFAULT_MOUNT_PATH = '/errors'
+end
+
+require 'rails_dynamic_errors/engine'

data/lib/tasks/rails_dynamic_errors_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_dynamic_errors do
+#   # Task goes here
+# end

data/spec/controllers/errors_controller_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe RailsDynamicErrors::ErrorsController do
+  describe "GET show" do
+    before(:each) do
+      @error_code = 404
+    end
+
+    it "makes the error code available" do
+      build_environment_after_exception_for_status_code(@error_code)
+      get :show, code: @error_code, use_route: :rails_dynamic_errors
+      controller.send(:error_code).should eq(@error_code.to_s)
+    end
+
+    context "makes a friendly error name available" do
+      context "when the status code is a valid HTTP status code" do
+        it "returns the name associated with that status code" do
+          build_environment_after_exception_for_status_code(@error_code)
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          controller.send(:error_name).should eq("Not Found")
+        end
+      end
+
+      context "when the status code is not a valid HTTP status code" do
+        it "returns 'Internal Server Error'" do
+          controller.env["PATH_INFO"] = "/my_error"
+          get :show, code: 'my_error', use_route: :rails_dynamic_errors
+          controller.send(:error_name).should eq("Internal Server Error")
+        end
+      end
+    end
+
+    context "makes the exception associated with the error (if any) available" do
+      context "when the error was caused by an exception" do
+        it "returns the exception" do
+          build_environment_after_exception_for_status_code(@error_code)
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          controller.send(:exception).should eq(@exception)
+        end
+      end
+
+      context "when the error was not caused by an exception" do
+        it "returns nil" do
+          controller.env["PATH_INFO"] = "/#{@error_code}"
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          controller.send(:exception).should eq(nil)
+        end
+      end
+    end
+
+    context "makes an error message available" do
+      context "when the error was caused by an exception and that exception has a message" do
+        it "renders that error message" do
+          build_environment_after_exception_for_status_code(@error_code)
+          @exception.stub(:message).and_return("Test")
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          controller.send(:error_message).should eq(@exception.message)
+        end
+      end
+
+      context "when the error was not caused by an exception or was but the exception doesn't have a message" do
+        it "renders a default error message" do
+          build_environment_after_exception_for_status_code(@error_code)
+          @exception.stub(:message).and_return(nil)
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          controller.send(:error_message).should eq("An error has occurred. This site administrator has been notified of this issue. We apologise for any inconvenience.")
+        end
+      end
+    end
+
+    context "renders an appropriate layout" do
+      before(:each) do
+        controller.stub(:template).and_return("show")
+      end
+
+      context "when a custom error layout is available" do
+        it "uses the custom error layout" do
+          build_environment_after_exception_for_status_code(@error_code)
+          controller.stub(:layout).and_return("errors")
+          begin
+            get :show, code: @error_code, use_route: :rails_dynamic_errors
+            response.should render_template("layouts/errors")
+          rescue ActionView::MissingTemplate => exception
+            exception.message.should =~ /Missing template layouts\/errors/
+          end
+        end
+      end
+
+      context "when a custom error layout is not available" do
+        it "uses the application layout" do
+          build_environment_after_exception_for_status_code(@error_code)
+          controller.stub(:layout).and_return("application")
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          response.should render_template("layouts/application")
+        end
+      end
+    end
+
+    context "renders an appropriate template" do
+      before(:each) do
+        controller.stub(:layout).and_return("application")
+      end
+
+      context "when a custom error template is available" do
+        it "uses the custom error template" do
+          build_environment_after_exception_for_status_code(@error_code)
+          controller.stub(:template).and_return(@error_code.to_s)
+          begin
+            get :show, code: @error_code, use_route: :rails_dynamic_errors
+            response.should render_template("rails_dynamic_errors/errors/#{@error_code}")
+          rescue ActionView::MissingTemplate => exception
+            exception.message.should =~ /Missing template rails_dynamic_errors\/errors\/#{@error_code}/
+          end
+        end
+      end
+
+      context "when a custom error template is not available" do
+        it "uses the show template" do
+          build_environment_after_exception_for_status_code(@error_code)
+          controller.stub(:template).and_return("show")
+          controller.stub(:template_exists?).and_return(false)
+          get :show, code: @error_code, use_route: :rails_dynamic_errors
+          response.should render_template("rails_dynamic_errors/errors/show")
+        end
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/booms.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/javascripts/things.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/assets/stylesheets/booms.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/spec/dummy/app/assets/stylesheets/things.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/booms_controller.rb

@@ -0,0 +1,6 @@
+class BoomsController < ApplicationController
+  # Force a 500 error to be raised (for integration testing)
+  def show
+    raise Exception.new("Oh no!")
+  end
+end