dynamic_error_pages 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45a97320da48fe28a0802c9d68327d321009ccb5
-  data.tar.gz: 4d25552cdd814ebb289413f9f5c4adb553c4417d
+  metadata.gz: 604898ea38f146522bbe987729e9834a93fcf1b7
+  data.tar.gz: 41745a7388e9e2f5b822279eb432a562f131089d
 SHA512:
-  metadata.gz: 024aeadca90cf9e1c34c661645c1f47ef569e9977b3fe98b83e464458beaad6d0801c6d6cca9b6c3ff6422ab285306e73f2bb43762aa78e554d4208980088e09
-  data.tar.gz: d4e95d95cd8a6473fae1df2a48b923e1dca04fc8cd03412e464c81b1d667a9499b19faa7eb0930e0b9f5d9e402ee70b7fed84ed8bc84807c7375dbb6798371bc
+  metadata.gz: aeb04c6f54ae53372ad23fa8f05614beaf96ea271759584e94f644df81c1027f5627e81e11e7f675e6f50e9fa0160e9332fa82194d594de768ff7ded00697915
+  data.tar.gz: ecf60f6b21bed4468f32e02d1280f03059ae7fa1fe90d49246e3dd6f8718c0301bf6d0702eaef06ded9e7140d139cd3fe68791d21f97d532bba28ae7ee22eef0

data/README.md

@@ -11,6 +11,13 @@ Engine that helps you to generate dynamic error pages with Rails
 
 ```rails >= 3.2```
 
+## What and why
+
+Normally Rails places some static error pages for special error codes (404, 422 and 500) inside the *public* directory. 
+These files are rendered if an error occures. But these templates are rendered without a layout. 
+This causes a bad integration into your custom layout. 
+The ``` dynamic_error_pages ``` gem let you create your own templates which are rendered inside your application layout. 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,18 +28,58 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install dynamic_error_pages
-
 ## Usage
 
+### Include your templates
+
 Just place your custom error templates inside the ``` app/views/dynamic_error_pages/errors ``` folder. The files need to
 be named like the returned status code. The ``` 404.html.erb ``` would be used for status code 404 like ```ActiveRecord::RecordNotFound``` would raise for example.
 
 If an error is raised and no template for the status code can be found, the engine will fallback to the ```404.html.erb```-template.
 
-That's all!
+### Include the routing
+
+Activate the routes for dynamic error handling in your ```routes.rb```. 
+
+```
+YourApp::Application.routes.draw do
+  # ....
+  
+  dynamic_error_pages
+
+end
+```
+
+### Custom error handling
+
+You may want to handle the incoming errors in a different way the gem handles this. Just create a subclass of 
+For example, create a file named ``` errors_controller.rb ``` in ``` app/controllers ```.
+
+
+    class ErrorsController < DynamicErrorPages::ErrorsController
+      skip_before_filter :my_fancy_stuff # change your filters...
+
+      def show
+        # do whatever you want...
+        super
+      end
+    end
+
+And adjust the routes file to support your custom ```errors_controller```
+
+```
+DeviseDynamicErrorPages::Application.routes.draw do
+  # ....
+  
+  dynamic_error_pages :controller => "errors"
+
+end
+```
+
+## Limitations
+
+At the moment, the gem will allways force :html format in the response. 
+In future versions, this behaviour will be extended.  
 
 ## TODO
 

data/dynamic_error_pages.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "appraisal", "~> 0.5.2"
   spec.add_development_dependency "capybara"
 
-  spec.add_dependency "rails", ">= 3.2.0", "<= 4.1"
+  spec.add_dependency "rails", ">= 3.2.0"
 end

data/gemfiles/3.2.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: /home/marcus/Work/repos/github/dynamic_error_pages
   specs:
-    dynamic_error_pages (0.0.2)
-      rails (>= 3.2.0, <= 4.1)
+    dynamic_error_pages (0.0.3)
+      rails (>= 3.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -58,7 +58,7 @@ GEM
     method_source (0.8.2)
     mime-types (1.25)
     mini_portile (0.5.1)
-    multi_json (1.8.0)
+    multi_json (1.8.1)
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
     polyglot (0.3.3)
@@ -116,7 +116,7 @@ GEM
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
+    tzinfo (0.3.38)
     xpath (2.0.0)
       nokogiri (~> 1.3)
 

data/gemfiles/4.0.gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: /home/marcus/Work/repos/github/dynamic_error_pages
   specs:
-    dynamic_error_pages (0.0.2)
-      rails (>= 3.2.0, <= 4.1)
+    dynamic_error_pages (0.0.3)
+      rails (>= 3.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -55,7 +55,7 @@ GEM
     mime-types (1.25)
     mini_portile (0.5.1)
     minitest (4.7.5)
-    multi_json (1.8.0)
+    multi_json (1.8.1)
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
     polyglot (0.3.3)
@@ -111,7 +111,7 @@ GEM
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
+    tzinfo (0.3.38)
     xpath (2.0.0)
       nokogiri (~> 1.3)
 

data/lib/dynamic_error_pages.rb

@@ -1,2 +1,3 @@
 require "dynamic_error_pages/version"
 require "dynamic_error_pages/engine"
+require "dynamic_error_pages/routes"

data/lib/dynamic_error_pages/routes.rb

@@ -0,0 +1,12 @@
+module ActionDispatch::Routing
+  class Mapper
+    def dynamic_error_pages(opts={})
+      Rails.application.routes.draw do
+        # rails 4 need the :via option
+        via = Rails::VERSION::MAJOR > 3 ? {:via => :all} : {}
+        controller = opts[:controller] || "dynamic_error_pages/errors"
+        match '/:status', {:to => "#{controller}#show", :constraints => { :status => /\d{3}/ }}.merge(via)
+      end
+    end
+  end
+end

data/lib/dynamic_error_pages/version.rb

@@ -1,3 +1,3 @@
 module DynamicErrorPages
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/dummy3.2/app/controllers/tests_controller.rb

@@ -6,4 +6,8 @@ class TestsController < ApplicationController
   def show
     raise ActionController::InvalidAuthenticityToken
   end
-end
+
+  def custom_exception
+    raise CustomException.new
+  end
+end

data/spec/dummy3.2/config/routes.rb

@@ -1,3 +1,6 @@
 Dummy::Application.routes.draw do
   resources :tests
+  get :custom_exception, :to => "tests#custom_exception"
+
+  dynamic_error_pages
 end

data/spec/dummy3.2/lib/custom_exception.rb

@@ -0,0 +1,2 @@
+class CustomException < StandardError
+end

data/spec/dummy4.0/app/controllers/tests_controller.rb

@@ -6,4 +6,9 @@ class TestsController < ApplicationController
   def show
     raise ActionController::InvalidAuthenticityToken
   end
-end
+
+  def custom_exception
+    raise CustomException.new
+  end
+
+end

data/spec/dummy4.0/config/routes.rb

@@ -1,3 +1,6 @@
 Dummy::Application.routes.draw do
   resources :tests
+  get :custom_exception, :to => "tests#custom_exception"
+
+  dynamic_error_pages
 end

data/spec/dummy4.0/lib/custom_exception.rb

@@ -0,0 +1,2 @@
+class CustomException < StandardError
+end

data/spec/features/exception_spec.rb

@@ -17,4 +17,9 @@ feature "dynamic exception pages should be delivered with html format" do
     page.should have_content "my 404" # 404 because 422 is not present
   end
 
-end
+  scenario "custom exception" do
+    visit custom_exception_url
+    page.should have_content "my 500"
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_error_pages
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Marcus Geißler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,9 +129,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
-    - - <=
-      - !ruby/object:Gem::Version
-        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,9 +136,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
-    - - <=
-      - !ruby/object:Gem::Version
-        version: '4.1'
 description: Engine that helps you to generate dynamic error pages with Rails
 email:
 - marcus3006@gmail.com
@@ -163,7 +157,6 @@ files:
 - app/controllers/dynamic_error_pages/errors_controller.rb
 - app/views/.gitkeep
 - app/views/dynamic_error_pages/errors/404.html.erb
-- config/routes.rb
 - dynamic_error_pages.gemspec
 - gemfiles/3.2.gemfile
 - gemfiles/3.2.gemfile.lock
@@ -171,6 +164,7 @@ files:
 - gemfiles/4.0.gemfile.lock
 - lib/dynamic_error_pages.rb
 - lib/dynamic_error_pages/engine.rb
+- lib/dynamic_error_pages/routes.rb
 - lib/dynamic_error_pages/version.rb
 - lib/tasks/dynamic_error_pages_tasks.rake
 - script/rails
@@ -204,6 +198,7 @@ files:
 - spec/dummy3.2/config/routes.rb
 - spec/dummy3.2/db/.gitkeep
 - spec/dummy3.2/lib/assets/.gitkeep
+- spec/dummy3.2/lib/custom_exception.rb
 - spec/dummy3.2/log/.gitkeep
 - spec/dummy3.2/public/favicon.ico
 - spec/dummy3.2/script/rails
@@ -244,6 +239,7 @@ files:
 - spec/dummy4.0/config/routes.rb
 - spec/dummy4.0/db/.gitkeep
 - spec/dummy4.0/lib/assets/.keep
+- spec/dummy4.0/lib/custom_exception.rb
 - spec/dummy4.0/log/.keep
 - spec/dummy4.0/public/favicon.ico
 - spec/features/exception_spec.rb
@@ -268,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.8
 signing_key: 
 specification_version: 4
 summary: Engine that helps you to generate dynamic error pages with Rails
@@ -303,6 +299,7 @@ test_files:
 - spec/dummy3.2/config/routes.rb
 - spec/dummy3.2/db/.gitkeep
 - spec/dummy3.2/lib/assets/.gitkeep
+- spec/dummy3.2/lib/custom_exception.rb
 - spec/dummy3.2/log/.gitkeep
 - spec/dummy3.2/public/favicon.ico
 - spec/dummy3.2/script/rails
@@ -343,6 +340,7 @@ test_files:
 - spec/dummy4.0/config/routes.rb
 - spec/dummy4.0/db/.gitkeep
 - spec/dummy4.0/lib/assets/.keep
+- spec/dummy4.0/lib/custom_exception.rb
 - spec/dummy4.0/log/.keep
 - spec/dummy4.0/public/favicon.ico
 - spec/features/exception_spec.rb

data/config/routes.rb

@@ -1,10 +0,0 @@
-Rails.application.routes.draw do
-
-  # rails 4 need the :via option
-  via = Rails::VERSION::MAJOR > 3 ? {:via => :all} : {}
-
-  # if a subclassed errorscontroller exist, route to it
-  controller = defined?(DynamicErrorPages::PatchedErrorsController) ? 'patched_errors' : 'errors'
-
-  match '/:status', {:to => "dynamic_error_pages/#{controller}#show", :constraints => { :status => /\d{3}/ }}.merge(via)
-end