rails_surrogate_key_logging 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7560b27adda872ef0742f8d5be560541849824d8cf3ec5ceaba42b50e2a4f7
-  data.tar.gz: a5ed6d8ced6c1fca2067dea1c4c975df569534542e2c0f8caf53ddac9298bb7b
+  metadata.gz: f5d3a0747a79affaf71480538b5ca2567c962ddf03c6af176661ea082b7427e5
+  data.tar.gz: aec5af8fb44ca382501cef61b9d142328a8befa571df08821e4b9f5ef365490c
 SHA512:
-  metadata.gz: 5ea28f7ec2eae90380bf4d786fa640bcf3d6489ca594ee7b76fe8f36b87d284fb3e6d8b1d3c7349f32fb947ee123c3614e98be1859f9e77313b7f3acf6e3a20c
-  data.tar.gz: 2d23b23e491b82ee53daa5987666797622912c9d915d8f63213668811fcfc7bf2b7ce248b316b1c5ede1d2702f4e637f9bbb3fb19e548340476a8d3c4cd240f9
+  metadata.gz: f8ec40ce47168317e745ed14d707ca7c8a35ce7bd9eec78c7224baf4bcaa5f2a92b8eeade6024a745aa66d018ea11bbb65fb5989461923d635df60cf0eb0f060
+  data.tar.gz: b245a066710ba8440584f4fb51588bf0a968e969ef41eef0ae52e739bfdf266cc40d63770ccc4866917a806437b7d1ebb8eb5bcfdc48f914ee47df44ca60f26e

data/lib/surrogate_key_logging/action_controller/params.rb

@@ -5,11 +5,11 @@ require 'active_support/concern'
 module SurrogateKeyLogging
   module ActionController
     module Params
-      extend ActiveSupport::Concern
+      extend ::ActiveSupport::Concern
 
       class_methods do
         def surrogate_params(*params, action: '*')
-          @surrogate_params ||= ActiveSupport::HashWithIndifferentAccess.new {|h,k| h[k] = [] }
+          @surrogate_params ||= ::ActiveSupport::HashWithIndifferentAccess.new {|h,k| h[k] = [] }
           params.each do |param|
             param = param.to_s
             @surrogate_params[action] << param

data/lib/surrogate_key_logging/action_controller.rb

@@ -2,7 +2,7 @@
 
 module SurrogateKeyLogging
   module ActionController
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
 
     autoload :LogSubscriber
 

data/lib/surrogate_key_logging/action_dispatch.rb

@@ -2,7 +2,7 @@
 
 module SurrogateKeyLogging
   module ActionDispatch
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
 
     autoload :ParamsFilter
     autoload :QueryStringFilter

data/lib/surrogate_key_logging/active_record/attributes.rb

@@ -5,7 +5,7 @@ require 'active_support/concern'
 module SurrogateKeyLogging
   module ActiveRecord
     module Attributes
-      extend ActiveSupport::Concern
+      extend ::ActiveSupport::Concern
 
       class_methods do
         def surrogate_parent_names(*names)

data/lib/surrogate_key_logging/active_record.rb

@@ -2,7 +2,7 @@
 
 module SurrogateKeyLogging
   module ActiveRecord
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
 
     autoload :Attributes
     autoload :LogSubscriber

data/lib/surrogate_key_logging/active_support.rb

@@ -1,36 +1,31 @@
 # frozen_string_literal: true
 
-require 'active_support/parameter_filter'
-
-# Add ability for @mask to be a class/instance/lambda/proc
-module ActiveSupport
-  class ParameterFilter
-    class CompiledFilter
-
-      def value_for_key(key, value, parents = [], original_params = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-        parents.push(key) if deep_regexps
-        if regexps.any? { |r| r.match?(key.to_s) }
-          value = @mask.respond_to?(:call) ? @mask.call(key, value, parents, original_params) : @mask
-        elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| r.match?(joined) } # rubocop:disable Lint/DuplicateBranch
-          value = @mask.respond_to?(:call) ? @mask.call(key, value, parents, original_params) : @mask
-        elsif value.is_a?(Hash)
-          value = call(value, parents, original_params)
-        elsif value.is_a?(Array)
-          # If we don't pop the current parent it will be duplicated as we
-          # process each array value.
-          parents.pop if deep_regexps
-          value = value.map { |v| value_for_key(key, v, parents, original_params) }
-          # Restore the parent stack after processing the array.
-          parents.push(key) if deep_regexps
-        elsif blocks.any?
-          key = key.dup if key.duplicable?
-          value = value.dup if value.duplicable?
-          blocks.each { |b| b.arity == 2 ? b.call(key, value) : b.call(key, value, original_params) }
-        end
+module SurrogateKeyLogging
+  module ActiveSupport
+    # Add ability for @mask to be a class/instance/lambda/proc
+    def value_for_key(key, value, parents = [], original_params = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      parents.push(key) if deep_regexps
+      if regexps.any? { |r| r.match?(key.to_s) }
+        value = @mask.respond_to?(:call) ? @mask.call(key, value, parents, original_params) : @mask
+      elsif deep_regexps && (joined = parents.join('.')) && deep_regexps.any? { |r| r.match?(joined) } # rubocop:disable Lint/DuplicateBranch
+        value = @mask.respond_to?(:call) ? @mask.call(key, value, parents, original_params) : @mask
+      elsif value.is_a?(Hash)
+        value = call(value, parents, original_params)
+      elsif value.is_a?(Array)
+        # If we don't pop the current parent it will be duplicated as we
+        # process each array value.
         parents.pop if deep_regexps
-        value
+        value = value.map { |v| value_for_key(key, v, parents, original_params) }
+        # Restore the parent stack after processing the array.
+        parents.push(key) if deep_regexps
+      elsif blocks.any?
+        key = key.dup if key.duplicable?
+        value = value.dup if value.duplicable?
+        blocks.each { |b| b.arity == 2 ? b.call(key, value) : b.call(key, value, original_params) }
       end
-
+      parents.pop if deep_regexps
+      value
     end
+    
   end
 end

data/lib/surrogate_key_logging/configuration.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module SurrogateKeyLogging
-  class Config < ActiveSupport::OrderedOptions
+  class Config < ::ActiveSupport::OrderedOptions
   end
 
   module Configuration
-    extend ActiveSupport::Concern
+    extend ::ActiveSupport::Concern
 
     def surrogate_key_logging
       SurrogateKeyLogging.config

data/lib/surrogate_key_logging/engine.rb

@@ -17,11 +17,6 @@ module SurrogateKeyLogging
       g.templates.unshift File.expand_path('lib/templates', root)
     end
 
-    rake_tasks do
-      # load 'tasks/surrogate_key_logging.rake'
-      # load 'tasks/key_store/active_record.rake'
-    end
-
     initializer 'surrogate_key_logging.config' do |app|
       SurrogateKeyLogging.configure do |config|
         config.enabled = Rails.env.production? unless config.key?(:enabled)
@@ -35,7 +30,9 @@ module SurrogateKeyLogging
     end
 
     initializer 'surrogate_key_logging.middleware' do |app|
-      app.middleware.insert_before(0, Middleware)
+      if SurrogateKeyLogging.config.enabled
+        app.middleware.insert_before(0, Middleware)
+      end
     end
 
     initializer 'surrogate_key_logging.filter_parameters' do
@@ -53,5 +50,15 @@ module SurrogateKeyLogging
       end
     end
 
+    initializer 'surrogate_key_logging.sidekiq' do
+      if SurrogateKeyLogging.config.enabled && defined?(::Sidekiq)
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.prepend SurrogateKeyLogging::SidekiqMiddleware
+          end
+        end
+      end
+    end
+
   end
 end

data/lib/surrogate_key_logging/key_manager.rb

@@ -33,6 +33,7 @@ module SurrogateKeyLogging
 
     def call(_key, value, _parents = [], _original_params = nil)
       return "" if value.blank?
+      return value unless SurrogateKeyLogging.config.enabled
       surrogate = get(value)
       Rails.logger.tagged('SurrogateKeyLogging') { Rails.logger.info "Surrogate: `#{surrogate}`, value: `#{value}`" } if SurrogateKeyLogging.config.debug
       surrogate

data/lib/surrogate_key_logging/key_store.rb

@@ -2,7 +2,7 @@
 
 module SurrogateKeyLogging
   module KeyStore
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
 
     eager_autoload do
       autoload :Base

data/lib/surrogate_key_logging/sidekiq.rb

@@ -39,3 +39,14 @@ if defined?(::Sidekiq)
 
   end
 end
+
+module SurrogateKeyLogging
+  class SidekiqMiddleware
+
+    def call(env)
+      yield
+      SurrogateKeyLogging.reset
+    end
+
+  end
+end

data/lib/surrogate_key_logging/version.rb

@@ -4,7 +4,7 @@ module SurrogateKeyLogging
 
   module Version
     MAJOR = 1
-    MINOR = 3
+    MINOR = 5
     PATCH = 0
 
   end

data/lib/surrogate_key_logging.rb

@@ -4,7 +4,7 @@ require 'active_support'
 
 # Container Module
 module SurrogateKeyLogging
-  extend ActiveSupport::Autoload
+  extend ::ActiveSupport::Autoload
 
   autoload :ActionController
   autoload :ActionDispatch
@@ -41,7 +41,7 @@ module SurrogateKeyLogging
     def reset
       reset! if config.cache
     end
-    
+
     def reset!
       @key_manager = @parameter_filter = nil
     end
@@ -55,7 +55,7 @@ module SurrogateKeyLogging
     end
 
     def filter_for_attributes(attrs)
-      ::ActiveSupport::ParameterFilter.new(attrs, mask: key_manager)
+      ::ActiveSupport::ParameterFilter.new(config.enabled ? attrs : [], mask: key_manager)
     end
 
     def key_store
@@ -63,11 +63,11 @@ module SurrogateKeyLogging
     end
 
     def filter_parameters(params)
-      parameter_filter.filter params
+      parameter_filter.filter(params)
     end
 
     def surrogate_for(value)
-      key_manager.get(value)
+      config.enabled ? key_manager.get(value) : value
     end
 
     def add_param_to_filter(attr, *parents)
@@ -84,6 +84,8 @@ module SurrogateKeyLogging
 
   end
 
+  require 'active_support/parameter_filter'
+  ::ActiveSupport::ParameterFilter::CompiledFilter.send(:prepend, ActiveSupport)
   KeyStore.eager_load!
   ::Rails::Application::Configuration.send(:include, Configuration)
   require 'surrogate_key_logging/engine'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_surrogate_key_logging
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Taylor Yelverton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack