paperclip 5.0.0.beta2 → 5.3.0

data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb

@@ -40,9 +40,9 @@ module Paperclip
 
         def failure_message
           "#{expected_attachment}\n".tap do |message|
-            message << accepted_types_and_failures
+            message << accepted_types_and_failures.to_s
             message << "\n\n" if @allowed_types.present? && @rejected_types.present?
-            message << rejected_types_and_failures
+            message << rejected_types_and_failures.to_s
           end
         end
 
@@ -55,7 +55,7 @@ module Paperclip
         def accepted_types_and_failures
           if @allowed_types.present?
             "Accept content types: #{@allowed_types.join(", ")}\n".tap do |message|
-              if @missing_allowed_types.any?
+              if @missing_allowed_types.present?
                 message << "  #{@missing_allowed_types.join(", ")} were rejected."
               else
                 message << "  All were accepted successfully."
@@ -66,7 +66,7 @@ module Paperclip
         def rejected_types_and_failures
           if @rejected_types.present?
             "Reject content types: #{@rejected_types.join(", ")}\n".tap do |message|
-              if @missing_rejected_types.any?
+              if @missing_rejected_types.present?
                 message << "  #{@missing_rejected_types.join(", ")} were accepted."
               else
                 message << "  All were rejected successfully."

data/lib/paperclip/media_type_spoof_detector.rb

@@ -72,8 +72,9 @@ module Paperclip
 
     def type_from_file_command
       begin
-        Paperclip.run("file", "-b --mime :file", :file => @file.path).split(/[:;]\s+/).first
-      rescue Cocaine::CommandLineError
+        Paperclip.run("file", "-b --mime :file", file: @file.path).
+          split(/[:;\s]+/).first
+      rescue Terrapin::CommandLineError
         ""
       end
     end

data/lib/paperclip/processor.rb

@@ -7,13 +7,14 @@ module Paperclip
   # Processors are required to be defined inside the Paperclip module and
   # are also required to be a subclass of Paperclip::Processor. There is
   # only one method you *must* implement to properly be a subclass:
-  # #make, but #initialize may also be of use. Both methods accept 3
+  # #make, but #initialize may also be of use. #initialize accepts 3
   # arguments: the file that will be operated on (which is an instance of
   # File), a hash of options that were defined in has_attached_file's
-  # style hash, and the Paperclip::Attachment itself.
+  # style hash, and the Paperclip::Attachment itself. These are set as
+  # instance variables that can be used within `#make`.
   #
-  # All #make needs to return is an instance of File (Tempfile is
-  # acceptable) which contains the results of the processing.
+  # #make must return an instance of File (Tempfile is acceptable) which
+  # contains the results of the processing.
   #
   # See Paperclip.run for more information about using command-line
   # utilities from within Processors.

data/lib/paperclip/storage/filesystem.rb

@@ -37,7 +37,7 @@ module Paperclip
         @queued_for_write.each do |style_name, file|
           FileUtils.mkdir_p(File.dirname(path(style_name)))
           begin
-            FileUtils.mv(file.path, path(style_name))
+            move_file(file.path, path(style_name))
           rescue SystemCallError
             File.open(path(style_name), "wb") do |new_file|
               while chunk = file.read(16 * 1024)
@@ -46,7 +46,7 @@ module Paperclip
             end
           end
           unless @options[:override_file_permissions] == false
-            resolved_chmod = (@options[:override_file_permissions] &~ 0111) || (0666 &~ File.umask)
+            resolved_chmod = (@options[:override_file_permissions] & ~0111) || (0666 & ~File.umask)
             FileUtils.chmod( resolved_chmod, path(style_name) )
           end
           file.rewind
@@ -84,6 +84,17 @@ module Paperclip
       def copy_to_local_file(style, local_dest_path)
         FileUtils.cp(path(style), local_dest_path)
       end
+
+      private
+
+      def move_file(src, dest)
+        # Support hardlinked files
+        if File.identical?(src, dest)
+          File.unlink(src)
+        else
+          FileUtils.mv(src, dest)
+        end
+      end
     end
 
   end

data/lib/paperclip/storage/fog.rb

@@ -48,7 +48,7 @@ module Paperclip
         end unless defined?(Fog)
 
         base.instance_eval do
-          unless @options[:url].to_s.match(/\A:fog.*url\Z/)
+          unless @options[:url].to_s.match(/\A:fog.*url\z/)
             @options[:path]  = @options[:path].gsub(/:url/, @options[:url]).gsub(/\A:rails_root\/public\/system\//, '')
             @options[:url]   = ':fog_public_url'
           end
@@ -58,7 +58,7 @@ module Paperclip
         end
       end
 
-      AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX = /\A(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}\Z))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]\Z/
+      AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX = /\A(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}\z))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]\z/
 
       def exists?(style = default_style)
         if original_filename
@@ -86,11 +86,14 @@ module Paperclip
       end
 
       def fog_public(style = default_style)
-        if @options.has_key?(:fog_public)
-          if @options[:fog_public].respond_to?(:has_key?) && @options[:fog_public].has_key?(style)
-            @options[:fog_public][style]
+        if @options.key?(:fog_public)
+          value = @options[:fog_public]
+          if value.respond_to?(:key?) && value.key?(style)
+            value[style]
+          elsif value.respond_to?(:call)
+            value.call(self)
           else
-            @options[:fog_public]
+            value
           end
         else
           true
@@ -114,6 +117,7 @@ module Paperclip
             raise if retried
             retried = true
             directory.save
+            file.rewind
             retry
           ensure
             file.rewind
@@ -170,6 +174,7 @@ module Paperclip
         log("copying #{path(style)} to local file #{local_dest_path}")
         ::File.open(local_dest_path, 'wb') do |local_file|
           file = directory.files.get(path(style))
+          return false unless file
           local_file.write(file.body)
         end
       rescue ::Fog::Errors::Error => e
@@ -180,7 +185,7 @@ module Paperclip
       private
 
       def convert_time(time)
-        if time.is_a?(Fixnum)
+        if time.is_a?(Integer)
           time = Time.now + time
         end
         time

data/lib/paperclip/storage/s3.rb

@@ -45,15 +45,14 @@ module Paperclip
     #
     #   You can set permission on a per style bases by doing the following:
     #     :s3_permissions => {
-    #       :original => :private
+    #       :original => "private"
     #     }
     #   Or globally:
-    #     :s3_permissions => :private
+    #     :s3_permissions => "private"
     #
-    # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
-    #   'http', 'https', or an empty string to generate protocol-relative URLs. Defaults to 'http'
-    #   when your :s3_permissions are :public_read (the default), and 'https' when your
-    #   :s3_permissions are anything else.
+    # * +s3_protocol+: The protocol for the URLs generated to your S3 assets.
+    #   Can be either 'http', 'https', or an empty string to generate
+    #   protocol-relative URLs. Defaults to empty string.
     # * +s3_headers+: A hash of headers or a Proc. You may specify a hash such as
     #   {'Expires' => 1.year.from_now.httpdate}. If you use a Proc, headers are determined at
     #   runtime. Paperclip will call that Proc with attachment as the only argument.
@@ -66,6 +65,9 @@ module Paperclip
     # * +s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the
     #   S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the
     #   link in the +url+ entry for more information about S3 domains and buckets.
+    # * +s3_prefixes_in_alias+: The number of prefixes that is prepended by
+    #   s3_host_alias. This will remove the prefixes from the path in
+    #   :s3_alias_url url interpolation
     # * +url+: There are four options for the S3 url. You can choose to have the bucket's name
     #   placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
     #   You can also specify a CNAME (which requires the CNAME to be specified as
@@ -92,24 +94,31 @@ module Paperclip
     #   to interpolate. Keys should be unique, like filenames, and despite the fact that
     #   S3 (strictly speaking) does not support directories, you can still use a / to
     #   separate parts of your file name.
-    # * +s3_host_name+: If you are using your bucket in Tokyo region etc, write host_name.
+    # * +s3_host_name+: If you are using your bucket in Tokyo region
+    #   etc, write host_name (e.g., 's3-ap-northeast-1.amazonaws.com').
     # * +s3_region+: For aws-sdk v2, s3_region is required.
     # * +s3_metadata+: These key/value pairs will be stored with the
     #   object.  This option works by prefixing each key with
     #   "x-amz-meta-" before sending it as a header on the object
     #   upload request. Can be defined both globally and within a style-specific hash.
     # * +s3_storage_class+: If this option is set to
-    #   <tt>:reduced_redundancy</tt>, the object will be stored using Reduced
-    #   Redundancy Storage.  RRS enables customers to reduce their
+    #   <tt>:REDUCED_REDUNDANCY</tt>, the object will be stored using Reduced
+    #   Redundancy Storage. RRS enables customers to reduce their
     #   costs by storing non-critical, reproducible data at lower
     #   levels of redundancy than Amazon S3's standard storage.
+    # * +use_accelerate_endpoint+: Use accelerate endpoint
+    #   http://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
     #
     #   You can set storage class on a per style bases by doing the following:
     #     :s3_storage_class => {
-    #       :thumb => :reduced_reduncancy
+    #       :thumb => :REDUCED_REDUNDANCY
     #     }
+    #
     #   Or globally:
-    #     :s3_storage_class => :reduced_redundancy
+    #     :s3_storage_class => :REDUCED_REDUNDANCY
+    #
+    #   Other storage classes, such as <tt>:STANDARD_IA</tt>, are also available—see the
+    #   documentation for the <tt>aws-sdk</tt> gem for the full list.
 
     module S3
       def self.extended base
@@ -127,12 +136,7 @@ module Paperclip
         base.instance_eval do
           @s3_options     = @options[:s3_options]     || {}
           @s3_permissions = set_permissions(@options[:s3_permissions])
-          @s3_protocol    = @options[:s3_protocol]    ||
-            Proc.new do |style, attachment|
-              permission  = (@s3_permissions[style.to_s.to_sym] || @s3_permissions[:default])
-              permission  = permission.call(attachment, style) if permission.respond_to?(:call)
-              (permission == :"public-read") ? 'http'.freeze : 'https'.freeze
-            end
+          @s3_protocol    = @options[:s3_protocol] || "".freeze
           @s3_metadata = @options[:s3_metadata] || {}
           @s3_headers = {}
           merge_s3_headers(@options[:s3_headers], @s3_headers, @s3_metadata)
@@ -147,17 +151,30 @@ module Paperclip
             @s3_server_side_encryption = @options[:s3_server_side_encryption]
           end
 
-          unless @options[:url].to_s.match(/\A:s3.*url\Z/) || @options[:url] == ":asset_host".freeze
+          unless @options[:url].to_s.match(/\A:s3.*url\z/) || @options[:url] == ":asset_host".freeze
             @options[:path] = path_option.gsub(/:url/, @options[:url]).sub(/\A:rails_root\/public\/system/, "".freeze)
             @options[:url]  = ":s3_path_url".freeze
           end
           @options[:url] = @options[:url].inspect if @options[:url].is_a?(Symbol)
 
           @http_proxy = @options[:http_proxy] || nil
+
+          if @options.has_key?(:use_accelerate_endpoint) &&
+              Gem::Version.new(Aws::VERSION) < Gem::Version.new("2.3.0")
+            raise LoadError, ":use_accelerate_endpoint is only available from aws-sdk version 2.3.0. Please upgrade aws-sdk to a newer version."
+          end
+
+          @use_accelerate_endpoint = @options[:use_accelerate_endpoint]
         end
 
         Paperclip.interpolates(:s3_alias_url) do |attachment, style|
-          "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_alias}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
+          protocol = attachment.s3_protocol(style, true)
+          host = attachment.s3_host_alias
+          path = attachment.path(style).
+            split("/")[attachment.s3_prefixes_in_alias..-1].
+            join("/").
+            sub(%r{\A/}, "".freeze)
+          "#{protocol}//#{host}/#{path}"
         end unless Paperclip::Interpolations.respond_to? :s3_alias_url
         Paperclip.interpolates(:s3_path_url) do |attachment, style|
           "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_name}/#{attachment.bucket_name}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
@@ -206,6 +223,10 @@ module Paperclip
         @s3_host_alias
       end
 
+      def s3_prefixes_in_alias
+        @s3_prefixes_in_alias ||= @options[:s3_prefixes_in_alias].to_i
+      end
+
       def s3_url_options
         s3_url_options = @options[:s3_url_options] || {}
         s3_url_options = s3_url_options.call(instance) if s3_url_options.respond_to?(:call)
@@ -234,6 +255,8 @@ module Paperclip
             config[:proxy_uri] = URI::HTTP.build(proxy_opts)
           end
 
+          config[:use_accelerate_endpoint] = use_accelerate_endpoint?
+
           [:access_key_id, :secret_access_key, :credential_provider, :credentials].each do |opt|
             config[opt] = s3_credentials[opt] if s3_credentials[opt]
           end
@@ -259,6 +282,10 @@ module Paperclip
         s3_bucket.object style_name_as_path(style_name)
       end
 
+      def use_accelerate_endpoint?
+        !!@use_accelerate_endpoint
+      end
+
       def using_http_proxy?
         !!@http_proxy
       end

data/lib/paperclip/thumbnail.rb

@@ -3,10 +3,11 @@ module Paperclip
   class Thumbnail < Processor
 
     attr_accessor :current_geometry, :target_geometry, :format, :whiny, :convert_options,
-                  :source_file_options, :animated, :auto_orient
+                  :source_file_options, :animated, :auto_orient, :frame_index
 
     # List of formats that we need to preserve animation
     ANIMATED_FORMATS = %w(gif)
+    MULTI_FRAME_FORMATS = %w(.mkv .avi .mp4 .mov .mpg .mpeg .gif)
 
     # Creates a Thumbnail object set to work on the +file+ given. It
     # will attempt to transform the image into one defined by +target_geometry+
@@ -25,6 +26,7 @@ module Paperclip
     #   +whiny+ - whether to raise an error when processing fails. Defaults to true
     #   +format+ - the desired filename extension
     #   +animated+ - whether to merge all the layers in the image. Defaults to true
+    #   +frame_index+ - the frame index of the source file to render as the thumbnail
     def initialize(file, options = {}, attachment = nil)
       super
 
@@ -41,12 +43,12 @@ module Paperclip
       if @auto_orient && @current_geometry.respond_to?(:auto_orient)
         @current_geometry.auto_orient
       end
-
       @source_file_options = @source_file_options.split(/\s+/) if @source_file_options.respond_to?(:split)
       @convert_options     = @convert_options.split(/\s+/)     if @convert_options.respond_to?(:split)
 
       @current_format      = File.extname(@file.path)
       @basename            = File.basename(@file.path, @current_format)
+      @frame_index         = multi_frame_format? ? options.fetch(:frame_index, 0) : 0
     end
 
     # Returns true if the +target_geometry+ is meant to crop.
@@ -76,10 +78,15 @@ module Paperclip
 
         parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
 
-        success = convert(parameters, :source => "#{File.expand_path(src.path)}#{'[0]' unless animated?}", :dest => File.expand_path(dst.path))
-      rescue Cocaine::ExitStatusError => e
+        frame = animated? ? "" : "[#{@frame_index}]"
+        convert(
+          parameters,
+          source: "#{File.expand_path(src.path)}#{frame}",
+          dest: File.expand_path(dst.path),
+        )
+      rescue Terrapin::ExitStatusError => e
         raise Paperclip::Error, "There was an error processing the thumbnail for #{@basename}" if @whiny
-      rescue Cocaine::CommandNotFoundError => e
+      rescue Terrapin::CommandNotFoundError => e
         raise Paperclip::Errors::CommandNotFoundError.new("Could not run the `convert` command. Please install ImageMagick.")
       end
 
@@ -101,7 +108,10 @@ module Paperclip
 
     protected
 
-    # Return true if the format is animated
+    def multi_frame_format?
+      MULTI_FRAME_FORMATS.include? @current_format
+    end
+
     def animated?
       @animated && (ANIMATED_FORMATS.include?(@format.to_s) || @format.blank?)  && identified_as_animated?
     end
@@ -112,9 +122,9 @@ module Paperclip
         @identified_as_animated = ANIMATED_FORMATS.include? identify("-format %m :file", :file => "#{@file.path}[0]").to_s.downcase.strip
       end
       @identified_as_animated
-    rescue Cocaine::ExitStatusError => e
+    rescue Terrapin::ExitStatusError => e
       raise Paperclip::Error, "There was an error running `identify` for #{@basename}" if @whiny
-    rescue Cocaine::CommandNotFoundError => e
+    rescue Terrapin::CommandNotFoundError => e
       raise Paperclip::Errors::CommandNotFoundError.new("Could not run the `identify` command. Please install ImageMagick.")
     end
   end

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)
-      timestamp_as_needed(
-        escape_url_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
 

data/lib/paperclip/validators.rb

@@ -36,7 +36,7 @@ module Paperclip
         options = attributes.extract_options!.dup
 
         Paperclip::Validators.constants.each do |constant|
-          if constant.to_s =~ /\AAttachment(.+)Validator\Z/
+          if constant.to_s =~ /\AAttachment(.+)Validator\z/
             validator_kind = $1.underscore.to_sym
 
             if options.has_key?(validator_kind)

data/lib/paperclip/version.rb

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