lib/paperclip.rb in paperclip-2.1.2 vs lib/paperclip.rb in paperclip-2.1.5
- old
+ new
@@ -31,14 +31,15 @@
require 'paperclip/geometry'
require 'paperclip/thumbnail'
require 'paperclip/storage'
require 'paperclip/attachment'
-# The base module that gets included in ActiveRecord::Base.
+# The base module that gets included in ActiveRecord::Base. See the
+# documentation for Paperclip::ClassMethods for more useful information.
module Paperclip
- VERSION = "2.1.2"
+ VERSION = "2.1.5"
class << self
# Provides configurability to Paperclip. There are a number of options available, such as:
# * whiny_thumbnails: Will raise an error if Paperclip cannot process thumbnails of
# an uploaded image. Defaults to true.
@@ -55,18 +56,33 @@
def path_for_command command #:nodoc:
path = [options[:image_magick_path], command].compact
File.join(*path)
end
+ def run cmd, params = "", expected_outcodes = 0
+ output = `#{%Q[#{path_for_command(cmd)} #{params} 2>#{bit_bucket}].gsub(/\s+/, " ")}`
+ unless [expected_outcodes].flatten.include?($?.exitstatus)
+ raise PaperclipCommandLineError, "Error while running #{cmd}"
+ end
+ output
+ end
+
+ def bit_bucket
+ File.exists?("/dev/null") ? "/dev/null" : "NUL"
+ end
+
def included base #:nodoc:
base.extend ClassMethods
end
end
class PaperclipError < StandardError #:nodoc:
end
+ class PaperclipCommandLineError < StandardError #:nodoc:
+ end
+
class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
end
module ClassMethods
# +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
@@ -80,11 +96,12 @@
# 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
+ # absolute paths. The default value is
+ # "/:class/:attachment/:id/:style_:basename.:extension". 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
@@ -100,28 +117,37 @@
# * +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"
- # * +path+: The location of the repository of attachments on disk. This can be coordinated
- # with the value of the +url+ option to allow files to be saved into a place where Apache
- # can serve them without hitting your app. Defaults to
- # ":rails_root/public/:class/:attachment/:id/:style_:filename".
- # By default this places the files in the app's public directory which can be served
- # directly. If you are using capistrano for deployment, a good idea would be to
- # make a symlink to the capistrano-created system directory from inside your app's
- # public directory.
- # See Paperclip::Attachment#interpolate for more information on variable interpolaton.
- # :path => "/var/app/attachments/:class/:id/:style/:filename"
# * +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.
+ # * +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: (http://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.
def has_attached_file name, options = {}
include InstanceMethods
write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
- attachment_definitions[name] = {:validations => []}.merge(options)
+ attachment_definitions[name] = {:validations => {}}.merge(options)
after_save :save_attached_files
before_destroy :destroy_attached_files
define_method name do |*args|
@@ -132,72 +158,67 @@
define_method "#{name}=" do |file|
attachment_for(name).assign(file)
end
define_method "#{name}?" do
- ! attachment_for(name).original_filename.blank?
+ attachment_for(name).file?
end
validates_each(name) do |record, attr, value|
- value.send(:flush_errors)
+ value.send(:flush_errors) unless value.valid?
end
end
# 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[:less_than]
# * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
# * +message+: error message to display, use :min and :max as replacements
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
+ 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."
+
+ attachment_definitions[name][:validations][:size] = lambda do |attachment, instance|
+ if attachment.file? && !range.include?(attachment.size.to_i)
+ message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
end
- unless options[:less_than].nil?
- options[:in] = (0..options[:less_than])
- end
- unless attachment.original_filename.blank? || 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
# Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
def validates_attachment_thumbnails name, options = {}
attachment_definitions[name][:whiny_thumbnails] = true
end
# Places ActiveRecord-style validations on the presence of a file.
def validates_attachment_presence name, options = {}
- attachment_definitions[name][:validations] << lambda do |attachment, instance|
- if attachment.original_filename.blank?
- options[:message] || "must be set."
- end
+ message = options[:message] || "must be set."
+ attachment_definitions[name][:validations][:presence] = lambda do |attachment, instance|
+ message unless attachment.file?
end
end
# 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. Allows all by default.
+ # * +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.
def validates_attachment_content_type name, options = {}
- attachment_definitions[name][:validations] << lambda do |attachment, instance|
+ attachment_definitions[name][:validations][:content_type] = lambda do |attachment, instance|
valid_types = [options[:content_type]].flatten
- unless attachment.original_filename.nil?
+ unless attachment.original_filename.blank?
unless options[:content_type].blank?
- content_type = instance[:"#{name}_content_type"]
+ content_type = attachment.instance_read(:content_type)
unless valid_types.any?{|t| t === content_type }
- options[:message] || ActiveRecord::Errors.default_error_messages[:inclusion]
+ options[:message] || "is not one of the allowed file types."
end
end
end
end
end
@@ -220,15 +241,17 @@
yield(name, attachment_for(name))
end
end
def save_attached_files
+ logger.info("[paperclip] Saving attachments.")
each_attachment do |name, attachment|
attachment.send(:save)
end
end
def destroy_attached_files
+ logger.info("[paperclip] Deleting attachments.")
each_attachment do |name, attachment|
attachment.send(:queue_existing_for_delete)
attachment.send(:flush_deletes)
end
end