moderate_parameters 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccebf986537b995e0dda4aaba0fac77329a0f87b885f36eb4b1a0b85b03dfb9b
-  data.tar.gz: a8fd30ef1653f7376370643772066700535effc2f2a6eef88e410f3724cc3314
+  metadata.gz: 7da243c4e3c3402126ab024168790ca875ce97288d783432ce7d7105aa0082a8
+  data.tar.gz: 981432f67a8d7a5e17e774dc171cc239ff2379059e164cd4e24f40b446e51a70
 SHA512:
-  metadata.gz: ef57958d1feb5a3a7d965bba16e829ddcfecdf881a17ae5ef4c9413ae2a13447b76999ee463381b376abb029055407e4bc99dbadbf1df510a9f888958133caf9
-  data.tar.gz: b65cc1997e65da4ae7c88045652edef1f73fa6efe417a4f0e6c41b711b89ed21f9eb8f97cfdd576dd09e7b307d4960cd82cf60cd4613620c5d0cd44ebed2c2b0
+  metadata.gz: f87a7a589852fccbc9dce81f5d4e041aeda5bbedbdadccd8a17599e5266a25cdc98b48047cf80886360c5f3e596b2b07aa705a2bd86f2ff575e929fac271740e
+  data.tar.gz: c0f48cd8721c99870af9229902bb26e7a3b805109afce9ea2fde53cce48266c546ccf267396db2780e1c34093556e63939db90fe0b399367e113394467b87af4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moderate_parameters (0.3.4)
+    moderate_parameters (0.4.0)
       actionpack (>= 4.2, < 6.1)
       activemodel (>= 4.2, < 6.1)
       activesupport (>= 4.2, < 6.1)

data/lib/moderate_parameters/breadcrumbs.rb

@@ -2,34 +2,90 @@
 
 module ModerateParameters
   module Breadcrumbs
-    def [](key)
-      internal_param_logging(key, 'read', caller_locations) if ModerateParameters.breadcrumbs_enabled
+    def []=(key, _value)
+      internal_param_logging(key, key?(key) ? 'overwritten' : 'added', caller_locations)
       super
     end
 
-    def []=(key, value)
-      internal_param_logging(key, 'overwritten', caller_locations) if ModerateParameters.breadcrumbs_enabled
+    def merge!(other_hash)
+      internal_method_logging('merge!', other_hash.keys, caller_locations)
+      super
+    end
+
+    def reverse_merge!(other_hash)
+      internal_method_logging('reverse_merge!', other_hash.keys, caller_locations)
       super
     end
 
     def extract!(*keys)
-      internal_method_logging('extract!', keys, caller_locations) if ModerateParameters.breadcrumbs_enabled
+      internal_method_logging('extract!', keys, caller_locations)
+      super
+    end
+
+    def slice!(*keys)
+      internal_method_logging('slice!', keys, caller_locations)
+      super
+    end
+
+    def delete(*keys, &block)
+      internal_method_logging('delete', keys, caller_locations)
+      super
+    end
+
+    def reject!(&block)
+      internal_block_logging('reject!', caller_locations)
+      super
+    end
+
+    # Alias for #reject!
+    def delete_if(&block)
+      internal_block_logging('delete_if', caller_locations)
+      super
+    end
+
+    def select!(&block)
+      internal_block_logging('select!', caller_locations)
+      super
+    end
+
+    # Alias for #select!
+    def keep_if(&block)
+      internal_block_logging('keep_if', caller_locations)
       super
     end
 
     private
 
+    def needs_logged?
+      ModerateParameters.breadcrumbs_enabled &&
+      instance_variable_get(:@moderate_params_object_id) &&
+      !permitted?
+    end
+
     def internal_param_logging(key, action, stack_array)
+      return unless needs_logged?
+
       ActiveSupport::Notifications.instrument('moderate_parameters') do |payload|
         payload[:caller_locations] = stack_array
         payload[:message] = "#{key} is being #{action} on: #{stack_array.join("\n")}"
       end
     end
 
-    def internal_method_logging(method, keys, stack_array)
+    def internal_method_logging(method, args, stack_array)
+      return unless needs_logged?
+
+      ActiveSupport::Notifications.instrument('moderate_parameters') do |payload|
+        payload[:caller_locations] = stack_array
+        payload[:message] = "#{method} is being called with #{args} on: #{stack_array.join("\n")}"
+      end
+    end
+
+    def internal_block_logging(method, stack_array)
+      return unless needs_logged?
+
       ActiveSupport::Notifications.instrument('moderate_parameters') do |payload|
         payload[:caller_locations] = stack_array
-        payload[:message] = "#{method} is being called with #{keys} on: #{stack_array.join("\n")}"
+        payload[:message] = "#{method} is being called with a block on: #{stack_array.join("\n")}"
       end
     end
   end

data/lib/moderate_parameters/logger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 ActiveSupport::Notifications.subscribe('moderate_parameters') do |_, _, _, _, payload|
-  (ModerateParameters.logger || ActiveSupport::Logger.new('/dev/null')).info "#{payload[:controller]}##{payload[:action]} #{payload[:message]}"
+  (ModerateParameters.logger || ActiveSupport::Logger.new('/dev/null')).info(
+    "#{payload[:controller]}##{payload[:action]} #{payload[:message]}"
+  )
 end

data/lib/moderate_parameters/parameters.rb

@@ -2,7 +2,17 @@
 
 module ModerateParameters
   module Parameters
+    MP_OBJECT_ID = :@moderate_params_object_id
+    MP_PARENT_KEY = :@moderate_params_parent_key
+
     def moderate(controller_name, action, *filters)
+      log_duplicate_moderate_warning(
+        caller_locations,
+        instance_variable_get(MP_PARENT_KEY),
+        controller_name,
+        action
+      ) if instance_variable_get(MP_OBJECT_ID)
+
       params = self.class.new
 
       filters.each do |filter|
@@ -19,7 +29,15 @@ module ModerateParameters
       end
 
       incoming_params_logging(params, controller_name, action)
-      dup.permit!
+      duplicate_params = dup
+      instance_variable_set(MP_OBJECT_ID, duplicate_params.object_id)
+      duplicate_params.permit!
+    end
+
+    def require(key)
+      return super if key.is_a?(Array) || self[key].blank?
+      self[key].instance_variable_set(MP_PARENT_KEY, key)
+      super
     end
 
     private
@@ -38,6 +56,12 @@ module ModerateParameters
       end
     end
 
+    def log_duplicate_moderate_warning(stack_array, parent_key, controller_name, action)
+      write_to_log(message: ".moderate has already been called on params.require(:#{parent_key}): #{stack_array.join("\n")}",
+                   action: action,
+                   controller: controller_name)
+    end
+
     def non_scalar_value_filter(params, key, controller_name, action)
       if has_key?(key) && !permitted_scalar?(self[key])
         params[key] = self[key].class.new
@@ -50,7 +74,7 @@ module ModerateParameters
     def array_of_permitted_scalars?(value)
       if value.is_a?(Array) && value.all? { |element| permitted_scalar?(element) }
         return true unless block_given?
-        
+
         yield value
       end
     end

data/lib/moderate_parameters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModerateParameters
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moderate_parameters
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Kyle Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack