escalate 0.2.0.pre.3 → 0.2.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67b615521fd3e15a59bb8401486496175afa19be36a98c415d9eccf52dd0815f
-  data.tar.gz: 951d5afc0052cde73fca383e23dc38aa63e759fce7f4863b2093e9bf9b2463b4
+  metadata.gz: fc6bd15f68b37624979732a8c7b2c55d323c407c397c01ac59d8b8df54e90504
+  data.tar.gz: 144d6a67f62d9ca4ce7d740a26285dae283372450fd1149b74da59ab5411c982
 SHA512:
-  metadata.gz: 7979594ec79d527e123efb08114d602ab11446d8e822a9a716b582150d7e0f4b97840443974270177d861d874fbf4544f7e14eb8bd5e98e66acc86d49b51e19a
-  data.tar.gz: 2ab19d1367350559290fb9603e7af73934fcf1085121bf5a1cebe03059d450d19e53f76dc9947d92fac8a06f2a08fc0bb6ed12d0135a1e09617c87c6835dc158
+  metadata.gz: 1490795a292d531715525872a8bc06d1d27330222a24a436ad22ea62aa1d5fbc2e80b8a36b382cec86ef6281173bd5bddcbaffe9aa35c7f5bc641f6ac3611380
+  data.tar.gz: e2e7f3d6fd1be1e679bc6286c7fb892cef56fe64b57bbd55fedf649aa681c6e1d26f2f4f4aadbe8db3d0c327a378da65c46baee8fd20d137a6d6f1e2d40257d0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    escalate (0.2.0.pre.3)
+    escalate (0.2.0.pre.4)
       activesupport
 
 GEM

data/README.md

@@ -78,6 +78,16 @@ Escalate.on_escalate do |exception, location_message, **context|
 end
 ```
 
+#### Callback Uniqueness
+Each callback may be named with the `name:` keyword argument.
+If a callback with the same name has been registered before, it will be overwritten with the new one.
+```
+Escalate.on_escalate(name: 'abc gem') do |exception, location_message, **context|
+  # send exception, location_message, **context to the error reporting service here
+end
+```
+If not given, the `name:` defaults to the `.source_location` property of the passed-in block.
+
 #### Handle the Logging in the `on_escalate` Callback
 Here is an example that handles logging itself with `log_first: false`:
 ```

data/lib/escalate.rb

@@ -11,7 +11,7 @@ module Escalate
 
   LOG_FIRST_INSTANCE_VARIABLE = :@_escalate_log_first
 
-  @on_escalate_callbacks = Set.new
+  @on_escalate_callbacks = {}
 
   class << self
     attr_reader :on_escalate_callbacks
@@ -31,7 +31,7 @@ module Escalate
     #   Any additional context to be tied to the escalation
     def escalate(exception, location_message, logger, **context)
       ensure_failsafe("Exception rescued while escalating #{exception.inspect}") do
-        if on_escalate_callbacks.none? || on_escalate_callbacks.any? { |block| block.instance_variable_get(LOG_FIRST_INSTANCE_VARIABLE) }
+        if on_escalate_callbacks.none? || on_escalate_callbacks.values.any? { |block| block.instance_variable_get(LOG_FIRST_INSTANCE_VARIABLE) }
           logger_allows_added_context?(logger) or context_string = " (#{context.inspect})"
           error_message = <<~EOS
             [Escalate] #{location_message}#{context_string}
@@ -46,7 +46,7 @@ module Escalate
           end
         end
 
-        on_escalate_callbacks.each do |block|
+        on_escalate_callbacks.values.each do |block|
           ensure_failsafe("Exception rescued while escalating #{exception.inspect} to #{block.inspect}") do
             block.call(exception, location_message, **context)
           end
@@ -88,14 +88,17 @@ module Escalate
       end
     end
 
-    # Registers an escalation callback to be executed when `escalate`
-    # is invoked.
+    # Registers an escalation callback to be executed when `escalate` is invoked.
     #
     # @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)
+    # @param [string | Array] name:
+    #   unique name for this callback block
+    #   any previously-registered block with the same name will be discarded
+    #   if not provided, name defaults to `block.source_location`
+    def on_escalate(log_first: true, name: nil, &block)
       block.instance_variable_set(LOG_FIRST_INSTANCE_VARIABLE, log_first)
-      on_escalate_callbacks.add(block)
+      on_escalate_callbacks[name || block.source_location] = block
     end
 
     def clear_on_escalate_callbacks

data/lib/escalate/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: escalate
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.3
+  version: 0.2.0.pre.4
 platform: ruby
 authors:
 - Invoca Development
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport