aboutsummaryrefslogtreecommitdiffstats
path: root/lib/active_storage/attached/one.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/active_storage/attached/one.rb')
-rw-r--r--lib/active_storage/attached/one.rb17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/active_storage/attached/one.rb b/lib/active_storage/attached/one.rb
index d08d265992..80e4cb6234 100644
--- a/lib/active_storage/attached/one.rb
+++ b/lib/active_storage/attached/one.rb
@@ -1,18 +1,34 @@
+# 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
@attachment ||= ActiveStorage::Attachment.find_by(record_gid: record.to_gid.to_s, name: name)
end
+ # Associates a given attachment with the current record, saving it to the
+ # database.
def attach(attachable)
@attachment = ActiveStorage::Attachment.create!(record_gid: record.to_gid.to_s, name: name, blob: create_blob_from(attachable))
end
+ # Checks the presence of the attachment.
+ #
+ # 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
@@ -20,6 +36,7 @@ class ActiveStorage::Attached::One < ActiveStorage::Attached
end
end
+ # Purges the attachment through the queuing system.
def purge_later
if attached?
attachment.purge_later