module ActiveStorage::Attached::Model
def attachment_changes # :nodoc:
def attachment_changes # :nodoc: @attachment_changes ||= {} end
def changed_for_autosave? # :nodoc:
def changed_for_autosave? # :nodoc: super || attachment_changes.any? end
def has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
active_storage_attachments.record_type polymorphic type column of
When renaming classes that use has_many, make sure to also update the class names in the
Note: Active Storage relies on polymorphic associations, which in turn store class names in the database.
end
has_many_attached :photos, strict_loading: true
class Gallery < ApplicationRecord
pass the +:strict_loading+ option. You can do:
If you need to enable +strict_loading+ to prevent lazy loading of attachments,
Gallery.where(user: Current.user).with_attached_photos
To avoid N+1 queries, you can include the attached blobs in your query like so:
end
has_many_attached :photos, service: ->(gallery) { gallery.personal? ? :personal_s3 : :s3 }
class Gallery < ActiveRecord::Base
+:service+ can also be specified as a proc, and it will be called with the model instance:
end
has_many_attached :photos, service: :s3
class Gallery < ActiveRecord::Base
pass the +:service+ option. For example:
If you need the attachment to use a service which differs from the globally configured one,
+purge+ instead.
If an ActiveJob::Backend queue adapter is not set in the application set it to
purged (i.e. destroyed) in the background whenever the record is destroyed.
The +:dependent+ option defaults to +:purge_later+. This means the attachments will be
user.photos.attach(uploaded_file)
provide access to the associations and factory methods, like +attach+:
Instead, +has_many_attached+ generates an ActiveStorage::Attached::Many proxy to
most circumstances.
and +photos_blobs+. But you shouldn't need to work with these associations directly in
ActiveStorage::Blob record. These associations are available as +photos_attachments+
ActiveStorage::Attachment record and a +has_many-through+ association to a
Under the covers, this relationship is implemented as a +has_many+ association to a
care of the mapping between your records and the attachments.
There are no columns defined on the model side, Active Storage takes
end
has_many_attached :photos
class Gallery < ApplicationRecord
Specifies the relation between multiple attachments and the model.
def has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false) Attached::Model.validate_service_configuration(service, self, name) unless service.is_a?(Proc) 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
def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
active_storage_attachments.record_type polymorphic type column of
When renaming classes that use has_one_attached, make sure to also update the class names in the
Note: Active Storage relies on polymorphic associations, which in turn store class names in the database.
end
has_one_attached :avatar, strict_loading: true
class User < ApplicationRecord
pass the +:strict_loading+ option. You can do:
If you need to enable +strict_loading+ to prevent lazy loading of attachment,
User.with_attached_avatar
To avoid N+1 queries, you can include the attached blobs in your query like so:
end
has_one_attached :avatar, service: ->(user) { user.in_europe_region? ? :s3_europe : :s3_usa }
class User < ActiveRecord::Base
+:service+ can also be specified as a proc, and it will be called with the model instance:
end
has_one_attached :avatar, service: :s3
class User < ActiveRecord::Base
pass the +:service+ option. For example:
If you need the attachment to use a service which differs from the globally configured one,
+purge+ instead.
If an ActiveJob::Backend queue adapter is not set in the application set it to
purged (i.e. destroyed) in the background whenever the record is destroyed.
The +:dependent+ option defaults to +:purge_later+. This means the attachment will be
user.avatar.attach(uploaded_file)
provide access to the associations and factory methods, like +attach+:
Instead, +has_one_attached+ generates an ActiveStorage::Attached::One proxy to
most circumstances.
and +avatar_blob+. But you shouldn't need to work with these associations directly in
ActiveStorage::Blob record. These associations are available as +avatar_attachment+
ActiveStorage::Attachment record and a +has_one-through+ association to a
Under the covers, this relationship is implemented as a +has_one+ association to a
care of the mapping between your records and the attachment.
There is no column defined on the model side, Active Storage takes
end
has_one_attached :avatar
class User < ApplicationRecord
Specifies the relation between a single attachment and the model.
def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false) Attached::Model.validate_service_configuration(service, self, name) unless service.is_a?(Proc) 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
def initialize_dup(*) # :nodoc:
def initialize_dup(*) # :nodoc: super @active_storage_attached = nil @attachment_changes = nil end
def reload(*) # :nodoc:
def reload(*) # :nodoc: super.tap { @attachment_changes = nil } end
def validate_global_service_configuration(model_class)
def validate_global_service_configuration(model_class) if model_class.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
def validate_service_configuration(service_name, model_class, association_name) # :nodoc:
def validate_service_configuration(service_name, model_class, association_name) # :nodoc: if service_name ActiveStorage::Blob.services.fetch(service_name) do raise ArgumentError, "Cannot configure service #{service_name.inspect} for #{model_class}##{association_name}" end else validate_global_service_configuration(model_class) end end