Parent

Included Modules

Files

Paperclip::Attachment

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.

Attributes

convert_options[R]
default_style[R]
instance[R]
name[R]
options[R]
post_processing[RW]
queued_for_write[R]
whiny[R]

Public Class Methods

default_options() click to toggle source
# File lib/dm-paperclip/attachment.rb, line 7
def self.default_options
  @default_options ||= {
    :url                   => "/system/:attachment/:id/:style/:filename",
    :path                  => ":web_root/public:url",
    :styles                => {},
    :processors            => [:thumbnail],
    :convert_options       => {},
    :default_url           => "/:attachment/:style/missing.png",
    :default_style         => :original,
    :validations           => [],
    :storage               => :filesystem,
    :use_timestamp         => true,
    :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails],
    :use_default_time_zone => true,
    :hash_digest           => "SHA1",
    :hash_data             => ":class/:attachment/:id/:style/:updated_at"
  }
end
interpolations() click to toggle source

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 260
def self.interpolations
  warn('[DEPRECATION] Paperclip::Attachment.interpolations is deprecated ' +
       'and will be removed from future versions. ' +
       'Use Paperclip.interpolates instead')
  Paperclip::Interpolations
end
new(name, instance, options = {}) click to toggle source

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 32
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]
  @normalized_styles     = nil
  @default_url           = options[:default_url]
  @validations           = options[:validations]
  @default_style         = options[:default_style]
  @storage               = options[:storage]
  @use_timestamp         = options[:use_timestamp]
  @whiny                 = options[:whiny_thumbnails] || options[:whiny]
  @use_default_time_zone = options[:use_default_time_zone]
  @hash_digest           = options[:hash_digest]
  @hash_data             = options[:hash_data]
  @hash_secret           = options[:hash_secret]
  @convert_options       = options[:convert_options]
  @processors            = options[:processors]
  @options               = options
  @post_processing       = true
  @queued_for_delete     = []
  @queued_for_write      = {}
  @errors                = {}
  @validation_errors     = nil
  @dirty                 = false

  initialize_storage
end

Public Instance Methods

assign(uploaded_file) click to toggle source

What gets called when you call instance.attachment = File. It clears errors, assigns attributes, and processes the file. 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
# File lib/dm-paperclip/attachment.rb, line 87
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 = DataMapper::Mash.new(uploaded_file)

    @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 || # sometimes it is 'type' instead of 'content_type'
                                        uploaded_file['type'] && uploaded_file['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)
  else
    @queued_for_write[:original]   = to_tempfile(uploaded_file)
    instance_write(:file_name,       uploaded_file.original_filename.strip)
    instance_write(:content_type,    uploaded_file.content_type.to_s.strip)
    instance_write(:file_size,       uploaded_file.size.to_i)
  end

  @dirty = true

  post_process if @post_processing && valid?

  # Reset the file size if the original file was reprocessed.
  instance_write(:file_size,   @queued_for_write[:original].size.to_i)
  instance_write(:fingerprint, generate_fingerprint(@queued_for_write[:original]))
  instance_write(:updated_at,      DateTime.now)
ensure
  uploaded_file.close if close_uploaded_file
  validate
end
clear() click to toggle source

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 189
def clear
  queue_existing_for_delete
  @errors            = {}
  @validation_errors = nil
end
content_type() click to toggle source

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 223
def content_type
  instance_read(:content_type)
end
destroy() click to toggle source

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 198
def destroy
  clear
  save
end
dirty?() click to toggle source

Returns true if there are changes that need to be saved.

# File lib/dm-paperclip/attachment.rb, line 168
def dirty?
  @dirty
end
errors() click to toggle source

Returns an array containing the errors on this attachment.

# File lib/dm-paperclip/attachment.rb, line 163
def errors
  @errors
end
file?() click to toggle source

Returns true if a file has been assigned.

# File lib/dm-paperclip/attachment.rb, line 293
def file?
  !Paperclip::Ext.blank?(original_filename)
end
fingerprint() click to toggle source

Returns the hash of the file as originally assigned, and lives in the <attachment>_fingerprint attribute of the model.

# File lib/dm-paperclip/attachment.rb, line 217
def fingerprint
  instance_read(:fingerprint) || (@queued_for_write[:original] && generate_fingerprint(@queued_for_write[:original]))
end
generate_fingerprint(source) click to toggle source
# File lib/dm-paperclip/attachment.rb, line 249
def generate_fingerprint(source)
  data = source.read
  source.rewind if source.respond_to?(:rewind)
  Digest::MD5.hexdigest(data)
end
hash(style_name = default_style) click to toggle source

Returns a unique hash suitable for obfuscating the URL of an otherwise publicly viewable attachment.

# File lib/dm-paperclip/attachment.rb, line 242
def hash(style_name = default_style)
  raise ArgumentError, "Unable to generate hash without :hash_secret" unless @hash_secret
  require 'openssl' unless defined?(OpenSSL)
  data = interpolate(@hash_data, style_name)
  OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@hash_digest).new, @hash_secret, data)
end
instance_read(attr) click to toggle source

Reads the attachment-specific attribute on the instance. See instance_write for more details.

# File lib/dm-paperclip/attachment.rb, line 309
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
instance_write(attr, value) click to toggle source

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 300
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
original_filename() click to toggle source

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 205
def original_filename
  instance_read(:file_name)
end
path(style_name = default_style) click to toggle source

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 147
def path style_name = default_style
  original_filename.nil? ? nil : interpolate(@path, style_name)
end
processors() click to toggle source
# File lib/dm-paperclip/attachment.rb, line 77
def processors
  @processors.respond_to?(:call) ? @processors.call(instance) : @processors
end
reprocess!(*style_args) click to toggle source

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 271
def reprocess!(*style_args)
  new_original = Tempfile.new("paperclip-reprocess")
  new_original.binmode
  if old_original = to_file(:original)
    new_original.write( old_original.respond_to?(:get) ? old_original.get : old_original.read )
    new_original.rewind

    @queued_for_write = { :original => new_original }
    post_process(*style_args)

    old_original.close if old_original.respond_to?(:close)

    save
  else
    true
  end
rescue Errno::EACCES => e
  log "Skipping file: #{e.message}"
  false
end
save() click to toggle source

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 174
def save
  if valid?
    flush_deletes
    flush_writes
    @dirty = false
    true
  else
    flush_errors
    false
  end
end
size() click to toggle source

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 211
def size
  instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size)
end
styles() click to toggle source
# File lib/dm-paperclip/attachment.rb, line 67
def styles
  unless @normalized_styles
    @normalized_styles = {}
    (@styles.respond_to?(:call) ? @styles.call(self) : @styles).each do |name, args|
      @normalized_styles[name] = Paperclip::Style.new(name, args.dup, self)
    end
  end
  @normalized_styles
end
to_s(style_name = default_style) click to toggle source

Alias to url

# File lib/dm-paperclip/attachment.rb, line 152
def to_s style_name = default_style
  url(style_name)
end
updated_at() click to toggle source

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 229
def updated_at
  time = instance_read(:updated_at)
  return nil unless time

  if time.is_a?(DateTime)
    time && ((time - ::DateTime.civil(1970)) * 86_400).to_i
  else
    time.to_i
  end
end
url(style_name = default_style, use_timestamp = @use_timestamp) click to toggle source

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 use_timestamp to false if you want to stop the attachment update time appended to the url

# File lib/dm-paperclip/attachment.rb, line 138
def url(style_name = default_style, use_timestamp = @use_timestamp)
  url = original_filename.nil? ? interpolate(@default_url, style_name) : interpolate(@url, style_name)
  use_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
end
valid?() click to toggle source

Returns true if there are no errors on this attachment.

# File lib/dm-paperclip/attachment.rb, line 157
def valid?
  validate
  errors.empty?
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.