Skip to Content Skip to Search

Active Storage Attached One ↑

Representation of a single attachment to a model.

Methods
A
B
D
P

Instance Public methods

as_json(options = nil)

Returns the attachment record’s JSON representation, or nil when no attachment is present.

Source: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 53
def as_json(options = nil)
  attached? ? attachment.as_json(options) : nil
end

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: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 69
def attach(attachable)
  record.public_send("#{name}=", attachable)
  if record.persisted? && !record.changed?
    return if !record.save
  end
  record.public_send("#{name}")
end

attach!(attachable)

Calls attach, and raises an exception if the record was meant to be saved but at least one of the validations failed.

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: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 85
def attach!(attachable)
  attach(attachable) || raise(ActiveRecord::RecordNotSaved.new("Failed to save the record", record))
end

attached?()

Returns true if an attachment has been made.

class User < ApplicationRecord
  has_one_attached :avatar
end

User.new.avatar.attached? # => false

Source: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 98
def attached?
  attachment.present?
end

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: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 34
def attachment
  change.present? ? change.attachment : record.public_send("#{name}_attachment")
end

blank?()

Returns true if an attachment is not attached.

class User < ApplicationRecord
  has_one_attached :avatar
end

User.new.avatar.blank? # => true

Source: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 47
def blank?
  !attached?
end

detach

Deletes the attachment without purging it, leaving its blob in place.

Source: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 26
delegate :detach, to: :detach_one

purge

Directly purges the attachment (i.e. destroys the blob and attachment and deletes the file on the service).

Source: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 14
delegate :purge, to: :purge_one

purge_later

Purges the attachment through the queuing system.

Source: show | on GitHub 

# File activestorage/lib/active_storage/attached/one.rb, line 20
delegate :purge_later, to: :purge_one