escalate 0.1.0 → 0.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca403c35fe8123ebf15d068d392789e5de418f71
-  data.tar.gz: df6eb4d755258ce4e6d3617ca88075266e591acc
+SHA256:
+  metadata.gz: 2a0dc76f8fb9f09d141c117b3b746b143078712c8d14687e9a413f9e0db0eee4
+  data.tar.gz: 0a8861399988e40db304ff5bed43a5a3c6359eb2f0853f162515c5883e74c613
 SHA512:
-  metadata.gz: aae531b8f6fc1f8bb4e52a2cbf1ff613fd74f19298ca18aca77936f6e44b741c9ce42b02817bcfb755379d95c6e577342b1a17af0a387e66a00348baf96a3703
-  data.tar.gz: 2d4c26aad91e60c1c2b192b66d6f332db6a858b7f06588788f5b166d41912a8daa27cac39d166ac3cea7e770417037062add542bf36f4429a8c0cc8f0ad74a7b
+  metadata.gz: 95f0fd83333e4245756cee9c5fff725255a8b81e954102ad22e8d0d2c0f49bf27050c15154a00a309d4c0bce8f9edd7e5247aba3dfdc8b2f9b1fa64cbf281ab8
+  data.tar.gz: 62f87cc4801ff0a5187c251ec2fe0e47433d52ab4bdc89558af29a57f6bbf50ee912c9e92127c4a152a5008cf1d7e3110735b8082ec540b6aac9e7d95bf2fa18

data/CHANGELOG.md

@@ -4,10 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - Unreleased
+### Added
+- Added support for `on_escalate(log_first: false)`. The `escalate` gem will log first before
+  escalating if either of these is true: there are no `on_escalate` blocks registered, or
+  there are some and at least one of them passed `log_first: false`.
+
 ## [0.1.0] - 2021-02-03
 ### Added
 - Added `Escalate.mixin` interface for mixing in `Escalate` with your module for easy escalation of rescued exceptions
 - Added `escalate` method for escalating rescued exceptions with default behavior of logging to `STDERR`
 - Added `Escalate.on_escalate` for registering escalation callbacks like `Honeybadger` or `Sentry`
 
+[0.2.0]: https://github.com/Invoca/escalate/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/Invoca/escalate/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    escalate (0.1.0)
+    escalate (0.2.0.pre.1)
       activesupport
 
 GEM
@@ -49,6 +49,7 @@ GEM
       thread_safe (~> 0.1)
 
 PLATFORMS
+  ruby
   x86_64-darwin-19
 
 DEPENDENCIES

data/lib/escalate.rb

@@ -13,33 +13,35 @@ module Escalate
     # Logs and escalated an exception
     #
     # @param [Exception] exception
-    #   The exception that was raised and needs to be escalated
+    #   The exception that was rescued and needs to be escalated
     #
-    # @param [String] message
-    #   An additional message about what was happening at the time of the exception
+    # @param [String] location_message
+    #   An additional message giving an indication of where in the code this exception was rescued
     #
     # @param [Logger] logger
     #   The logger object to use when logging the exception
     #
     # @param [Hash] context
     #   Any additional context to be tied to the escalation
-    def escalate(exception, message, logger, **context)
+    def escalate(exception, location_message, logger, **context)
       ensure_failsafe("Exception rescued while escalating #{exception.inspect}") do
-        error_message = <<~EOS
-          [Escalate] #{message} (#{context.inspect})
+        if on_escalate_blocks.any? || on_escalate_no_log_first_blocks.none?
+          error_message = <<~EOS
+            [Escalate] #{location_message} (#{context.inspect})
             #{exception.class.name}: #{exception.message}
             #{exception.backtrace.join("\n")}
-        EOS
+          EOS
 
-        if logger_allows_added_context?(logger)
-          logger.error(error_message, **context)
-        else
-          logger.error(error_message)
+          if logger_allows_added_context?(logger)
+            logger.error(error_message, **context)
+          else
+            logger.error(error_message)
+          end
         end
 
-        on_escalate_blocks.each do |block|
+        all_on_escalate_blocks.each do |block|
           ensure_failsafe("Exception rescued while escalating #{exception.inspect} to #{block.inspect}") do
-            block.call(exception, message, **context)
+            block.call(exception, location_message, **context)
           end
         end
       end
@@ -63,8 +65,8 @@ module Escalate
 
         attr_accessor :escalate_logger_block
 
-        def escalate(exception, message, **context)
-          Escalate.escalate(exception, message, escalate_logger, **context)
+        def escalate(exception, location_message, **context)
+          Escalate.escalate(exception, location_message, escalate_logger, **context)
         end
 
         private
@@ -81,8 +83,20 @@ module Escalate
 
     # Registers an escalation callback to be executed when `escalate`
     # is invoked.
-    def on_escalate(&block)
-      on_escalate_blocks.add(block)
+    #
+    # @param [boolean] log_first: true
+    #   whether escalate should log first before escalating, or leave the logging to the escalate block
+    def on_escalate(log_first: true, &block)
+      if log_first
+        on_escalate_blocks.add(block)
+      else
+        on_escalate_no_log_first_blocks.add(block)
+      end
+    end
+
+    def clear_all_on_escalate_blocks
+      on_escalate_blocks.clear
+      on_escalate_no_log_first_blocks.clear
     end
 
     private
@@ -101,5 +115,13 @@ module Escalate
     def on_escalate_blocks
       @on_escalate_blocks ||= Set.new
     end
+
+    def on_escalate_no_log_first_blocks
+      @on_escalate_no_log_first_blocks ||= Set.new
+    end
+
+    def all_on_escalate_blocks
+      on_escalate_blocks + on_escalate_no_log_first_blocks
+    end
   end
 end

data/lib/escalate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Escalate
-  VERSION = "0.1.0"
+  VERSION = "0.2.0.pre.1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: escalate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.pre.1
 platform: ruby
 authors:
 - Invoca Development
 - Octothorp
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,7 +56,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/invoca/escalate
   changelog_uri: https://github.com/invoca/escalate/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -67,13 +67,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: A simple and lightweight gem to escalate rescued exceptions.
 test_files: []