lib/paperclip.rb in paperclip-2.2.8 vs lib/paperclip.rb in paperclip-2.2.9.1
- old
+ new
@@ -3,11 +3,11 @@
# are stored in Tempfiles until the record is saved. Paperclip does not require a
# separate model for storing the attachment's information, instead adding a few simple
# columns to your table.
#
# Author:: Jon Yurek
-# Copyright:: Copyright (c) 2008 thoughtbot, inc.
+# Copyright:: Copyright (c) 2008-2009 thoughtbot, inc.
# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
#
# Paperclip defines an attachment as any file, though it makes special considerations
# for image files. You can declare that a model has an attached file with the
# +has_attached_file+ method:
@@ -30,10 +30,11 @@
require 'paperclip/iostream'
require 'paperclip/geometry'
require 'paperclip/processor'
require 'paperclip/thumbnail'
require 'paperclip/storage'
+require 'paperclip/interpolations'
require 'paperclip/attachment'
if defined? RAILS_ROOT
Dir.glob(File.join(File.expand_path(RAILS_ROOT), "lib", "paperclip_processors", "*.rb")).each do |processor|
require processor
end
@@ -41,28 +42,29 @@
# The base module that gets included in ActiveRecord::Base. See the
# documentation for Paperclip::ClassMethods for more useful information.
module Paperclip
- VERSION = "2.2.8"
+ VERSION = "2.2.9.1"
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
+ # * whiny: Will raise an error if Paperclip cannot process thumbnails of
# an uploaded image. Defaults to true.
# * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
# log levels, etc. Defaults to true.
# * command_path: Defines the path at which to find the command line
# programs if they are not visible to Rails the system's search path. Defaults to
# nil, which uses the first executable found in the user's search path.
# * image_magick_path: Deprecated alias of command_path.
def options
@options ||= {
- :whiny_thumbnails => true,
+ :whiny => true,
:image_magick_path => nil,
:command_path => nil,
:log => true,
+ :log_command => false,
:swallow_stderr => true
}
end
def path_for_command command #:nodoc:
@@ -72,11 +74,11 @@
path = [options[:command_path] || options[:image_magick_path], command].compact
File.join(*path)
end
def interpolates key, &block
- Paperclip::Attachment.interpolations[key] = block
+ Paperclip::Interpolations[key] = block
end
# The run method takes a command to execute and a string of parameters
# that get passed to it. The command is prefixed with the :command_path
# option from Paperclip.options. If you have many commands to run and
@@ -84,13 +86,18 @@
# symlink them so they are all in the same directory.
#
# If the command returns with a result code that is not one of the
# expected_outcodes, a PaperclipCommandLineError will be raised. Generally
# a code of 0 is expected, but a list of codes may be passed if necessary.
+ #
+ # This method can log the command being run when
+ # Paperclip.options[:log_command] is set to true (defaults to false). This
+ # will only log if logging in general is set to true as well.
def run cmd, params = "", expected_outcodes = 0
command = %Q<#{%Q[#{path_for_command(cmd)} #{params}].gsub(/\s+/, " ")}>
command = "#{command} 2>#{bit_bucket}" if Paperclip.options[:swallow_stderr]
+ Paperclip.log(command) if Paperclip.options[:log_command]
output = `#{command}`
unless [expected_outcodes].flatten.include?($?.exitstatus)
raise PaperclipCommandLineError, "Error while running #{cmd}"
end
output
@@ -113,20 +120,37 @@
unless processor.ancestors.include?(Paperclip::Processor)
raise PaperclipError.new("Processor #{name} was not found")
end
processor
end
+
+ # Log a paperclip-specific line. Uses ActiveRecord::Base.logger
+ # by default. Set Paperclip.options[:log] to false to turn off.
+ def log message
+ logger.info("[paperclip] #{message}") if logging?
+ end
+
+ def logger #:nodoc:
+ ActiveRecord::Base.logger
+ end
+
+ def logging? #:nodoc:
+ options[:log]
+ end
end
class PaperclipError < StandardError #:nodoc:
end
class PaperclipCommandLineError < StandardError #:nodoc:
end
class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
end
+
+ class InfiniteInterpolationError < PaperclipError #:nodoc:
+ end
module ClassMethods
# +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
@@ -139,13 +163,13 @@
# * +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
+ # "/system/:attachment/:id/:style/:filename". See
# Paperclip::Attachment#interpolate for more information on variable interpolaton.
- # :url => "/:class/:attachment/:id/:style_:basename.:extension"
+ # :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"
@@ -159,13 +183,14 @@
# * +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 post_process an uploaded file due
+ # * +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.
+ # 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
# 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)
@@ -177,19 +202,22 @@
# 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.
# * +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_callbacks :before_post_process, :after_post_process
@@ -218,34 +246,43 @@
# 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
+ # * +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.
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."
- 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
- end
+ attachment_definitions[name][:validations] << [:size, {:range => range,
+ :message => message,
+ :if => options[:if],
+ :unless => options[:unless]}]
end
# Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
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.')
attachment_definitions[name][:whiny_thumbnails] = true
end
# 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.
def validates_attachment_presence name, options = {}
message = options[:message] || "must be set."
- attachment_definitions[name][:validations][:presence] = lambda do |attachment, instance|
- message unless attachment.file?
- end
+ attachment_definitions[name][:validations] << [:presence, {:message => message,
+ :if => options[:if],
+ :unless => options[:unless]}]
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
@@ -254,25 +291,20 @@
# 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.
def validates_attachment_content_type name, options = {}
- attachment_definitions[name][:validations][:content_type] = lambda do |attachment, instance|
- valid_types = [options[:content_type]].flatten
-
- unless attachment.original_filename.blank?
- unless valid_types.blank?
- content_type = attachment.instance_read(:content_type)
- unless valid_types.any?{|t| content_type.nil? || t === content_type }
- options[:message] || "is not one of the allowed file types."
- end
- end
- end
- end
+ attachment_definitions[name][:validations] << [:content_type, {:content_type => options[:content_type],
+ :message => options[:message],
+ :if => options[:if],
+ :unless => options[:unless]}]
end
# Returns the attachment definitions defined by each call to
# has_attached_file.
def attachment_definitions