mosaic-errors 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in mosaic-errors.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kel Stopper
+
+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.md

@@ -0,0 +1,51 @@
+mosaic-errors
+=============
+
+Gem to add custom error pages to your rails 3 app.
+
+Installation
+------------
+
+Add to Gemfile:
+
+    gem 'mosaic-errors'
+
+Then...
+
+    bundle install
+  
+Usage
+-----
+
+### Auto Install
+
+Use the generator to copy the error files over and add the route to catch all routing errors:
+
+    rails generator mosaic_errors
+  
+Add to ApplicationController:
+
+    include Mosaic::Errors
+  
+Ensure the provided route goes very last in your config/routes.rb file as it will catch anything that is not previously configured
+  
+### Manual Install
+
+Add to config/routes.rb:
+
+    match '*path', :to => 'application#routing_error'
+  
+Ensure the above route comes very last in your config/routes.rb file as it will catch anything that is not previously configured.
+
+Create the folder app/views/errors and drop the files internal_server_error.html.haml & not_found.html.haml
+  
+Add to ApplicationController:
+
+    include Mosaic::Errors
+
+Configuration
+-------------
+
+By default this gem will not display a stacktrace when something goes wrong. This can potentially be problematic when debugging an application so this behaviour can be overridden by adding the following to an initializer:
+
+    Mosaic::Errors.include_stack_trace!

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'rake'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+Rake::Task[:test].comment = "Run all tests"
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/generators/error_pages_generator.rb

@@ -0,0 +1,13 @@
+class ErrorPagesGenerator < Rails::Generators::Base
+  desc "adds error pages haml to the application and add routes"
+  source_root File.expand_path("../templates", __FILE__)
+  
+  def copy_error_pages
+    copy_file "internal_server_error.html.haml", "app/views/errors/internal_server_error.html.haml"
+    copy_file "not_found.html.haml", "app/views/errors/not_found.html.haml"
+  end
+  
+  def add_route
+    route "match '*path', :to => 'application#routing_error'"
+  end
+end

data/lib/generators/templates/internal_server_error.html.haml

@@ -0,0 +1,2 @@
+%h1.server_error.error_page We're sorry...
+%p.error_page There was an error with the page you requested.

data/lib/generators/templates/not_found.html.haml

@@ -0,0 +1,2 @@
+%h1.not_found.error_page Page Not Found
+%p.error_page You may have mistyped the address or the page may have moved.

data/lib/mosaic-errors.rb

@@ -0,0 +1,2 @@
+STDERR.puts "WARNING: mosaic-errors will soon be deprecated - use Rails 3.2+ config.exception_app instead"
+require 'mosaic/errors'

data/lib/mosaic/errors.rb

@@ -0,0 +1,66 @@
+module Mosaic
+  module Errors
+    @@include_stack_trace = false
+
+    def self.include_stack_trace!
+      @@include_stack_trace = true
+    end
+
+    def self.included(controller)
+      controller.extend(ClassMethods)
+      controller.rescue_from Exception do |exception|
+       render_application_error_template_for_exception(exception)
+       Rails.logger.error exception.backtrace.join("\n") if include_stack_trace?
+      end
+    end
+
+    def routing_error
+      render_application_error_template :not_found
+    end
+
+    module ClassMethods
+      DEFAULT_RESCUE_RESPONSE = :internal_server_error
+
+      DEFAULT_RESCUE_RESPONSES = {
+        'ActionController::RoutingError'             => :not_found,
+        'ActionController::UnknownAction'            => :not_found,
+        'ActiveRecord::RecordNotFound'               => :not_found,
+        'ActiveRecord::StaleObjectError'             => :conflict,
+        'ActiveRecord::RecordInvalid'                => :unprocessable_entity,
+        'ActiveRecord::RecordNotSaved'               => :unprocessable_entity,
+        'ActionController::MethodNotAllowed'         => :method_not_allowed,
+        'ActionController::NotImplemented'           => :not_implemented,
+        'ActionController::InvalidAuthenticityToken' => :unprocessable_entity
+      }
+
+      def rescue_responses
+        @rescue_responses ||= Hash.new(DEFAULT_RESCUE_RESPONSE).merge(DEFAULT_RESCUE_RESPONSES)
+      end
+    end
+
+    protected
+      def render_application_error_template(status)
+        render :template => "errors/#{status}", :status => status
+      rescue ActionView::MissingTemplate
+        render :nothing => true, :status => status
+      end
+
+      def render_application_error_template_for_exception(exception)
+        status = self.class.rescue_responses[exception.class.name]
+        send_exception_notification(exception) if status == :internal_server_error || status == :not_found
+        render_application_error_template status
+      end
+
+      def send_exception_notification(exception)
+        if defined? notify_airbrake
+          notify_airbrake(exception)
+        elsif defined? notify_hoptoad
+          notify_hoptoad(exception)
+        end
+      end
+
+      def include_stack_trace?
+        @@include_stack_trace
+      end
+  end
+end

data/lib/mosaic/errors/version.rb

@@ -0,0 +1,5 @@
+module Mosaic
+  module Errors
+    VERSION = "1.0.0"
+  end
+end

data/lib/mosaic_errors.rb

@@ -0,0 +1,2 @@
+STDERR.puts "WARNING: mosaic_errors is deprecated - change all instances of require 'mosaic_errors' to 'mosaic-errors'"
+require 'mosaic-errors'

data/mosaic-errors.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mosaic/errors/version"
+require "date"
+
+Gem::Specification.new do |gem|
+  gem.name        = "mosaic-errors"
+  gem.version     = Mosaic::Errors::VERSION
+  gem.date        = Date.today.to_s
+
+  gem.summary     = "Rails 3.x custom error page support."
+  gem.description = "A gem to simplify implementation of custom error pages in a Rails 3.x application."
+
+  gem.authors     = ["Kel Stopper"]
+  gem.email       = ["kel.stopper@mosaic.com"]
+  gem.homepage    = "http://git.corp.mosaic.com/mosaiccis/mosaic-errors"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "haml", [">= 0"]
+
+  gem.add_development_dependency "rake", [">= 0"]
+  gem.add_development_dependency "shoulda", [">= 0"]
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mosaic_errors'
+
+class Test::Unit::TestCase
+end

data/test/test_mosaic_errors.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMosaicErrors < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mosaic-errors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kel Stopper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to simplify implementation of custom error pages in a Rails 3.x
+  application.
+email:
+- kel.stopper@mosaic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- install.rb
+- lib/generators/error_pages_generator.rb
+- lib/generators/templates/internal_server_error.html.haml
+- lib/generators/templates/not_found.html.haml
+- lib/mosaic-errors.rb
+- lib/mosaic/errors.rb
+- lib/mosaic/errors/version.rb
+- lib/mosaic_errors.rb
+- mosaic-errors.gemspec
+- test/helper.rb
+- test/test_mosaic_errors.rb
+- uninstall.rb
+homepage: http://git.corp.mosaic.com/mosaiccis/mosaic-errors
+licenses: []
+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: -4474960627516075816
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4474960627516075816
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rails 3.x custom error page support.
+test_files:
+- test/helper.rb
+- test/test_mosaic_errors.rb