The Attachment class manages the files for a given attachment. It saves when the model saves, deletes when the model is destroyed, and processes the file upon assignment.
# File lib/dm-paperclip/attachment.rb, line 7 def self.default_options @default_options ||= { :url => "/system/:attachment/:id/:style/:filename", :path => ":rails_root/public:url", :styles => {}, :default_url => "/:attachment/:style/missing.png", :default_style => :original, :validations => [], :storage => :filesystem, :whiny => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails] } end
Paths and URLs can have a number of variables interpolated into them to vary the storage location based on name, id, style, class, etc. This method is a deprecated access into supplying and retrieving these interpolations. Future access should use either Paperclip.interpolates or extend the Paperclip::Interpolations module directly.
# File lib/dm-paperclip/attachment.rb, line 208 def self.interpolations warn('[DEPRECATION] Paperclip::Attachment.interpolations is deprecated ' + 'and will be removed from future versions. ' + 'Use Paperclip.interpolates instead') Paperclip::Interpolations end
Creates an Attachment object. name is the name of the attachment, instance is the ActiveRecord object instance it's attached to, and options is the same as the hash passed to has_attached_file.
# File lib/dm-paperclip/attachment.rb, line 25 def initialize name, instance, options = {} @name = name @instance = instance options = self.class.default_options.merge(options) @url = options[:url] @url = @url.call(self) if @url.is_a?(Proc) @path = options[:path] @path = @path.call(self) if @path.is_a?(Proc) @styles = options[:styles] @styles = @styles.call(self) if @styles.is_a?(Proc) @default_url = options[:default_url] @validations = options[:validations] @default_style = options[:default_style] @storage = options[:storage] @whiny = options[:whiny_thumbnails] || options[:whiny] @convert_options = options[:convert_options] || {} @processors = options[:processors] || [:thumbnail] @options = options @queued_for_delete = [] @queued_for_write = {} @errors = {} @validation_errors = nil @dirty = false normalize_style_definition initialize_storage end
What gets called when you call instance.attachment = File. It clears errors, assigns attributes, processes the file, and runs validations. It also queues up the previous file for deletion, to be flushed away on save of its host. In addition to form uploads, you can also assign another Paperclip attachment:
new_user.avatar = old_user.avatar
If the file that is assigned is not valid, the processing (i.e. thumbnailing, etc) will NOT be run.
# File lib/dm-paperclip/attachment.rb, line 63 def assign uploaded_file ensure_required_accessors! if uploaded_file.is_a?(Paperclip::Attachment) uploaded_file = uploaded_file.to_file(:original) close_uploaded_file = uploaded_file.respond_to?(:close) end return nil unless valid_assignment?(uploaded_file) uploaded_file.binmode if uploaded_file.respond_to? :binmode self.clear return nil if uploaded_file.nil? if uploaded_file.respond_to?(:[]) uploaded_file = uploaded_file.to_mash @queued_for_write[:original] = uploaded_file['tempfile'] instance_write(:file_name, uploaded_file['filename'].strip.gsub(/[^\w\d\.\-]+/, '_')) instance_write(:content_type, uploaded_file['content_type'] ? uploaded_file['content_type'].strip : uploaded_file['tempfile'].content_type.to_s.strip) instance_write(:file_size, uploaded_file['size'] ? uploaded_file['size'].to_i : uploaded_file['tempfile'].size.to_i) instance_write(:updated_at, Time.now) else @queued_for_write[:original] = uploaded_file.to_tempfile instance_write(:file_name, uploaded_file.original_filename.strip.gsub(/[^\w\d\.\-]+/, '_')) instance_write(:content_type, uploaded_file.content_type.to_s.strip) instance_write(:file_size, uploaded_file.size.to_i) instance_write(:updated_at, Time.now) end @dirty = true post_process if valid? # Reset the file size if the original file was reprocessed. instance_write(:file_size, @queued_for_write[:original].size.to_i) ensure uploaded_file.close if close_uploaded_file validate end
Clears out the attachment. Has the same effect as previously assigning nil to the attachment. Does NOT save. If you wish to clear AND save, use destroy.
# File lib/dm-paperclip/attachment.rb, line 165 def clear queue_existing_for_delete @errors = {} @validation_errors = nil end
Returns the content_type of the file as originally assigned, and lives in the <attachment>_content_type attribute of the model.
# File lib/dm-paperclip/attachment.rb, line 193 def content_type instance_read(:content_type) end
Destroys the attachment. Has the same effect as previously assigning nil to the attachment *and saving*. This is permanent. If you wish to wipe out the existing attachment but not save, use clear.
# File lib/dm-paperclip/attachment.rb, line 174 def destroy clear save end
Returns true if there are changes that need to be saved.
# File lib/dm-paperclip/attachment.rb, line 144 def dirty? @dirty end
Returns an array containing the errors on this attachment.
# File lib/dm-paperclip/attachment.rb, line 139 def errors @errors end
Returns true if a file has been assigned.
# File lib/dm-paperclip/attachment.rb, line 238 def file? !original_filename.blank? end
Reads the attachment-specific attribute on the instance. See instance_write for more details.
# File lib/dm-paperclip/attachment.rb, line 254 def instance_read(attr) getter = :"#{name}_#{attr}" responds = instance.respond_to?(getter) cached = self.instance_variable_get("@_#{getter}") return cached if cached instance.send(getter) if responds || attr.to_s == "file_name" end
Writes the attachment-specific attribute on the instance. For example, instance_write(:file_name, "me.jpg") will write "me.jpg" to the instance's "avatar_file_name" field (assuming the attachment is called avatar).
# File lib/dm-paperclip/attachment.rb, line 245 def instance_write(attr, value) setter = :"#{name}_#{attr}=" responds = instance.respond_to?(setter) self.instance_variable_set("@_#{setter.to_s.chop}", value) instance.send(setter, value) if responds || attr.to_s == "file_name" end
Returns the name of the file as originally assigned, and lives in the <attachment>_file_name attribute of the model.
# File lib/dm-paperclip/attachment.rb, line 181 def original_filename instance_read(:file_name) end
Returns the path of the attachment as defined by the :path option. If the file is stored in the filesystem the path refers to the path of the file on disk. If the file is stored in S3, the path is the "key" part of the URL, and the :bucket option refers to the S3 bucket.
# File lib/dm-paperclip/attachment.rb, line 123 def path style = default_style original_filename.nil? ? nil : interpolate(@path, style) end
This method really shouldn't be called that often. It's expected use is in the paperclip:refresh rake task and that's it. It will regenerate all thumbnails forcefully, by reobtaining the original file and going through the post-process again.
# File lib/dm-paperclip/attachment.rb, line 219 def reprocess! new_original = Tempfile.new("paperclip-reprocess") new_original.binmode if old_original = to_file(:original) new_original.write( old_original.read ) new_original.rewind @queued_for_write = { :original => new_original } post_process old_original.close if old_original.respond_to?(:close) save else true end end
Saves the file, if there are no errors. If there are, it flushes them to the instance's errors and returns false, cancelling the save.
# File lib/dm-paperclip/attachment.rb, line 150 def save if valid? flush_deletes flush_writes @dirty = false true else flush_errors false end end
Returns the size of the file as originally assigned, and lives in the <attachment>_file_size attribute of the model.
# File lib/dm-paperclip/attachment.rb, line 187 def size instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size) end
Alias to url
# File lib/dm-paperclip/attachment.rb, line 128 def to_s style = nil url(style) end
Returns the last modified time of the file as originally assigned, and lives in the <attachment>_updated_at attribute of the model.
# File lib/dm-paperclip/attachment.rb, line 199 def updated_at instance_read(:updated_at) end
Returns the public URL of the attachment, with a given style. Note that this does not necessarily need to point to a file that your web server can access and can point to an action in your app, if you need fine grained security. This is not recommended if you don't need the security, however, for performance reasons. set include_updated_timestamp to false if you want to stop the attachment update time appended to the url
# File lib/dm-paperclip/attachment.rb, line 114 def url style = default_style, include_updated_timestamp = true the_url = original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style) include_updated_timestamp && updated_at ? [the_url, updated_at.to_time.to_i].compact.join(the_url.include?("?") ? "&" : "?") : the_url end
Generated with the Darkfish Rdoc Generator 2.