Active Storage Attached Model
Provides the class-level DSL for declaring an Active Record model’s attachments.
- #
- H
- V
- W
Instance Public methods
*_attachment Link
Returns the attachment for the has_one_attached
.
User.last.avatar_attachment
Source: on GitHub
# File activestorage/lib/active_storage/attached/model.rb, line 13
*_attachments Link
Returns the attachments for the has_many_attached
.
Gallery.last.photos_attachments
Source: on GitHub
# File activestorage/lib/active_storage/attached/model.rb, line 20
*_blob Link
Returns the blob for the has_one_attached
attachment.
User.last.avatar_blob
Source: on GitHub
# File activestorage/lib/active_storage/attached/model.rb, line 27
*_blobs Link
Returns the blobs for the has_many_attached
attachments.
Gallery.last.photos_blobs
Source: on GitHub
# File activestorage/lib/active_storage/attached/model.rb, line 34
has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false) Link
Specifies the relation between multiple attachments and the model.
class Gallery < ApplicationRecord
has_many_attached :photos
end
There are no columns defined on the model side, Active Storage takes care of the mapping between your records and the attachments.
To avoid N+1 queries, you can include the attached blobs in your query like so:
Gallery.where(user: Current.user).with_attached_photos
Under the covers, this relationship is implemented as a has_many
association to a ActiveStorage::Attachment
record and a has_many-through
association to a ActiveStorage::Blob
record. These associations are available as photos_attachments
and photos_blobs
. But you shouldn’t need to work with these associations directly in most circumstances.
The system has been designed to having you go through the ActiveStorage::Attached::Many
proxy that provides the dynamic proxy to the associations and factory methods, like #attach
.
If the :dependent
option isn’t set, all the attachments will be purged (i.e. destroyed) whenever the record is destroyed.
If you need the attachment to use a service which differs from the globally configured one, pass the :service
option. For instance:
class Gallery < ActiveRecord::Base
has_many_attached :photos, service: :s3
end
If you need to enable strict_loading
to prevent lazy loading of attachments, pass the :strict_loading
option. You can do:
class Gallery < ApplicationRecord
has_many_attached :photos, strict_loading: true
end
# File activestorage/lib/active_storage/attached/model.rb, line 182 def has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false) validate_service_configuration(name, service) generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1 # frozen_string_literal: true def #{name} @active_storage_attached ||= {} @active_storage_attached[:#{name}] ||= ActiveStorage::Attached::Many.new("#{name}", self) end def #{name}=(attachables) attachables = Array(attachables).compact_blank pending_uploads = attachment_changes["#{name}"].try(:pending_uploads) attachment_changes["#{name}"] = if attachables.none? ActiveStorage::Attached::Changes::DeleteMany.new("#{name}", self) else ActiveStorage::Attached::Changes::CreateMany.new("#{name}", self, attachables, pending_uploads: pending_uploads) end end CODE has_many :"#{name}_attachments", -> { where(name: name) }, as: :record, class_name: "ActiveStorage::Attachment", inverse_of: :record, dependent: :destroy, strict_loading: strict_loading has_many :"#{name}_blobs", through: :"#{name}_attachments", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading scope :"with_attached_#{name}", -> { if ActiveStorage.track_variants includes("#{name}_attachments": { blob: { variant_records: { image_attachment: :blob }, preview_image_attachment: { blob: { variant_records: { image_attachment: :blob } } } } }) else includes("#{name}_attachments": :blob) end } after_save { attachment_changes[name.to_s]&.save } after_commit(on: %i[ create update ]) { attachment_changes.delete(name.to_s).try(:upload) } reflection = ActiveRecord::Reflection.create( :has_many_attached, name, nil, { dependent: dependent, service_name: service }, self ) yield reflection if block_given? ActiveRecord::Reflection.add_attachment_reflection(self, name, reflection) end
has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false) Link
Specifies the relation between a single attachment and the model.
class User < ApplicationRecord
has_one_attached :avatar
end
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
and avatar_blob
. But you shouldn’t need to work with these associations directly in most circumstances.
The system has been designed to having you go through the ActiveStorage::Attached::One
proxy that provides the dynamic proxy to the associations and factory methods, like attach
.
If the :dependent
option isn’t set, the attachment will be purged (i.e. destroyed) whenever the record is destroyed.
If you need the attachment to use a service which differs from the globally configured one, pass the :service
option. For instance:
class User < ActiveRecord::Base
has_one_attached :avatar, service: :s3
end
If you need to enable strict_loading
to prevent lazy loading of attachment, pass the :strict_loading
option. You can do:
class User < ApplicationRecord
has_one_attached :avatar, strict_loading: true
end
# File activestorage/lib/active_storage/attached/model.rb, line 94 def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false) validate_service_configuration(name, service) generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1 # frozen_string_literal: true def #{name} @active_storage_attached ||= {} @active_storage_attached[:#{name}] ||= ActiveStorage::Attached::One.new("#{name}", self) end def #{name}=(attachable) attachment_changes["#{name}"] = if attachable.nil? || attachable == "" ActiveStorage::Attached::Changes::DeleteOne.new("#{name}", self) else ActiveStorage::Attached::Changes::CreateOne.new("#{name}", self, attachable) end end CODE has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record, inverse_of: :record, dependent: :destroy, strict_loading: strict_loading has_one :"#{name}_blob", through: :"#{name}_attachment", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading scope :"with_attached_#{name}", -> { if ActiveStorage.track_variants includes("#{name}_attachment": { blob: { variant_records: { image_attachment: :blob }, preview_image_attachment: { blob: { variant_records: { image_attachment: :blob } } } } }) else includes("#{name}_attachment": :blob) end } after_save { attachment_changes[name.to_s]&.save } after_commit(on: %i[ create update ]) { attachment_changes.delete(name.to_s).try(:upload) } reflection = ActiveRecord::Reflection.create( :has_one_attached, name, nil, { dependent: dependent, service_name: service }, self ) yield reflection if block_given? ActiveRecord::Reflection.add_attachment_reflection(self, name, reflection) end
validate_global_service_configuration() Link
# File activestorage/lib/active_storage/attached/model.rb, line 244 def validate_global_service_configuration if connected? && ActiveStorage::Blob.table_exists? && Rails.configuration.active_storage.service.nil? raise RuntimeError, "Missing Active Storage service name. Specify Active Storage service name for config.active_storage.service in config/environments/#{Rails.env}.rb" end end
validate_service_configuration(association_name, service) Link
# File activestorage/lib/active_storage/attached/model.rb, line 234 def validate_service_configuration(association_name, service) if service.present? ActiveStorage::Blob.services.fetch(service) do raise ArgumentError, "Cannot configure service :#{service} for #{name}##{association_name}" end else validate_global_service_configuration end end
with_attached_* Link
Includes the attached blobs in your query to avoid N+1 queries.
If ActiveStorage.track_variants
is enabled, it will also include the variants record and their attached blobs.
User.with_attached_avatar
Use the plural form for has_many_attached
:
Gallery.with_attached_photos
# File activestorage/lib/active_storage/attached/model.rb, line 54 class_methods do # Specifies the relation between a single attachment and the model. # # class User < ApplicationRecord # has_one_attached :avatar # end # # 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+ # and +avatar_blob+. But you shouldn't need to work with these associations directly in # most circumstances. # # The system has been designed to having you go through the ActiveStorage::Attached::One # proxy that provides the dynamic proxy to the associations and factory methods, like +attach+. # # If the +:dependent+ option isn't set, the attachment will be purged # (i.e. destroyed) whenever the record is destroyed. # # If you need the attachment to use a service which differs from the globally configured one, # pass the +:service+ option. For instance: # # class User < ActiveRecord::Base # has_one_attached :avatar, service: :s3 # end # # If you need to enable +strict_loading+ to prevent lazy loading of attachment, # pass the +:strict_loading+ option. You can do: # # class User < ApplicationRecord # has_one_attached :avatar, strict_loading: true # end # def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false) validate_service_configuration(name, service) generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1 # frozen_string_literal: true def #{name} @active_storage_attached ||= {} @active_storage_attached[:#{name}] ||= ActiveStorage::Attached::One.new("#{name}", self) end def #{name}=(attachable) attachment_changes["#{name}"] = if attachable.nil? || attachable == "" ActiveStorage::Attached::Changes::DeleteOne.new("#{name}", self) else ActiveStorage::Attached::Changes::CreateOne.new("#{name}", self, attachable) end end CODE has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record, inverse_of: :record, dependent: :destroy, strict_loading: strict_loading has_one :"#{name}_blob", through: :"#{name}_attachment", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading scope :"with_attached_#{name}", -> { if ActiveStorage.track_variants includes("#{name}_attachment": { blob: { variant_records: { image_attachment: :blob }, preview_image_attachment: { blob: { variant_records: { image_attachment: :blob } } } } }) else includes("#{name}_attachment": :blob) end } after_save { attachment_changes[name.to_s]&.save } after_commit(on: %i[ create update ]) { attachment_changes.delete(name.to_s).try(:upload) } reflection = ActiveRecord::Reflection.create( :has_one_attached, name, nil, { dependent: dependent, service_name: service }, self ) yield reflection if block_given? ActiveRecord::Reflection.add_attachment_reflection(self, name, reflection) end # Specifies the relation between multiple attachments and the model. # # class Gallery < ApplicationRecord # has_many_attached :photos # end # # There are no columns defined on the model side, Active Storage takes # care of the mapping between your records and the attachments. # # To avoid N+1 queries, you can include the attached blobs in your query like so: # # Gallery.where(user: Current.user).with_attached_photos # # Under the covers, this relationship is implemented as a +has_many+ association to a # ActiveStorage::Attachment record and a +has_many-through+ association to a # ActiveStorage::Blob record. These associations are available as +photos_attachments+ # and +photos_blobs+. But you shouldn't need to work with these associations directly in # most circumstances. # # The system has been designed to having you go through the ActiveStorage::Attached::Many # proxy that provides the dynamic proxy to the associations and factory methods, like +#attach+. # # If the +:dependent+ option isn't set, all the attachments will be purged # (i.e. destroyed) whenever the record is destroyed. # # If you need the attachment to use a service which differs from the globally configured one, # pass the +:service+ option. For instance: # # class Gallery < ActiveRecord::Base # has_many_attached :photos, service: :s3 # end # # If you need to enable +strict_loading+ to prevent lazy loading of attachments, # pass the +:strict_loading+ option. You can do: # # class Gallery < ApplicationRecord # has_many_attached :photos, strict_loading: true # end # def has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false) validate_service_configuration(name, service) generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1 # frozen_string_literal: true def #{name} @active_storage_attached ||= {} @active_storage_attached[:#{name}] ||= ActiveStorage::Attached::Many.new("#{name}", self) end def #{name}=(attachables) attachables = Array(attachables).compact_blank pending_uploads = attachment_changes["#{name}"].try(:pending_uploads) attachment_changes["#{name}"] = if attachables.none? ActiveStorage::Attached::Changes::DeleteMany.new("#{name}", self) else ActiveStorage::Attached::Changes::CreateMany.new("#{name}", self, attachables, pending_uploads: pending_uploads) end end CODE has_many :"#{name}_attachments", -> { where(name: name) }, as: :record, class_name: "ActiveStorage::Attachment", inverse_of: :record, dependent: :destroy, strict_loading: strict_loading has_many :"#{name}_blobs", through: :"#{name}_attachments", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading scope :"with_attached_#{name}", -> { if ActiveStorage.track_variants includes("#{name}_attachments": { blob: { variant_records: { image_attachment: :blob }, preview_image_attachment: { blob: { variant_records: { image_attachment: :blob } } } } }) else includes("#{name}_attachments": :blob) end } after_save { attachment_changes[name.to_s]&.save } after_commit(on: %i[ create update ]) { attachment_changes.delete(name.to_s).try(:upload) } reflection = ActiveRecord::Reflection.create( :has_many_attached, name, nil, { dependent: dependent, service_name: service }, self ) yield reflection if block_given? ActiveRecord::Reflection.add_attachment_reflection(self, name, reflection) end private def validate_service_configuration(association_name, service) if service.present? ActiveStorage::Blob.services.fetch(service) do raise ArgumentError, "Cannot configure service :#{service} for #{name}##{association_name}" end else validate_global_service_configuration end end def validate_global_service_configuration if connected? && ActiveStorage::Blob.table_exists? && Rails.configuration.active_storage.service.nil? raise RuntimeError, "Missing Active Storage service name. Specify Active Storage service name for config.active_storage.service in config/environments/#{Rails.env}.rb" end end end