bulk_dependency_eraser 1.3.3 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb8d638145b6ff810e2cb3deb79c11a134b9df5e6abdc25755a166d92158c583
-  data.tar.gz: 0f7525a93ddb69db0b0fdb1243973c2a1db1db1d33051fa3fe49e1aaefdb538d
+  metadata.gz: 5258d3b15269fb6bd51a5f89f949983a3cf48862cc83f26a8f189bbc11e2ae84
+  data.tar.gz: dbab67950500c1037266232592915a3c27f0b54102619092be465ded4a53024d
 SHA512:
-  metadata.gz: 8841e5385fdd92b2d1c14315d849df28a4d8af00a7d8f151a4e04767fd27a9b1cd1653d269912a23385520cb7eb18f8e4b483ab74c7f9a0a5249048fbb81f20b
-  data.tar.gz: c0701a14385970abc0ac5ec0025215a11c5818d391d2bcbef89c36e47c8f7a7919a6dbded77521efdb60108bdb88266ef21268e743265399d58c9a7c4044f648
+  metadata.gz: 351634d20e814264885ddd4746e2fbaa7a8d27c4ab78fda5d3690e21697de51d1fd51c75d2b749e6f9a4727f79e6fa43d571617364df1e44870a55aeb0e88166
+  data.tar.gz: e8e477e1d5139bd4ac38cb3d4e4371b06688b5dc5e000d8a6a6077cc300ec998916cdd754c00d87ea1efd0b0a179479c60491450467cfc8eefbb6b0bda391690

data/lib/bulk_dependency_eraser/base.rb

@@ -1,6 +1,22 @@
 module BulkDependencyEraser
   class Base
-    DEFAULT_OPTS = {}.freeze
+    # Default Custom Scope for all classes, no effect.
+    DEFAULT_SCOPE_WRAPPER = ->(query) { nil }
+    # Default Custom Scope for mapped-by-name classes, no effect.
+    DEFAULT_KLASS_MAPPED_SCOPE_WRAPPER = ->(query) { query }
+
+    DEFAULT_OPTS = {
+      # 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
+      # - 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
+      proc_scopes_per_class_name: {},
+    }.freeze
+
 
     # Default Database wrapper, no effect.
     DEFAULT_DB_WRAPPER = ->(block) { block.call }
@@ -21,6 +37,21 @@ module BulkDependencyEraser
 
     protected
 
+    def custom_scope_for_klass_name(klass)
+      if opts_c.proc_scopes_per_class_name.key?(klass.name)
+        opts_c.proc_scopes_per_class_name[klass.name]
+      else
+        # See if non-class-mapped proc returns a value
+        non_class_name_mapped_query = opts_c.proc_scopes.call(klass.where({})) # convert klass to query
+        if !non_class_name_mapped_query.nil?
+          return opts_c.proc_scopes
+        else
+          # No custom wrapper, return non-effect default
+          return self.class::DEFAULT_KLASS_MAPPED_SCOPE_WRAPPER
+        end
+      end
+    end
+
     # Create options container
     def options_container
       Struct.new(

data/lib/bulk_dependency_eraser/builder.rb

@@ -20,6 +20,18 @@ module BulkDependencyEraser
       read_batch_size: nil,
       # A specific read batching disable option
       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
+      # - 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
+      proc_scopes_per_class_name: {},
+      # Applied to reading queries
+      # - 1st priority of scopes
+      reading_proc_scopes_per_class_name: {},
     }.freeze
 
     DEFAULT_DB_WRAPPER = ->(block) do
@@ -151,10 +163,20 @@ module BulkDependencyEraser
     attr_reader :table_names_to_parsed_klass_names
     attr_reader :ignore_table_name_and_dependencies, :ignore_klass_name_and_dependencies
 
+    def custom_scope_for_klass_name(klass)
+      if opts_c.reading_proc_scopes_per_class_name.key?(klass.name)
+        opts_c.reading_proc_scopes_per_class_name[klass.name]
+      else
+        super(klass)
+      end
+    end
+
     def pluck_from_query query, column = :id
       # ordering shouldn't matter in these queries, and would slow it down
       # - we're ignoring default_scope ordering, but assoc-defined ordering would still take effect
       query = query.reorder('')
+      query = custom_scope_for_klass_name(query.klass).call(query)
+
       query_ids = []
       read_from_db do
         # If the query has a limit, then we don't want to clobber with batching.
@@ -617,6 +639,8 @@ module BulkDependencyEraser
         return
       end
 
+      query = custom_scope_for_klass_name(query.klass).call(query)
+
       foreign_ids_by_type = read_from_db do
         if batching_disabled? || !query.where({}).limit_value.nil?
           # query without batching

data/lib/bulk_dependency_eraser/deleter.rb

@@ -12,6 +12,18 @@ module BulkDependencyEraser
       delete_batch_size: nil,
       # A specific batching size for this class, overrides the batch_size
       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
+      # - 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
+      proc_scopes_per_class_name: {},
+      # Applied to deletion queries
+      # - 1st priority of scopes
+      deletion_proc_scopes_per_class_name: {},
     }.freeze
 
     DEFAULT_DB_WRAPPER = ->(block) do
@@ -65,6 +77,14 @@ module BulkDependencyEraser
 
     attr_reader :class_names_and_ids
 
+    def custom_scope_for_klass_name(klass)
+      if opts_c.deletion_proc_scopes_per_class_name.key?(klass.name)
+        opts_c.deletion_proc_scopes_per_class_name[klass.name]
+      else
+        super(klass)
+      end
+    end
+
     def batch_size
       opts_c.delete_batch_size || opts_c.batch_size
     end
@@ -75,16 +95,19 @@ module BulkDependencyEraser
 
     def delete_by_klass_and_ids klass, ids
       puts "Deleting #{klass.name}'s IDs: #{ids}" if opts_c.verbose
+      query = klass.unscoped
+      query = custom_scope_for_klass_name(klass).call(query)
+
       if batching_disabled?
         puts "Deleting without batching" if opts_c.verbose
         delete_in_db do
-          klass.unscoped.where(id: ids).delete_all
+          query.where(id: ids).delete_all
         end
       else
         puts "Deleting with batching" if opts_c.verbose
         ids.each_slice(batch_size) do |ids_subset|
           delete_in_db do
-            klass.unscoped.where(id: ids_subset).delete_all
+            query.where(id: ids_subset).delete_all
           end
         end
       end

data/lib/bulk_dependency_eraser/nullifier.rb

@@ -14,6 +14,18 @@ module BulkDependencyEraser
       nullify_batch_size: nil,
       # A specific batching size for this class, overrides the batch_size
       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
+      # - 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
+      proc_scopes_per_class_name: {},
+      # Applied to nullification queries
+      # - 1st priority of scopes
+      nullification_proc_scopes_per_class_name: {},
     }.freeze
 
     DEFAULT_DB_WRAPPER = ->(block) do
@@ -123,6 +135,14 @@ module BulkDependencyEraser
 
     attr_reader :class_names_columns_and_ids
 
+    def custom_scope_for_klass_name(klass)
+      if opts_c.nullification_proc_scopes_per_class_name.key?(klass.name)
+        opts_c.nullification_proc_scopes_per_class_name[klass.name]
+      else
+        super(klass)
+      end
+    end
+
     def batch_size
       opts_c.nullify_batch_size || opts_c.batch_size
     end
@@ -132,8 +152,10 @@ module BulkDependencyEraser
     end
 
     def nullify_by_klass_column_and_ids klass, columns, ids
-      nullify_columns = {}
+      query = klass.unscoped
+      query = custom_scope_for_klass_name(klass).call(query)
 
+      nullify_columns = {}
       # supporting nullification of groups of columns simultaneously
       if columns.is_a?(Array)
         columns.each do |column|
@@ -145,12 +167,12 @@ module BulkDependencyEraser
 
       if batching_disabled?
         nullify_in_db do
-          klass.unscoped.where(id: ids).update_all(nullify_columns)
+          query.where(id: ids).update_all(nullify_columns)
         end
       else
         ids.each_slice(batch_size) do |ids_subset|
           nullify_in_db do
-            klass.unscoped.where(id: ids_subset).update_all(nullify_columns)
+            query.where(id: ids_subset).update_all(nullify_columns)
           end
         end
       end

data/lib/bulk_dependency_eraser/version.rb

@@ -1,3 +1,3 @@
 module BulkDependencyEraser
-  VERSION = "1.3.3".freeze
+  VERSION = "1.4.1".freeze
 end

metadata

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