escalate 0.1.0.pre.1 → 0.1.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb743da8ea57e11a7bfa80d653548239e0b760ab
-  data.tar.gz: 36555a0ba6f8bca3f821c5b0044739e26762cc23
+  metadata.gz: a3e33eb654953f4c511b2207a89df47f6db4865c
+  data.tar.gz: 4b245b1e402c24a933eae6ba6ac6eb9be362e5f1
 SHA512:
-  metadata.gz: 7c735aa3214359068d14e0fd981c64c62e14896d73965d467d5b28ebaa3d2bf300ae9037164d3a4a7e5a6b4a77439a8a5137dd5d3b7b51eda27cef0ec7a57a60
-  data.tar.gz: a3899dc985f47f6e87d609b5fdf85443b9278ca100b40e5e41e4be641c8aa6116850dc80a4426f779c34e741b5b0893c9032e3c2b59974a9b802da0bcc8629bd
+  metadata.gz: 28a1ecb9c22129c0b68c62ac6c5bd00eb5b41580bae1763dfdc9e0d9e732dfd22b7acc37ec84f353d4a3f7f35c18334ae92a78a5677c5e9e6453c4ccfb074767
+  data.tar.gz: dc2271ab38903b2c8f874adc0b21f26c3851a759f5ed1db34482d447573d3d8f13d8b8d1b5565b9106b73bde766dee65260aeb6c645d402b9326371536d3dce0

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in escalate.gemspec
 gemspec
 
+gem "contextual_logger"
+
 gem "pry"
 gem "pry-byebug"
 

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    escalate (0.1.0.pre.1)
+    escalate (0.1.0.pre.2)
       activesupport
-      contextual_logger
 
 GEM
   remote: https://rubygems.org/
@@ -53,6 +52,7 @@ PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
+  contextual_logger
   escalate!
   pry
   pry-byebug

data/README.md

@@ -1,6 +1,10 @@
 # Escalate
 
-A simple and lightweight gem to help with escalating errors
+A simple and lightweight gem to escalate rescued exceptions. This implementation
+is an abstract interface that can be used on it's own, or attached to more concrete
+implementations like Honeybadger, Airbrake, or Sentry in order to not just log
+exceptions in an easy to parse way, but also escalate the appropriate information
+to third party systems.
 
 ## Installation
 
@@ -30,7 +34,7 @@ module SomeGem
 end
 ```
 
-This will expose the `Escalate#ex_escalate` method within your gem to be used instead
+This will expose the `Escalate#escalate` method within your gem to be used instead
 of using `logger.error`.
 
 ```ruby

data/escalate.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Invoca Development", "Octothorp"]
   spec.email         = ["development@invoca.com", "octothorp@invoca.com"]
 
-  spec.summary       = "Simple gem for abstracting log escalations"
-  spec.description   = "Simple gem for abstracting log escalations"
+  spec.summary       = "A simple and lightweight gem to escalate rescued exceptions."
+  spec.description   = "A simple and lightweight gem to escalate rescued exceptions."
   spec.homepage      = "https://github.com/invoca/escalate"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
@@ -28,5 +28,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "contextual_logger"
 end

data/lib/escalate.rb

@@ -2,7 +2,6 @@
 
 require "active_support"
 require "active_support/core_ext"
-require "contextual_logger"
 
 require_relative "escalate/version"
 require_relative "escalate/mixin"
@@ -25,28 +24,29 @@ module Escalate
     # @param [Hash] context
     #   Any additional context to be tied to the escalation
     def escalate(exception, message, logger, **context)
-      error_message = <<~EOS
-        [Escalate] #{message} (#{context.inspect})
-          #{exception.class.name}: #{exception.message}
-          #{exception.backtrace.join("\n")}
-      EOS
+      ensure_failsafe("Exception rescued while escalating #{exception.inspect}") do
+        error_message = <<~EOS
+          [Escalate] #{message} (#{context.inspect})
+            #{exception.class.name}: #{exception.message}
+            #{exception.backtrace.join("\n")}
+        EOS
 
-      if logger.is_a?(ContextualLogger::LoggerMixin)
-        logger.error(error_message, **context)
-      else
-        logger.error(error_message)
-      end
+        if logger_allows_added_context?(logger)
+          logger.error(error_message, **context)
+        else
+          logger.error(error_message)
+        end
 
-      on_escalate_blocks.each do |block|
-        block.call(exception, message, **context)
+        on_escalate_blocks.each do |block|
+          ensure_failsafe("Exception rescued while escalating #{exception.inspect} to #{block.inspect}") do
+            block.call(exception, message, **context)
+          end
+        end
       end
-    rescue Exception => ex
-      STDERR.puts("[ExEscalator] Exception rescued while escalating #{exception.inspect}:" \
-                "#{ex.class.name}: #{ex.message}")
     end
 
     # Returns a module to be mixed into a class or module exposing
-    # the ex_escalate method to be used for escalating and logging
+    # the escalate method to be used for escalating and logging
     # exceptions.
     #
     # @param [Proc] logger_block
@@ -63,7 +63,7 @@ module Escalate
       end
     end
 
-    # Registers an escalation callback to be executed when `ex_escalate`
+    # Registers an escalation callback to be executed when `escalate`
     # is invoked.
     def on_escalate(&block)
       on_escalate_blocks.add(block)
@@ -71,6 +71,17 @@ module Escalate
 
     private
 
+    def ensure_failsafe(message)
+      yield
+    rescue Exception => ex
+      STDERR.puts("[Escalator] #{message}: #{ex.class.name}: #{ex.message}")
+    end
+
+    def logger_allows_added_context?(logger)
+      defined?(ContextualLogger::LoggerMixin) &&
+        logger.is_a?(ContextualLogger::LoggerMixin)
+    end
+
     def on_escalate_blocks
       @on_escalate_blocks ||= Set.new
     end

data/lib/escalate/mixin.rb

@@ -4,13 +4,13 @@ module Escalate
   module Mixin
     class << self
       def included(base)
-        raise 'instead of `include ExEscalator::Mixin`, you should `include ExEscalator.mixin`'
+        raise 'instead of `include Escalator::Mixin`, you should `include Escalator.mixin`'
       end
     end
 
     attr_accessor :escalate_logger_block
 
-    def ex_escalate(exception, message, **context)
+    def escalate(exception, message, **context)
       Escalate.escalate(exception, message, escalate_logger, **context)
     end
 

data/lib/escalate/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: escalate
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.1
+  version: 0.1.0.pre.2
 platform: ruby
 authors:
 - Invoca Development
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,21 +25,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: contextual_logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Simple gem for abstracting log escalations
+description: A simple and lightweight gem to escalate rescued exceptions.
 email:
 - development@invoca.com
 - octothorp@invoca.com
@@ -89,5 +75,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
-summary: Simple gem for abstracting log escalations
+summary: A simple and lightweight gem to escalate rescued exceptions.
 test_files: []