aboutsummaryrefslogtreecommitdiffstats
path: root/activestorage/lib/active_storage/attached/one.rb
blob: 0c522e856e5c6cdf0cf36291132d6f53b29a47b7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# Representation of a single attachment to a model.
class ActiveStorage::Attached::One < ActiveStorage::Attached
  delegate_missing_to :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.
  def attachment
    record.public_send("#{name}_attachment")
  end

  # Associates a given attachment with the current record, saving it to the database.
  # Examples:
  #
  #   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("~/face.jpg"), filename: "face.jpg", content_type: "image/jpg")
  #   person.avatar.attach(avatar_blob) # ActiveStorage::Blob object
  def attach(attachable)
    write_attachment \
      ActiveStorage::Attachment.create!(record: record, name: name, blob: create_blob_from(attachable))
  end

  # Returns true if an attachment has been made.
  #
  #   class User < ActiveRecord::Base
  #     has_one_attached :avatar
  #   end
  #
  #   User.new.avatar.attached? # => false
  def attached?
    attachment.present?
  end

  # Directly purges the attachment (i.e. destroys the blob and
  # attachment and deletes the file on the service).
  def purge
    if attached?
      attachment.purge
      write_attachment nil
    end
  end

  # Purges the attachment through the queuing system.
  def purge_later
    if attached?
      attachment.purge_later
    end
  end

  private
    def write_attachment(attachment)
      record.public_send("#{name}_attachment=", attachment)
    end
end