Merge pull request #30629 from yhirano55/add_scope_to_has_one_attached_macro

Add `with_attached_*` scope to `has_one_attached` macro

1 files changed, 6 insertions, 0 deletions

diff --git a/activestorage/lib/active_storage/attached/macros.rb b/activestorage/lib/active_storage/attached/macros.rb
index 35a081adc4..f0256718ac 100644
--- a/activestorage/lib/active_storage/attached/macros.rb
+++ b/activestorage/lib/active_storage/attached/macros.rb
@@ -12,6 +12,10 @@ module ActiveStorage
     # There is no column defined on the model side, Active Storage takes
     # care of the mapping between your records and the attachment.
     #
+    # To avoid N+1 queries, you can include the attached blobs in your query like so:
+    #
+    #   User.with_attached_avatar
+    #
     # Under the covers, this relationship is implemented as a +has_one+ association to a
     # ActiveStorage::Attachment record and a +has_one-through+ association to a
     # ActiveStorage::Blob record. These associations are available as +avatar_attachment+
@@ -33,6 +37,8 @@ module ActiveStorage
       has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record
       has_one :"#{name}_blob", through: :"#{name}_attachment", class_name: "ActiveStorage::Blob", source: :blob
 
+      scope :"with_attached_#{name}", -> { includes("#{name}_attachment": :blob) }
+
       if dependent == :purge_later
         before_destroy { public_send(name).purge_later }
       end