bulk_dependency_eraser 4.1.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b8469147c79e15bbd947d75f9b9e7aa243f219be6796f516967a4f134609bd
-  data.tar.gz: a7a45c24562a67a1762d120caa9b4a14ab211594245383be4b21a70fa9f5a5e0
+  metadata.gz: f1ee041fa51d9506fdabf317bd2b72fab8be589073d5fa8c8940c6e5654a6bf6
+  data.tar.gz: 8d68033f0554c47a1818ce8e5f96ed047598c6dd3e302151e53589e3475ebdf8
 SHA512:
-  metadata.gz: 8ea34f3b1963b7c8d7720292a47edffb1351f18b6ecb6822e2965fe96244700044d9dcba8124cc088033d3114da0775b0a3be0c4636424af11c101e5e90fb686
-  data.tar.gz: fe4901ea4c7f99ef0e5228b94280f76b6102ef9686c2a8a6fa5fcb4da768fc0303e1da2929a1672bfea77ebcb0e42c9692c7774df21bf891d4e8054979d2c3ea
+  metadata.gz: feae06d17b683a2a19518eca228fa04374265946cf308f45bd95c0e507fcf2a14cb74a79b45a03d03d7d5ad029769f85a68585234cb31c9ca2e45a38be6a80c7
+  data.tar.gz: 928c7bcc857f6ea3bc97165a93d11d7aaf74b15a90c5219e4bfb38137a22d27edf1edcacdc638b3d0bd39d14c91dfd92957663b2e3bb3cb9e473f997817d4080

data/lib/bulk_dependency_eraser/base.rb

@@ -128,17 +128,17 @@ module BulkDependencyEraser
     def custom_scope_for_query(query)
       klass = query.klass
       if opts_c.proc_scopes_per_class_name.key?(klass.name)
-        opts_c.proc_scopes_per_class_name[klass.name].call(query)
-      else
-        # See if non-class-mapped proc returns a value
-        non_class_name_mapped_query = opts_c.proc_scopes.call(query)
-        if !non_class_name_mapped_query.nil?
-          return non_class_name_mapped_query
-        else
-          # No custom wrapper, return non-effect default
-          return self.class::DEFAULT_KLASS_MAPPED_SCOPE_WRAPPER.call(query)
-        end
+        result = opts_c.proc_scopes_per_class_name[klass.name].call(query)
+        return result unless result.nil?
       end
+
+      if opts_c.proc_scopes
+        result = opts_c.proc_scopes.call(query)
+        return result unless result.nil?
+      end
+
+      # Could just return query, but don't wnat to break backwards compatiblity
+      return self.class::DEFAULT_KLASS_MAPPED_SCOPE_WRAPPER.call(query)
     end
 
     # Create options container

data/lib/bulk_dependency_eraser/builder.rb

@@ -42,13 +42,16 @@ module BulkDependencyEraser
       disable_read_batching: nil,
       # Applied to all queries. Useful for taking advantage of specific indexes
       # - not indexed by klass name. Proc would handle the logic for that.
-      # - 3rd, and lowest, priority of scopes
+      # - 4th, and lowest, priority of scopes
       # - accepts rails query as parameter
       # - return nil if no applicable scope.
       proc_scopes: self::DEFAULT_SCOPE_WRAPPER,
       # Applied to all queries. Useful for taking advantage of specific indexes
-      # - 2nd highest priority of scopes
+      # - 3rd highest priority of scopes
       proc_scopes_per_class_name: {},
+      # Applied to all queries. Useful for taking advantage of specific indexes
+      # - 2nd highest priority of scopes
+      reading_proc_scopes: self::DEFAULT_SCOPE_WRAPPER,
       # Applied to reading queries
       # - 1st priority of scopes
       reading_proc_scopes_per_class_name: {},
@@ -146,11 +149,18 @@ module BulkDependencyEraser
 
     def custom_scope_for_query(query)
       klass = query.klass
+
       if opts_c.reading_proc_scopes_per_class_name.key?(klass.name)
-        opts_c.reading_proc_scopes_per_class_name[klass.name].call(query)
-      else
-        super(query)
+        result = opts_c.reading_proc_scopes_per_class_name[klass.name].call(query)
+        return result unless result.nil?
+      end
+
+      if opts_c.reading_proc_scopes
+        result = opts_c.reading_proc_scopes.call(query)
+        return result unless result.nil?
       end
+
+      super(query)
     end
 
     # @param [ActiveRecord::Relation] query

data/lib/bulk_dependency_eraser/deleter.rb

@@ -41,13 +41,16 @@ module BulkDependencyEraser
       disable_delete_batching: nil,
       # Applied to all queries. Useful for taking advantage of specific indexes
       # - not indexed by klass name. Proc would handle the logic for that.
-      # - 3rd, and lowest, priority of scopes
+      # - 4th, and lowest, priority of scopes
       # - accepts rails query as parameter
       # - return nil if no applicable scope.
       proc_scopes: self::DEFAULT_SCOPE_WRAPPER,
       # Applied to all queries. Useful for taking advantage of specific indexes
-      # - 2nd highest priority of scopes
+      # - 3rd highest priority of scopes
       proc_scopes_per_class_name: {},
+      # Applied to all queries. Useful for taking advantage of specific indexes
+      # - 2nd highest priority of scopes
+      deletion_proc_scopes: self::DEFAULT_SCOPE_WRAPPER,
       # Applied to deletion queries
       # - 1st priority of scopes
       deletion_proc_scopes_per_class_name: {},
@@ -55,7 +58,7 @@ module BulkDependencyEraser
 
     def initialize class_names_and_ids: {}, additional_identifiers_by_id: {}, opts: {}
       @class_names_and_ids = class_names_and_ids
-      @additional_identifiers_by_id = additional_identifiers_by_id
+      @additional_identifiers_by_id = additional_identifiers_by_id || {}
       super(opts:)
     end
 
@@ -70,7 +73,8 @@ module BulkDependencyEraser
           class_names_and_ids.keys.reverse.each do |class_name|
             current_class_name = class_name
             additional_identifiers = additional_identifiers_by_id[class_name]
-            raise "invalid state! #{class_name} not found in 'additional_identifiers_by_id' list" if additional_identifiers.nil?
+            # We have to give implementers the ability to make changes to these lists. Even a full clear.
+            # raise "invalid state! #{class_name} not found in 'additional_identifiers_by_id' list" if additional_identifiers.nil?
 
             # Last in, First out
             ids = class_names_and_ids[class_name].reverse
@@ -103,11 +107,18 @@ module BulkDependencyEraser
 
     def custom_scope_for_query(query)
       klass = query.klass
+
       if opts_c.deletion_proc_scopes_per_class_name.key?(klass.name)
-        opts_c.deletion_proc_scopes_per_class_name[klass.name].call(query)
-      else
-        super(query)
+        result = opts_c.deletion_proc_scopes_per_class_name[klass.name].call(query)
+        return result unless result.nil?
+      end
+
+      if opts_c.deletion_proc_scopes
+        result = opts_c.deletion_proc_scopes.call(query)
+        return result unless result.nil?
       end
+
+      return super(query)
     end
 
     def batch_size
@@ -118,6 +129,7 @@ module BulkDependencyEraser
       opts_c.disable_delete_batching.nil? ? opts_c.disable_batching : opts_c.disable_delete_batching
     end
 
+    # @param additional_identifiers [Hash] can be nil, if chosen to be so by implementers
     def delete_by_klass_and_ids(klass, ids, additional_identifiers:)
       puts "Deleting #{klass.name}'s IDs: #{ids}" if opts_c.verbose
       query = klass.unscoped
@@ -126,7 +138,7 @@ module BulkDependencyEraser
       if batching_disabled?
         puts "Deleting without batching" if opts_c.verbose
         # Get column-names/keys of any additional identifer columns
-        detected_additional_identifier_columns = additional_identifiers.values.flat_map(&:keys).uniq
+        detected_additional_identifier_columns = additional_identifiers&.values&.flat_map(&:keys)&.uniq || []
         delete_in_db do
           deletion_query = query.where(id: ids)
           # Apply any additional query identifiers (i.e. :ctid column)
@@ -144,9 +156,9 @@ module BulkDependencyEraser
       else
         puts "Deleting with batching" if opts_c.verbose
         ids.each_slice(batch_size) do |ids_subset|
-          additional_identifiers_subset = additional_identifiers.slice(*ids_subset)
+          additional_identifiers_subset = additional_identifiers&.slice(*ids_subset)
           # Get column-names/keys of any additional identifer columns
-          detected_additional_identifier_columns = additional_identifiers_subset.values.flat_map(&:keys).uniq
+          detected_additional_identifier_columns = additional_identifiers_subset&.values&.flat_map(&:keys)&.uniq || []
           delete_in_db do
             deletion_query = query.where(id: ids_subset)
             # Apply any additional query identifiers (i.e. :ctid column)

data/lib/bulk_dependency_eraser/nullifier.rb

@@ -43,13 +43,16 @@ module BulkDependencyEraser
       disable_nullify_batching: nil,
       # Applied to all queries. Useful for taking advantage of specific indexes
       # - not indexed by klass name. Proc would handle the logic for that.
-      # - 3rd, and lowest, priority of scopes
+      # - 4th, and lowest, priority of scopes
       # - accepts rails query as parameter
       # - return nil if no applicable scope.
       proc_scopes: self::DEFAULT_SCOPE_WRAPPER,
       # Applied to all queries. Useful for taking advantage of specific indexes
-      # - 2nd highest priority of scopes
+      # - 3rd highest priority of scopes
       proc_scopes_per_class_name: {},
+      # Applied to all queries. Useful for taking advantage of specific indexes
+      # - 2nd highest priority of scopes
+      nullification_proc_scopes: self::DEFAULT_SCOPE_WRAPPER,
       # Applied to nullification queries
       # - 1st priority of scopes
       nullification_proc_scopes_per_class_name: {},
@@ -164,11 +167,18 @@ module BulkDependencyEraser
 
     def custom_scope_for_query(query)
       klass = query.klass
+
       if opts_c.nullification_proc_scopes_per_class_name.key?(klass.name)
-        opts_c.nullification_proc_scopes_per_class_name[klass.name].call(query)
-      else
-        super(query)
+        result = opts_c.nullification_proc_scopes_per_class_name[klass.name].call(query)
+        return result unless result.nil?
+      end
+
+      if opts_c.nullification_proc_scopes
+        result = opts_c.nullification_proc_scopes.call(query)
+        return result unless result.nil?
       end
+
+      return super(query)
     end
 
     def batch_size

data/lib/bulk_dependency_eraser/version.rb

@@ -1,3 +1,3 @@
 module BulkDependencyEraser
-  VERSION = "4.1.0".freeze
+  VERSION = "4.2.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bulk_dependency_eraser
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.1
 platform: ruby
 authors:
 - benjamin.dana.software.dev@gmail.com