bulk_dependency_eraser 1.5.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3466516854a6d613dae24320c55a3a5de1d921b53f8e9de06f08cde2226ff87d
-  data.tar.gz: 34c1025b73e2410eb3dca55ff7197903a1da148ed1bad55833f8495d70900265
+  metadata.gz: e4bda32570c3319238a5ea03f6a71cbae1e20015caf5fe7bdba78cab3c7883a7
+  data.tar.gz: 9e371750cd1a05b54bfe724873daaf2c7e9aa66942f168d6417505a1427d46c1
 SHA512:
-  metadata.gz: 67caff3857272988508f54f08aad5b8eddefb4fbd545a652e1d1cb060690b49c01270758237f6a37be4cac52a7c2f8ca43d3d543ab25d5287e0868cca9819443
-  data.tar.gz: 366cc6941a419a0a5437422f7c22f64c712a1cf4a222638de58c22b672f5d60086aadffda673f7edc60565e34eda7bf613345d4d87593097ed24a0aef60aa592
+  metadata.gz: 33130d09c651a9757af826cbbd5e1363a8f136a3d6e3bf1e2a128dad776185b544fd75a493013cd28d279690094e90cc3dc0f3b23597704df9842eb80e215808
+  data.tar.gz: 27f4e6014155961a1286f2d1f490a7ca2709fd2b9594a7c8ab3fb3164c26bbdf99e8609c5494e15e8595b0db9eee94d485a20a772f5a37d58554b497eaee5154

data/lib/bulk_dependency_eraser/builder.rb

@@ -94,27 +94,6 @@ module BulkDependencyEraser
         end
       end
 
-      # Reverse order IDs
-      # - if a class self-referenced itself the children will be deleted/nullified before parent
-      deletion_list.keys.each do |class_name|
-        deletion_list[class_name] = deletion_list.delete(class_name).reverse
-
-        # TODO: Hard to test if not sorted
-        deletion_list[class_name] = deletion_list[class_name].sort if Rails.env.test?
-      end
-
-      nullification_list.keys.each do |class_name|
-        columns_and_ids = nullification_list.delete(class_name)
-        # we don't need to reverse the column keys
-        columns_and_ids.keys.each do |column_name|
-          columns_and_ids[column_name] = columns_and_ids.delete(column_name).reverse
-
-          # TODO: Hard to test if not sorted
-          columns_and_ids[column_name] = columns_and_ids.delete(column_name).sort if Rails.env.test?
-        end
-        nullification_list[class_name] = columns_and_ids
-      end
-
       return build_result
     end
 

data/lib/bulk_dependency_eraser/deleter.rb

@@ -1,7 +1,29 @@
 module BulkDependencyEraser
   class Deleter < Base
+    DEFAULT_DB_DELETE_ALL_WRAPPER = ->(block) do
+      begin
+        block.call
+      rescue StandardError => e
+        report_error("Issue attempting to delete '#{current_class_name}': #{e.class.name} - #{e.message}")
+      end
+    end
+
     DEFAULT_OPTS = {
       verbose: false,
+      # Runs once, all deletions occur within it
+      # - useful if you wanted to implement a rollback:
+      #   - i.e:
+          # db_delete_all_wrapper: lambda do |block|
+          #   ActiveRecord::Base.transaction do
+          #     begin
+          #       block.call
+          #     rescue StandardError => e
+          #       report_error("Issue attempting to delete '#{current_class_name}': #{e.class.name} - #{e.message}")
+          #       raise ActiveRecord::Rollback
+          #     end
+          #   end
+          # end
+      db_delete_all_wrapper: self::DEFAULT_DB_DELETE_ALL_WRAPPER,
       db_delete_wrapper: self::DEFAULT_DB_WRITE_WRAPPER,
       # Set to true if you want 'ActiveRecord::InvalidForeignKey' errors raised during deletions
       enable_invalid_foreign_key_detection: false,
@@ -36,31 +58,25 @@ module BulkDependencyEraser
         puts "ActiveRecord::Base.connection.disable_referential_integrity - disabled!"
       end
 
-      ActiveRecord::Base.transaction do
-        current_class_name = 'N/A'
-        begin
-          # IDs should have already been reversed in builder
-          class_names_and_ids.keys.reverse.each do |class_name|
-            current_class_name = class_name
-            ids = class_names_and_ids[class_name]
-            klass = class_name.constantize
+      current_class_name = 'N/A'
+      delete_all_in_db do
+        class_names_and_ids.keys.reverse.each do |class_name|
+          current_class_name = class_name
+          ids = class_names_and_ids[class_name].reverse
+          klass = class_name.constantize
 
-            if opts_c.enable_invalid_foreign_key_detection
-              # delete with referential integrity
+          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)
-            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
-        rescue StandardError => e
-          report_error("Issue attempting to delete '#{current_class_name}': #{e.class.name} - #{e.message}")
-          raise ActiveRecord::Rollback
         end
       end
 
@@ -119,6 +135,13 @@ module BulkDependencyEraser
     def delete_in_db(&block)
       puts "Deleting from DB..." if opts_c.verbose
       opts_c.db_delete_wrapper.call(block)
+      puts "Deleting from DB complete." if opts_c.verbose
+    end
+
+    def delete_all_in_db(&block)
+      puts "Deleting all from DB..." if opts_c.verbose
+      opts_c.db_delete_all_wrapper.call(block)
+      puts "Deleting all from DB complete." if opts_c.verbose
     end
   end
 end

data/lib/bulk_dependency_eraser/nullifier.rb

@@ -1,7 +1,29 @@
 module BulkDependencyEraser
   class Nullifier < Base
+    DEFAULT_DB_NULLIFY_ALL_WRAPPER = lambda do |block|
+      begin
+        block.call
+      rescue StandardError => e
+        report_error("Issue attempting to nullify '#{current_class_name}' column '#{current_column}': #{e.class.name} - #{e.message}")
+      end
+    end
+
     DEFAULT_OPTS = {
       verbose: false,
+      # Runs once, all deletions occur within it
+      # - useful if you wanted to implement a rollback:
+      #   - i.e:
+      #     db_nullify_all_wrapper: lambda do |block|
+      #       ActiveRecord::Base.transaction do
+      #         begin
+      #           block.call
+      #         rescue StandardError => e
+      #           report_error("Issue attempting to nullify '#{current_class_name}': #{e.class.name} - #{e.message}")
+      #           raise ActiveRecord::Rollback
+      #         end
+      #       end
+      #     end
+      db_nullify_all_wrapper: self::DEFAULT_DB_NULLIFY_ALL_WRAPPER,
       db_nullify_wrapper: self::DEFAULT_DB_WRITE_WRAPPER,
       # Set to true if you want 'ActiveRecord::InvalidForeignKey' errors raised during nullifications
       # - I can't think of a use-case where a nullification would generate an invalid key error
@@ -89,36 +111,33 @@ module BulkDependencyEraser
     end
 
     def execute
-      ActiveRecord::Base.transaction do
-        current_class_name = 'N/A'
-        current_column = 'N/A'
-        begin
-          # column_and_ids should have already been reversed in builder
-          class_names_columns_and_ids.keys.reverse.each do |class_name|
-            current_class_name = class_name
-            klass = class_name.constantize
-            columns_and_ids = class_names_columns_and_ids[class_name]
-
-            columns_and_ids.each do |column, ids|
-              current_column = column
-
-              if opts_c.enable_invalid_foreign_key_detection
-                # nullify with referential integrity
+      current_class_name = 'N/A'
+      current_column = 'N/A'
+      nullify_all_in_db do
+        # column_and_ids should have already been reversed in builder
+        class_names_columns_and_ids.keys.reverse.each do |class_name|
+          current_class_name = class_name
+          klass = class_name.constantize
+          columns_and_ids = class_names_columns_and_ids[class_name]
+
+          columns_and_ids.each do |column, ids|
+            current_column = column
+            # Reversing IDs. Last ones in are more likely to be dependencies, and should be deleted first.
+            ids = ids.reverse
+
+            if opts_c.enable_invalid_foreign_key_detection
+              # nullify with referential integrity
+              nullify_by_klass_column_and_ids(klass, column, ids)
+            else
+              # nullify 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
                 nullify_by_klass_column_and_ids(klass, column, ids)
-              else
-                # nullify 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
-                  nullify_by_klass_column_and_ids(klass, column, ids)
-                end
               end
             end
           end
-        rescue StandardError => e
-          report_error("Issue attempting to nullify '#{current_class_name}' column '#{current_column}': #{e.class.name} - #{e.message}")
-          raise ActiveRecord::Rollback
         end
       end
 
@@ -146,6 +165,9 @@ module BulkDependencyEraser
       opts_c.disable_nullify_batching.nil? ? opts_c.disable_batching : opts_c.disable_nullify_batching
     end
 
+    # @param klass   [ActiveRecord::Base]
+    # @param columns [Symbol | String | Array<String | Symbol>]
+    # @param ids     [Array[String | Integer]]
     def nullify_by_klass_column_and_ids klass, columns, ids
       query = klass.unscoped
       query = custom_scope_for_query(query)
@@ -184,6 +206,13 @@ module BulkDependencyEraser
     def nullify_in_db(&block)
       puts "Nullifying from DB..." if opts_c.verbose
       opts_c.db_nullify_wrapper.call(block)
+      puts "Nullifying from DB complete." if opts_c.verbose
+    end
+
+    def nullify_all_in_db(&block)
+      puts "Nullifying all from DB..." if opts_c.verbose
+      opts_c.db_nullify_all_wrapper.call(block)
+      puts "Nullifying all from DB complete." if opts_c.verbose
     end
 
   end

data/lib/bulk_dependency_eraser/version.rb

@@ -1,3 +1,3 @@
 module BulkDependencyEraser
-  VERSION = "1.5.0".freeze
+  VERSION = "2.1.0".freeze
 end

metadata

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