Module: Paperclip::ClassMethods

Defined in:
lib/paperclip.rb,
lib/smarter_paperclip.rb

Instance Method Summary collapse

Instance Method Details

#has_attached_file(name, options = {}) ⇒ Object

has_attached_file gives the class it is called on an attribute that maps to a file. This is typically a file stored somewhere on the filesystem and has been uploaded by a user. The attribute returns a Paperclip::Attachment object which handles the management of that file. The intent is to make the attachment as much like a normal attribute. The thumbnails will be created when the new file is assigned, but they will not be saved until save is called on the record. Likewise, if the attribute is set to nil is called on it, the attachment will not be deleted until save is called. See the Paperclip::Attachment documentation for more specifics. There are a number of options you can set to change the behavior of a Paperclip attachment:

  • url: The full URL of where the attachment is publically accessible. This can just as easily point to a directory served directly through Apache as it can to an action that can control permissions. You can specify the full domain and path, but usually just an absolute path is sufficient. The leading slash must be included manually for absolute paths. The default value is “/system/:attachment/:id/:style/:filename”. See Paperclip::Attachment#interpolate for more information on variable interpolaton.

    :url => "/:class/:attachment/:id/:style_:filename"
:url => "http://some.other.host/stuff/:class/:id_:extension"

  • default_url: The URL that will be returned if there is no attachment assigned. This field is interpolated just as the url is. The default value is “/:attachment/:style/missing.png”

    has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
User.new.avatar_url(:small) # => "/images/default_small_avatar.png"

  • styles: A hash of thumbnail styles and their geometries. You can find more about geometry strings at the ImageMagick website (www.imagemagick.org/script/command-line-options.php#resize). Paperclip also adds the “#” option (e.g. “50x50#”), which will resize the image to fit maximally inside the dimensions and then crop the rest off (weighted at the center). The default value is to generate no thumbnails.

  • default_style: The thumbnail style that will be used by default URLs. Defaults to original.

    has_attached_file :avatar, :styles => { :normal => "100x100#" },
                  :default_style => :normal
user.avatar.url # => "/avatars/23/normal_me.png"

  • whiny: Will raise an error if Paperclip cannot post_process an uploaded file due to a command line error. This will override the global setting for this attachment. Defaults to true. This option used to be called :whiny_thumbanils, but this is deprecated.

  • convert_options: When creating thumbnails, use this free-form options array to pass in various convert command options. Typical options are “-strip” to remove all Exif data from the image (save space for thumbnails and avatars) or “-depth 8” to specify the bit depth of the resulting conversion. See ImageMagick convert documentation for more options: (www.imagemagick.org/script/convert.php) Note that this option takes a hash of options, each of which correspond to the style of thumbnail being generated. You can also specify :all as a key, which will apply to all of the thumbnails being generated. If you specify options for the :original, it would be best if you did not specify destructive options, as the intent of keeping the original around is to regenerate all the thumbnails when requirements change.

    has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
                           :convert_options => {
                             :all => "-strip",
                             :negative => "-negate"
                           }

    NOTE: While not deprecated yet, it is not recommended to specify options this way. It is recommended that :convert_options option be included in the hash passed to each :styles for compatability with future versions. NOTE: Strings supplied to :convert_options are split on space in order to undergo shell quoting for safety. If your options require a space, please pre-split them and pass an array to :convert_options instead.

  • storage: Chooses the storage backend where the files will be stored. The current choices are :filesystem and :s3. The default is :filesystem. Make sure you read the documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3 for backend-specific options.



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/paperclip.rb', line 229

def has_attached_file name, options = {}
  include InstanceMethods

  unless self.methods.include?(:attachment_definitions)
    class_attribute :attachment_definitions
    self.attachment_definitions = {} if self.attachment_definitions.nil?
    self.attachment_definitions[name] = {:validations => []}.merge(options)
  else
    self.attachment_definitions[name] = {:validations => []}.merge(options)
  end

  after_save :save_attached_files
  before_destroy :destroy_attached_files

  define_paperclip_callbacks :post_process, :"#{name}_post_process"

  define_method name do |*args|
    a = attachment_for(name)
    (args.length > 0) ? a.to_s(args.first) : a
  end

  define_method "#{name}=" do |file|
    attachment_for(name).assign(file)
  end

  define_method "#{name}?" do
    attachment_for(name).file?
  end

  validates_each(name) do |record, attr, value|
    attachment = record.attachment_for(name)
    attachment.send(:flush_errors)
  end
end

#has_interpolated_attached_file(name, options = {}) ⇒ Object

Allows you to use interpolations embed to object instance without worrying about file renaming. It rename them for you. Just use it instead of has_attached_file Params:

  • same as has_attached_file

Of course you can use it instead of has_attached_file all the time, because with standard (not interpolated) models - it works same as has_attached_file



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/smarter_paperclip.rb', line 52

def has_interpolated_attached_file name, options = {}

  # Get old pathes to all files from file and save in instance variable
  before_update do |record|
    @interpolated_names = {} unless @interpolated_names
    @interpolated_names[name] = {} unless @interpolated_names[name]
    old_record = self.class.find(record.id)
    (record.send(name).styles.keys+[:original]).each do |style|
      @interpolated_names[name][style] = old_record.send(name).path(style)
    end
  end

  # If validation has been passed - move files to a new location
  after_update do |record|
    (record.send(name).styles.keys+[:original]).each do |style|
      orig_path = @interpolated_names[name][style]
      dest_path = record.send(name).path(style)
      if orig_path && dest_path && File.exist?(orig_path) && orig_path != dest_path
        FileUtils.move(orig_path, dest_path)
      end
    end
  end

  # If renaming (or other callbacks) went wrong - restore old names to files
  after_rollback do |record|
    return unless @interpolated_names
    (record.send(name).styles.keys+[:original]).each do |style|
      dest_path = @interpolated_names[name][style]
      orig_path = record.send(name).path(style)
      if orig_path && dest_path && File.exist?(orig_path) && orig_path != dest_path
        FileUtils.move(orig_path, dest_path)
      end
    end
  end

  has_attached_file name, options
end

#validates_attachment_content_type(name, options = {}) ⇒ Object

Places ActiveRecord-style validations on the content type of the file assigned. The possible options are:

  • content_type: Allowed content types. Can be a single content type or an array. Each type can be a String or a Regexp. It should be noted that Internet Explorer upload files with content_types that you may not expect. For example, JPEG images are given image/pjpeg and PNGs are image/x-png, so keep that in mind when determining how you match. Allows all by default.

  • message: The message to display when the uploaded file has an invalid content type.

  • if: A lambda or name of a method on the instance. Validation will only be run is this lambda or method returns true.

  • unless: Same as if but validates if lambda or method returns false.

NOTE: If you do not specify an [attachment]_content_type field on your model, content_type validation will work _ONLY upon assignment_ and re-validation after the instance has been reloaded will always succeed.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/paperclip.rb', line 334

def validates_attachment_content_type name, options = {}
  validation_options = options.dup
  allowed_types = [validation_options[:content_type]].flatten
  validates_each(:"#{name}_content_type", validation_options) do |record, attr, value|
    if !allowed_types.any?{|t| t === value } && !(value.nil? || value.blank?)
      if record.errors.method(:add).arity == -2
        message = options[:message] || "is not one of #{allowed_types.join(", ")}"
        message = message.call if message.is_a?(Proc)
        record.errors.add(:"#{name}", message)
      else
        record.errors.add(:"#{name}", :inclusion, :default => options[:message], :value => value)
      end
    end
  end
end

#validates_attachment_if_included(name, options = {}) ⇒ Object

It force attachment validation only if attachment (file) was send if file was not send - it will not validate it (will pass without errors)



38
39
40
41
 
# File 'lib/smarter_paperclip.rb', line 38

def validates_attachment_if_included name, options = {}
  options[:if] = Proc.new { |imports| imports.send(name).file? }
  validates_attachment_presence name, options
end

#validates_attachment_minimum_resolution(name, options = {}) ⇒ Object

Picture minimal resolution validation Parameters

  • name - name of file field that should be validated

  • width - minimal picture width

  • height - minimal picture height

  • message - error message - can be a Proc



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/smarter_paperclip.rb', line 13

def validates_attachment_minimum_resolution name, options = {}
  validation_options = options.dup
  validates_each(name, validation_options) do |record, attr, value|
    unless record.errors.include?(name)
      m_width  = options[:width]
      m_height = options[:height]
      message = options[:message] || "must be bigger."
      message = message.call if message.is_a?(Proc)
      image = record.send(name)
      if image && image.queued_for_write[:original]
        dimensions = Paperclip::Geometry.from_file(image.queued_for_write[:original])
        if dimensions.width < m_width || dimensions.height < m_height
          if record.errors.method(:add).arity == -2
            record.errors.add(:"#{name}", message)
          else
            record.errors.add(:"#{name}", :inclusion, :default => options[:message], :value => value)
          end
        end
      end
    end
  end
end

#validates_attachment_presence(name, options = {}) ⇒ Object

Places ActiveRecord-style validations on the presence of a file. Options:

  • if: A lambda or name of a method on the instance. Validation will only be run is this lambda or method returns true.

  • unless: Same as if but validates if lambda or method returns false.



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/paperclip.rb', line 307

def validates_attachment_presence name, options = {}
  message = options[:message] || "must be set."
  # What a crazy workaround ;)
  msg = Proc.new{message.call} if message.is_a?(Proc)
  validate proc{ |object|
    object.errors.add(name, msg) if object.send("#{name}_file_name").blank?
  }, 
  :if => options[:if],
  :unless => options[:unless]
end

#validates_attachment_size(name, options = {}) ⇒ Object

Places ActiveRecord-style validations on the size of the file assigned. The possible options are:

  • in: a Range of bytes (i.e. 1..1.megabyte),

  • less_than: equivalent to :in => 0..options

  • greater_than: equivalent to :in => options..Infinity

  • message: error message to display, use :min and :max as replacements

  • if: A lambda or name of a method on the instance. Validation will only be run is this lambda or method returns true.

  • unless: Same as if but validates if lambda or method returns false.



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/paperclip.rb', line 273

def validates_attachment_size name, options = {}
  min     = options[:greater_than] || (options[:in] && options[:in].first) || 0
  max     = options[:less_than]    || (options[:in] && options[:in].last)  || (1.0/0)
  range   = (min..max)
  message = options[:message] || "file size must be between :min and :max bytes."
  message = message.call if message.is_a?(Proc)
  message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s) if message.is_a?(String)

  validates_inclusion_of :"#{name}_file_size",
                         :in        => range,
                         :message   => message,
                         :if        => options[:if],
                         :unless    => options[:unless],
                         :allow_nil => true
  validate do |subject|
    unless subject.errors[:"#{name}_file_size"].empty?
      subject.errors.add(:"#{name}", subject.errors[:"#{name}_file_size"].first)
    end
  end
end

#validates_attachment_thumbnails(name, options = {}) ⇒ Object

Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.



295
296
297
298
299
300
 
# File 'lib/paperclip.rb', line 295

def validates_attachment_thumbnails name, options = {}
  warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
       'This validation is on by default and will be removed from future versions. ' +
       'If you wish to turn it off, supply :whiny => false in your definition.')
  self.attachment_definitions[name][:whiny_thumbnails] = true
end