rambulance 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 41a24d609992f2ce07071bb783b231bbc358c66f
-  data.tar.gz: bee5f47a4df8ed67999da43b29652b613f7fab02
+SHA256:
+  metadata.gz: 56cafb27235f043f1b05600421ba5a01671aa3cd10d9f56beea8b29554e158a9
+  data.tar.gz: 78329235f2a74d2250f33cf80ab32c1312a507808a056a74a1b12c8fe956cdd3
 SHA512:
-  metadata.gz: 216306d2a9b1f76ececd7cf671823f8731f7f7bf4a99c90eb869b20b77fbc6e587d3a4806e3ab23610fe1ad66739d9fa6c06d2e2de80c4e7e34e72efd0bff3d0
-  data.tar.gz: c51fa8b131ab5fd77b00d73c7a6d85db0dc63bf8fe298643088b36714281d3e787bd1cc8085c798a0498b3ece725dfc35559435420dbca74e26bd97f839d661f
+  metadata.gz: 6d64689dae226f3d81305cf569f8de5ea5d90a261de6dd305441dfb231b5565f3821681de0d88895019953d2db6b50829b3c2dde3dcd8c919b4b430f844d3cff
+  data.tar.gz: 3783088dae915e9ac27897858dedb939017fc82d4bda229db4d10ea629bad01e1d14cdfef195e1c04877bee893fda0ae4e258df507d4f0f7552b5c992b05dba3

data/.travis.yml

@@ -15,7 +15,7 @@ rvm:
   - 2.4.3
   - 2.5.0
   - ruby-head
-  - jruby-9.1.15.0
+  - jruby-9.1.16.0
   - jruby-head
 
 gemfile:
@@ -25,6 +25,7 @@ gemfile:
   - gemfiles/rails_42.gemfile
   - gemfiles/rails_50.gemfile
   - gemfiles/rails_51.gemfile
+  - gemfiles/rails_52.gemfile
   - gemfiles/rails_edge.gemfile
 
 matrix:
@@ -33,18 +34,28 @@ matrix:
       gemfile: gemfiles/rails_50.gemfile
     - rvm: 2.0.0
       gemfile: gemfiles/rails_51.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_52.gemfile
     - rvm: 2.0.0
       gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.1
       gemfile: gemfiles/rails_50.gemfile
     - rvm: 2.1
       gemfile: gemfiles/rails_51.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_52.gemfile
     - rvm: 2.1
       gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.2.9
       gemfile: gemfiles/rails_32.gemfile
+    - rvm: 2.2.9
+      gemfile: gemfiles/rails_51.gemfile
+    - rvm: 2.2.9
+      gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.3.6
       gemfile: gemfiles/rails_32.gemfile
+    - rvm: 2.3.6
+      gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.4.3
       gemfile: gemfiles/rails_32.gemfile
     - rvm: 2.4.3
@@ -63,11 +74,11 @@ matrix:
       gemfile: gemfiles/rails_40.gemfile
     - rvm: ruby-head
       gemfile: gemfiles/rails_41.gemfile
-    - rvm: jruby-9.1.15.0
+    - rvm: jruby-9.1.16.0
       gemfile: gemfiles/rails_32.gemfile
-    - rvm: jruby-9.1.15.0
+    - rvm: jruby-9.1.16.0
       gemfile: gemfiles/rails_40.gemfile
-    - rvm: jruby-9.1.15.0
+    - rvm: jruby-9.1.16.0
       gemfile: gemfiles/rails_41.gemfile
     - rvm: jruby-head
       gemfile: gemfiles/rails_32.gemfile
@@ -77,7 +88,7 @@ matrix:
       gemfile: gemfiles/rails_41.gemfile
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-9.1.15.0
+    - rvm: jruby-9.1.16.0
     - rvm: jruby-head
     - gemfile: gemfiles/rails_edge.gemfile
     - gemfile: gemfiles/rails_32.gem

data/Appraisals

@@ -42,6 +42,12 @@ appraise "rails_51" do
   gem "railties", "~> 5.1.0"
 end
 
+appraise "rails_52" do
+  gem "activesupport", "~> 5.2.0.rc1"
+  gem "actionpack", "~> 5.2.0.rc1"
+  gem "railties", "~> 5.2.0.rc1"
+end
+
 appraise "rails_edge" do
   git 'git://github.com/rails/rails.git' do
     gem "activesupport", require: 'active_support'

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [v0.5.0](https://github.com/yuki24/rambulance/tree/v0.5.0)
+
+_<sup>released at 2018-01-02 21:36:02 UTC</sup>_
+
+#### New features
+
+- Add support for Ruby 2.5.0
+- Add support for Rails 5.1
+
+#### Breaking changes & deprecations
+
+- Drop support for Ruby 1.9.3
+- Drop support for Haml and Slim templates
+
+#### Bug fixes
+
+- Fixes a bug where the exceptions app fails to show an error page properly when a malformed body is posted ([<tt>474b6b3</tt>](https://github.com/yuki24/rambulance/commit/474b6b329e5590db3c0a7e33c795b18c00812729), [#40](https://github.com/yuki24/rambulance/issues/40), [@jasim](https://github.com/jasim))
+
 ## [v0.4.0](https://github.com/yuki24/rambulance/tree/v0.4.0)
 
 _<sup>released at 2016-10-12 02:25:55 UTC</sup>_

data/README.md

@@ -96,10 +96,44 @@ It'll generate your own custom exceptions app. You can use whatever techniques y
 
 **Keep in mind that you shouldn't do too many things because something already went wrong with your application!**
 
+## Testing
+
+Ramnurance ships with a test helper that allows you to test an error page generated by Rails. All you have to do is to `include Rambulance::TestHelper` and you will be able to use the `with_exceptions_app` DSDL:
+
+Rspec:
+
+```ruby
+include Rambulance::TestHelper
+
+it "shows an error page" do
+  with_exceptions_app do
+    get '/does_not_exist'
+  end
+
+  assert_equal 404, response.status
+end
+```
+
+Minitest:
+
+```ruby
+include Rambulance::TestHelper
+
+test "it shows an error page" do
+  with_exceptions_app do
+    get '/does_not_exist'
+  end
+
+  assert_equal 404, response.status
+end
+```
+
+Note that testing error pages is not encouraged in Rails as it leads to overuse of the `rescue_from` DSL in controllers.
+
 ## Supported Versions
 
-* Ruby 2.0.0, 2.1, 2.2, 2.3, JRuby 1.7.19, JRuby head, Rubinius 2.4.1 and 2.5.3
-* Rails 3.2, 4.0, 4.1, 4.2, 5.0 and edge
+* Ruby 2.0.0, 2.1, 2.2, 2.3, 2,4, 2,5, trunk,  JRuby 9.1.16.0, and JRuby head
+* Rails 3.2, 4.0, 4.1, 4.2, 5.0, 5,1, 5,2 and edge
 
 Rambulance doesn't work with Rails 3.1 and below since they don't provide a way to use a custom exceptions app.
 

data/app/views/errors/internal_server_error.text.erb

@@ -0,0 +1 @@
+Something went wrong.

data/app/views/errors/not_acceptable.text.erb

@@ -0,0 +1 @@
+The requested content type is not acceptable.

data/gemfiles/rails_52.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0.rc1"
+gem "actionpack", "~> 5.2.0.rc1"
+gem "railties", "~> 5.2.0.rc1"
+
+gemspec path: "../"

data/lib/generators/rambulance/templates/views/not_acceptable.text.erb

@@ -0,0 +1 @@
+Unknown format.

data/lib/rambulance.rb

@@ -1,5 +1,7 @@
 require "rambulance/version"
 require "rambulance/railtie"
+require "rambulance/engine"
+require "rambulance/test_helper"
 
 module Rambulance
 

data/lib/rambulance/engine.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Rambulance #:nodoc:
+  class Engine < ::Rails::Engine #:nodoc:
+  end
+end

data/lib/rambulance/exceptions_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambulance
   ERROR_HTTP_STATUSES = Rack::Utils::SYMBOL_TO_STATUS_CODE.select do |status_in_words, http_status|
     # Exclude http statuses that:
@@ -34,7 +36,7 @@ module Rambulance
     end if ActionPack::VERSION::STRING >= "4.2.0"
 
     ERROR_HTTP_STATUSES.values.each do |status_in_words|
-      eval <<-ACTION
+      eval <<-ACTION, nil, __FILE__, __LINE__ + 1
         def #{status_in_words}
           render(template_exists?(error_path) ? error_path : error_path(:internal_server_error))
         end
@@ -43,9 +45,8 @@ module Rambulance
 
     def process(action, *args)
       if action.to_s.empty?
-        action = request.env["PATH_INFO"][1..-1].to_sym.tap do |status_in_words|
-          request.env["PATH_INFO"] = "/#{Rack::Utils::SYMBOL_TO_STATUS_CODE[status_in_words]}"
-        end
+        action = request.env["PATH_INFO"][1..-1].to_sym
+        request.env["PATH_INFO"] = "/#{Rack::Utils::SYMBOL_TO_STATUS_CODE[action]}"
       end
 
       super
@@ -66,6 +67,14 @@ module Rambulance
         request.env["MALFORMED_BODY"], request.env["rack.input"] = request.env["rack.input"], StringIO.new
       end
 
+      # The #formats method needs to be called after the sanitization above.
+      if request.respond_to?(:formats)
+        request.formats << Mime::Type.lookup('text/plain')
+      elsif request.respond_to?(:format) && status == 406
+        # TODO: Remove this conditional when dropping support for Rails 3.2
+        request.format = Mime::Type.lookup('text/plain')
+      end
+
       super
     end
 

data/lib/rambulance/test_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Rambulance #:nodoc:
+  module TestHelper
+    # enables the exceptions app in the block.
+    #
+    # Rspec:
+    #
+    #   it "shows an error page" do
+    #     with_exceptions_app do
+    #       get '/'
+    #     end
+    #
+    #     ...
+    #   end
+    #
+    # Minitest:
+    #
+    #   test "it shows an error page" do
+    #     with_exceptions_app do
+    #       get '/'
+    #     end
+    #
+    #     ...
+    #   end
+    #
+    def with_exceptions_app(enabled: true)
+      org_show_detailed_exceptions = Rails.application.env_config['action_dispatch.show_detailed_exceptions']
+      org_show_exceptions          = Rails.application.env_config['action_dispatch.show_exceptions']
+
+      Rails.application.env_config['action_dispatch.show_detailed_exceptions'] = !enabled
+      Rails.application.env_config['action_dispatch.show_exceptions']          = enabled
+
+      yield
+    ensure
+      Rails.application.env_config['action_dispatch.show_detailed_exceptions'] = org_show_detailed_exceptions
+      Rails.application.env_config['action_dispatch.show_exceptions']          = org_show_exceptions
+    end
+  end
+end
+

data/lib/rambulance/version.rb

@@ -1,3 +1,3 @@
 module Rambulance
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/test/exceptions_app_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class ExeptionsAppTest < ActionDispatch::IntegrationTest
+  test 'returns 404 for unknown format for pages that do not exist' do
+    get '/does_not_exist', headers: { 'Accept' => '*/*'  }
+
+    assert_equal 404, response.status
+  end
+end
+

data/test/fake_app/rails_app.rb

@@ -15,6 +15,7 @@ Rails.application.initialize!
 # routes
 Rails.application.routes.draw do
   resources :users
+  resources :projects, only: :index
 end
 
 # custom exception class
@@ -74,3 +75,12 @@ class UsersController < ApplicationController
     raise ForbiddenException
   end
 end
+class ProjectsController < ApplicationController
+  if self.respond_to? :skip_before_action
+    skip_before_action :bad_filter
+  else
+    skip_filter :bad_filter
+  end
+
+  def index; end
+end

data/test/requests/error_page_test.rb

@@ -1,6 +1,22 @@
 require 'test_helper'
 
 class ErrorPageTest < ActionDispatch::IntegrationTest
+  test 'displays the corresponding error page if /rambulance/status_in_words is requested in development' do
+    skip
+
+    visit '/rambulance/forbidden'
+
+    assert_equal 403, page.status_code
+    assert_includes page.body, "Error page"
+    assert_includes page.body, "Forbidden."
+
+    visit '/rambulance/internal_server_error'
+
+    assert_equal 500, page.status_code
+    assert_includes page.body, "Error page"
+    assert_includes page.body, "Something went wrong."
+  end
+
   test 'displays the 500 page for RuntimeError' do
     visit '/users/1'
 
@@ -17,6 +33,21 @@ class ErrorPageTest < ActionDispatch::IntegrationTest
     assert_includes page.body, "Page not found."
   end
 
+  test 'displays the 406 page for unknown format' do
+    visit '/projects'
+
+    assert_equal 200, page.status_code # Just to make sure normal html request succeeds
+
+    visit '/projects.jpeg'
+
+    if Rails.version < '5.0.0'
+      assert_equal 500, page.status_code
+    else
+      assert_equal 406, page.status_code
+      assert_includes page.body, "The requested content type is not acceptable."
+    end
+  end
+
   test 'displays the 404 page for ActionController::RoutingError' do
     visit '/doesnt_exist'
 

data/test/test_helper.rb

@@ -1,6 +1,9 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+# RAILS_ENV needs to be set to development to mount the error page debug view
+ENV['RAILS_ENV'] ||= 'development'
+
 require 'rails'
 require 'minitest/autorun'
 require 'minitest/pride'

data/test/test_helper_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class TestHelperTest < ActionDispatch::IntegrationTest
+  include Rambulance::TestHelper
+
+  test '#with_exceptions_app can enable the exceptions app in test' do
+    with_exceptions_app do
+      get '/does_not_exist'
+    end
+
+    assert_equal 404, response.status
+  end
+
+  test '#with_exceptions_app can disable the exceptions app in test' do
+    with_exceptions_app enabled: false do
+      assert_raises ActionController::RoutingError do
+        get '/does_not_exist'
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rambulance
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -152,12 +152,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/errors/internal_server_error.text.erb
+- app/views/errors/not_acceptable.text.erb
 - gemfiles/rails_32.gemfile
 - gemfiles/rails_40.gemfile
 - gemfiles/rails_41.gemfile
 - gemfiles/rails_42.gemfile
 - gemfiles/rails_50.gemfile
 - gemfiles/rails_51.gemfile
+- gemfiles/rails_52.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/generators/rambulance/exceptions_app_generator.rb
 - lib/generators/rambulance/install_generator.rb
@@ -169,15 +172,19 @@ files:
 - lib/generators/rambulance/templates/views/forbidden.json.jbuilder
 - lib/generators/rambulance/templates/views/internal_server_error.html.erb
 - lib/generators/rambulance/templates/views/internal_server_error.json.jbuilder
+- lib/generators/rambulance/templates/views/not_acceptable.text.erb
 - lib/generators/rambulance/templates/views/not_found.html.erb
 - lib/generators/rambulance/templates/views/not_found.json.jbuilder
 - lib/generators/rambulance/templates/views/unprocessable_entity.html.erb
 - lib/generators/rambulance/templates/views/unprocessable_entity.json.jbuilder
 - lib/rambulance.rb
+- lib/rambulance/engine.rb
 - lib/rambulance/exceptions_app.rb
 - lib/rambulance/railtie.rb
+- lib/rambulance/test_helper.rb
 - lib/rambulance/version.rb
 - rambulance.gemspec
+- test/exceptions_app_test.rb
 - test/fake_app/app/helpers/application_helper.rb
 - test/fake_app/app/views/errors/bad_request.html.erb
 - test/fake_app/app/views/errors/forbidden.html.erb
@@ -187,11 +194,13 @@ files:
 - test/fake_app/app/views/errors/not_found.json.jbuilder
 - test/fake_app/app/views/layouts/application.html.erb
 - test/fake_app/app/views/layouts/error.html.erb
+- test/fake_app/app/views/projects/index.html.erb
 - test/fake_app/lib/exceptions_app.rb
 - test/fake_app/rails_app.rb
 - test/requests/error_json_test.rb
 - test/requests/error_page_test.rb
 - test/test_helper.rb
+- test/test_helper_test.rb
 homepage: http://github.com/yuki24/rambulance
 licenses:
 - MIT
@@ -212,11 +221,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple and safe way to dynamically generate error pages
 test_files:
+- test/exceptions_app_test.rb
 - test/fake_app/app/helpers/application_helper.rb
 - test/fake_app/app/views/errors/bad_request.html.erb
 - test/fake_app/app/views/errors/forbidden.html.erb
@@ -226,8 +236,10 @@ test_files:
 - test/fake_app/app/views/errors/not_found.json.jbuilder
 - test/fake_app/app/views/layouts/application.html.erb
 - test/fake_app/app/views/layouts/error.html.erb
+- test/fake_app/app/views/projects/index.html.erb
 - test/fake_app/lib/exceptions_app.rb
 - test/fake_app/rails_app.rb
 - test/requests/error_json_test.rb
 - test/requests/error_page_test.rb
 - test/test_helper.rb
+- test/test_helper_test.rb