rexception 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24a25113fbbb43426828f6de6097162baf65e3f9
-  data.tar.gz: d443721593818ec4de8f75af7ca4f9d1205e2dc0
+  metadata.gz: 0f1548316fad12668415072e05a723299ebce5b2
+  data.tar.gz: 624cc7489047fec4d5778db9ec3519ae492b402a
 SHA512:
-  metadata.gz: 44abab142291c6969576e3fb188975f8516ec407b343de6c036f864399f4b71c2f06d002fde6cfb67c6e698ada03fba59b7821f6713c834387e3453c10316398
-  data.tar.gz: 4eb25ffdd6c3e064c65297de1ac5b2a394d3afa1ab2ac30500ee86026afb772507face10a3be3914b3575942fe3eb85e77e07da605ee91e9db83c8b74ce97bb2
+  metadata.gz: d059c5e073e1e4c761cf73dd0f6b963e5b0b6fa6780723ced702512c8e8711b110db07ef1701c73c4dadc18f3bce592536469a6ccab3d2add0b726918634ecda
+  data.tar.gz: dcc9fe3ff08f459b831eba0976f3f8e74608a1242d8afb5caa13418c96eeeee30aa6ed3aee4775d6e4aa82408d7bfc61a5b9c04e310aaa6a49ac012251a9dfb7

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle/
+pkg/
+spec/dummy/log/
+spec/dummy/tmp/
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,61 @@
+# Rexception
+
+[![Build Status](https://travis-ci.org/kami30k/rexception.svg)](https://travis-ci.org/kami30k/rexception)
+[![Gem Version](https://badge.fury.io/rb/rexception.svg)](http://badge.fury.io/rb/rexception)
+
+Rexception is a Rails plugin that renders error pages dynamically, such as 403, 404, 500, and so on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rexception'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+The simplest way, just add `app/views/errors/application.html.erb`.
+That's it, and Rails application render it when raise any errors.
+
+If you placed specific views, such as `forbidden.html.erb` or `not_found.html.erb`, Rexception prefers these views to `application.html.erb`.
+(File name is see also: [ActionDispatch::ExceptionWrapper.rescue_responses](https://github.com/rails/rails/blob/083f657c0f1990e980d33f89f44d8943a9270475/actionpack/lib/action_dispatch/middleware/exception_wrapper.rb#L9-L19))
+
+And you can specify layout file name, directory name to place views, and custom exceptions.
+Create `config/initializers/rexception.rb` and add following lines:
+
+```ruby
+Rexception.configure do |config|
+  # Layout file name to use for rendering error page.
+  config.layout = 'application'
+
+  # Directory name where you place error pages.
+  config.errors_dir = 'errors_dir'
+
+  # Pairs of custom exceptions and statuses.
+  config.rescue_responses = {
+    'CustomException' => :not_found
+  }
+end
+
+```
+
+In `development` mode, you should add this line to `config/environments/development.rb` to render error pages:
+
+```ruby
+config.consider_all_requests_local = false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kami30k/rexception/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

@@ -1,3 +1,7 @@
 require 'bundler'
+require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/rexception.rb

@@ -1,17 +1,34 @@
 require 'rexception/version'
-require 'rexception/controller'
 require 'rexception/railtie' if defined?(Rails)
 
 module Rexception
-  autoload :Setting, 'rexception/setting'
+  autoload :ExceptionsController, 'rexception/exceptions_controller'
 
   class << self
-    def setup(&block)
-      Setting.instance.setup(&block)
+    # Layout file name to use for rendering error page.
+    #
+    # @return [String]
+    attr_accessor :layout
+
+    # Directory name where you place error pages.
+    #
+    # @return [String]
+    attr_accessor :errors_dir
+
+    # Pairs of custom exceptions and statuses.
+    #
+    # @return [Hash{String => Symbol}]
+    def rescue_responses=(rescue_responses)
+      ActionDispatch::ExceptionWrapper.rescue_responses.merge!(rescue_responses)
     end
 
-    def setting
-      Setting.instance
+    # Configuring module attributes by initializer.
+    #
+    # @yield Rexception
+    def configure
+      yield self
     end
   end
 end
+
+require 'rexception/config'

data/lib/rexception/config.rb

@@ -0,0 +1,12 @@
+Rexception.configure do |config|
+  # Layout file name to use for rendering error page.
+  config.layout = 'application'
+
+  # Directory name where you place error pages.
+  config.errors_dir = 'errors_dir'
+
+  # Pairs of custom exceptions and statuses.
+  config.rescue_responses = {
+    'CustomException' => :not_found
+  }
+end

data/lib/rexception/{controller.rb → exceptions_controller.rb}

@@ -10,20 +10,24 @@ module Rexception
       RUBY
     end
 
-    layout -> { setting.layout }
+    layout -> { layout }
 
     private
 
     def view(status = status())
-      "#{setting.errors_dir}/#{status}"
+      "#{errors_dir}/#{status}"
     end
 
     def status
       self.class.status(env)
     end
 
-    def setting
-      Rexception.setting
+    def layout
+      Rexception.layout
+    end
+
+    def errors_dir
+      Rexception.errors_dir
     end
 
     class << self

data/lib/rexception/railtie.rb

@@ -1,5 +1,3 @@
-require 'rails'
-
 module Rexception
   class Railtie < Rails::Railtie
     initializer 'rexception' do |app|

data/lib/rexception/version.rb

@@ -1,3 +1,3 @@
 module Rexception
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/rexception.gemspec

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rexception/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rexception'
+  s.version     = Rexception::VERSION
+  s.authors     = 'kami'
+  s.email       = 'kami30k@gmail.com'
+  s.homepage    = 'https://github.com/kami30k/rexception'
+  s.summary     = 'Rendering error pages for Rails application.'
+  s.description = 'Rendering error pages for Rails application.'
+  s.license     = 'MIT'
+
+  s.files = `git ls-files -z`.split("\x0")
+
+  s.add_dependency 'rails'
+
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+end

data/spec/dummy/app/views/errors_dir/application.html.erb

@@ -0,0 +1 @@
+Application Error

data/spec/dummy/app/views/errors_dir/forbidden.html.erb

@@ -0,0 +1 @@
+Forbidden

data/spec/dummy/app/views/errors_dir/not_found.html.erb

@@ -0,0 +1 @@
+Not Found

data/spec/dummy/app/views/layouts/layout.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/application.rb

@@ -0,0 +1,48 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+require 'rexception'
+
+module Dummy
+  class Application < Rails::Application
+    config.secret_token = 'abcdefghijklmnopqrstuvwxyz0123456789'
+    config.session_store :cookie_store, key: '_dummy_session'
+    config.eager_load = false
+    config.active_support.deprecation = :log
+  end
+end
+
+Dummy::Application.initialize!
+
+Dummy::Application.routes.draw do
+  get '/application_error', to: 'errors#application_error'
+  get '/forbidden',         to: 'errors#forbidden'
+end
+
+class CustomException < StandardError
+end
+
+class ApplicationController < ActionController::Base
+end
+
+class ErrorsController < ApplicationController
+  def application_error
+    raise Exception
+  end
+
+  def forbidden
+    raise CustomException
+  end
+end
+
+Rexception.configure do |config|
+  config.layout = 'layout'
+
+  config.errors_dir = 'errors_dir'
+
+  config.rescue_responses = {
+    'CustomException' => :forbidden
+  }
+end

data/spec/dummy/bin/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+APP_PATH = File.expand_path('../../application', __FILE__)
+
+require 'rails/commands'

data/spec/dummy/config.ru

@@ -0,0 +1 @@
+run Rails.application

data/spec/requests/error_pages_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'Error pages' do
+  shared_examples_for 'error page' do |path, code, content|
+    it "should return #{code}" do
+      visit path
+
+      expect(page.status_code).to eq code
+      expect(page).to have_content content
+    end
+  end
+
+  context 'access to 403 page' do
+    it_behaves_like 'error page', '/forbidden', 403, 'Forbidden'
+  end
+
+  context 'access to 404 page' do
+    it_behaves_like 'error page', '/not_found', 404, 'Not Found'
+  end
+
+  context 'access to 500 page' do
+    it_behaves_like 'error page', '/application_error', 500, 'Application Error'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'dummy/application'
+
+require 'rspec/rails'
+require 'capybara/rails'
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.include Capybara::DSL
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rexception
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - kami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Rendering error pages for Rails application.
-email:
-- kami30k@gmail.com
+email: kami30k@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/rexception.rb
-- lib/rexception/controller.rb
+- lib/rexception/config.rb
+- lib/rexception/exceptions_controller.rb
 - lib/rexception/railtie.rb
-- lib/rexception/setting.rb
 - lib/rexception/version.rb
+- rexception.gemspec
+- spec/dummy/app/views/errors_dir/application.html.erb
+- spec/dummy/app/views/errors_dir/forbidden.html.erb
+- spec/dummy/app/views/errors_dir/not_found.html.erb
+- spec/dummy/app/views/layouts/layout.html.erb
+- spec/dummy/application.rb
+- spec/dummy/bin/rails
+- spec/dummy/config.ru
+- spec/requests/error_pages_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/kami30k/rexception
 licenses:
 - MIT
@@ -86,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rendering error pages for Rails application.

data/lib/rexception/setting.rb

@@ -1,31 +0,0 @@
-require 'singleton'
-
-module Rexception
-  class Setting
-    include Singleton
-
-    attr_accessor :layout
-    attr_accessor :errors_dir
-
-    def initialize
-      defaults.each { |k, v| instance_variable_set("@#{k}", v) }
-    end
-
-    def setup
-      yield self
-    end
-
-    def rescue_responses=(rescue_responses)
-      ActionDispatch::ExceptionWrapper.rescue_responses.merge!(rescue_responses)
-    end
-
-    private
-
-    def defaults
-      @defaults ||= {
-        layout:     'application',
-        errors_dir: 'errors'
-      }
-    end
-  end
-end