glib-web 0.5.73 → 0.5.75

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f4ae4213c1c8cd32dd3f1726335e8ad63f878ae480bc83792636f217b88cd5e
-  data.tar.gz: 8b395ee2a1f16ae8c9c9b0af8ecaf9aca9e03b2c0cb819d8217281229b2cbc56
+  metadata.gz: 024cbfd3c136b878553f4f7cbeb484cd3b1591bcda6e77ef4b0c9c8fd9217712
+  data.tar.gz: e129fc931a5f85f4870a1e62706589fbd410fef4eb60c46527f335cfe7bc09dd
 SHA512:
-  metadata.gz: 8c61abfa42bba5bcbd11d70ac9840b0e6aed1a1dae7b01e480615ff650161e330a4fae35937d7a2f1e9e513126b5f016a5828dfb85e91e362b80b4d7782a78dc
-  data.tar.gz: 6432a393428e3568832d9c8e7e07ba851ac0326479277bdce8e80c7969f22752e5f7634953349f707dec71b5801cebdc9aa2bb117e9b4eabbccf42b6ba881cbd
+  metadata.gz: 68da687986a2806b6ac987beff6fe8aded090ad33b664846b28c40ca061b1f05361ed272483207e04c361af57ff292e1e6a8d473271d1b005f99de77f51616cc
+  data.tar.gz: 2fff915aaf95c1d3c2dddf6ddf02492e4a5f936c6ef8c03c702240108acacfe7e2eb872104e242f3c2e88262f4c75ed9b2770f4219ab2e4d05a96aa784174f97

data/app/models/concerns/glib/soft_deletable.rb

@@ -0,0 +1,68 @@
+module Glib
+  module SoftDeletable
+    extend ActiveSupport::Concern
+
+    included do
+      default_scope { where(deleted_at: nil) }
+      scope :with_deleted, -> { unscope(where: :deleted_at) }
+
+      # "Soft delete" - set deleted_at if it is nil, actually destroy the record
+      # if forced.
+      #
+      # @param force [Boolean]
+      def destroy(force = nil)
+        return force_destroy_record if force == :force
+        return self if deleted?
+
+        soft_destroy_record
+      end
+
+      # Revive a soft-deleted record and associated records if soft-deleted,
+      # otherwise return self
+      def revive
+        return self unless deleted?
+
+        ActiveRecord::Base.transaction do
+          update(deleted_at: nil)
+          revive_associated_records
+        end
+      end
+
+      # Whether or not a record is deleted
+      def deleted?
+        deleted_at.present?
+      end
+
+      private
+        def force_destroy_record
+          ActiveRecord::Base.transaction do
+            destroy_associated_records(:force)
+            method(:destroy).super_method.call
+          end
+        end
+
+        def soft_destroy_record
+          ActiveRecord::Base.transaction do
+            destroy_associated_records
+            update(deleted_at: Time.zone.now)
+          end
+        end
+
+        def destroy_associated_records(force = nil)
+          associated_records.each { |r| r.destroy(force) }
+        end
+
+        def revive_associated_records
+          associated_records.each(&:revive)
+        end
+
+        # This should return an array of all associated records of an object that
+        # should be soft deleted with it (i.e. those that have dependent: :destroy
+        # set). In principle we could figure this out automatically but in the
+        # interest of simplicity we'll just define it manually for each class.
+        def associated_records
+          []
+        end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glib-web
 version: !ruby/object:Gem::Version
-  version: 0.5.73
+  version: 0.5.75
 platform: ruby
 authors:
 - ''
@@ -113,6 +113,7 @@ files:
 - app/helpers/glib/json_ui/view_builder/fields.rb
 - app/helpers/glib/json_ui/view_builder/panels.rb
 - app/helpers/glib/urls_helper.rb
+- app/models/concerns/glib/soft_deletable.rb
 - app/models/glib/active_storage/attachment.rb
 - app/models/glib/active_storage/blob.rb
 - app/models/glib/application_record.rb