technologic 0.25.3 → 0.25.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fac527e781d749fb20e815bfc288adc1e22a40297e80a75805e1632442886c0
-  data.tar.gz: 9a4244bdafac62e23eb0019e1d85b1d892641191faf80c780cf70610b2a88790
+  metadata.gz: 867ea0c1c13f987e6ea9c148375f50803155ff34c6ead84b92e94af1138cdf00
+  data.tar.gz: 25b698e4db148102e8572603271ca1d356ec68db440be4a8f725aecedaab6b69
 SHA512:
-  metadata.gz: 16d11b6464725b8a451c7633853c2c7e3d74e51ddf4b10504fc9071567101737e0b77d0441378be164a6ed297b055dbcdddda3757ceb899eda3a0dba74060dd8
-  data.tar.gz: a958d41ac5d074e01560decd34c1f3f66fb4ededba5baa4c9b60ffec516e6ad3e63ffe066bdd02248cbd13dac07e2a1097c7ec28bbb931fa7655bf256829565d
+  metadata.gz: 58e5345aa69a1af3e8c52eb62a292c3de36438a1761c4e74d4629fd9ebdd029d782eb0c41b6603e07b3c14e5f325691fbd2114e5cdd0fd93fc5ea9cbbdd0a166
+  data.tar.gz: 28e937ff41ba8417fd452634c39b6136ec996c336ab168a9da111e90db07c340d2a4f0262e2aff2498275c498e0044f5ae43bc5dabff0ff0f3666e7c01ccae05

data/lib/technologic.rb

@@ -29,9 +29,11 @@ module Technologic
   SEVERITIES = %i[debug info warn error fatal].freeze
   EXCEPTION_SEVERITIES = %i[error fatal].freeze
 
+  ACTIVEJOB_WORKAROUND_FIRST_VERSION = Gem::Version.new("6.1.0")
+
   included do
-    delegate :instrument, :surveil, to: :class
-    protected :instrument, :surveil
+    delegate :_tl_instrument, :surveil, to: :class
+    protected :_tl_instrument, :surveil
 
     SEVERITIES.each do |severity|
       delegate severity, to: :class
@@ -46,31 +48,43 @@ module Technologic
     end
   end
 
-  class_methods do
-    def instrument(severity, event, **data, &block)
-      ActiveSupport::Notifications.instrument("#{event}.#{name}.#{severity}", data, &block).tap do
-        # If a block was defined, :instrument will return the value of the block.
-        # Otherwise, :instrument will return nil, since it didn't do anything.
-        # Returning true here allows us to do fun things like `info :subscription_created and return subscription`
-        return true unless block_given?
-      end
+  protected
+
+  # DEP-2021-01-14
+  # Remove this method
+  def instrument(*args, **opts, &block)
+    # Targeted workaround for ActiveJob#instrument in Rails 6.1+
+    return super if defined?(ActiveJob) && self.class <= ActiveJob::Base && ActiveJob.version >= ACTIVEJOB_WORKAROUND_FIRST_VERSION
+
+    self.class.instrument(*args, **opts, &block)
+  end
+
+  module ClassMethods
+    # DEP-2021-01-14
+    # Remove this method
+    def instrument(*args, **opts, &block)
+      ActiveSupport::Deprecation.warn("Technologic.instrument is deprecated. Instead, use the corresponding severity-level convenience method (#info, #error etc)")
+
+      _tl_instrument(*args, **opts, &block)
     end
 
     def surveil(event, severity: :info, **data, &block)
       raise LocalJumpError unless block_given?
 
-      instrument(severity, "#{event}_started", **data)
-      instrument(severity, "#{event}_finished", &block)
+      raise ArgumentError, "Invalid severity: #{severity}" unless severity.to_sym.in?(SEVERITIES)
+
+      _tl_instrument(severity, "#{event}_started", **data)
+      _tl_instrument(severity, "#{event}_finished", &block)
     end
 
     SEVERITIES.each do |severity|
-      define_method(severity) { |event, **data, &block| instrument(severity, event, **data, &block) }
+      define_method(severity) { |event, **data, &block| _tl_instrument(severity, event, **data, &block) }
     end
 
     EXCEPTION_SEVERITIES.each do |severity|
       define_method("#{severity}!") do |exception = StandardError, message = nil, **data, &block|
         if exception.is_a?(Exception)
-          instrument(
+          _tl_instrument(
             severity,
             exception.class.name.demodulize,
             **{
@@ -83,11 +97,22 @@ module Technologic
 
           raise exception
         else
-          instrument severity, exception.name.demodulize, message: message, **data, &block
+          _tl_instrument severity, exception.name.demodulize, message: message, **data, &block
           raise exception, message
         end
       end
     end
+
+    protected
+
+    def _tl_instrument(severity, event, **data, &block)
+      ActiveSupport::Notifications.instrument("#{event}.#{name}.#{severity}", data, &block).tap do
+        # If a block was defined, :instrument will return the value of the block.
+        # Otherwise, :instrument will return nil, since it didn't do anything.
+        # Returning true here allows us to do fun things like `info :subscription_created and return subscription`
+        return true unless block_given?
+      end
+    end
   end
 end
 

data/lib/technologic/version.rb

@@ -2,5 +2,5 @@
 
 module Technologic
   # This constant is managed by spicerack
-  VERSION = "0.25.3"
+  VERSION = "0.25.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: technologic
 version: !ruby/object:Gem::Version
-  version: 0.25.3
+  version: 0.25.8
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.25.3
+        version: 0.25.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.25.3
+        version: 0.25.8
 description: A clean and terse way to produce standardized, highly actionable, and
   data-rich logs
 email:
@@ -87,7 +87,7 @@ metadata:
   homepage_uri: https://github.com/Freshly/spicerack/tree/master/technologic
   source_code_uri: https://github.com/Freshly/spicerack/tree/master/technologic
   changelog_uri: https://github.com/Freshly/spicerack/blob/master/technologic/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/technologic/0.25.3
+  documentation_uri: https://www.rubydoc.info/gems/technologic/0.25.8
 post_install_message: 
 rdoc_options: []
 require_paths: