exception_handling 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c756149958cc585d26d470b83d28eae00adf19c3d7e6a5ac0e19ea28e301bb
-  data.tar.gz: 374842c72bdb92b8e4e311aca9c9021016c907fc1b9bc1679c89fb0a4932bce8
+  metadata.gz: 55e89ccca99bfdef126c57f9674d62d90d2048405099e83467ddc2997ffb3526
+  data.tar.gz: f7fae0d722026d38af12400a95812a14e2a7f32e7d79cbae90b3bd332a30fc04
 SHA512:
-  metadata.gz: 378b6795aa9d7c3819bc9890467f2318e17414d34ddfd28ab7a1c6e91ee6ac74c8fd22a429c7ea29cec928a4ba9ac5489451bd24533ef1b0da6b1b533b3dc5d9
-  data.tar.gz: 051a52b1b5a43a6e38ebfb6f6a1f293d0e35846dea8741f0c392a7fe22adc16b4f5692eabad4ec4b685e70047f2e82eb28cca3bb417fc8bf7357fbd8b723ffdf
+  metadata.gz: 509366eaf0081abe570f51d1ff09707a1ff880e94870616b850b5af000bc489d304bf222452799ff5f9848190247a3c526feb2ac4e3a62057dd04a3558e585eb
+  data.tar.gz: 7b26674dbf9862b43ba7b63650b1a9bc637d3b360d28b469e8d5ec231d3db7af7c4d12030e5e93653c1b1d2c2b84c47189a269472ce8c9dc6b370a5ee43cd3cb

data/.gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 .rubocop-http*
 test/reports/*
+gemfiles/*.lock

data/.jenkins/Jenkinsfile

@@ -19,6 +19,7 @@ pipeline {
     stage('Setup') {
       steps {
         script {
+          updateGitHubStatus('clean-build', 'pending', 'Unit tests.')
           sh '''
             # get SSH setup inside the container
             eval `ssh-agent -s`
@@ -27,18 +28,55 @@ pipeline {
             ssh-keyscan -t rsa github.com > /root/.ssh/known_hosts
 
             bundle install
+            bundle exec appraisal install
           '''
         }
       }
     }
-    stage('Unit Test') {
-      steps {
-        script {
-          sh 'bundle exec rake'
+    stage('Appraisals') {
+      parallel {
+        stage('Current') {
+          steps {
+            sh 'JUNIT_OUTPUT_DIR=test/reports/current bundle exec rake'
+          }
+
+          post {
+            always { junit '*/reports/current/*.xml' }
+          }
+        }
+
+        stage('Rails 4') {
+          steps {
+            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-4 bundle exec appraisal rails-4 rake'
+          }
+
+          post {
+            always { junit '*/reports/rails-4/*.xml' }
+          }
+        }
+
+        stage('Rails 5') {
+          steps {
+            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-5 bundle exec appraisal rails-5 rake'
+          }
+
+          post {
+            always { junit '*/reports/rails-5/*.xml' }
+          }
+        }
+
+        stage('Rails 6') {
+          steps {
+            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-6 bundle exec appraisal rails-6 rake'
+          }
+
+          post {
+            always { junit '*/reports/rails-6/*.xml' }
+          }
         }
       }
+
       post {
-        always { junit '*/reports/*.xml' }
         success { updateGitHubStatus('clean-build', 'success', 'Unit tests.') }
         failure { updateGitHubStatus('clean-build', 'failure', 'Unit tests.') }
       }
@@ -52,7 +90,7 @@ void updateGitHubStatus(String context, String status, String description) {
     sha:         env.GIT_COMMIT,
     description: description,
     context:     context,
-    targetURL:   env.BUILD_URL,
+    targetURL:   env.RUN_DISPLAY_URL,
     token:       env.GITHUB_TOKEN,
     status:      status
   ])

data/Appraisals

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+appraise "rails-4" do
+  gem 'actionmailer',  '~> 4.2'
+  gem 'actionpack',    '~> 4.2'
+  gem 'activesupport', '~> 4.2'
+end
+
+appraise "rails-5" do
+  gem 'actionmailer',  '~> 5.0'
+  gem 'actionpack',    '~> 5.0'
+  gem 'activesupport', '~> 5.0'
+end
+
+appraise "rails-6" do
+  gem 'actionmailer',  '~> 6.0'
+  gem 'actionpack',    '~> 6.0'
+  gem 'activesupport', '~> 6.0'
+end

data/CHANGELOG.md

@@ -4,8 +4,18 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.4.2] - 2020-05-11
+### Added
+- Added support for rails 5 and 6.
+- Added appraisal tests for all supported rails version: 4/5/6
+
+### Changed
+- Updated various test to be compatible with rails version 4/5/6
+- Updated the CI pipeline to test against all three supported versions of rails
+
 ## [2.4.1] - 2020-04-29
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
+[2.4.2]: https://github.com/Invoca/exception_handling/compare/v2.4.1...v2.4.2
 [2.4.1]: https://github.com/Invoca/exception_handling/compare/v2.4.0...v2.4.1

data/Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'appraisal', '~> 2.2'
 gem 'honeybadger', '3.3.1-1', git: 'git@github.com:Invoca/honeybadger-ruby', ref: 'bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6'
 gem "minitest"
 gem "minitest-reporters"

data/Gemfile.lock

@@ -8,10 +8,10 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.4.1)
-      actionmailer (~> 4.2)
-      actionpack (~> 4.2)
-      activesupport (~> 4.2)
+    exception_handling (2.4.2)
+      actionmailer (>= 4.2, < 7.0)
+      actionpack (>= 4.2, < 7.0)
+      activesupport (>= 4.2, < 7.0)
       contextual_logger
       eventmachine (~> 1.0)
       invoca-utils (~> 0.3)
@@ -47,6 +47,10 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     ansi (1.5.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
     ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
@@ -64,13 +68,13 @@ GEM
     invoca-utils (0.3.0)
     jaro_winkler (1.5.3)
     json (2.3.0)
-    loofah (2.4.0)
+    loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     method_source (0.9.2)
-    mini_mime (1.0.1)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     minitest-reporters (1.0.20)
@@ -86,7 +90,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (1.6.12)
+    rack (1.6.13)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails-deprecated_sanitizer (1.0.3)
@@ -95,8 +99,8 @@ GEM
       activesupport (>= 4.2.0, < 5.0)
       nokogiri (~> 1.6)
       rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
     rainbow (3.0.0)
     rake (13.0.1)
     rr (1.2.1)
@@ -114,6 +118,7 @@ GEM
     shoulda-context (1.2.2)
     shoulda-matchers (3.1.3)
       activesupport (>= 4.0.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -123,6 +128,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal (~> 2.2)
   exception_handling!
   honeybadger (= 3.3.1.pre.1)!
   minitest

data/README.md

@@ -2,6 +2,10 @@
 
 Enable emails for your exceptions that occur in your application!
 
+## Dependencies
+- Ruby 2.6
+- Rails >= 4, < 7
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -89,15 +93,15 @@ There is another hook available intended for custom actions after an error email
       else
         Invoca::Metrics::Client.metrics.counter("exception_handling/exception")
       end
-      
+
       case honeybadger_status
       when :success
         Invoca::Metrics::Client.metrics.counter("exception_handling.honeybadger.success")
-      when :failure 
+      when :failure
         Invoca::Metrics::Client.metrics.counter("exception_handling.honeybadger.failure")
       when :skipped
         Invoca::Metrics::Client.metrics.counter("exception_handling.honeybadger.skipped")
-      end  
+      end
     end
     ExceptionHandling.post_log_error_hook = method(:log_error_metrics)
 

data/exception_handling.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
     "allowed_push_host" => "https://rubygems.org"
   }
 
-  spec.add_dependency 'actionmailer',  '~> 4.2'
-  spec.add_dependency 'actionpack',    '~> 4.2'
-  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'actionmailer',  '>= 4.2', '< 7.0'
+  spec.add_dependency 'actionpack',    '>= 4.2', '< 7.0'
+  spec.add_dependency 'activesupport', '>= 4.2', '< 7.0'
   spec.add_dependency 'contextual_logger'
   spec.add_dependency 'eventmachine',  '~> 1.0'
   spec.add_dependency 'invoca-utils',  '~> 0.3'

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2"
+gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
+gem "minitest"
+gem "minitest-reporters"
+gem "pry"
+gem "rake"
+gem "rr"
+gem "rubocop"
+gem "shoulda"
+gem "actionmailer", "~> 4.2"
+gem "actionpack", "~> 4.2"
+gem "activesupport", "~> 4.2"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2"
+gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
+gem "minitest"
+gem "minitest-reporters"
+gem "pry"
+gem "rake"
+gem "rr"
+gem "rubocop"
+gem "shoulda"
+gem "actionmailer", "~> 5.0"
+gem "actionpack", "~> 5.0"
+gem "activesupport", "~> 5.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2"
+gem "honeybadger", "3.3.1-1", git: "git@github.com:Invoca/honeybadger-ruby", ref: "bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6"
+gem "minitest"
+gem "minitest-reporters"
+gem "pry"
+gem "rake"
+gem "rr"
+gem "rubocop"
+gem "shoulda"
+gem "actionmailer", "~> 6.0"
+gem "actionpack", "~> 6.0"
+gem "activesupport", "~> 6.0"
+
+gemspec path: "../"

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.4.1'
+  VERSION = '2.4.2'
 end

data/test/test_helper.rb

@@ -9,7 +9,9 @@ require 'shoulda'
 require 'rr'
 require 'minitest/autorun'
 require "minitest/reporters"
-Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new, Minitest::Reporters::JUnitReporter.new]
+
+junit_ouptut_dir = ENV["JUNIT_OUTPUT_DIR"].presence || "test/reports"
+Minitest::Reporters.use!([Minitest::Reporters::DefaultReporter.new, Minitest::Reporters::JUnitReporter.new(junit_ouptut_dir)])
 
 require 'pry'
 require 'honeybadger'

data/test/unit/exception_handling/exception_catalog_test.rb

@@ -52,7 +52,7 @@ module ExceptionHandling
       setup do
         @filename = File.expand_path('../../../config/exception_filters.yml',  __dir__)
         @exception_catalog = ExceptionCatalog.new(@filename)
-        assert_nothing_raised "Loading the exception filter should not raise" do
+        assert_nothing_raised do
           @exception_catalog.send :load_file
         end
       end

data/test/unit/exception_handling_test.rb

@@ -306,9 +306,24 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
           ExceptionHandling.ensure_safe { raise ArgumentError, "blah" }
         end
 
-        should "log an exception with call stack if an ActionView template exception is raised." do
-          mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
-          ExceptionHandling.ensure_safe { raise ActionView::TemplateError.new({}, ArgumentError.new("blah")) }
+        if ActionView::VERSION::MAJOR >= 5
+          should "log an exception with call stack if an ActionView template exception is raised." do
+            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+            ExceptionHandling.ensure_safe do
+              begin
+                # Rails 5 made the switch from ActionView::TemplateError taking in the original exception
+                # as an argument to using the $! global to extract the original exception
+                raise ArgumentError, "blah"
+              rescue
+                raise ActionView::TemplateError.new({})
+              end
+            end
+          end
+        else
+          should "log an exception with call stack if an ActionView template exception is raised." do
+            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+            ExceptionHandling.ensure_safe { raise ActionView::TemplateError.new({}, ArgumentError.new("blah")) }
+          end
         end
 
         should "should not log an exception if an exception is not raised." do

metadata

@@ -1,57 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Invoca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: contextual_logger
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +124,7 @@ files:
 - ".jenkins/ruby_build_pod.yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -114,6 +133,10 @@ files:
 - Rakefile
 - config/exception_filters.yml
 - exception_handling.gemspec
+- gemfiles/.bundle/config
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_6.gemfile
 - lib/exception_handling.rb
 - lib/exception_handling/exception_catalog.rb
 - lib/exception_handling/exception_description.rb