bulk_dependency_eraser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e51d0383cb5b2111181c9dc48b499b046d225adad1d1f8b985216a0d395cb612
-  data.tar.gz: 02ce5200f03d7a4cec2cfa72b64fbfdf84e73ce5b3e6b43ba073173b48e5139b
+  metadata.gz: dca31bd9e7da64eaade636f74a6d787a1faacaf7f1489d8c2e3970443cd61c24
+  data.tar.gz: bd407ef3c87918562d28f350c5b3051406ef605c93bbbf55e017969b601e39f0
 SHA512:
-  metadata.gz: 25857421c4e8cc6af0f952bacd106b39f19d34ac8d2292f74e9daa90c10ea07ab82e11fe584b7c0fcb60209fb1e4ba0d126e6e9102587b3d6ff6a69e495373e5
-  data.tar.gz: 68f2ec5423d953bf842de7c98ea778f44795a89cfa948b400c5171e08489446aba765467744175a5de69df6957fef1b04f0c017af7d63b1959d756caaac07a22
+  metadata.gz: 3bb5b2c4dc13c792fc9dc909e1a4e7593dff9978f152a62d834fbe273a0166ac7e659004f299d3d8ab5e5cc9464d7d11c5fa88f1c8d3c4bac2b1661a4f344563
+  data.tar.gz: c9ed11ba64c5de00b3dc248935c9345873741c071e7517f321b6c928b103bc52a9a59c69f65cf4e110d616c12257642c496e25a987501ab80a898b7231d8b774

data/lib/bulk_dependency_eraser/builder.rb

@@ -6,7 +6,12 @@ module BulkDependencyEraser
       # Some associations scopes take parameters.
       # - We would have to instantiate if we wanted to apply that scope filter.
       instantiate_if_assoc_scope_with_arity: false,
+      # wraps around the DB reading
       db_read_wrapper: self::DEFAULT_DB_WRAPPER,
+      # Will parse these tables and their dependencies, but will remove the tables from the lists after parsing.
+      ignore_tables: [],
+      # Won't parse any table in this list
+      ignore_tables_and_dependencies: [],
     }.freeze
 
     DEPENDENCY_NULLIFY = %i[
@@ -36,17 +41,40 @@ module BulkDependencyEraser
     ].freeze
 
     attr_reader :deletion_list, :nullification_list
+    attr_reader :ignore_table_deletion_list, :ignore_table_nullification_list
 
     def initialize query:, opts: {}
       @query = query
       @deletion_list  = {}
       @nullification_list = {}
+
+      # For any ignored table results, they will be stored here
+      @ignore_table_deletion_list = {}
+      @ignore_table_nullification_list = {}
+
       super(opts:)
+
+      # populate with klass_names for ignorable klasses
+      @ignore_klass_and_dependencies = opts_c.ignore_tables_and_dependencies.collect { |table_name| table_name.classify }
     end
 
     def execute
+      # go through deletion/nullification lists and remove any tables from 'ignore_tables' option
+      build_result = build
+
+      # move any klass names if told to ignore them into their respective new lists
+      opts_c.ignore_tables.each do |table_name|
+        klass_name = table_name.classify
+        ignore_table_deletion_list[klass_name]      = deletion_list.delete(klass_name)      if deletion_list.key?(klass_name)
+        ignore_table_nullification_list[klass_name] = nullification_list.delete(klass_name) if nullification_list.key?(klass_name)
+      end
+
+      return build_result
+    end
+
+    def build
       begin
-        build_result = deletion_query_parser(@query)
+        deletion_query_parser(@query)
 
         uniqify_errors!
 
@@ -88,6 +116,11 @@ module BulkDependencyEraser
         table_klass_name = query.table_name.classify
       end
 
+      if ignore_klass_and_dependencies.include?(table_klass_name)
+        # Not parsing, table and dependencies ignorable
+        return
+      end
+
       if opts_c.verbose
         if association_parent
           puts "Building #{klass_name}"
@@ -247,7 +280,7 @@ module BulkDependencyEraser
         deletion_query_parser(assoc_query, parent_class)
       elsif type == :nullify
         # No need for recursion here.
-        # - we're not destroying these assocs so we don't need to parse their dependencies.
+        # - we're not destroying these assocs (just nullifying foreign_key columns) so we don't need to parse their dependencies.
         assoc_ids = read_from_db do
           assoc_query.pluck(:id)
         end
@@ -255,7 +288,6 @@ module BulkDependencyEraser
         # No assoc_ids, no need to add it to the nullification list
         return if assoc_ids.none?
 
-        # puts "FOUND IDS: #{assoc_ids.insect}"
         nullification_list[assoc_table_klass_name] ||= {}
         nullification_list[assoc_table_klass_name][specified_foreign_key] ||= []
         nullification_list[assoc_table_klass_name][specified_foreign_key] += assoc_ids
@@ -267,6 +299,8 @@ module BulkDependencyEraser
 
     protected
 
+    attr_reader :ignore_klass_and_dependencies
+
     # A dependent assoc may be through another association. Follow the throughs to find the correct assoc to destroy.
     def find_root_association_from_through_assocs klass, association_name
       reflection = klass.reflect_on_association(association_name)

data/lib/bulk_dependency_eraser/deleter.rb

@@ -3,6 +3,8 @@ module BulkDependencyEraser
     DEFAULT_OPTS = {
       verbose: false,
       db_delete_wrapper: self::DEFAULT_DB_WRAPPER,
+      # Set to true if you want 'ActiveRecord::InvalidForeignKey' errors raised during deletions
+      enable_invalid_foreign_key_detection: false
     }.freeze
 
     def initialize class_names_and_ids: {}, opts: {}
@@ -11,6 +13,10 @@ module BulkDependencyEraser
     end
 
     def execute
+      if opts_c.verbose && opts_c.enable_invalid_foreign_key_detection
+        puts "ActiveRecord::Base.connection.disable_referential_integrity - disabled!"
+      end
+
       ActiveRecord::Base.transaction do
         current_class_name = 'N/A'
         begin
@@ -19,12 +25,16 @@ module BulkDependencyEraser
             ids = class_names_and_ids[class_name]
             klass = class_name.constantize
 
-            # Disable any ActiveRecord::InvalidForeignKey raised errors.
-            # src https://stackoverflow.com/questions/41005849/rails-migrations-temporarily-ignore-foreign-key-constraint
-            #     https://apidock.com/rails/ActiveRecord/ConnectionAdapters/AbstractAdapter/disable_referential_integrity
-            ActiveRecord::Base.connection.disable_referential_integrity do
-              delete_in_db do
-                klass.unscoped.where(id: ids).delete_all
+            if opts_c.enable_invalid_foreign_key_detection
+              # delete with referential integrity
+              delete_by_klass_and_ids(klass, ids)
+            else
+              # delete without referential integrity
+              # Disable any ActiveRecord::InvalidForeignKey raised errors.
+              # - src: https://stackoverflow.com/questions/41005849/rails-migrations-temporarily-ignore-foreign-key-constraint
+              #        https://apidock.com/rails/ActiveRecord/ConnectionAdapters/AbstractAdapter/disable_referential_integrity
+              ActiveRecord::Base.connection.disable_referential_integrity do
+                delete_by_klass_and_ids(klass, ids)
               end
             end
           end
@@ -39,6 +49,13 @@ module BulkDependencyEraser
 
     protected
 
+    def delete_by_klass_and_ids klass, ids
+      puts "Deleting #{klass.name}'s IDs: #{ids}" if opts_c.verbose
+      delete_in_db do
+        klass.unscoped.where(id: ids).delete_all
+      end
+    end
+
     attr_reader :class_names_and_ids
 
     def delete_in_db(&block)

data/lib/bulk_dependency_eraser/manager.rb

@@ -5,6 +5,7 @@ module BulkDependencyEraser
     }.freeze
 
     delegate :nullification_list, :deletion_list, to: :dependency_builder
+    delegate :ignore_table_deletion_list, :ignore_table_nullification_list, to: :dependency_builder
 
     # @param query [ActiveRecord::Base | ActiveRecord::Relation]
     def initialize query:, opts: {}
@@ -62,7 +63,6 @@ module BulkDependencyEraser
       unless nullifier_execution
         puts "Nullifier execution FAILED" if opts_c.verbose
         merge_errors(nullifier.errors, 'Nullifier: ')
-        @errors += nullifier.errors
       else
         puts "Nullifier execution SUCCESSFUL" if opts_c.verbose
       end

metadata

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