dependent-auto-rails 0.1.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c2ce49224fd43ed1657864ba4f770c55d027b9a1d3fa31067f4a34496b49a0
-  data.tar.gz: 7efbfee3f5f2a01d512c7d5e45cd7e7f80ae86cf901f907243a3b8f3247eadfa
+  metadata.gz: 6440f408848bb2bae6587ac5e84a6c1b8025e083d43bc0536512727fb11a6fcd
+  data.tar.gz: f2eda5a45cf5facbeb02ca99801fc1e6493083423bb06904ff05b2d89cb99af8
 SHA512:
-  metadata.gz: e0515328b712cd07be349167fa70603142d2a052be4d47395ce9890cd9adaa2c88b498a2a3ab7985556f31ea2dafe4d951baca947b764e4901ec033a26fc1de1
-  data.tar.gz: 0cc9aaa16aad850eb95f6a23d2625d8fbeacb74a05b2702bfb340f3782415cc04169f7b2f58faac0a8ccf4331e365f1d1e83c72de44142542264d672b4e57d7f
+  metadata.gz: 0f90fa81d2ea2a0a4478d380cfd9edc38fea534e5b88e975393c3c86ee43464fefb34dda23dd6a94d67abaf37a792e4002f2a1830c77d00ec7dce50322bf16e7
+  data.tar.gz: 2f9bfe5254002c37726e70aeb40067686f2277c1a76372fb5086a524fbb30fac85311f450cf77f817ea6fd890f4a1bb8082dcafb8afc4c3269a79fec36902bf1

data/README.md

@@ -3,11 +3,13 @@
 
 # dependent-auto-rails
 
-This gem provides a new `dependent` option for ActiveRecord associations, `:auto`. Using this option will automatically select between `:destroy` and `:delete` / `:delete_all` during runtime based on whether or not the associated model has any destroy callbacks defined. This is useful since `dependent: :destroy` always initialises the associated records in order to execute their destroy callbacks regardless of whether or not there are any defined, but is often the go-to option since it is the safest. This can be expensive if there are many records to destroy.
+This gem provides a new `dependent` option for ActiveRecord associations, `:auto`. Using this option will automatically select between `:destroy` and `:delete` / `:delete_all` during runtime based on whether or not the associated model has any callbacks defined which would usually be executed as part of the destroy lifecycle.
+
+This is useful since `dependent: :destroy` always initialises the associated records in order to execute their callbacks regardless of whether or not there are any defined, but is often the go-to option since it is the safest. This can be expensive if there are many records to destroy.
 
 It is also useful since a model's associations are rarely updated, but it's business logic can change frequently. This means that if destroy callbacks are added or removed on the associated model, the `dependent` option on the parent model's association may need to be updated to reflect this. Using `dependent: :auto` will automatically select the appropriate `dependent` option based on the current state of the model.
 
-**NOTE**: The `:auto` option **ONLY** decides between `:destroy` and `:delete` / `:delete_all`. It does not support any other `dependent` option, such as:
+**NOTE**: The `:auto` option **ONLY** decides between `:destroy` and `:delete` / `:delete_all`. It does not use any of the other `dependent` options:
 - `:nullify`
 - `:destroy_async`
 - `:restrict_with_error`
@@ -15,6 +17,8 @@ It is also useful since a model's associations are rarely updated, but it's busi
 
 **NOTE**: If for some reason the `:auto` option is unable to decide between `:destroy` and `:delete` / `:delete_all`, it will default to `:destroy`.
 
+**INFO**: If you're looking for a solution with a little less magic, check out the `incorrect_dependent_option` detector provided by https://github.com/gregnavis/active_record_doctor.
+
 ## Installation
 
 Install the gem and add it to the application's Gemfile by executing:

data/lib/dependent-auto-rails/activerecord/reflection.rb

@@ -20,16 +20,16 @@ module ActiveRecord
           return super unless key == :dependent && super(:dependent) == :auto
 
           return @dependent_auto if defined?(@dependent_auto)
-          # The method returned here is only used for defining an after_commit callback
-          # for :destroy_async, so it doesn't really matter what we return here.
-          # This helps us cause we can't yet determine the correct method as
+          # The method returned here is only used to define an after_commit callback
+          # for :destroy_async, so it doesn't really matter what we return.
+          # This helps us since we can't yet determine the correct method as
           # the associated model might not have been evaluated.
           return fallback_method if defining_dependent_callbacks?
 
           @dependent_auto = begin
             model = super(:association_model_name).constantize
 
-            if model._destroy_callbacks.empty?
+            if executable_callbacks_on_destroy_for(model).empty?
               case super(:association_type)
               when :singular then :delete
               when :collection then :delete_all
@@ -43,13 +43,21 @@ module ActiveRecord
 
         private
 
-        def fallback_method
-          :destroy # The safest, also common to all supported associations
-        end
-
         def defining_dependent_callbacks?
           caller.any? { |line| line.include?("active_record/associations/builder/association.rb") }
         end
+
+        def executable_callbacks_on_destroy_for(model)
+          model._find_callbacks.to_a +
+            model._initialize_callbacks.to_a +
+            model._destroy_callbacks.to_a +
+            model._commit_callbacks.to_a +
+            model._rollback_callbacks.to_a
+        end
+
+        def fallback_method
+          :destroy # The safest, also common to all supported associations
+        end
       end
     end
 

data/lib/dependent-auto-rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DependentAutoRails
-  VERSION = "0.1.9"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependent-auto-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.1
 platform: ruby
 authors:
 - Joshua Young
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord