Class: ActiveStorage::Attached::Many

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

Overview

Decorated proxy object representing of multiple attachments 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(*attachables) ⇒ Object

Attaches one or more attachables to the record.

If the record is persisted and unchanged, the attachments are saved to the database immediately. Otherwise, they'll be saved to the DB when the record is next saved.

document.images.attach(params[:images]) # Array of ActionDispatch::Http::UploadedFile objects
document.images.attach(params[:signed_blob_id]) # Signed reference to blob from direct upload
document.images.attach(io: File.open("/path/to/racecar.jpg"), filename: "racecar.jpg", content_type: "image/jpeg")
document.images.attach([ first_blob, second_blob ])

49
50
51
52
53
54
55
56
57
58
59
60
# File 'activestorage/lib/active_storage/attached/many.rb', line 49

def attach(*attachables)
  if record.persisted? && !record.changed?
    record.public_send("#{name}=", blobs + attachables.flatten)
    if record.save
      record.public_send("#{name}")
    else
      false
    end
  else
    record.public_send("#{name}=", (change&.attachables || blobs) + attachables.flatten)
  end
end

#attached?Boolean

Returns true if any attachments have been made.

class Gallery < ApplicationRecord
  has_many_attached :photos
end

Gallery.new.photos.attached? # => false

Returns:

  • (Boolean)

69
70
71
# File 'activestorage/lib/active_storage/attached/many.rb', line 69

def attached?
  attachments.any?
end

#attachmentsObject

Returns all the associated attachment records.

All methods called on this proxy object that aren't listed here will automatically be delegated to attachments.


30
31
32
# File 'activestorage/lib/active_storage/attached/many.rb', line 30

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

#blobsObject

Returns all attached blobs.


35
36
37
# File 'activestorage/lib/active_storage/attached/many.rb', line 35

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

#detachObject

:method: detach

Deletes associated attachments without purging them, leaving their respective blobs in place.


23
# File 'activestorage/lib/active_storage/attached/many.rb', line 23

delegate :detach, to: :detach_many

#purgeObject

:method: purge

Directly purges each associated attachment (i.e. destroys the blobs and attachments and deletes the files on the service).


11
# File 'activestorage/lib/active_storage/attached/many.rb', line 11

delegate :purge, to: :purge_many

#purge_laterObject

:method: purge_later

Purges each associated attachment through the queuing system.


17
# File 'activestorage/lib/active_storage/attached/many.rb', line 17

delegate :purge_later, to: :purge_many