paperclip 3.4.0 → 6.1.0

data/lib/paperclip/url_generator.rb

@@ -1,30 +1,34 @@
 require 'uri'
+require 'active_support/core_ext/module/delegation'
 
 module Paperclip
   class UrlGenerator
-    def initialize(attachment, attachment_options)
+    def initialize(attachment)
       @attachment = attachment
-      @attachment_options = attachment_options
     end
 
     def for(style_name, options)
-      escape_url_as_needed(
-        timestamp_as_needed(
-          @attachment_options[:interpolator].interpolate(most_appropriate_url, @attachment, style_name),
-          options
-      ), options)
+      interpolated = attachment_options[:interpolator].interpolate(
+        most_appropriate_url, @attachment, style_name
+      )
+
+      escaped = escape_url_as_needed(interpolated, options)
+      timestamp_as_needed(escaped, options)
     end
 
     private
 
+    attr_reader :attachment
+    delegate :options, to: :attachment, prefix: true
+
     # This method is all over the place.
     def default_url
-      if @attachment_options[:default_url].respond_to?(:call)
-        @attachment_options[:default_url].call(@attachment)
-      elsif @attachment_options[:default_url].is_a?(Symbol)
-        @attachment.instance.send(@attachment_options[:default_url])
+      if attachment_options[:default_url].respond_to?(:call)
+        attachment_options[:default_url].call(@attachment)
+      elsif attachment_options[:default_url].is_a?(Symbol)
+        @attachment.instance.send(attachment_options[:default_url])
       else
-        @attachment_options[:default_url]
+        attachment_options[:default_url]
       end
     end
 
@@ -32,7 +36,7 @@ module Paperclip
       if @attachment.original_filename.nil?
         default_url
       else
-        @attachment_options[:url]
+        attachment_options[:url]
       end
     end
 
@@ -58,7 +62,15 @@ module Paperclip
     end
 
     def escape_url(url)
-      (url.respond_to?(:escape) ? url.escape : URI.escape(url)).gsub(/(\/.+)\?(.+\.)/, '\1%3F\2')
+      if url.respond_to?(:escape)
+        url.escape
+      else
+        URI.escape(url).gsub(escape_regex){|m| "%#{m.ord.to_s(16).upcase}" }
+      end
+    end
+
+    def escape_regex
+      /[\?\(\)\[\]\+]/
     end
   end
 end

data/lib/paperclip/validators/attachment_content_type_validator.rb

@@ -6,7 +6,12 @@ module Paperclip
         super
       end
 
+      def self.helper_method_name
+        :validates_attachment_content_type
+      end
+
       def validate_each(record, attribute, value)
+        base_attribute = attribute.to_sym
         attribute = "#{attribute}_content_type".to_sym
         value = record.send :read_attribute_for_validation, attribute
 
@@ -14,6 +19,12 @@ module Paperclip
 
         validate_whitelist(record, attribute, value)
         validate_blacklist(record, attribute, value)
+
+        if record.errors.include? attribute
+          record.errors[attribute].each do |error|
+            record.errors.add base_attribute, error
+          end
+        end
       end
 
       def validate_whitelist(record, attribute, value)
@@ -48,7 +59,7 @@ module Paperclip
     end
 
     module HelperMethods
-      # Places ActiveRecord-style validations on the content type of the file
+      # Places ActiveModel 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
@@ -68,7 +79,9 @@ module Paperclip
       # You'll still need to have a virtual attribute (created by +attr_accessor+)
       # name +[attachment]_content_type+ to be able to use this validator.
       def validates_attachment_content_type(*attr_names)
-        validates_with AttachmentContentTypeValidator, _merge_attributes(attr_names)
+        options = _merge_attributes(attr_names)
+        validates_with AttachmentContentTypeValidator, options.dup
+        validate_before_processing AttachmentContentTypeValidator, options.dup
       end
     end
   end

data/lib/paperclip/validators/attachment_file_name_validator.rb

@@ -0,0 +1,80 @@
+module Paperclip
+  module Validators
+    class AttachmentFileNameValidator < ActiveModel::EachValidator
+      def initialize(options)
+        options[:allow_nil] = true unless options.has_key?(:allow_nil)
+        super
+      end
+
+      def self.helper_method_name
+        :validates_attachment_file_name
+      end
+
+      def validate_each(record, attribute, value)
+        base_attribute = attribute.to_sym
+        attribute = "#{attribute}_file_name".to_sym
+        value = record.send :read_attribute_for_validation, attribute
+
+        return if (value.nil? && options[:allow_nil]) || (value.blank? && options[:allow_blank])
+
+        validate_whitelist(record, attribute, value)
+        validate_blacklist(record, attribute, value)
+
+        if record.errors.include? attribute
+          record.errors[attribute].each do |error|
+            record.errors.add base_attribute, error
+          end
+        end
+      end
+
+      def validate_whitelist(record, attribute, value)
+        if allowed.present? && allowed.none? { |type| type === value }
+          mark_invalid record, attribute, allowed
+        end
+      end
+
+      def validate_blacklist(record, attribute, value)
+        if forbidden.present? && forbidden.any? { |type| type === value }
+          mark_invalid record, attribute, forbidden
+        end
+      end
+
+      def mark_invalid(record, attribute, patterns)
+        record.errors.add attribute, :invalid, options.merge(:names => patterns.join(', '))
+      end
+
+      def allowed
+        [options[:matches]].flatten.compact
+      end
+
+      def forbidden
+        [options[:not]].flatten.compact
+      end
+
+      def check_validity!
+        unless options.has_key?(:matches) || options.has_key?(:not)
+          raise ArgumentError, "You must pass in either :matches or :not to the validator"
+        end
+      end
+    end
+
+    module HelperMethods
+      # Places ActiveModel validations on the name of the file
+      # assigned. The possible options are:
+      # * +matches+: Allowed filename patterns as Regexps. Can be a single one
+      #   or an array.
+      # * +not+: Forbidden file name patterns, specified the same was as +matches+.
+      # * +message+: The message to display when the uploaded file has an invalid
+      #   name.
+      # * +if+: A lambda or name of an instance method. 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_file_name(*attr_names)
+        options = _merge_attributes(attr_names)
+        validates_with AttachmentFileNameValidator, options.dup
+        validate_before_processing AttachmentFileNameValidator, options.dup
+      end
+    end
+  end
+end
+

data/lib/paperclip/validators/attachment_file_type_ignorance_validator.rb

@@ -0,0 +1,29 @@
+require 'active_model/validations/presence'
+
+module Paperclip
+  module Validators
+    class AttachmentFileTypeIgnoranceValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        # This doesn't do anything. It's just to mark that you don't care about
+        # the file_names or content_types of your incoming attachments.
+      end
+
+      def self.helper_method_name
+        :do_not_validate_attachment_file_type
+      end
+    end
+
+    module HelperMethods
+      # Places ActiveModel validations on the presence of a file.
+      # Options:
+      # * +if+: A lambda or name of an instance method. Validation will only
+      #   be run if this lambda or method returns true.
+      # * +unless+: Same as +if+ but validates if lambda or method returns false.
+      def do_not_validate_attachment_file_type(*attr_names)
+        options = _merge_attributes(attr_names)
+        validates_with AttachmentFileTypeIgnoranceValidator, options.dup
+      end
+    end
+  end
+end
+

data/lib/paperclip/validators/attachment_presence_validator.rb

@@ -2,24 +2,28 @@ require 'active_model/validations/presence'
 
 module Paperclip
   module Validators
-    class AttachmentPresenceValidator < ActiveModel::Validations::PresenceValidator
-      def validate(record)
-        [attributes].flatten.map do |attribute|
-          if record.send(:read_attribute_for_validation, "#{attribute}_file_name").blank?
-            record.errors.add(attribute, :blank, options)
-          end
+    class AttachmentPresenceValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        if record.send("#{attribute}_file_name").blank?
+          record.errors.add(attribute, :blank, options)
         end
       end
+
+      def self.helper_method_name
+        :validates_attachment_presence
+      end
     end
 
     module HelperMethods
-      # Places ActiveRecord-style validations on the presence of a file.
+      # Places ActiveModel validations on the presence of a file.
       # Options:
       # * +if+: A lambda or name of an instance method. Validation will only
       #   be run if this lambda or method returns true.
       # * +unless+: Same as +if+ but validates if lambda or method returns false.
       def validates_attachment_presence(*attr_names)
-        validates_with AttachmentPresenceValidator, _merge_attributes(attr_names)
+        options = _merge_attributes(attr_names)
+        validates_with AttachmentPresenceValidator, options.dup
+        validate_before_processing AttachmentPresenceValidator, options.dup
       end
     end
   end

data/lib/paperclip/validators/attachment_size_validator.rb

@@ -10,7 +10,12 @@ module Paperclip
         super
       end
 
+      def self.helper_method_name
+        :validates_attachment_size
+      end
+
       def validate_each(record, attr_name, value)
+        base_attr_name = attr_name
         attr_name = "#{attr_name}_file_size".to_sym
         value = record.send(:read_attribute_for_validation, attr_name)
 
@@ -21,11 +26,13 @@ module Paperclip
 
             unless value.send(CHECKS[option], option_value)
               error_message_key = options[:in] ? :in_between : option
-              record.errors.add(attr_name, error_message_key, filtered_options(value).merge(
-                :min => min_value_in_human_size(record),
-                :max => max_value_in_human_size(record),
-                :count => human_size(option_value)
-              ))
+              [ attr_name, base_attr_name ].each do |error_attr_name|
+                record.errors.add(error_attr_name, error_message_key, filtered_options(value).merge(
+                  :min => min_value_in_human_size(record),
+                  :max => max_value_in_human_size(record),
+                  :count => human_size(option_value)
+                ))
+              end
             end
           end
         end
@@ -64,9 +71,7 @@ module Paperclip
       end
 
       def human_size(size)
-        storage_units_format = I18n.translate(:'number.human.storage_units.format', :locale => options[:locale], :raise => true)
-        unit = I18n.translate(:'number.human.storage_units.units.byte', :locale => options[:locale], :count => size.to_i, :raise => true)
-        storage_units_format.gsub(/%n/, size.to_i.to_s).gsub(/%u/, unit).html_safe
+        ActiveSupport::NumberHelper.number_to_human_size(size)
       end
 
       def min_value_in_human_size(record)
@@ -85,7 +90,7 @@ module Paperclip
     end
 
     module HelperMethods
-      # Places ActiveRecord-style validations on the size of the file assigned. The
+      # Places ActiveModel 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]
@@ -95,7 +100,9 @@ module Paperclip
       #   be run if this lambda or method returns true.
       # * +unless+: Same as +if+ but validates if lambda or method returns false.
       def validates_attachment_size(*attr_names)
-        validates_with AttachmentSizeValidator, _merge_attributes(attr_names)
+        options = _merge_attributes(attr_names)
+        validates_with AttachmentSizeValidator, options.dup
+        validate_before_processing AttachmentSizeValidator, options.dup
       end
     end
   end

data/lib/paperclip/validators/media_type_spoof_detection_validator.rb

@@ -0,0 +1,31 @@
+require 'active_model/validations/presence'
+
+module Paperclip
+  module Validators
+    class MediaTypeSpoofDetectionValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        adapter = Paperclip.io_adapters.for(value)
+        if Paperclip::MediaTypeSpoofDetector.using(adapter, value.original_filename, value.content_type).spoofed?
+          record.errors.add(attribute, :spoofed_media_type)
+        end
+
+        if adapter.tempfile
+          adapter.tempfile.close(true)
+        end
+      end
+    end
+
+    module HelperMethods
+      # Places ActiveModel validations on the presence of a file.
+      # Options:
+      # * +if+: A lambda or name of an instance method. Validation will only
+      #   be run if this lambda or method returns true.
+      # * +unless+: Same as +if+ but validates if lambda or method returns false.
+      def validates_media_type_spoof_detection(*attr_names)
+        options = _merge_attributes(attr_names)
+        validates_with MediaTypeSpoofDetectionValidator, options.dup
+        validate_before_processing MediaTypeSpoofDetectionValidator, options.dup
+      end
+    end
+  end
+end

data/lib/paperclip/validators.rb

@@ -1,8 +1,12 @@
 require 'active_model'
 require 'active_support/concern'
+require 'active_support/core_ext/array/wrap'
 require 'paperclip/validators/attachment_content_type_validator'
+require 'paperclip/validators/attachment_file_name_validator'
 require 'paperclip/validators/attachment_presence_validator'
 require 'paperclip/validators/attachment_size_validator'
+require 'paperclip/validators/media_type_spoof_detection_validator'
+require 'paperclip/validators/attachment_file_type_ignorance_validator'
 
 module Paperclip
   module Validators
@@ -13,6 +17,8 @@ module Paperclip
       include HelperMethods
     end
 
+    ::Paperclip::REQUIRED_VALIDATORS = [AttachmentFileNameValidator, AttachmentContentTypeValidator, AttachmentFileTypeIgnoranceValidator]
+
     module ClassMethods
       # This method is a shortcut to validator classes that is in
       # "Attachment...Validator" format. It is almost the same thing as the
@@ -30,17 +36,39 @@ module Paperclip
         options = attributes.extract_options!.dup
 
         Paperclip::Validators.constants.each do |constant|
-          if constant.to_s =~ /^Attachment(.+)Validator$/
+          if constant.to_s =~ /\AAttachment(.+)Validator\z/
             validator_kind = $1.underscore.to_sym
 
             if options.has_key?(validator_kind)
-              options[:"attachment_#{validator_kind}"] = options.delete(validator_kind)
+              validator_options = options.delete(validator_kind)
+              validator_options = {} if validator_options == true
+              conditional_options = options.slice(:if, :unless)
+              Array.wrap(validator_options).each do |local_options|
+                method_name = Paperclip::Validators.const_get(constant.to_s).helper_method_name
+                send(method_name, attributes, local_options.merge(conditional_options))
+              end
             end
           end
         end
+      end
 
-        validates(*attributes + [options])
+      def validate_before_processing(validator_class, options)
+        options = options.dup
+        attributes = options.delete(:attributes)
+        attributes.each do |attribute|
+          options[:attributes] = [attribute]
+          create_validating_before_filter(attribute, validator_class, options)
+        end
       end
+
+      def create_validating_before_filter(attribute, validator_class, options)
+        if_clause = options.delete(:if)
+        unless_clause = options.delete(:unless)
+        send(:"before_#{attribute}_post_process", :if => if_clause, :unless => unless_clause) do |*args|
+          validator_class.new(options.dup).validate(self)
+        end
+      end
+
     end
   end
 end

data/lib/paperclip/version.rb

@@ -1,3 +1,5 @@
 module Paperclip
-  VERSION = "3.4.0" unless defined? Paperclip::VERSION
+  unless defined?(Paperclip::VERSION)
+    VERSION = "6.1.0".freeze
+  end
 end

data/lib/paperclip.rb

@@ -33,29 +33,43 @@ require 'paperclip/geometry_parser_factory'
 require 'paperclip/geometry_detector_factory'
 require 'paperclip/geometry'
 require 'paperclip/processor'
+require 'paperclip/processor_helpers'
 require 'paperclip/tempfile'
 require 'paperclip/thumbnail'
+require 'paperclip/interpolations/plural_cache'
 require 'paperclip/interpolations'
 require 'paperclip/tempfile_factory'
 require 'paperclip/style'
 require 'paperclip/attachment'
-require 'paperclip/attachment_options'
 require 'paperclip/storage'
 require 'paperclip/callbacks'
 require 'paperclip/file_command_content_type_detector'
+require 'paperclip/media_type_spoof_detector'
 require 'paperclip/content_type_detector'
 require 'paperclip/glue'
 require 'paperclip/errors'
 require 'paperclip/missing_attachment_styles'
 require 'paperclip/validators'
-require 'paperclip/instance_methods'
 require 'paperclip/logger'
 require 'paperclip/helpers'
-require 'mime/types'
+require 'paperclip/has_attached_file'
+require 'paperclip/attachment_registry'
+require 'paperclip/filename_cleaner'
+require 'paperclip/rails_environment'
+
+begin
+  # Use mime/types/columnar if available, for reduced memory usage
+  require "mime/types/columnar"
+rescue LoadError
+  require "mime/types"
+end
+
+require 'mimemagic'
+require 'mimemagic/overlay'
 require 'logger'
-require 'cocaine'
+require 'terrapin'
 
-require 'paperclip/railtie' if defined?(Rails)
+require 'paperclip/railtie' if defined?(Rails::Railtie)
 
 # The base module that gets included in ActiveRecord::Base. See the
 # documentation for Paperclip::ClassMethods for more useful information.
@@ -72,14 +86,19 @@ module Paperclip
   # * 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.
+  # * use_exif_orientation: Whether to inspect EXIF data to determine an
+  #   image's orientation. Defaults to true.
   def self.options
     @options ||= {
-      :whiny             => true,
-      :image_magick_path => nil,
-      :command_path      => nil,
-      :log               => true,
-      :log_command       => true,
-      :swallow_stderr    => true
+      command_path: nil,
+      content_type_mappings: {},
+      log: true,
+      log_command: true,
+      read_timeout: nil,
+      swallow_stderr: true,
+      use_exif_orientation: true,
+      whiny: true,
+      is_windows: Gem.win_platform?
     }
   end
 
@@ -101,7 +120,7 @@ module Paperclip
     # 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
+    # * +url+: The full URL of where the attachment is publicly 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
@@ -110,6 +129,9 @@ module Paperclip
     #   Paperclip::Attachment#interpolate for more information on variable interpolaton.
     #     :url => "/:class/:attachment/:id/:style_:filename"
     #     :url => "http://some.other.host/stuff/:class/:id_:extension"
+    #   Note: When using the +s3+ storage option, the +url+ option expects
+    #   particular values. See the Paperclip::Storage::S3#url documentation for
+    #   specifics.
     # * +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"
@@ -127,8 +149,9 @@ module Paperclip
     #                       :default_style => :normal
     #     user.avatar.url # => "/avatars/23/normal_me.png"
     # * +keep_old_files+: Keep the existing attachment files (original + resized) from
-    #   being automatically deleted when an attachment is cleared or updated.
-    #   Defaults to +false+.#
+    #   being automatically deleted when an attachment is cleared or updated. Defaults to +false+.
+    # * +preserve_files+: Keep the existing attachment files in all cases, even if the parent
+    #   record is destroyed. Defaults to +false+.
     # * +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.
@@ -172,47 +195,7 @@ module Paperclip
     #     end
     #   end
     def has_attached_file(name, options = {})
-      include InstanceMethods
-
-      if attachment_definitions.nil?
-        self.attachment_definitions = {}
-      else
-        self.attachment_definitions = self.attachment_definitions.dup
-      end
-
-      attachment_definitions[name] = Paperclip::AttachmentOptions.new(options)
-      Paperclip.classes_with_attachments << self.name
-      Paperclip.check_for_path_clash(name,attachment_definitions[name][:path],self.name)
-
-      after_save :save_attached_files
-      before_destroy :prepare_for_destroy
-      after_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
-
-    # Returns the attachment definitions defined by each call to
-    # has_attached_file.
-    def attachment_definitions
-      self.attachment_definitions
+      HasAttachedFile.define_on(self, name, options)
     end
   end
 end
@@ -220,10 +203,13 @@ end
 # This stuff needs to be run after Paperclip is defined.
 require 'paperclip/io_adapters/registry'
 require 'paperclip/io_adapters/abstract_adapter'
+require 'paperclip/io_adapters/empty_string_adapter'
 require 'paperclip/io_adapters/identity_adapter'
 require 'paperclip/io_adapters/file_adapter'
 require 'paperclip/io_adapters/stringio_adapter'
+require 'paperclip/io_adapters/data_uri_adapter'
 require 'paperclip/io_adapters/nil_adapter'
 require 'paperclip/io_adapters/attachment_adapter'
 require 'paperclip/io_adapters/uploaded_file_adapter'
 require 'paperclip/io_adapters/uri_adapter'
+require 'paperclip/io_adapters/http_url_proxy_adapter'