paperclip 5.1.0 → 5.2.0

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -1,7 +1,13 @@
 module Paperclip
   class UploadedFileAdapter < AbstractAdapter
-    def initialize(target)
-      @target = target
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        target.class.name.include?("UploadedFile")
+      end
+    end
+
+    def initialize(target, options = {})
+      super
       cache_current_values
 
       if @target.respond_to?(:tempfile)
@@ -37,6 +43,4 @@ module Paperclip
   end
 end
 
-Paperclip.io_adapters.register Paperclip::UploadedFileAdapter do |target|
-  target.class.name.include?("UploadedFile")
-end
+Paperclip::UploadedFileAdapter.register

data/lib/paperclip/io_adapters/uri_adapter.rb

@@ -1,11 +1,17 @@
-require 'open-uri'
+require "open-uri"
 
 module Paperclip
   class UriAdapter < AbstractAdapter
     attr_writer :content_type
 
-    def initialize(target)
-      @target = target
+    def self.register
+      Paperclip.io_adapters.register self do |target|
+        target.is_a?(URI)
+      end
+    end
+
+    def initialize(target, options = {})
+      super
       @content = download_content
       cache_current_values
       @tempfile = copy_to_tempfile(@content)
@@ -28,9 +34,9 @@ module Paperclip
     end
 
     def filename_from_content_disposition
-      if @content.meta.has_key?("content-disposition")
-        @content.meta["content-disposition"].
-          match(/filename="([^"]*)"/)[1]
+      if @content.meta.key?("content-disposition")
+        matches = @content.meta["content-disposition"].match(/filename="([^"]*)"/)
+        matches[1] if matches
       end
     end
 
@@ -49,7 +55,7 @@ module Paperclip
     end
 
     def copy_to_tempfile(src)
-      while data = src.read(16*1024)
+      while data = src.read(16 * 1024)
         destination.write(data)
       end
       src.close
@@ -58,7 +64,3 @@ module Paperclip
     end
   end
 end
-
-Paperclip.io_adapters.register Paperclip::UriAdapter do |target|
-  target.kind_of?(URI)
-end

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

@@ -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

data/lib/paperclip/storage/s3.rb

@@ -45,10 +45,10 @@ 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
@@ -65,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
@@ -102,6 +105,8 @@ module Paperclip
     #   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 => {
@@ -152,10 +157,23 @@ module Paperclip
           @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)}"
@@ -204,6 +222,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)
@@ -232,6 +254,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
@@ -257,6 +281,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,7 +78,12 @@ 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))
+        frame = animated? ? "" : "[#{@frame_index}]"
+        convert(
+          parameters,
+          source: "#{File.expand_path(src.path)}#{frame}",
+          dest: File.expand_path(dst.path),
+        )
       rescue Cocaine::ExitStatusError => e
         raise Paperclip::Error, "There was an error processing the thumbnail for #{@basename}" if @whiny
       rescue Cocaine::CommandNotFoundError => e
@@ -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

data/lib/paperclip/version.rb

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

data/lib/tasks/paperclip.rake

@@ -46,7 +46,7 @@ namespace :paperclip do
           attachment = instance.send(name)
           begin
             attachment.reprocess!(*styles)
-          rescue Exception => e
+          rescue StandardError => e
             Paperclip::Task.log_error("exception while processing #{klass} ID #{instance.id}:")
             Paperclip::Task.log_error(" " + e.message + "\n")
           end
@@ -64,7 +64,8 @@ namespace :paperclip do
       names = Paperclip::Task.obtain_attachments(klass)
       names.each do |name|
         Paperclip.each_instance_with_attachment(klass, name) do |instance|
-          if file = Paperclip.io_adapters.for(instance.send(name))
+          attachment = instance.send(name)
+          if file = Paperclip.io_adapters.for(attachment, attachment.options[:adapter_options])
             instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
             instance.send("#{name}_content_type=", file.content_type.to_s.strip)
             instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
@@ -90,6 +91,19 @@ namespace :paperclip do
       end
       Paperclip.save_current_attachments_styles!
     end
+
+    desc "Regenerates fingerprints for a given CLASS (and optional ATTACHMENT). Useful when changing digest."
+    task :fingerprints => :environment do
+      klass = Paperclip::Task.obtain_class
+      names = Paperclip::Task.obtain_attachments(klass)
+      names.each do |name|
+        Paperclip.each_instance_with_attachment(klass, name) do |instance|
+          attachment = instance.send(name)
+          attachment.assign(attachment)
+          instance.save(:validate => false)
+        end
+      end
+    end
   end
 
   desc "Cleans out invalid attachments. Useful after you've added new validations."
@@ -109,7 +123,7 @@ namespace :paperclip do
     end
   end
 
- desc "find missing attachments. Useful to know which attachments are broken"
+  desc "find missing attachments. Useful to know which attachments are broken"
   task :find_broken_attachments => :environment do
     klass = Paperclip::Task.obtain_class
     names = Paperclip::Task.obtain_attachments(klass)

data/paperclip.gemspec

@@ -35,9 +35,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('appraisal')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk', '>= 2.0.34', '< 3.0')
+  s.add_development_dependency('aws-sdk', '>= 2.3.0', '< 3.0')
   s.add_development_dependency('bourne')
-  s.add_development_dependency('cucumber', '~> 1.3.18')
+  s.add_development_dependency('cucumber-rails')
+  s.add_development_dependency('cucumber-expressions', '4.0.3') # TODO: investigate failures on 4.0.4
   s.add_development_dependency('aruba', '~> 0.9.0')
   s.add_development_dependency('nokogiri')
   s.add_development_dependency('capybara')
@@ -48,7 +49,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake')
   s.add_development_dependency('fakeweb')
   s.add_development_dependency('railties')
-  s.add_development_dependency('actionmailer', '>= 4.2.0')
   s.add_development_dependency('generator_spec')
   s.add_development_dependency('timecop')
 end

data/spec/paperclip/attachment_spec.rb

@@ -500,6 +500,7 @@ describe Paperclip::Attachment do
       @attachment.expects(:post_process).with(:thumb)
       @attachment.expects(:post_process).with(:large).never
       @attachment.assign(@file)
+      @attachment.save
     end
   end
 
@@ -1433,16 +1434,46 @@ describe Paperclip::Attachment do
         assert_nothing_raised { @dummy.avatar = @file }
       end
 
-      it "returns the right value when sent #avatar_fingerprint" do
-        @dummy.avatar = @file
-        assert_equal 'aec488126c3b33c08a10c3fa303acf27', @dummy.avatar_fingerprint
+      context "with explicitly set digest" do
+        before do
+          rebuild_class adapter_options: { hash_digest: Digest::SHA256 }
+          @dummy = Dummy.new
+        end
+
+        it "returns the right value when sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          assert_equal "734016d801a497f5579cdd4ef2ae1d020088c1db754dc434482d76dd5486520a",
+                       @dummy.avatar_fingerprint
+        end
+
+        it "returns the right value when saved, reloaded, and sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          @dummy.save
+          @dummy = Dummy.find(@dummy.id)
+          assert_equal "734016d801a497f5579cdd4ef2ae1d020088c1db754dc434482d76dd5486520a",
+                       @dummy.avatar_fingerprint
+        end
       end
 
-      it "returns the right value when saved, reloaded, and sent #avatar_fingerprint" do
-        @dummy.avatar = @file
-        @dummy.save
-        @dummy = Dummy.find(@dummy.id)
-        assert_equal 'aec488126c3b33c08a10c3fa303acf27', @dummy.avatar_fingerprint
+      context "with the default digest" do
+        before do
+          rebuild_class # MD5 is the default
+          @dummy = Dummy.new
+        end
+
+        it "returns the right value when sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          assert_equal "aec488126c3b33c08a10c3fa303acf27",
+                       @dummy.avatar_fingerprint
+        end
+
+        it "returns the right value when saved, reloaded, and sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          @dummy.save
+          @dummy = Dummy.find(@dummy.id)
+          assert_equal "aec488126c3b33c08a10c3fa303acf27",
+                       @dummy.avatar_fingerprint
+        end
       end
     end
   end

data/spec/paperclip/io_adapters/abstract_adapter_spec.rb

@@ -9,70 +9,93 @@ describe Paperclip::AbstractAdapter do
     end
   end
 
+  subject { TestAdapter.new(nil) }
+
   context "content type from file contents" do
     before do
-      @adapter = TestAdapter.new
-      @adapter.stubs(:path).returns("image.png")
+      subject.stubs(:path).returns("image.png")
       Paperclip.stubs(:run).returns("image/png\n")
       Paperclip::ContentTypeDetector.any_instance.stubs(:type_from_mime_magic).returns("image/png")
     end
 
     it "returns the content type without newline" do
-      assert_equal "image/png", @adapter.content_type
+      assert_equal "image/png", subject.content_type
     end
   end
 
   context "nil?" do
     it "returns false" do
-      assert !TestAdapter.new.nil?
+      assert !subject.nil?
     end
   end
 
   context "delegation" do
     before do
-      @adapter = TestAdapter.new
-      @adapter.tempfile = stub("Tempfile")
+      subject.tempfile = stub("Tempfile")
     end
 
     [:binmode, :binmode?, :close, :close!, :closed?, :eof?, :path, :readbyte, :rewind, :unlink].each do |method|
       it "delegates #{method} to @tempfile" do
-        @adapter.tempfile.stubs(method)
-        @adapter.public_send(method)
-        assert_received @adapter.tempfile, method
+        subject.tempfile.stubs(method)
+        subject.public_send(method)
+        assert_received subject.tempfile, method
       end
     end
   end
 
   it 'gets rid of slashes and colons in filenames' do
-    @adapter = TestAdapter.new
-    @adapter.original_filename = "awesome/file:name.png"
+    subject.original_filename = "awesome/file:name.png"
 
-    assert_equal "awesome_file_name.png", @adapter.original_filename
+    assert_equal "awesome_file_name.png", subject.original_filename
   end
 
   it 'is an assignment' do
-    assert TestAdapter.new.assignment?
+    assert subject.assignment?
   end
 
   it 'is not nil' do
-    assert !TestAdapter.new.nil?
+    assert !subject.nil?
   end
 
   it "generates a destination filename with no original filename" do
-    @adapter = TestAdapter.new
-    expect(@adapter.send(:destination).path).to_not be_nil
+    expect(subject.send(:destination).path).to_not be_nil
   end
 
   it 'uses the original filename to generate the tempfile' do
-    @adapter = TestAdapter.new
-    @adapter.original_filename = "file.png"
-    expect(@adapter.send(:destination).path).to end_with(".png")
+    subject.original_filename = "file.png"
+    expect(subject.send(:destination).path).to end_with(".png")
+  end
+
+  context "generates a fingerprint" do
+    subject { TestAdapter.new(nil, options) }
+
+    before do
+      subject.stubs(:path).returns(fixture_file("50x50.png"))
+    end
+
+    context "MD5" do
+      let(:options) { { hash_digest: Digest::MD5 } }
+
+      it "returns a fingerprint" do
+        expect(subject.fingerprint).to be_a String
+        expect(subject.fingerprint).to eq "a790b00c9b5d58a8fd17a1ec5a187129"
+      end
+    end
+
+    context "SHA256" do
+      let(:options) { { hash_digest: Digest::SHA256 } }
+
+      it "returns a fingerprint" do
+        expect(subject.fingerprint).to be_a String
+        expect(subject.fingerprint).
+          to eq "243d7ce1099719df25f600f1c369c629fb979f88d5a01dbe7d0d48c8e6715bb1"
+      end
+    end
   end
 
   context "#original_filename=" do
     it "should not fail with a nil original filename" do
-      adapter = TestAdapter.new
-      expect{ adapter.original_filename = nil }.not_to raise_error
+      expect { subject.original_filename = nil }.not_to raise_error
     end
   end
 end