bulk_dependency_eraser 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0b2a7c10501166d33e7076cf19b7c241ffd9de2704d94aca6f7c9fecc6e2d4
-  data.tar.gz: 6788ed915a4a6b4f7d7dbe2c8387244b0ff5e758098fe48f47b47127e64d9fb5
+  metadata.gz: 9c8e832cdb51105145cc3a1ba8487d32dab71b32d5a9f25808c84026d3f82b25
+  data.tar.gz: 556c96e6eb0a2b98aca3afbaf03ce8aad41012b793a7a45bccd4f2f459e1aaa5
 SHA512:
-  metadata.gz: ab13a12a9e5965890ae2e27cbf0971ba75aec2dbdc463d92c1631ac9cdb6dd98729e22cedb9c05cfb4cd4f897ca774c5204d0c3a61c804f8f7f8961de4e686cb
-  data.tar.gz: 9d0968970dd212e9e07c459134e829c8b1fd17c3c65d2b1e7665f983a68c4655044e3732ce7e2f6d28fb0c0e59606ffde0f343761a4730abb2f6dc74c3ba521d
+  metadata.gz: 8b23c1429318d5c56850d7fa615956f083929751b58a72a2e584d2470feff430b4c374691cd2e436beb5890619c7d1c533d64a1fa9cd1b6aa3df7776f6c73387
+  data.tar.gz: 06e3bebaf98dd80af62ca714a3c8edd92548873ac84b88569d344cad64709444464197c1e2ec7febc7c74a5c981e234677b5accfb29e4936ca1a1ec06acb44d1

data/lib/bulk_dependency_eraser/base.rb

@@ -1,6 +1,12 @@
 module BulkDependencyEraser
   class Base
-    DEFAULT_OPTS = {}.freeze
+    DEFAULT_OPTS = {
+      # Applied to all queries. Useful for taking advantage of specific indexes
+      proc_scopes_per_class_name: {},
+    }.freeze
+
+    # Default Custom Scope for all classes, no effect.
+    DEFAULT_SCOPE_WRAPPER = ->(query) { query }
 
     # Default Database wrapper, no effect.
     DEFAULT_DB_WRAPPER = ->(block) { block.call }
@@ -21,6 +27,15 @@ module BulkDependencyEraser
 
     protected
 
+    def custom_scope_for_klass_name(klass_name)
+      if opts_c.proc_scopes_per_class_name.key?(klass_name)
+        opts_c.proc_scopes_per_class_name[klass_name]
+      else
+        # No custom wrapper, return non-effect default
+        DEFAULT_SCOPE_WRAPPER
+      end
+    end
+
     # Create options container
     def options_container
       Struct.new(

data/lib/bulk_dependency_eraser/builder.rb

@@ -20,6 +20,10 @@ 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
+      proc_scopes_per_class_name: {},
+      # Applied to deletion queries
+      reading_proc_scopes_per_class_name: {},
     }.freeze
 
     DEFAULT_DB_WRAPPER = ->(block) do
@@ -151,10 +155,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_name)
+      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_name)
+      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.name).call(query)
+
       query_ids = []
       read_from_db do
         # If the query has a limit, then we don't want to clobber with batching.
@@ -427,11 +441,8 @@ module BulkDependencyEraser
         assoc_query = assoc_query.where(specified_foreign_key.to_sym => query_ids)
       end
 
-      # Works in theory for ONE record's has_one, but we're dealing with potentially many
-      # # Apply limit if has_one assocation (subset of has_many)
-      # if opts[:limit]
-      #   assoc_query = assoc_query.limit(opts[:limit])
-      # end
+      # remove any ordering or limits imposed on the association queries from the association definitions
+      assoc_query = assoc_query.reorder('').unscope(:limit)
 
       if type == :delete
         # Recursively call 'deletion_query_parser' on association query, to delete any if the assoc's dependencies
@@ -554,6 +565,9 @@ module BulkDependencyEraser
         specified_primary_key.to_sym => foreign_keys
       )
 
+      # remove any ordering or limits imposed on the association queries from the association definitions
+      assoc_query = assoc_query.reorder('').unscope(:limit)
+
       if type == :delete
         # Recursively call 'deletion_query_parser' on association query, to delete any if the assoc's dependencies
         deletion_query_parser(assoc_query, parent_class)
@@ -572,6 +586,7 @@ module BulkDependencyEraser
     # This method will replicate association_parser, but instantiate and iterate in batches
     def association_parser_belongs_to_instantiation(parent_class, query, query_ids, association_name, type)
       # pending
+      raise "Invalid State! Not ready to instantiate!"
     end
 
     # In this case, it's like a `belongs_to :polymorphicable, polymorphic: true, dependent: :destroy` use-case
@@ -616,6 +631,8 @@ module BulkDependencyEraser
         return
       end
 
+      query = custom_scope_for_klass_name(query.klass.name).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,10 @@ 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
+      proc_scopes_per_class_name: {},
+      # Applied to deletion queries
+      deletion_proc_scopes_per_class_name: {},
     }.freeze
 
     DEFAULT_DB_WRAPPER = ->(block) do
@@ -65,6 +69,14 @@ module BulkDependencyEraser
 
     attr_reader :class_names_and_ids
 
+    def custom_scope_for_klass_name(klass_name)
+      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_name)
+      end
+    end
+
     def batch_size
       opts_c.delete_batch_size || opts_c.batch_size
     end
@@ -75,16 +87,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.name).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,10 @@ 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
+      proc_scopes_per_class_name: {},
+      # Applied to deletion queries
+      nullification_proc_scopes_per_class_name: {},
     }.freeze
 
     DEFAULT_DB_WRAPPER = ->(block) do
@@ -123,6 +127,14 @@ module BulkDependencyEraser
 
     attr_reader :class_names_columns_and_ids
 
+    def custom_scope_for_klass_name(klass_name)
+      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_name)
+      end
+    end
+
     def batch_size
       opts_c.nullify_batch_size || opts_c.batch_size
     end
@@ -132,8 +144,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.name).call(query)
 
+      nullify_columns = {}
       # supporting nullification of groups of columns simultaneously
       if columns.is_a?(Array)
         columns.each do |column|
@@ -145,12 +159,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.2".freeze
+  VERSION = "1.4.0".freeze
 end

metadata

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