custom_errors_handler 0.2.0

data.tar.gz.sig

@@ -0,0 +1,3 @@
+F�7�+�7�: �_$�{#n8Y������t"x	g��_7#$�q��[~
��}��մ����a<�+��1��
+8G��F�K��VV��Ԃ]�"OT�8�>�D`T:�K����ĥ>��ג�=�ҿ��G�+��n�����n��ދ�
v�	��m�R��9u,f�����.)Ė��"j $�T��E���7����خ;���(��l�z��%)lF�߀���7/WTn�{�hl�
+����so̦�藻

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+= Version 0.2.0
+* Migrated to middleware
+= Version 0.1.1
+* Small fix for html layout view
+= Version 0.1.0
+* Gem existence started

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Maciej Mensfeld
+
+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/Manifest

@@ -0,0 +1,9 @@
+CHANGELOG.rdoc
+Gemfile
+MIT-LICENSE
+Manifest
+README.md
+Rakefile
+init.rb
+lib/custom_errors_handler.rb
+lib/custom_errors_handler_controller.rb

data/README.md

@@ -0,0 +1,72 @@
+# CustomErrorsHandler
+
+## Install
+
+    gem install custom_error_handler
+
+and in your Gemfile:
+    
+    gem 'custom_error_handler'
+
+## About
+
+Custom Errors Handler is intended as an easy alternative to manage showing/rendering exceptions templates (404, 500) in Rails3.
+
+The intent behind it was to KISS as much as it is possible. It allows you to render different 404/500 templates for different controllers/modules. If no errors templates are found, it renders default public/error_code template. It works only with Rails3 and it integrates to its middleware, swapping with default ActionDispatch::ShowExceptions.
+
+## Usage
+
+The basics of Custom Errors Handler are quite simple:
+
+It fetches all errors comming from controllers and it decides frm which file
+Rails should render error.
+
+It search throught all the directories from the place where error occured, up
+to views root path.
+
+It also checks in subdir "template" in any subdir.
+
+## Example
+
+First easy one:
+
+Error 404 (not found) occurred in controller ErrorMakingController.
+
+Custom Errors Handler searches for template called "404.erb" in following directories:
+
+    /views/error_making/layouts
+    /views/error_making/
+    /views/layouts
+    /views/
+
+After it find template - it just render it.
+
+
+Controller in Module:
+
+Error 500 occurred in controller MyModule::ErrorMakingController in action index.
+
+Our Custom Errors Handler searches in (searches for "500.erb"):
+
+    /views/my_module/error_making/layouts
+    /views/my_module/error_making/
+    /views/my_module/layouts
+    /views/my_module/
+    /views/layouts
+    /views/
+
+So as you can see you can use different error templates for both controllers and modules.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Maciej Mensfeld. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('custom_errors_handler', '0.2.0') do |p|
+  p.description    = "Custom Errors Handler is intended as an easy alternative to manage showing/rendering exceptions templates (404, 500) in Rails3"
+  p.url            = "https://github.com/mensfeld/custom_errors_handler"
+  p.author         = "Maciej Mensfeld"
+  p.email          = "maciej@mensfeld.pl"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ["rspec >=2.0.0", "rails >=3.0.0"]
+end
+

data/custom_errors_handler.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{custom_errors_handler}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Maciej Mensfeld"]
+  s.cert_chain = ["/home/mencio/.cert_keys/gem-public_cert.pem"]
+  s.date = %q{2011-04-10}
+  s.description = %q{Custom Errors Handler is intended as an easy alternative to manage showing/rendering exceptions templates (404, 500) in Rails3}
+  s.email = %q{maciej@mensfeld.pl}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.md", "lib/custom_errors_handler.rb", "lib/custom_errors_handler_controller.rb"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "MIT-LICENSE", "Manifest", "README.md", "Rakefile", "init.rb", "lib/custom_errors_handler.rb", "lib/custom_errors_handler_controller.rb", "custom_errors_handler.gemspec"]
+  s.homepage = %q{https://github.com/mensfeld/custom_errors_handler}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Custom_errors_handler", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{custom_errors_handler}
+  s.rubygems_version = %q{1.5.2}
+  s.signing_key = %q{/home/mencio/.cert_keys/gem-private_key.pem}
+  s.summary = %q{Custom Errors Handler is intended as an easy alternative to manage showing/rendering exceptions templates (404, 500) in Rails3}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_development_dependency(%q<rails>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'custom_errors_handler'

data/lib/custom_errors_handler.rb

@@ -0,0 +1,29 @@
+require 'custom_errors_handler_controller'
+
+# Use our show exception dispatcher localized in errors_controller to handle showing/rendering exceptions
+module MyActionDispatch
+  # Basicly - we do same stuff as ActionDispatch::ShowExceptions - but we render different things
+  class ShowExceptions < ActionDispatch::ShowExceptions
+    
+    private
+  
+    def render_exception_with_template(env, exception)
+      log_error(exception)
+      begin
+        CustomErrorsHandlerController.action(rescue_responses[exception.class.name]).call(env)
+      rescue
+        render_exception_without_template(env, exception)
+      end
+    end
+
+    alias_method_chain :render_exception, :template
+  end
+
+  # Swap actiondispatcher
+  class Railtie < Rails::Railtie
+    initializer "app.insert_my_errors_handler" do |app|
+      app.config.middleware.swap ActionDispatch::ShowExceptions, MyActionDispatch::ShowExceptions
+    end
+  end
+end
+

data/lib/custom_errors_handler_controller.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'action_controller'
+
+class CustomErrorsHandlerController < ActionController::Base
+  # Where it should look for error templates
+  VALID_ERRORS_SUBDIRS = ['layouts']
+
+  ERRORS = [
+    :internal_server_error,
+    :not_found,
+    :unprocessable_entity
+  ].freeze
+
+  # Handle error by creating action corresponding to error type
+  ERRORS.each do |e|
+    define_method e do
+      # Get path parts to check if error template exists
+      path = env["action_dispatch.request.path_parameters"]
+      path = "#{path[:controller]}/#{path[:action]}/#{path[:d]}"
+      respond_to do |format|
+        format.html { render error_layout(path, e), :status => e }
+        format.any { head e }
+      end
+    end
+  end
+
+  private
+
+  # Returns the file from which Rails should render error template
+  def error_layout(path, e)
+    e = translate_error(e)
+    path= path.split('/')
+    path.size.downto(0) do |i|
+      VALID_ERRORS_SUBDIRS.each { |lay_path|
+        template_path = File.join((path[0,i]).join('/'), lay_path, e)
+        return template_path if template?(template_path)
+      }
+      template_path = File.join(path[0,i], e)
+      return template_path if template?(template_path)
+    end
+    e
+  end
+
+  def template?(template)
+    FileTest.exist?(File.join(Rails.root, 'app', 'views', "#{template}.html.erb"))
+  end
+
+  # Converts "name" of error into its number
+  def translate_error(e)
+    case e
+    when :internal_server_error then '500'
+    when :not_found then '404'
+    when :unprocessable_entity then '422'
+    else '500'
+    end
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: custom_errors_handler
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZtYWNp
+  ZWoxGDAWBgoJkiaJk/IsZAEZFghtZW5zZmVsZDESMBAGCgmSJomT8ixkARkWAnBs
+  MB4XDTExMDQwOTA5NDcyMloXDTEyMDQwODA5NDcyMlowPzEPMA0GA1UEAwwGbWFj
+  aWVqMRgwFgYKCZImiZPyLGQBGRYIbWVuc2ZlbGQxEjAQBgoJkiaJk/IsZAEZFgJw
+  bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0+nG3V4/exIeiJ0IN+
+  wVfq8Utcu4Qpo+58EIVMIu3FiK+8w6MBvatZnUrRu12pqWLw9xrUkCiYeRErD+jF
+  AmdggIM/tu9CcjvURXH7VeTzOVA+pnV+eJWMD61o8HljFVcb/nyEYYVKErtr9/O4
+  QrIGv5lnszq1PMj2sBMy2gOP1YnzawncMLmkpp/T5SU4JZ5gAktGMRVz8RxmZzF5
+  6NVqFLbuqSRSU5U//WJvZVJt8dycCGgQzBM4Vi3nkOWyjIF0BANf1TqnlU2u6s8d
+  UK1AoDZfg5feef5e8eqoomHebX1opNGM/SOQhu3LRgax4rJfnl6VS3I2wighohsf
+  AgcCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUGlrWBqxVieAPk7NEzBDp
+  kM+iAMMwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQAJMoyBaJs8boiz
+  lFpbw6MWjk+7ZhqoHpFrWEV4nzb5GzyHZ7GU/pa1fSEQR0SCs+LnTLQbAYNQyUTT
+  O+UsTuA7xzI//v6cSodv3Q9NbfoDlou74xv1NXorWoosQFMpVWrXv+c/1RqU3cq4
+  WUr+rRiveEXG4tXOwkrpX8KH8xVp2vQZcGw3AXPqhzfqDGzpHd6ws3lk+8HoSrSo
+  2L68tDoxraF2Z2toAg9vfFw1+mOeDk1xVIPVcBy3tJxstHfHGHlQuMiRiDQX2b2D
+  YYU8UWVt2841IwB5Dgl4O+atXhe9ZTBO0W32pl4Bq5CP9lhQRT1KL7sxfznJlF7Y
+  BH3YFsdk
+  -----END CERTIFICATE-----
+
+date: 2011-04-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id002
+description: Custom Errors Handler is intended as an easy alternative to manage showing/rendering exceptions templates (404, 500) in Rails3
+email: maciej@mensfeld.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.md
+- lib/custom_errors_handler.rb
+- lib/custom_errors_handler_controller.rb
+files: 
+- CHANGELOG.rdoc
+- Gemfile
+- MIT-LICENSE
+- Manifest
+- README.md
+- Rakefile
+- init.rb
+- lib/custom_errors_handler.rb
+- lib/custom_errors_handler_controller.rb
+- custom_errors_handler.gemspec
+has_rdoc: true
+homepage: https://github.com/mensfeld/custom_errors_handler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Custom_errors_handler
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+requirements: []
+
+rubyforge_project: custom_errors_handler
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Custom Errors Handler is intended as an easy alternative to manage showing/rendering exceptions templates (404, 500) in Rails3
+test_files: []
+