Class: ActiveStorage::Attached::One

Inherits:
ActiveStorage::Attached show all
Defined in:
activestorage/lib/active_storage/attached/one.rb

Overview

Representation of a single attachment to a model.

Instance Attribute Summary

Attributes inherited from ActiveStorage::Attached

#name, #record

Instance Method Summary collapse

Methods inherited from ActiveStorage::Attached

#initialize

Constructor Details

This class inherits a constructor from ActiveStorage::Attached

Instance Method Details

#attach(attachable) ⇒ Object

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

30
31
32
33
34
35
36
37
# File 'activestorage/lib/active_storage/attached/one.rb', line 30

def attach(attachable)
  if record.persisted? && !record.changed?
    record.public_send("#{name}=", attachable)
    record.save
  else
    record.public_send("#{name}=", attachable)
  end
end

#attached?Boolean

Returns true if an attachment has been made.

class User < ApplicationRecord
  has_one_attached :avatar
end

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

Returns:

  • (Boolean)

46
47
48
# File 'activestorage/lib/active_storage/attached/one.rb', line 46

def attached?
  attachment.present?
end

#attachmentObject

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.


12
13
14
# File 'activestorage/lib/active_storage/attached/one.rb', line 12

def attachment
  change.present? ? change.attachment : record.public_send("#{name}_attachment")
end

#blank?Boolean

Returns:

  • (Boolean)

16
17
18
# File 'activestorage/lib/active_storage/attached/one.rb', line 16

def blank?
  !attached?
end

#detachObject

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


51
52
53
54
55
56
# File 'activestorage/lib/active_storage/attached/one.rb', line 51

def detach
  if attached?
    attachment.delete
    write_attachment nil
  end
end

#purgeObject

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


60
61
62
63
64
65
# File 'activestorage/lib/active_storage/attached/one.rb', line 60

def purge
  if attached?
    attachment.purge
    write_attachment nil
  end
end

#purge_laterObject

Purges the attachment through the queuing system.


68
69
70
71
72
73
# File 'activestorage/lib/active_storage/attached/one.rb', line 68

def purge_later
  if attached?
    attachment.purge_later
    write_attachment nil
  end
end