Module: Paperclip::ClassMethods
- Defined in:
- lib/paperclip.rb
Instance Method Summary collapse
-
#attachment_definitions ⇒ Object
Returns the attachment definitions defined by each call to has_attached_file.
-
#has_attached_file(name, options = {}) ⇒ Object
has_attached_file
gives the class it is called on an attribute that maps to a file. -
#validates_attachment_content_type(name, options = {}) ⇒ Object
Places ActiveRecord-style validations on the content type of the file assigned.
-
#validates_attachment_presence(name, options = {}) ⇒ Object
Places ActiveRecord-style validations on the presence of a file.
-
#validates_attachment_size(name, options = {}) ⇒ Object
Places ActiveRecord-style validations on the size of the file assigned.
-
#validates_attachment_thumbnails(name, options = {}) ⇒ Object
Adds errors if thumbnail creation fails.
Instance Method Details
#attachment_definitions ⇒ Object
Returns the attachment definitions defined by each call to has_attached_file.
270 271 272 |
# File 'lib/paperclip.rb', line 270 def 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 “/system/:attachment/:id/:style/:basename.:extension”. See Paperclip::Attachment#interpolate for more information on variable interpolaton.:url => "/:class/: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 “/: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 tooriginal
.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 post_process an uploaded file due to a command line error. This will override the global setting for this attachment. Defaults to true. -
convert_options
: When creating thumbnails, use this free-form options field 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" }
-
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.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/paperclip.rb', line 181 def has_attached_file name, = {} include InstanceMethods write_inheritable_attribute(:attachment_definitions, {}) if .nil? [name] = {:validations => {}}.merge() after_save :save_attached_files before_destroy :destroy_attached_files define_callbacks :before_post_process, :after_post_process define_callbacks :"before_#{name}_post_process", :"after_#{name}_post_process" define_method name do |*args| a = (name) (args.length > 0) ? a.to_s(args.first) : a end define_method "#{name}=" do |file| (name).assign(file) end define_method "#{name}?" do (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 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.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/paperclip.rb', line 253 def name, = {} [name][:validations][:content_type] = lambda do |, instance| valid_types = [[:content_type]].flatten unless .original_filename.blank? unless valid_types.blank? content_type = .instance_read(:content_type) unless valid_types.any?{|t| t === content_type } [: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.
236 237 238 239 240 241 |
# File 'lib/paperclip.rb', line 236 def name, = {} = [:message] || "must be set." [name][:validations][:presence] = lambda do |, instance| unless .file? 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
217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/paperclip.rb', line 217 def name, = {} min = [:greater_than] || ([:in] && [:in].first) || 0 max = [:less_than] || ([:in] && [:in].last) || (1.0/0) range = (min..max) = [:message] || "file size must be between :min and :max bytes." [name][:validations][:size] = lambda do |, instance| if .file? && !range.include?(.size.to_i) .gsub(/:min/, min.to_s).gsub(/:max/, max.to_s) end end end |
#validates_attachment_thumbnails(name, options = {}) ⇒ Object
Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
231 232 233 |
# File 'lib/paperclip.rb', line 231 def name, = {} [name][:whiny_thumbnails] = true end |