Active Storage Attached One
Representation of a single attachment to a model.
Methods
Instance Public methods
attach(attachable)
Attaches an attachable
to the record.
If the record is persisted and unchanged, the attachment is saved to the database immediately. Otherwise, itβll be saved to the DB when the record is next saved.
person.avatar.attach(params[:avatar]) # ActionDispatch::Http::UploadedFile object
person.avatar.attach(params[:signed_blob_id]) # Signed reference to blob from direct upload
person.avatar.attach(io: File.open("/path/to/face.jpg"), filename: "face.jpg", content_type: "image/jpeg")
person.avatar.attach(avatar_blob) # ActiveStorage::Blob object
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 58
def attach(attachable)
record.public_send("#{name}=", attachable)
if record.persisted? && !record.changed?
return if !record.save
end
record.public_send("#{name}")
end
π See on GitHub
attached?()
Returns true
if an attachment has been made.
class User < ApplicationRecord
has_one_attached :avatar
end
User.new.avatar.attached? # => false
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 73
def attached?
attachment.present?
end
π See on GitHub
attachment()
Returns the associated attachment record.
You donβt have to call this method to access the attachmentβs methods as they are all available at the model level.
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 33
def attachment
change.present? ? change.attachment : record.public_send("#{name}_attachment")
end
π See on GitHub
blank?()
Returns true
if an attachment is not attached.
class User < ApplicationRecord
has_one_attached :avatar
end
User.new.avatar.blank? # => true
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 44
def blank?
!attached?
end
π See on GitHub
detach
Deletes the attachment without purging it, leaving its blob in place.
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 25
delegate :detach, to: :detach_one
π See on GitHub
purge
Directly purges the attachment (i.e. destroys the blob and attachment and deletes the file on the service).
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 13
delegate :purge, to: :purge_one
π See on GitHub
purge_later
Purges the attachment through the queuing system.
π Source code
# File activestorage/lib/active_storage/attached/one.rb, line 19
delegate :purge_later, to: :purge_one
π See on GitHub