paperclip 4.2.2 → 6.1.0

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,11 +26,11 @@ 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
 
       geometry             = options[:geometry].to_s
-      @file                = file
       @crop                = geometry[-1,1] == '#'
       @target_geometry     = options.fetch(:string_geometry_parser, Geometry).parse(geometry)
       @current_geometry    = options.fetch(:file_geometry_parser, Geometry).from_file(@file)
@@ -42,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.
@@ -64,8 +65,8 @@ module Paperclip
     # that contains the new image.
     def make
       src = @file
-      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
-      dst.binmode
+      filename = [@basename, @format ? ".#{@format}" : ""].join
+      dst = TempfileFactory.new.generate(filename)
 
       begin
         parameters = []
@@ -77,10 +78,18 @@ 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
-        raise Paperclip::Error, "There was an error processing the thumbnail for #{@basename}" if @whiny
-      rescue Cocaine::CommandNotFoundError => e
+        frame = animated? ? "" : "[#{@frame_index}]"
+        convert(
+          parameters,
+          source: "#{File.expand_path(src.path)}#{frame}",
+          dest: File.expand_path(dst.path),
+        )
+      rescue Terrapin::ExitStatusError => e
+        if @whiny
+          message = "There was an error processing the thumbnail for #{@basename}:\n" + e.message
+          raise Paperclip::Error, message
+        end
+      rescue Terrapin::CommandNotFoundError => e
         raise Paperclip::Errors::CommandNotFoundError.new("Could not run the `convert` command. Please install ImageMagick.")
       end
 
@@ -102,7 +111,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
@@ -113,9 +125,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/attachment_size_validator.rb

@@ -71,13 +71,7 @@ module Paperclip
       end
 
       def human_size(size)
-        if defined?(ActiveSupport::NumberHelper) # Rails 4.0+
-          ActiveSupport::NumberHelper.number_to_human_size(size)
-        else
-          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
-        end
+        ActiveSupport::NumberHelper.number_to_human_size(size)
       end
 
       def min_value_in_human_size(record)

data/lib/paperclip/validators/media_type_spoof_detection_validator.rb

@@ -8,6 +8,10 @@ module Paperclip
         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
 

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 = "4.2.2" unless defined? Paperclip::VERSION
+  unless defined?(Paperclip::VERSION)
+    VERSION = "6.1.0".freeze
+  end
 end

data/lib/paperclip.rb

@@ -55,11 +55,21 @@ require 'paperclip/helpers'
 require 'paperclip/has_attached_file'
 require 'paperclip/attachment_registry'
 require 'paperclip/filename_cleaner'
-require 'mime/types'
+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.
@@ -80,14 +90,15 @@ module Paperclip
   #   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,
-      :content_type_mappings => {},
-      :use_exif_orientation => 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
 
@@ -109,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
@@ -118,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"
@@ -136,7 +150,7 @@ module Paperclip
     #     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+.
-    # * +preserve_files+: Keep the existing attachment files in all cases, even if the parent 
+    # * +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.

data/lib/tasks/paperclip.rake

@@ -18,7 +18,7 @@ module Paperclip
         raise "Class #{klass.name} has no attachments specified"
       end
 
-      if !name.blank? && attachment_names.map(&:to_s).include?(name.to_s)
+      if name.present? && attachment_names.map(&:to_s).include?(name.to_s)
         [ name ]
       else
         attachment_names
@@ -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."
@@ -108,4 +122,20 @@ namespace :paperclip do
       end
     end
   end
+
+  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)
+    names.each do |name|
+      Paperclip.each_instance_with_attachment(klass, name) do |instance|
+        attachment = instance.send(name)
+        if attachment.exists?
+          print "."
+        else
+          Paperclip::Task.log_error("#{instance.class}##{attachment.name}, #{instance.id}, #{attachment.url}")
+        end
+      end
+    end
+  end
 end

data/paperclip.gemspec

@@ -12,40 +12,43 @@ Gem::Specification.new do |s|
   s.description       = "Easy upload management for ActiveRecord"
   s.license           = "MIT"
 
-  s.rubyforge_project = "paperclip"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  if File.exist?('UPGRADING')
+    s.post_install_message = File.read("UPGRADING")
+  end
+
   s.requirements << "ImageMagick"
-  s.required_ruby_version = ">= 1.9.2"
+  s.required_ruby_version = ">= 2.1.0"
 
-  s.add_dependency('activemodel', '>= 3.0.0')
-  s.add_dependency('activesupport', '>= 3.0.0')
-  s.add_dependency('cocaine', '~> 0.5.3')
+  s.add_dependency('activemodel', '>= 4.2.0')
+  s.add_dependency('activesupport', '>= 4.2.0')
+  s.add_dependency('terrapin', '~> 0.6.0')
   s.add_dependency('mime-types')
+  s.add_dependency('mimemagic', '~> 0.3.0')
 
-  s.add_development_dependency('activerecord', '>= 3.0.0')
+  s.add_development_dependency('activerecord', '>= 4.2.0')
   s.add_development_dependency('shoulda')
-  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('appraisal')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk', '>= 1.5.7')
+  s.add_development_dependency('aws-sdk-s3')
   s.add_development_dependency('bourne')
-  s.add_development_dependency('cucumber', '~> 1.3.11')
-  s.add_development_dependency('aruba')
+  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')
-  # Ruby version < 1.9.3 can't install capybara > 2.0.3.
-  s.add_development_dependency('capybara', '= 2.0.3')
+  s.add_development_dependency('capybara')
   s.add_development_dependency('bundler')
-  s.add_development_dependency('fog', '~> 1.0')
+  s.add_development_dependency('fog-aws')
+  s.add_development_dependency('fog-local')
   s.add_development_dependency('launchy')
   s.add_development_dependency('rake')
   s.add_development_dependency('fakeweb')
   s.add_development_dependency('railties')
-  s.add_development_dependency('actionmailer', '>= 3.0.0')
   s.add_development_dependency('generator_spec')
   s.add_development_dependency('timecop')
 end

data/spec/paperclip/attachment_definitions_spec.rb

@@ -8,6 +8,6 @@ describe "Attachment Definitions" do
     Dummy.do_not_validate_attachment_file_type :avatar
     expected = {avatar: {path: "abc"}, other_attachment: {url: "123"}}
 
-    assert_equal expected, Dummy.attachment_definitions
+    expect(Dummy.attachment_definitions).to eq expected
   end
 end

data/spec/paperclip/attachment_processing_spec.rb

@@ -1,12 +1,9 @@
-# encoding: utf-8
 require 'spec_helper'
 
 describe 'Attachment Processing' do
-  context 'using validates_attachment_content_type' do
-    before do
-      rebuild_class
-    end
+  before { rebuild_class }
 
+  context 'using validates_attachment_content_type' do
     it 'processes attachments given a valid assignment' do
       file = File.new(fixture_file("5k.png"))
       Dummy.validates_attachment_content_type :avatar, content_type: "image/png"

data/spec/paperclip/attachment_registry_spec.rb

@@ -31,8 +31,8 @@ describe 'Attachment Registry' do
     it 'calls the block with the class, attachment name, and options' do
       foo = Class.new
       expected_accumulations = [
-        [foo, :avatar, { yo: 'greeting' }],
-        [foo, :greeter, { ciao: 'greeting' }]
+        [foo, :avatar, { yo: "greeting" }],
+        [foo, :greeter, { ciao: "greeting" }]
       ]
       expected_accumulations.each do |args|
         Paperclip::AttachmentRegistry.register(*args)
@@ -50,25 +50,92 @@ describe 'Attachment Registry' do
   context '.definitions_for' do
     it 'produces the attachment name and options' do
       expected_definitions = {
-        avatar: { yo: 'greeting' },
-        greeter: { ciao: 'greeting' }
+        avatar: { yo: "greeting" },
+        greeter: { ciao: "greeting" }
       }
       foo = Class.new
-      Paperclip::AttachmentRegistry.register(foo, :avatar, { yo: 'greeting' })
-      Paperclip::AttachmentRegistry.register(foo, :greeter, { ciao: 'greeting' })
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        yo: "greeting"
+      )
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :greeter,
+        ciao: "greeting"
+      )
 
       definitions = Paperclip::AttachmentRegistry.definitions_for(foo)
 
       assert_equal expected_definitions, definitions
     end
 
-    it "produces defintions for subclasses" do
-      expected_definitions = { avatar: { yo: 'greeting' } }
-      Foo = Class.new
-      Bar = Class.new(Foo)
-      Paperclip::AttachmentRegistry.register(Foo, :avatar, expected_definitions[:avatar])
+    it 'produces defintions for subclasses' do
+      expected_definitions = { avatar: { yo: "greeting" } }
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        expected_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
+
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'produces defintions for subclasses but deep merging them' do
+      foo_definitions = { avatar: { yo: "greeting" } }
+      bar_definitions = { avatar: { ciao: "greeting" } }
+      expected_definitions = {
+        avatar: {
+          yo: "greeting",
+          ciao: "greeting"
+        }
+      }
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        foo_definitions[:avatar]
+      )
+      Paperclip::AttachmentRegistry.register(
+        bar,
+        :avatar,
+        bar_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
 
-      definitions = Paperclip::AttachmentRegistry.definitions_for(Bar)
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'allows subclasses to override attachment defitions' do
+      foo_definitions = { avatar: { yo: "greeting" } }
+      bar_definitions = { avatar: { yo: "hello" } }
+
+      expected_definitions = {
+        avatar: {
+          yo: "hello"
+        }
+      }
+
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        foo_definitions[:avatar]
+      )
+      Paperclip::AttachmentRegistry.register(
+        bar,
+        :avatar,
+        bar_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
 
       assert_equal expected_definitions, definitions
     end
@@ -77,7 +144,11 @@ describe 'Attachment Registry' do
   context '.clear' do
     it 'removes all of the existing attachment definitions' do
       foo = Class.new
-      Paperclip::AttachmentRegistry.register(foo, :greeter, { ciao: 'greeting' })
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :greeter,
+        ciao: "greeting"
+      )
 
       Paperclip::AttachmentRegistry.clear