exception_handling 2.6.1 → 2.7.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e775cff5b73e955140fcc3a5492564e565567e8de147424da3602b83ad2e3b55
-  data.tar.gz: 35fa446e469e356ae600c5b24860ec8ff73dda25a72df59d5954be0748aac6bd
+  metadata.gz: 3794611262e09346bab80e7a683f4ce1d78d6ba04b46fa15fa4bc84ac087e41e
+  data.tar.gz: 36f96bed7f2b3375df4730d35ee5ec96cdf70e7c07f4ba589e187c75275c1736
 SHA512:
-  metadata.gz: d3486a507210596be078ae1953105859d9d2e556b5794f9e1b01bbee21b34e6cd04be115429548a02cce1c6fec80ea680f990ba8b83d07c9594fed5c7de712d5
-  data.tar.gz: e19c845b8d8332f5118c0668c4520cabf00bf88c94117111ee2801d5320f2af2cc620224d79e3dc2e4daef62c4c7cb4115e3cc010cf56e8292cf9dcfef49f974
+  metadata.gz: 2d1dad10749b867696c0f4dcacedcfb4af466ba792fa0c98ae307ee4bbeda10657f172fc95ff3c9b0162d1787d39c3c2a15a220fa6c6f4a7f7b10d857dad5eec
+  data.tar.gz: 8b28f2829a1e34787d7de51fdee4d0fe5a39356584d6d910c106edac2fe5d8ebcf0f3f5f1e9e1b7e4e7b0c36dd62035885214248072e47a7fdec7d1e4a854f94

data/.gitignore

@@ -1,6 +1,6 @@
 .idea
 .DS_Store
 .rubocop-http*
-spec/reports/*
+test/reports/*
 gemfiles/*.lock
 pkg/

data/.jenkins/Jenkinsfile

@@ -36,58 +36,42 @@ pipeline {
     stage('Appraisals') {
       parallel {
         stage('Current') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/current'
-          }
-
           steps {
-            sh "bundle exec rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
+            sh 'JUNIT_OUTPUT_DIR=test/reports/current bundle exec rake'
           }
 
           post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
+            always { junit '*/reports/current/*.xml' }
           }
         }
 
         stage('Rails 4') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/rails-4'
-          }
-
           steps {
-            sh "bundle exec appraisal rails-4 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
+            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-4 bundle exec appraisal rails-4 rake'
           }
 
           post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
+            always { junit '*/reports/rails-4/*.xml' }
           }
         }
 
         stage('Rails 5') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/rails-5'
-          }
-
           steps {
-            sh "bundle exec appraisal rails-5 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
+            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-5 bundle exec appraisal rails-5 rake'
           }
 
           post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
+            always { junit '*/reports/rails-5/*.xml' }
           }
         }
 
         stage('Rails 6') {
-          environment {
-            JUNIT_OUTPUT = 'spec/reports/rails-6'
-          }
-
           steps {
-            sh "bundle exec appraisal rails-6 rspec --format RspecJunitFormatter --out ${JUNIT_OUTPUT}/rspec.xml"
+            sh 'JUNIT_OUTPUT_DIR=test/reports/rails-6 bundle exec appraisal rails-6 rake'
           }
 
           post {
-            always { junit "${JUNIT_OUTPUT}/*.xml" }
+            always { junit '*/reports/rails-6/*.xml' }
           }
         }
       }

data/CHANGELOG.md

@@ -4,7 +4,13 @@ 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.6.1] - 2020-10-14
+## [2.7.0] - Unreleased
+### Added
+- Added `LoggingMethods` as a replacement for `Methods` without setting controller or checking for long controller action.
+### Deprecated
+- Deprecated `Methods` in favor of `LoggingMethods`.
+
+## [2.6.1] - Unreleased
 ### Fixed
 - Fixed honeybadger_context_data to always merge `current_context_for_thread`, even if `log_context:` is passed as `nil`.
 
@@ -46,6 +52,7 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
+[2.7.0]: https://github.com/Invoca/exception_handling/compare/v2.6.1...v2.7.0
 [2.6.1]: https://github.com/Invoca/exception_handling/compare/v2.6.0...v2.6.1
 [2.6.0]: https://github.com/Invoca/exception_handling/compare/v2.5.0...v2.6.0
 [2.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.4...v2.5.0

data/Gemfile

@@ -6,10 +6,10 @@ 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"
 gem 'pry'
-gem 'pry-byebug'
 gem 'rake'
-gem 'rspec'
-gem 'rspec_junit_formatter'
+gem 'rr'
 gem 'rubocop'
-gem 'test-unit'
+gem 'shoulda'

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.6.1)
+    exception_handling (2.7.0.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
@@ -46,20 +46,19 @@ GEM
       minitest (~> 5.1)
       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)
-    byebug (11.1.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    contextual_logger (0.10.0)
+    contextual_logger (0.11.0)
       activesupport
       json
     crass (1.0.6)
-    diff-lcs (1.4.4)
     erubis (2.7.0)
     eventmachine (1.2.7)
     globalid (0.4.2)
@@ -78,18 +77,19 @@ GEM
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
+    minitest-reporters (1.0.20)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    power_assert (1.2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.8.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
     rack (1.6.13)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -103,21 +103,7 @@ GEM
       loofah (~> 2.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
+    rr (1.2.1)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -126,8 +112,12 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    test-unit (3.3.6)
-      power_assert
+    shoulda (3.6.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (~> 3.0)
+    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)
@@ -141,13 +131,13 @@ DEPENDENCIES
   appraisal (~> 2.2)
   exception_handling!
   honeybadger (= 3.3.1.pre.1)!
+  minitest
+  minitest-reporters
   pry
-  pry-byebug
   rake
-  rspec
-  rspec_junit_formatter
+  rr
   rubocop
-  test-unit
+  shoulda
 
 BUNDLED WITH
    1.17.3

data/Rakefile

@@ -1,15 +1,14 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
 
-require 'rake/testtask'
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+require_relative 'test/rake_test_warning_false'
 
-require_relative 'spec/rake_test_warning_false'
+task default: :test
 
-desc "run rspec unit tests"
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:rspec)
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
 end
 
-task default: :rspec

data/lib/exception_handling/log_stub_error.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Test Helper that supports Minitest::Test and Test::Unit
-# Used by tests in the consumers of this gem to track exceptions.
+# Used by functional tests to track exceptions.
 #
 
 module LogErrorStub

data/lib/exception_handling/logging_methods.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation.rb'
+
+module ExceptionHandling
+  module LoggingMethods # included on models and controllers
+    extend ActiveSupport::Concern
+
+    protected
+
+    delegate :log_error_rack, :log_warning, :log_info, :log_debug, :escalate_error, :escalate_warning, :ensure_escalation, :alert_warning, to: ExceptionHandling
+
+    # TODO: delegate log_error as well
+    def log_error(exception_or_string, exception_context = '')
+      controller = self if respond_to?(:request) && respond_to?(:session)
+      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
+    end
+
+    def ensure_safe(exception_context = "")
+      yield
+    rescue => ex
+      log_error ex, exception_context
+      nil
+    end
+
+    def ensure_alert(*args)
+      ExceptionHandling.ensure_alert(*args) do
+        yield
+      end
+    end
+  end
+end

data/lib/exception_handling/methods.rb

@@ -1,65 +1,15 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
+require_relative 'logging_methods'
 
 module ExceptionHandling
   module Methods # included on models and controllers
     extend ActiveSupport::Concern
+    include ExceptionHandling::LoggingMethods
 
     protected
 
-    def log_error(exception_or_string, exception_context = '')
-      controller = self if respond_to?(:request) && respond_to?(:session)
-      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
-    end
-
-    def log_error_rack(exception_or_string, exception_context = '', rack_filter = '')
-      ExceptionHandling.log_error_rack(exception_or_string, exception_context, rack_filter)
-    end
-
-    def log_warning(message)
-      ExceptionHandling.log_warning(message)
-    end
-
-    def log_info(message)
-      ExceptionHandling.logger.info(message)
-    end
-
-    def log_debug(message)
-      ExceptionHandling.logger.debug(message)
-    end
-
-    def ensure_safe(exception_context = "")
-      yield
-    rescue => ex
-      log_error ex, exception_context
-      nil
-    end
-
-    def escalate_error(exception_or_string, email_subject)
-      ExceptionHandling.escalate_error(exception_or_string, email_subject)
-    end
-
-    def escalate_warning(message, email_subject)
-      ExceptionHandling.escalate_warning(message, email_subject)
-    end
-
-    def ensure_escalation(*args)
-      ExceptionHandling.ensure_escalation(*args) do
-        yield
-      end
-    end
-
-    def alert_warning(*args)
-      ExceptionHandling.alert_warning(*args)
-    end
-
-    def ensure_alert(*args)
-      ExceptionHandling.ensure_alert(*args) do
-        yield
-      end
-    end
-
     def long_controller_action_timeout
       if defined?(Rails) && Rails.respond_to?(:env) && Rails.env == 'test'
         300
@@ -88,7 +38,10 @@ module ExceptionHandling
     end
 
     included do
-      around_filter :set_current_controller if respond_to? :around_filter
+      Deprecation3_0.deprecation_warning('ExceptionHandling::Methods', 'include LoggingMethods; in controllers, set your own around_filter to set logging context')
+      if respond_to? :around_filter
+        around_filter :set_current_controller
+      end
     end
 
     class_methods do

data/lib/exception_handling/testing.rb

@@ -4,7 +4,7 @@
 
 module ExceptionHandling
   module Testing
-    class ControllerStub
+    class ControllerStubBase
 
       class Request
         attr_accessor :parameters, :protocol, :host, :request_uri, :env, :session_options
@@ -25,7 +25,7 @@ module ExceptionHandling
         attr_accessor :around_filter_method
 
         def around_filter(method)
-          ControllerStub.around_filter_method = method
+          self.around_filter_method = method
         end
       end
 
@@ -44,14 +44,6 @@ module ExceptionHandling
           end
       end
 
-      def simulate_around_filter(&block)
-        set_current_controller(&block)
-      end
-
-      def controller_name
-        "ControllerStub"
-      end
-
       def action_name
         "test_action"
       end
@@ -59,9 +51,27 @@ module ExceptionHandling
       def complete_request_uri
         "#{@request.protocol}#{@request.host}#{@request.request_uri}"
       end
+    end
+
+    class LoggingMethodsControllerStub < ControllerStubBase
+      include ExceptionHandling::LoggingMethods
+
+      def controller_name
+        "LoggingMethodsControllerStub"
+      end
+    end
 
+    class MethodsControllerStub < ControllerStubBase
       include ExceptionHandling::Methods
       set_long_controller_action_timeout 2
+
+      def simulate_around_filter(&block)
+        set_current_controller(&block)
+      end
+
+      def controller_name
+        "MethodsControllerStub"
+      end
     end
   end
 end

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.6.1'
+  VERSION = '2.7.0.pre.1'
 end

data/lib/exception_handling.rb

@@ -29,6 +29,8 @@ module ExceptionHandling # never included
   AUTHENTICATION_HEADERS = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION', 'REDIRECT_X_HTTP_AUTHORIZATION'].freeze
   HONEYBADGER_STATUSES   = [:success, :failure, :skipped].freeze
 
+  Deprecation3_0 = ActiveSupport::Deprecation.new('3.0', 'exception_handling')
+
   class << self
 
     #
@@ -54,8 +56,6 @@ module ExceptionHandling # never included
       @logger or raise ArgumentError, "You must assign a value to #{name}.logger"
     end
 
-    Deprecation3_0 = ActiveSupport::Deprecation.new('3.0', 'exception_handling')
-
     def logger=(logger)
       @logger = if logger.nil? || logger.is_a?(ContextualLogger::LoggerMixin)
                   logger

data/{spec → test}/helpers/exception_helpers.rb

@@ -7,7 +7,7 @@ module ExceptionHelpers
 
   def exception_with_nil_message
     exception_with_nil_message = RuntimeError.new(nil)
-    allow(exception_with_nil_message).to receive(:message).and_return(nil)
+    stub(exception_with_nil_message).message { nil }
     exception_with_nil_message
   end
 
@@ -15,6 +15,6 @@ module ExceptionHelpers
 
   def capture_notifications
     @sent_notifications = []
-    allow(ExceptionHandling).to receive(:send_exception_to_honeybadger).with(anything) { |exception_info| @sent_notifications << exception_info }
+    stub(ExceptionHandling).send_exception_to_honeybadger(anything) { |exception_info| @sent_notifications << exception_info }
   end
 end

data/{spec/spec_helper.rb → test/test_helper.rb}

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
-require 'rspec'
-require 'rspec/mocks'
-require 'rspec_junit_formatter'
+require 'active_support'
+require 'active_support/time'
+require 'active_support/test_case'
+require 'action_mailer'
+require 'action_dispatch'
+require 'shoulda'
+require 'rr'
+require 'minitest/autorun'
+require "minitest/reporters"
+
+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'
@@ -11,6 +20,8 @@ require 'contextual_logger'
 require 'exception_handling'
 require 'exception_handling/testing'
 
+ActiveSupport::TestCase.test_order = :sorted
+
 class LoggerStub
   include ContextualLogger::LoggerMixin
   attr_accessor :logged, :level
@@ -76,17 +87,27 @@ end
 
 ActionMailer::Base.delivery_method = :test
 
+_ = ActiveSupport
+_ = ActiveSupport::TestCase
 
-module TestHelper
-  @constant_overrides = []
-  class << self
-    attr_accessor :constant_overrides
-  end
+class ActiveSupport::TestCase
+  @@constant_overrides = []
 
+  setup do
+    unless @@constant_overrides.nil? || @@constant_overrides.empty?
+      raise "Uh-oh! constant_overrides left over: #{@@constant_overrides.inspect}"
+    end
 
-  def setup_constant_overrides
-    unless TestHelper.constant_overrides.nil? || TestHelper.constant_overrides.empty?
-      raise "Uh-oh! constant_overrides left over: #{TestHelper.constant_overrides.inspect}"
+    unless defined?(Rails) && defined?(Rails.env)
+      module ::Rails
+        class << self
+          attr_writer :env
+
+          def env
+            @env ||= 'test'
+          end
+        end
+      end
     end
 
     Time.now_override = nil
@@ -106,8 +127,8 @@ module TestHelper
     ExceptionHandling.sensu_prefix            = ""
   end
 
-  def teardown_constant_overrides
-    TestHelper.constant_overrides&.reverse&.each do |parent_module, k, v|
+  teardown do
+    @@constant_overrides&.reverse&.each do |parent_module, k, v|
       ExceptionHandling.ensure_safe "constant cleanup #{k.inspect}, #{parent_module}(#{parent_module.class})::#{v.inspect}(#{v.class})" do
         silence_warnings do
           if v == :never_defined
@@ -118,7 +139,7 @@ module TestHelper
         end
       end
     end
-    TestHelper.constant_overrides = []
+    @@constant_overrides = []
   end
 
   def set_test_const(const_name, value)
@@ -138,7 +159,7 @@ module TestHelper
         end
       end
 
-    TestHelper.constant_overrides << [final_parent_module, final_const_name, original_value]
+    @@constant_overrides << [final_parent_module, final_const_name, original_value]
 
     silence_warnings { final_parent_module.const_set(final_const_name, value) }
   end
@@ -150,15 +171,15 @@ module TestHelper
     else
       original_count = 0
     end
-    expect(ActionMailer::Base.deliveries.size - original_count).to eq(expected), "wrong number of emails#{': ' + message.to_s if message}"
+    assert_equal expected, ActionMailer::Base.deliveries.size - original_count, "wrong number of emails#{': ' + message.to_s if message}"
   end
 end
 
 def assert_equal_with_diff(arg1, arg2, msg = '')
   if arg1 == arg2
-    expect(true).to be_truthy # To keep the assertion count accurate
+    assert true # To keep the assertion count accurate
   else
-    expect(arg1).to eq(arg2), "#{msg}\n#{Diff.compare(arg1, arg2)}"
+    assert_equal arg1, arg2, "#{msg}\n#{Diff.compare(arg1, arg2)}"
   end
 end
 
@@ -189,35 +210,3 @@ class Time
     end
   end
 end
-
-RSpec.configure do |config|
-  config.add_formatter(RspecJunitFormatter, 'spec/reports/rspec.xml')
-  config.include TestHelper
-
-  config.before(:each) do
-    setup_constant_overrides
-    unless defined?(Rails) && defined?(Rails.env)
-      module Rails
-        class << self
-          attr_writer :env
-
-          def env
-            @env ||= 'test'
-          end
-        end
-      end
-    end
-  end
-
-  config.after(:each) do
-    teardown_constant_overrides
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  config.expect_with(:rspec, :test_unit)
-
-  RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
-end