Module: Paperclip::ClassMethods

Defined in:
lib/paperclip.rb

Instance Method Summary collapse

Instance Method Details

#attachment_definitions ⇒ Object

Returns the attachment definitions defined by each call to has_attached_file.



206
207
208
 
# File 'lib/paperclip.rb', line 206

def attachment_definitions
  read_inheritable_attribute(:attachment_definitions)
end

#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 “/:class/:attachment/:id/:style_:filename”. See Paperclip::Attachment#interpolate for more information on variable interpolaton.

    :url => "/:attachment/:id/:style_:basename:extension"
: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 “/:class/:attachment/missing_:style.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_thumbnails: Will raise an error if Paperclip cannot process thumbnails of an uploaded image. This will ovrride the global setting for this attachment. Defaults to true.

  • 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.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/paperclip.rb', line 113

def has_attached_file name, options = {}
  include InstanceMethods

  write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
  attachment_definitions[name] = {:validations => []}.merge(options)

  after_save :save_attached_files
  before_destroy :destroy_attached_files

  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|
    value.send(:flush_errors) unless value.valid?
  end
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 uploads 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.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/paperclip.rb', line 190

def validates_attachment_content_type name, options = {}
  attachment_definitions[name][:validations] << lambda do |attachment, instance|
    valid_types = [options[:content_type]].flatten
    
    unless attachment.original_filename.nil?
      unless options[:content_type].blank?
        content_type = instance[:"#{name}_content_type"]
        unless valid_types.any?{|t| t === content_type }
          options[:message] || "is not one of the allowed file types."
        end
      end
    end
  end
end

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

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



174
175
176
177
178
179
180
 
# File 'lib/paperclip.rb', line 174

def validates_attachment_presence name, options = {}
  attachment_definitions[name][:validations] << lambda do |attachment, instance|
    unless attachment.file?
      options[:message] || "must be set."
    end
  end
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/paperclip.rb', line 146

def validates_attachment_size name, options = {}
  attachment_definitions[name][:validations] << lambda do |attachment, instance|
    unless options[:greater_than].nil?
      options[:in] = (options[:greater_than]..(1/0)) # 1/0 => Infinity
    end
    unless options[:less_than].nil?
      options[:in] = (0..options[:less_than])
    end
    
    if attachment.file? && !options[:in].include?(instance[:"#{name}_file_size"].to_i)
      min = options[:in].first
      max = options[:in].last
      
      if options[:message]
        options[:message].gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
      else
        "file size is not between #{min} and #{max} bytes."
      end
    end
  end
end

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

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



169
170
171
 
# File 'lib/paperclip.rb', line 169

def validates_attachment_thumbnails name, options = {}
  attachment_definitions[name][:whiny_thumbnails] = true
end