cascade-deleter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a0e10f1734aed0dcc89834897e051c0e26bbf463706843f60fa90564e90188a
+  data.tar.gz: 46fdd8434d43e0ab32c92cfcff66047988023c2494f00e47eff5ea5b87512e7e
+SHA512:
+  metadata.gz: 7dd2d5bb3669bd742fe76fecf44ff5236b47e43c27cddfeaf7cf675ac85f1a8ca0b2dd3d2d1523451c9e08cc43e489502fa06d04e079441b28a67b4c76456c36
+  data.tar.gz: 7697d23ef95f3661b30a82c29f22882e02d2fdf4c3bdbad12befb8c99255b976c0f8f1d1a1c4e9b1e625a21bac862f80ac12d3a873b83888d5c4efd5a691da00

data/lib/cascade_deleter.rb

@@ -0,0 +1,77 @@
+require 'hierarchy_tree'
+require 'deactivator'
+
+# Cascade delete items and all of their children items
+# ⚠ Be aware, this lib executes HARD deletions, so
+# 1. The items will be completely removed from the database
+# 2. No validations or callbacks will be triggered
+# Usage 1: CascadeDeleter.new(Project.unscoped.where(active: false)).delete_all
+# Usage 2: CascadeDeleter.new(Project.unscoped.where(active: false)).delete_all(
+#            custom_joins: { 'Attachment' => {:subproject=>:project} }
+#          )
+# Usage 3: CascadeDeleter.new(Discipline.where_like(description: '[TO BE DELETED]')).delete_all(
+#            method: :soft
+#          )
+
+################ Debug ################
+# gem cleanup cascade-deleter
+# rm cascade-deleter-0.1.0.gem
+# gem build cascade_deleter
+# gem install cascade-deleter-0.1.0.gem
+# ruby -Itest test/test_cascade_deleter.rb
+class CascadeDeleter
+  def initialize(items)
+    @items = items
+    @class = @items.klass
+    @classes = classes
+  end
+
+  def delete_all(custom_joins: {}, method: :hard)
+    Deactivator.new(@classes).without_default_scopes do
+      ActiveRecord::Base.connection.execute('SET FOREIGN_KEY_CHECKS = 0;')
+
+      ActiveRecord::Base.transaction do
+        @classes.map(&:constantize).each do |klass|
+          delete(klass, build_join(klass, custom_joins), method)
+        end
+      end
+    ensure
+      ActiveRecord::Base.connection.execute('SET FOREIGN_KEY_CHECKS = 1;')
+    end
+  end
+
+  private
+
+  def classes
+    Hierarchy.bottom_up_classes(@class).without('Audited::Audit')
+  end
+
+  def delete(klass, join, method)
+    puts "#{method.to_s.titleize} Deleting #{klass.name.pluralize.titleize}".green
+    count = apply_delete(build_query(klass, join), method)
+    puts "#{count} #{klass.name.pluralize.titleize} are #{method} deleted".yellow
+  end
+
+  def apply_delete(items, method)
+    case method
+    when :hard
+      items.delete_all
+    when :soft
+      items.update_all(active: false, updated_at: Time.now)
+    else
+      puts 'Unregistered Delete Method. Possible methods → :hard or :soft'.red
+      0
+    end
+  end
+
+  def build_query(klass, join)
+    return @items if @class.to_s == klass.to_s
+
+    klass.joins(join).where(@class.table_name => { id: @items.select(:id) })
+  end
+
+  def build_join(model, custom_joins = {})
+    custom_joins[model.to_s] || Hierarchy.ancestors_bfs(from: model, to: @class)
+    # You can use `Hierarchy.ancestors(from: model, to: @class)` to choose one custom_join
+  end
+end

data/lib/deactivator.rb

@@ -0,0 +1,45 @@
+# Deactivate default_scopes for the given classes for a given code block
+# --------------------------- Usage ---------------------------
+# Deactivator.new(['ClassA', 'ClassB']).without_default_scopes do
+#   My
+#   Code
+#   Block
+#   Without ClassA and ClassB default_scopes
+# end
+class Deactivator
+  def initialize(classes)
+    @classes = classes
+    @default_scopes = capture_default_scopes
+  end
+
+  def without_default_scopes
+    remove_default_scopes
+    yield
+  ensure
+    restore_default_scopes
+  end
+
+  private
+
+  def capture_default_scopes
+    @classes.to_h do |klass|
+      [klass, klass.constantize.default_scopes]
+    end
+  end
+
+  def remove_default_scopes
+    @classes.each do |klass|
+      klass.constantize.class_eval { self.default_scopes = [] }
+    end
+  end
+
+  def restore_default_scopes
+    deactivator = self
+
+    @classes.each do |klass|
+      klass.constantize.class_eval do
+        self.default_scopes = deactivator.instance_variable_get(:@default_scopes)[klass]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: cascade-deleter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Cordeiro Costa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hierarchy-tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+description: |-
+  cascade-deleter is a ruby gem designed to delete items
+                                 with all of their descendant items in their hierarchy.
+email:
+- victorcorcos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cascade_deleter.rb
+- lib/deactivator.rb
+homepage: https://github.com/Victorcorcos/cascade-deleter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: cascade-deleter is a ruby gem designed to delete items with all of their
+  descendant items in their hierarchy.
+test_files: []