simple_errors 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07c4fdfabfc7951d7ecae5da3a1c4f22f5a279b1
+  data.tar.gz: 5e52770ae6dcb327e5ccf5dd47fb32d6c9646713
+SHA512:
+  metadata.gz: 608b210fe517c7eb6aa2e67b7ccca0c3a4d413f15afbb04c5f7b3a102c7805a8c569e5865aa1cd364d4cf570598b70f58825c2eab2417a9ba33adde1c36ecfb4
+  data.tar.gz: 622a949c311932714a912964f2f90c50cb3857206490248a3a29e1aaa2f3916f5519c16df9a43b5944e196ec77acd0f58b068a6295105c00384595e5c008f93c

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_errors.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Ed Jones
+
+MIT License
+
+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,81 @@
+# SimpleErrors - a simple way to rescue errors in Rails applications
+
+On practically every job we rescue errors in the ApplicationController in the same way, so it was time for a gem. This gem rescues from defined error classes (along with the standard Rails ActiveRecordNotFound and RoutingError classes) to either a 404 or 500 error page.
+
+If you need something more complicated than that (e.g. 403 errors), you still need to rescue in ApplicationController. They're not mutually exclusive, though.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_errors'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_errors
+    
+## Configuration and setup
+
+There's a generator to set up the files you need, and add a mixin in the application controller:
+
+    rails generate simple_errors
+    
+This will set up:
+
+* /app/views/layouts/error.html.erb - a layout for errors.
+* /app/views/errors/500.html.erb - the 500 error page 
+* /app/views/errors/404.html.erb - the 404 error page
+
+It also removes the default error pages in /public.
+
+## Configuring `ApplicationController`
+
+After you've run the generator, your Application Controller will look like this:
+
+```
+class ApplicationController < ActionController::Base
+  include SimpleErrors::Rescue
+  # other stuff
+end
+
+```
+
+There are a couple of class methods provided by this gem to configure it.
+                                                                          
+### Rescuing from other classes
+If your application raises errors of other types, you might want to rescue to 404 instead of 500. Do that by adding a call to `rescue_with_not_found`, passing one or many classes:
+ 
+```
+class ApplicationController < ActionController::Base
+  rescue_with_not_found Rooftop::RecordNotFoundError, Rooftop::Rails::AncestorMismatch
+  include SimpleErrors::Rescue
+  # other stuff
+end  
+```
+
+### Doing something before rescuing
+Sometime you want your error page to render something - for example, call the same method as a before_filter does to get navigation items.
+
+```
+class ApplicationController < ActionController::Base
+  rescue_with_not_found Rooftop::RecordNotFoundError, Rooftop::Rails::AncestorMismatch
+  include SimpleErrors::Rescue
+  before_rescue do
+    @foo = SomeMenu.find(1234)
+  end
+end
+```
+
+The `before_rescue` block is evaluated in the context of the rendering call, so if you set @foo in the example above it'll be available in your view.
+
+## Contributing
+
+1. Fork it ( https://github.com/errorstudio/simple_errors/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/simple_errors/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Install SimpleErrors views and ApplicationController mixin in your Rails app
+
+Example:
+    rails generate simple_errors
+
+    This will create:
+        views/layouts/error.html.erb
+        views/errors/404.html.erb
+        views/errors/500.erb

data/lib/generators/simple_errors/simple_errors_generator.rb

@@ -0,0 +1,25 @@
+class SimpleErrorsGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+  desc "This generator adds error page views and layout to your application."
+  def copy_layout
+    copy_file "error.html.erb", "app/views/layouts/error.html.erb"
+  end
+
+  def copy_error_pages
+    %w(404.html.erb 500.html.erb).each do |file|
+      copy_file file, "app/views/errors/#{file}"
+    end
+  end
+
+  def include_simple_errors
+    inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do <<-RUBY
+      include SimpleErrors::Rescue
+    RUBY
+    end
+  end
+
+  def remove_default_files
+    remove_file 'public/404.html'
+    remove_file 'public/500.html'
+  end
+end

data/lib/generators/simple_errors/templates/404.html.erb

@@ -0,0 +1 @@
+<p>This is the 404 error page, available at <%= __FILE__ %>.</p>

data/lib/generators/simple_errors/templates/500.html.erb

@@ -0,0 +1 @@
+<p>This is the 500 error page, available at <%= __FILE__ %>.</p>

data/lib/generators/simple_errors/templates/error.html.erb

@@ -0,0 +1,3 @@
+<p>This is the error page template. By default it just renders the application template but you can customise as
+    necessary</p>
+<%= render template: "layouts/application"%>

data/lib/simple_errors.rb

@@ -0,0 +1,4 @@
+require "simple_errors/version"
+require 'simple_errors/rescue'
+module SimpleErrors
+end

data/lib/simple_errors/rescue.rb

@@ -0,0 +1,76 @@
+module SimpleErrors
+  # A mixin for ApplicationController which rescues from common errors. If you have specific ones you want to rescue
+  # with a 404, call the class method rescue_with_not_found, passing one or more error classes
+  module Rescue
+    extend ActiveSupport::Concern
+
+    included do
+      @@rescue_with_not_found_from ||= []
+      rescue_from StandardError do |e|
+        #if we're considering all requests to be local, raise the error
+        if ::Rails.application.config.consider_all_requests_local
+          raise e
+        end
+
+        if e.class.in?(@@rescue_with_not_found_from + [ActiveRecord::RecordNotFound, ActionController::RoutingError])
+          render_not_found(e)
+        else
+          render_error(e)
+        end
+
+        # If rollbar is defined, send a message to it.
+        if defined?(Rollbar)
+          Rollbar.error(e, rollbar_request_data, rollbar_person_data)
+        end
+
+      end
+    end
+
+    class_methods do
+      def rescue_with_not_found(*klasses)
+        @@rescue_with_not_found_from ||= []
+        @@rescue_with_not_found_from << klasses
+        @@rescue_with_not_found_from.flatten!
+      end
+
+      def before_rescue(&block)
+        @@before_rescue = block
+      end
+    end
+
+
+
+    def render_not_found(exception = nil)
+      call_before_rescue_block
+      @exception = exception
+      respond_to do |format|
+        format.html do
+          render 'errors/404', status: 404, layout: "layouts/error"
+        end
+        format.all do
+          render nothing: true, status: 404
+        end
+      end
+    end
+
+    def render_error(exception = nil)
+      call_before_rescue_block
+      @exception = exception
+      respond_to do |format|
+        format.html do
+          render 'errors/500', status: 500, layout: 'layouts/error'
+        end
+        format.all do
+          render nothing: true, status: 500
+        end
+      end
+    end
+
+    def call_before_rescue_block
+      if defined?(@@before_rescue) && @@before_rescue.is_a?(Proc)
+        instance_eval(&@@before_rescue)
+      end
+    end
+
+  end
+end

data/lib/simple_errors/version.rb

@@ -0,0 +1,3 @@
+module SimpleErrors
+  VERSION = "0.0.1"
+end

data/simple_errors.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_errors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_errors"
+  spec.version       = SimpleErrors::VERSION
+  spec.authors       = ["Ed Jones"]
+  spec.email         = ["ed@errorstudio.co.uk"]
+  spec.summary       = %q{A simple way to rescue errors in rails apps}
+  spec.description   = %q{We're forever writing the same rescue code for our Rails apps. This gem will hopefully stop that :-)}
+  spec.homepage      = "https://github.com/errorstudio/simple_errors"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "rails", "~> 4"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simple_errors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+description: We're forever writing the same rescue code for our Rails apps. This gem
+  will hopefully stop that :-)
+email:
+- ed@errorstudio.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/simple_errors/USAGE
+- lib/generators/simple_errors/simple_errors_generator.rb
+- lib/generators/simple_errors/templates/404.html.erb
+- lib/generators/simple_errors/templates/500.html.erb
+- lib/generators/simple_errors/templates/error.html.erb
+- lib/simple_errors.rb
+- lib/simple_errors/rescue.rb
+- lib/simple_errors/version.rb
+- simple_errors.gemspec
+homepage: https://github.com/errorstudio/simple_errors
+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: A simple way to rescue errors in rails apps
+test_files: []