exception_handler 0.7.7.0 → 0.8.0.0

data/lib/exception_handler/engine.rb

@@ -7,7 +7,7 @@
 ##    | |__| | | | (_| | | | | |  __/    ##
 ##    \____/_| |_|\__, |_|_| |_|\___|    ##
 ##                 __/ |                 ##
-##                |___/                  ##                     
+##                |___/                  ##
 ###########################################
 ###########################################
 
@@ -39,7 +39,8 @@ module ExceptionHandler
 
       # => Config
       # => Builds lib/exception_handler/config.rb
-      # config.before_initialize do |app| => Needs to be fixed for ActiveRecord::Base
+      # => config.before_initialize do |app| => Needs to be fixed for ActiveRecord::Base
+      # => to support later version of config, "with_indifferent_access" used in config.rb
       initializer :exception_handler_config, before: "better_errors.configure_rails_initialization" do |app|
         ExceptionHandler.config ||= ExceptionHandler::Config.new config.try(:exception_handler)
       end
@@ -51,7 +52,14 @@ module ExceptionHandler
       # => This should be config.before_initialize but because ActiveRecord is not initialized, cannot check for table
       initializer :exception_handler, before: "better_errors.configure_rails_initialization" do |app|
         app.config.exceptions_app = ->(env) { ExceptionHandler::ExceptionsController.action(:show).call(env) }
-        app.config.consider_all_requests_local = !ExceptionHandler.config.try(:dev) if Rails.env.development?
+        app.config.consider_all_requests_local = !ExceptionHandler.config.try(:dev) if Rails.env.development? || Rails.env.test?
+      end
+
+      # => Custom Exceptions
+      # => This just mimicks standard Rails behaviour
+      # => Look for "config.action_dispatch.rescue_responses" for more info)
+      initializer :exception_handler_custom_exceptions do |app|
+        app.config.action_dispatch.rescue_responses.merge! ExceptionHandler.config.custom_exceptions if ExceptionHandler.config.custom_exceptions
       end
 
       # => Migrations

data/lib/exception_handler/version.rb

@@ -13,8 +13,8 @@
 module ExceptionHandler
   module VERSION
     MAJOR = 0
-    MINOR = 7
-    TINY  = 7
+    MINOR = 8
+    TINY  = 0
     PRE   = 0 # "alpha"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/spec/controllers/controller_spec.rb

@@ -0,0 +1,107 @@
+#####################################################
+#####################################################
+##  _____             _             _ _            ##
+## /  __ \           | |           | | |           ##
+## | /  \/ ___  _ __ | |_ _ __ ___ | | | ___ _ __  ##
+## | |    / _ \| '_ \| __| '__/ _ \| | |/ _ \ '__| ##
+## | \__/\ (_) | | | | |_| | | (_) | | |  __/ |    ##
+##  \____/\___/|_| |_|\__|_|  \___/|_|_|\___|_|    ##
+##                                                 ##
+#####################################################
+#####################################################
+
+require 'spec_helper'
+
+###############################################
+###############################################
+
+# => ExceptionHandler (Controller)
+# => Test erroneous requests under different circumstances
+# => Expect the return of 404, 500 (etc) Error Pages
+# => Test layout, show action, @exception object and different config options
+RSpec.describe ExceptionHandler::ExceptionsController do
+
+    # => General
+    # => Used to describe the actual Controller class
+    describe "class" do
+      subject { controller }
+      it { should respond_to :show }
+    end
+
+  #################################
+  #################################
+
+    # => Layout
+    # => Expected results & overall views
+    describe "layout" do
+      #subject { response.layout }
+      #it { should be_a String }
+    end
+
+  #################################
+  #################################
+
+    # => Response
+    # => Should deliver 404 / 500 error responses
+    # => Should deliver appropriate headers, layout etc
+    describe "response" do
+
+      # => Before
+      before(:each) { }
+
+      # => 404
+      context "404" do
+        subject { response }
+        it { should have_http_status :ok }
+
+      end
+
+      # => 500
+      context "500" do
+      end
+
+    end
+
+  #################################
+  #################################
+
+    # => Dev Routes
+    # => Should deliver 404 / 500 error responses
+    # => Should deliver appropriate headers, layout etc
+    describe "dev routes" do
+
+      # => Item
+      before(:context) { ExceptionHandler.config.dev = true }
+      before(:context) { Rails.application.reload_routes! }
+
+      # => Items
+      let(:dev) { ExceptionHandler.config.dev }
+
+      # => Config
+
+      # => Pages
+      # => These are shown when
+      context "pages" do
+
+        # => Dev Mode
+        # => Only works with dev enabled
+        it "has Dev mode enabled" do
+          expect(dev).to eq(true)
+        end
+
+        # => The error pages need to return the correct status code
+        #Rack::Utils::SYMBOL_TO_STATUS_CODE.select{ |key, value| value.to_s.match('\b(?:4[0-9]{2}|5[0-9]{2}|599)\b') }.each do |status,code|
+        #  it "shows #{code.to_s} page" do
+        #    get :show, params: { code: status.to_sym }
+        #    expect(response).to have_http_status status.to_sym
+        #    expect(response.body).to match /404/
+        #  end
+        #end
+
+      end
+    end
+
+end
+
+###############################################
+###############################################

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/spec/dummy/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

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

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby.exe
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby.exe
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby.exe
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby.exe
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby.exe
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby.exe
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,18 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'exception_handler'
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3