class ActiveStorage::Attached::One
Representation of a single attachment to a model.
Public Instance Methods
attach(attachable)
click to toggle source
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/jpg") person.avatar.attach(avatar_blob) # ActiveStorage::Blob object
# File lib/active_storage/attached/one.rb, line 29 def attach(attachable) if record.persisted? && !record.changed? record.update(name => attachable) else record.public_send("#{name}=", attachable) end end
attached?()
click to toggle source
Returns true
if an attachment has been made.
class User < ActiveRecord::Base has_one_attached :avatar end User.new.avatar.attached? # => false
# File lib/active_storage/attached/one.rb, line 44 def attached? attachment.present? end
attachment()
click to toggle source
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.
# File lib/active_storage/attached/one.rb, line 11 def attachment change.present? ? change.attachment : record.public_send("#{name}_attachment") end
blank?()
click to toggle source
# File lib/active_storage/attached/one.rb, line 15 def blank? !attached? end
detach()
click to toggle source
Deletes the attachment without purging it, leaving its blob in place.
# File lib/active_storage/attached/one.rb, line 49 def detach if attached? attachment.delete write_attachment nil end end
purge()
click to toggle source
Directly purges the attachment (i.e. destroys the blob and attachment and deletes the file on the service).
# File lib/active_storage/attached/one.rb, line 58 def purge if attached? attachment.purge write_attachment nil end end
purge_later()
click to toggle source
Purges the attachment through the queuing system.
# File lib/active_storage/attached/one.rb, line 66 def purge_later if attached? attachment.purge_later write_attachment nil end end
Private Instance Methods
write_attachment(attachment)
click to toggle source
# File lib/active_storage/attached/one.rb, line 74 def write_attachment(attachment) record.public_send("#{name}_attachment=", attachment) end