exception_handling 2.4.2 → 2.4.3.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e89ccca99bfdef126c57f9674d62d90d2048405099e83467ddc2997ffb3526
-  data.tar.gz: f7fae0d722026d38af12400a95812a14e2a7f32e7d79cbae90b3bd332a30fc04
+  metadata.gz: b5acc3546b0ac3da2bcfbdc00e013fafa3d4fa552dc3d899a61e109c9b406b93
+  data.tar.gz: 05ddf01fa324a5951b6af074ade46090db6fe9288a85d137331f33ababf9e8e9
 SHA512:
-  metadata.gz: 509366eaf0081abe570f51d1ff09707a1ff880e94870616b850b5af000bc489d304bf222452799ff5f9848190247a3c526feb2ac4e3a62057dd04a3558e585eb
-  data.tar.gz: 7b26674dbf9862b43ba7b63650b1a9bc637d3b360d28b469e8d5ec231d3db7af7c4d12030e5e93653c1b1d2c2b84c47189a269472ce8c9dc6b370a5ee43cd3cb
+  metadata.gz: a2cc8be5a481a2ef381f710f5c566415635e2cbe8964a5d15ef0612aea72a4a62e7dde5a571b354025c8c0ca98076c323cedaab96ab54cff2e9359700b487dc4
+  data.tar.gz: 259376e8b5a1053203f5aeb358b765a7b61b56bd817e1a664e2b98ea2ca783d7f46997056ec4508007f36e002122e83f4d992a3b27d29984d852ae9c1a698922

data/.gitignore

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

data/Appraisals

@@ -7,9 +7,9 @@ appraise "rails-4" do
 end
 
 appraise "rails-5" do
-  gem 'actionmailer',  '~> 5.0'
-  gem 'actionpack',    '~> 5.0'
-  gem 'activesupport', '~> 5.0'
+  gem 'actionmailer',  '~> 5.2'
+  gem 'actionpack',    '~> 5.2'
+  gem 'activesupport', '~> 5.2'
 end
 
 appraise "rails-6" do

data/CHANGELOG.md

@@ -4,6 +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.4.3] - Unreleased
+### Deprecated
+- In `ExceptionHandling.logger=`, implicit `logger.extend ContextualLogger::LoggerMixin` is now deprecated.
+  This will be removed in version 3.0 and an `ArgumentError` will be raised if the logger
+  doesn't have that mixin. Instead of this implicit behavior, you should explicitly either `extend`
+  your logger instance or `include` that mixin into your `Logger` class. 
+
 ## [2.4.2] - 2020-05-11
 ### Added
 - Added support for rails 5 and 6.
@@ -17,5 +24,6 @@ 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.4.3]: https://github.com/Invoca/exception_handling/compare/v2.4.2...v2.4.3
 [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.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.4.2)
+    exception_handling (2.4.3.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)

data/README.md

@@ -4,7 +4,7 @@ Enable emails for your exceptions that occur in your application!
 
 ## Dependencies
 - Ruby 2.6
-- Rails >= 4, < 7
+- Rails >= 4.2, < 7
 
 ## Installation
 

data/gemfiles/rails_5.gemfile

@@ -11,8 +11,8 @@ gem "rake"
 gem "rr"
 gem "rubocop"
 gem "shoulda"
-gem "actionmailer", "~> 5.0"
-gem "actionpack", "~> 5.0"
-gem "activesupport", "~> 5.0"
+gem "actionmailer", "~> 5.2"
+gem "actionpack", "~> 5.2"
+gem "activesupport", "~> 5.2"
 
 gemspec path: "../"

data/lib/exception_handling/version.rb

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

data/lib/exception_handling.rb

@@ -54,8 +54,15 @@ 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 = logger.is_a?(ContextualLogger) ? logger : ContextualLogger.new(logger)
+      @logger = if logger.is_a?(ContextualLogger::LoggerMixin)
+                  logger
+                else
+                  Deprecation3_0.deprecation_warning('implicit extend with ContextualLogger::LoggerMixin', 'extend your logger instance or include your into your logger class first')
+                  logger.extend(ContextualLogger::LoggerMixin)
+                end
     end
 
     def default_metric_name(exception_data, exception, treat_like_warning)

data/test/test_helper.rb

@@ -23,10 +23,13 @@ require 'exception_handling/testing'
 ActiveSupport::TestCase.test_order = :sorted
 
 class LoggerStub
-  include ContextualLogger
-  attr_accessor :logged
+  include ContextualLogger::LoggerMixin
+  attr_accessor :logged, :level
 
   def initialize
+    @level = Logger::Severity::DEBUG
+    @progname = nil
+    @logdev = nil
     clear
   end
 

data/test/unit/exception_handling_test.rb

@@ -8,6 +8,10 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
   include ControllerHelpers
   include ExceptionHelpers
 
+  setup do
+    @fail_count = 0
+  end
+
   def dont_stub_log_error
     true
   end
@@ -109,6 +113,30 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
       stub(Honeybadger).notify(anything)
     end
 
+    context "with logger stashed" do
+      setup { @original_logger = ExceptionHandling.logger }
+      teardown { ExceptionHandling.logger = @original_logger }
+
+      should "store logger as-is if it has ContextualLogger::Mixin" do
+        logger = Logger.new('/dev/null')
+        logger.extend(ContextualLogger::LoggerMixin)
+        ancestors = logger.singleton_class.ancestors.*.name
+
+        ExceptionHandling.logger = logger
+        assert_equal ancestors, ExceptionHandling.logger.singleton_class.ancestors.*.name
+      end
+
+      should "[deprecated] mix in ContextualLogger::Mixin if not there" do
+        mock(STDERR).puts(/DEPRECATION WARNING: implicit extend with ContextualLogger::LoggerMixin is deprecated and will be removed from exception_handling 3\.0/)
+        logger = Logger.new('/dev/null')
+        ancestors = logger.singleton_class.ancestors.*.name
+
+        ExceptionHandling.logger = logger
+        assert_not_equal ancestors, ExceptionHandling.logger.singleton_class.ancestors.*.name
+        assert_kind_of ContextualLogger::LoggerMixin, ExceptionHandling.logger
+      end
+    end
+
     context "#log_error" do
       should "take in additional logging context hash and pass it to the logger" do
         ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
@@ -168,7 +196,6 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
       end
 
       should "support a log_error hook, and pass exception_data, treat_like_warning, and logged_to_honeybadger to it" do
-        @fail_count = 0
         @honeybadger_status = nil
         ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
 
@@ -185,7 +212,6 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
       end
 
       should "plumb treat_like_warning and logged_to_honeybadger to log error hook" do
-        @fail_count = 0
         @honeybadger_status = nil
         ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
         ExceptionHandling.log_error(StandardError.new("Some Exception"), "mooo", treat_like_warning: true)
@@ -658,7 +684,6 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             end
 
             should "not send notification to honeybadger when exception description has the flag turned off and call log error callback with logged_to_honeybadger set to nil" do
-              @fail_count = 0
               @honeybadger_status = nil
               ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
               filter_list = {
@@ -677,7 +702,6 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             end
 
             should "call log error callback with logged_to_honeybadger set to false if an error occurs while attempting to notify honeybadger" do
-              @fail_count = 0
               @honeybadger_status = nil
               ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
               mock(Honeybadger).notify.with_any_args { raise "Honeybadger Notification Failure" }
@@ -686,7 +710,6 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             end
 
             should "call log error callback with logged_to_honeybadger set to false on unsuccessful honeybadger notification" do
-              @fail_count = 0
               @honeybadger_status = nil
               ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
               mock(Honeybadger).notify.with_any_args { false }
@@ -695,7 +718,6 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             end
 
             should "call log error callback with logged_to_honeybadger set to true on successful honeybadger notification" do
-              @fail_count = 0
               @honeybadger_status = nil
               ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
               mock(Honeybadger).notify.with_any_args { '06220c5a-b471-41e5-baeb-de247da45a56' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.3.pre.1
 platform: ruby
 authors:
 - Invoca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -179,9 +179,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: