diff options
author | Robin Dupret <robin.dupret@gmail.com> | 2017-07-07 14:20:38 +0200 |
---|---|---|
committer | Robin Dupret <robin.dupret@gmail.com> | 2017-07-07 18:41:37 +0200 |
commit | 27f87b68b26e4ac68fa9bf05e6003c61cdca854d (patch) | |
tree | ba8ee4ebbc80f42b32c9ca956f658b388aee3e1f /lib/active_storage/attached/many.rb | |
parent | c9846fc0e8d4faf4f4686c5bfe548431cdae837c (diff) | |
download | rails-27f87b68b26e4ac68fa9bf05e6003c61cdca854d.tar.gz rails-27f87b68b26e4ac68fa9bf05e6003c61cdca854d.tar.bz2 rails-27f87b68b26e4ac68fa9bf05e6003c61cdca854d.zip |
Add some documentation
Diffstat (limited to 'lib/active_storage/attached/many.rb')
-rw-r--r-- | lib/active_storage/attached/many.rb | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/active_storage/attached/many.rb b/lib/active_storage/attached/many.rb index f1535dfbc6..99d980196a 100644 --- a/lib/active_storage/attached/many.rb +++ b/lib/active_storage/attached/many.rb @@ -1,20 +1,36 @@ +# Representation of multiple attachments to a model. class ActiveStorage::Attached::Many < ActiveStorage::Attached delegate_missing_to :attachments + # Returns all the associated attachment records. + # + # You don't have to call this method to access the attachments' methods as + # they are all available at the model level. def attachments @attachments ||= ActiveStorage::Attachment.where(record_gid: record.to_gid.to_s, name: name) end + # Associates one or several attachments with the current record, saving + # them to the database. def attach(*attachables) @attachments = attachments | Array(attachables).flatten.collect do |attachable| ActiveStorage::Attachment.create!(record_gid: record.to_gid.to_s, name: name, blob: create_blob_from(attachable)) end end + # Checks the presence of attachments. + # + # class Gallery < ActiveRecord::Base + # has_many_attached :photos + # end + # + # Gallery.new.photos.attached? # => false def attached? attachments.any? end + # Directly purges each associated attachment (i.e. destroys the blobs and + # attachments and deletes the files on the service). def purge if attached? attachments.each(&:purge) @@ -22,6 +38,7 @@ class ActiveStorage::Attached::Many < ActiveStorage::Attached end end + # Purges each associated attachment through the queuing system. def purge_later if attached? attachments.each(&:purge_later) |