bulk_dependency_eraser 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8e832cdb51105145cc3a1ba8487d32dab71b32d5a9f25808c84026d3f82b25
-  data.tar.gz: 556c96e6eb0a2b98aca3afbaf03ce8aad41012b793a7a45bccd4f2f459e1aaa5
+  metadata.gz: 5258d3b15269fb6bd51a5f89f949983a3cf48862cc83f26a8f189bbc11e2ae84
+  data.tar.gz: dbab67950500c1037266232592915a3c27f0b54102619092be465ded4a53024d
 SHA512:
-  metadata.gz: 8b23c1429318d5c56850d7fa615956f083929751b58a72a2e584d2470feff430b4c374691cd2e436beb5890619c7d1c533d64a1fa9cd1b6aa3df7776f6c73387
-  data.tar.gz: 06e3bebaf98dd80af62ca714a3c8edd92548873ac84b88569d344cad64709444464197c1e2ec7febc7c74a5c981e234677b5accfb29e4936ca1a1ec06acb44d1
+  metadata.gz: 351634d20e814264885ddd4746e2fbaa7a8d27c4ab78fda5d3690e21697de51d1fd51c75d2b749e6f9a4727f79e6fa43d571617364df1e44870a55aeb0e88166
+  data.tar.gz: e8e477e1d5139bd4ac38cb3d4e4371b06688b5dc5e000d8a6a6077cc300ec998916cdd754c00d87ea1efd0b0a179479c60491450467cfc8eefbb6b0bda391690

data/lib/bulk_dependency_eraser/base.rb

@@ -1,12 +1,22 @@
 module BulkDependencyEraser
   class Base
+    # 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 Custom Scope for all classes, no effect.
-    DEFAULT_SCOPE_WRAPPER = ->(query) { query }
 
     # Default Database wrapper, no effect.
     DEFAULT_DB_WRAPPER = ->(block) { block.call }
@@ -27,12 +37,18 @@ 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]
+    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
-        # No custom wrapper, return non-effect default
-        DEFAULT_SCOPE_WRAPPER
+        # 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
 

data/lib/bulk_dependency_eraser/builder.rb

@@ -21,8 +21,16 @@ module BulkDependencyEraser
       # 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 deletion queries
+      # Applied to reading queries
+      # - 1st priority of scopes
       reading_proc_scopes_per_class_name: {},
     }.freeze
 
@@ -155,11 +163,11 @@ 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]
+    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_name)
+        super(klass)
       end
     end
 
@@ -167,7 +175,7 @@ module BulkDependencyEraser
       # 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 = custom_scope_for_klass_name(query.klass).call(query)
 
       query_ids = []
       read_from_db do
@@ -631,7 +639,7 @@ module BulkDependencyEraser
         return
       end
 
-      query = custom_scope_for_klass_name(query.klass.name).call(query)
+      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?

data/lib/bulk_dependency_eraser/deleter.rb

@@ -13,8 +13,16 @@ module BulkDependencyEraser
       # 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
 
@@ -69,11 +77,11 @@ 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]
+    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_name)
+        super(klass)
       end
     end
 
@@ -88,7 +96,7 @@ 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)
+      query = custom_scope_for_klass_name(klass).call(query)
 
       if batching_disabled?
         puts "Deleting without batching" if opts_c.verbose

data/lib/bulk_dependency_eraser/nullifier.rb

@@ -15,8 +15,16 @@ module BulkDependencyEraser
       # 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 deletion queries
+      # Applied to nullification queries
+      # - 1st priority of scopes
       nullification_proc_scopes_per_class_name: {},
     }.freeze
 
@@ -127,11 +135,11 @@ 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]
+    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_name)
+        super(klass)
       end
     end
 
@@ -145,7 +153,7 @@ module BulkDependencyEraser
 
     def nullify_by_klass_column_and_ids klass, columns, ids
       query = klass.unscoped
-      query = custom_scope_for_klass_name(klass.name).call(query)
+      query = custom_scope_for_klass_name(klass).call(query)
 
       nullify_columns = {}
       # supporting nullification of groups of columns simultaneously

data/lib/bulk_dependency_eraser/version.rb

@@ -1,3 +1,3 @@
 module BulkDependencyEraser
-  VERSION = "1.4.0".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.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - benjamin.dana.software.dev@gmail.com