paperclip 3.0.3 → 3.5.1

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -1,7 +1,8 @@
 module Paperclip
-  class UploadedFileAdapter
+  class UploadedFileAdapter < AbstractAdapter
     def initialize(target)
       @target = target
+      cache_current_values
 
       if @target.respond_to?(:tempfile)
         @tempfile = copy_to_tempfile(@target.tempfile)
@@ -10,52 +11,28 @@ module Paperclip
       end
     end
 
-    def original_filename
-      @target.original_filename
+    class << self
+      attr_accessor :content_type_detector
     end
 
-    def content_type
-      @target.content_type
-    end
-
-    def fingerprint
-      @fingerprint ||= Digest::MD5.file(path).to_s
-    end
-
-    def size
-      File.size(path)
-    end
-
-    def nil?
-      false
-    end
-
-    def read(length = nil, buffer = nil)
-      @tempfile.read(length, buffer)
-    end
-
-    # We don't use this directly, but aws/sdk does.
-    def rewind
-      @tempfile.rewind
-    end
+    private
 
-    def eof?
-      @tempfile.eof?
+    def cache_current_values
+      self.original_filename = @target.original_filename
+      @content_type = determine_content_type
+      @size = File.size(@target.path)
     end
 
-    def path
-      @tempfile.path
+    def content_type_detector
+      self.class.content_type_detector
     end
 
-    private
-
-    def copy_to_tempfile(src)
-      extension = File.extname(original_filename)
-      basename = File.basename(original_filename, extension)
-      dest = Tempfile.new([basename, extension])
-      dest.binmode
-      FileUtils.cp(src.path, dest.path)
-      dest
+    def determine_content_type
+      content_type = @target.content_type.to_s.strip
+      if content_type_detector
+        content_type = content_type_detector.new(@target.path).detect
+      end
+      content_type
     end
   end
 end

data/lib/paperclip/io_adapters/uri_adapter.rb

@@ -0,0 +1,44 @@
+require 'open-uri'
+
+module Paperclip
+  class UriAdapter < AbstractAdapter
+    def initialize(target)
+      @target = target
+      @content = download_content
+      cache_current_values
+      @tempfile = copy_to_tempfile(@content)
+    end
+
+    attr_writer :content_type
+
+    private
+
+    def download_content
+      open(@target)
+    end
+
+    def cache_current_values
+      @original_filename = @target.path.split("/").last
+      @original_filename ||= "index.html"
+      self.original_filename = @original_filename.strip
+
+      @content_type = @content.content_type if @content.respond_to?(:content_type)
+      @content_type ||= "text/html"
+
+      @size = @content.size
+    end
+
+    def copy_to_tempfile(src)
+      while data = src.read(16*1024)
+        destination.write(data)
+      end
+      src.close
+      destination.rewind
+      destination
+    end
+  end
+end
+
+Paperclip.io_adapters.register Paperclip::UriAdapter do |target|
+  target.kind_of?(URI)
+end

data/lib/paperclip/matchers/have_attached_file_matcher.rb

@@ -20,7 +20,7 @@ module Paperclip
         def matches? subject
           @subject = subject
           @subject = @subject.class unless Class === @subject
-          responds? && has_column? && included?
+          responds? && has_column?
         end
 
         def failure_message
@@ -47,10 +47,6 @@ module Paperclip
         def has_column?
           @subject.column_names.include?("#{@attachment_name}_file_name")
         end
-
-        def included?
-          @subject.ancestors.include?(Paperclip::InstanceMethods)
-        end
       end
     end
   end

data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb

@@ -39,18 +39,10 @@ module Paperclip
         end
 
         def failure_message
-          "".tap do |str|
-            str << "Content types #{@allowed_types.join(", ")} should be accepted" if @allowed_types.present?
-            str << "\n" if @allowed_types.present? && @rejected_types.present?
-            str << "Content types #{@rejected_types.join(", ")} should be rejected by #{@attachment_name}" if @rejected_types.present?
-          end
-        end
-
-        def negative_failure_message
-          "".tap do |str|
-            str << "Content types #{@allowed_types.join(", ")} should be rejected" if @allowed_types.present?
-            str << "\n" if @allowed_types.present? && @rejected_types.present?
-            str << "Content types #{@rejected_types.join(", ")} should be accepted by #{@attachment_name}" if @rejected_types.present?
+          "#{expected_attachment}\n".tap do |message|
+            message << accepted_types_and_failures
+            message << "\n\n" if @allowed_types.present? && @rejected_types.present?
+            message << rejected_types_and_failures
           end
         end
 
@@ -60,20 +52,47 @@ module Paperclip
 
         protected
 
+        def accepted_types_and_failures
+          if @allowed_types.present?
+            "Accept content types: #{@allowed_types.join(", ")}\n".tap do |message|
+              if @missing_allowed_types.any?
+                message << "  #{@missing_allowed_types.join(", ")} were rejected."
+              else
+                message << "  All were accepted successfully."
+              end
+            end
+          end
+        end
+        def rejected_types_and_failures
+          if @rejected_types.present?
+            "Reject content types: #{@rejected_types.join(", ")}\n".tap do |message|
+              if @missing_rejected_types.any?
+                message << "  #{@missing_rejected_types.join(", ")} were accepted."
+              else
+                message << "  All were rejected successfully."
+              end
+            end
+          end
+        end
+
+        def expected_attachment
+          "Expected #{@attachment_name}:\n"
+        end
+
         def type_allowed?(type)
-          file = Paperclip.io_adapters.for(StringIO.new("."))
-          file.content_type = type
-          @subject.attachment_for(@attachment_name).assign(file)
+          @subject.send("#{@attachment_name}_content_type=", type)
           @subject.valid?
           @subject.errors[:"#{@attachment_name}_content_type"].blank?
         end
 
         def allowed_types_allowed?
-          @allowed_types.all? { |type| type_allowed?(type) }
+          @missing_allowed_types ||= @allowed_types.reject { |type| type_allowed?(type) }
+          @missing_allowed_types.none?
         end
 
         def rejected_types_rejected?
-          !@rejected_types.any? { |type| type_allowed?(type) }
+          @missing_rejected_types ||= @rejected_types.select { |type| type_allowed?(type) }
+          @missing_rejected_types.none?
         end
       end
     end

data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb

@@ -46,7 +46,11 @@ module Paperclip
           @file = StringIO.new(".")
           @subject.send(@attachment_name).assign(@file)
           @subject.valid?
-          @subject.errors[:"#{@attachment_name}"].blank?
+          expected_message = [
+            @attachment_name.to_s.titleize,
+            I18n.t(:blank, scope: [:errors, :messages])
+          ].join(' ')
+          @subject.errors.full_messages.exclude?(expected_message)
         end
       end
     end

data/lib/paperclip/matchers.rb

@@ -15,7 +15,7 @@ module Paperclip
     #
     # And _include_ the module:
     #
-    #   Spec::Runner.configure do |config|
+    #   RSpec.configure do |config|
     #     config.include Paperclip::Shoulda::Matchers
     #   end
     #
@@ -41,7 +41,7 @@ module Paperclip
     #
     #   class ActiveSupport::TestCase
     #     extend Paperclip::Shoulda::Matchers
-    #     
+    #
     #     #...other initializers...#
     #   end
     #
@@ -57,7 +57,7 @@ module Paperclip
     #     should validate_attachment_size(:avatar).
     #                  less_than(2.megabytes)
     #   end
-    #  
+    #
     module Matchers
     end
   end

data/lib/paperclip/missing_attachment_styles.rb

@@ -1,16 +1,14 @@
-
+require 'paperclip/attachment_registry'
 require 'set'
+
 module Paperclip
   class << self
-    attr_accessor :classes_with_attachments
     attr_writer :registered_attachments_styles_path
     def registered_attachments_styles_path
       @registered_attachments_styles_path ||= Rails.root.join('public/system/paperclip_attachments.yml').to_s
     end
   end
 
-  self.classes_with_attachments = Set.new
-
   # Get list of styles saved on previous deploy (running rake paperclip:refresh:missing_styles)
   def self.get_registered_attachments_styles
     YAML.load_file(Paperclip.registered_attachments_styles_path)
@@ -36,18 +34,15 @@ module Paperclip
   #   }
   def self.current_attachments_styles
     Hash.new.tap do |current_styles|
-      Paperclip.classes_with_attachments.each do |klass_name|
-        klass = Paperclip.class_for(klass_name)
-        klass.attachment_definitions.each do |attachment_name, attachment_attributes|
-          # TODO: is it even possible to take into account Procs?
-          next if attachment_attributes[:styles].kind_of?(Proc)
-          attachment_attributes[:styles].try(:keys).try(:each) do |style_name|
-            klass_sym = klass.to_s.to_sym
-            current_styles[klass_sym] ||= Hash.new
-            current_styles[klass_sym][attachment_name.to_sym] ||= Array.new
-            current_styles[klass_sym][attachment_name.to_sym] << style_name.to_sym
-            current_styles[klass_sym][attachment_name.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq!
-          end
+      Paperclip::AttachmentRegistry.each_definition do |klass, attachment_name, attachment_attributes|
+        # TODO: is it even possible to take into account Procs?
+        next if attachment_attributes[:styles].kind_of?(Proc)
+        attachment_attributes[:styles].try(:keys).try(:each) do |style_name|
+          klass_sym = klass.to_s.to_sym
+          current_styles[klass_sym] ||= Hash.new
+          current_styles[klass_sym][attachment_name.to_sym] ||= Array.new
+          current_styles[klass_sym][attachment_name.to_sym] << style_name.to_sym
+          current_styles[klass_sym][attachment_name.to_sym].map!(&:to_s).sort!.map!(&:to_sym).uniq!
         end
       end
     end

data/lib/paperclip/processor.rb

@@ -32,6 +32,18 @@ module Paperclip
     def self.make file, options = {}, attachment = nil
       new(file, options, attachment).make
     end
+
+    # The convert method runs the convert binary with the provided arguments.
+    # See Paperclip.run for the available options.
+    def convert(arguments = "", local_options = {})
+      Paperclip.run('convert', arguments, local_options)
+    end
+
+    # The identify method runs the identify binary with the provided arguments.
+    # See Paperclip.run for the available options.
+    def identify(arguments = "", local_options = {})
+      Paperclip.run('identify', arguments, local_options)
+    end
   end
 
   module ProcessorHelpers

data/lib/paperclip/railtie.rb

@@ -5,10 +5,14 @@ module Paperclip
   require 'rails'
 
   class Railtie < Rails::Railtie
-    initializer 'paperclip.insert_into_active_record' do
+    initializer 'paperclip.insert_into_active_record' do |app|
       ActiveSupport.on_load :active_record do
         Paperclip::Railtie.insert
       end
+
+      if app.config.respond_to?(:paperclip_defaults)
+        Paperclip::Attachment.default_options.merge!(app.config.paperclip_defaults)
+      end
     end
 
     rake_tasks { load "tasks/paperclip.rake" }

data/lib/paperclip/schema.rb

@@ -1,39 +1,75 @@
+require 'active_support/deprecation'
+
 module Paperclip
-  # Provides two helpers that can be used in migrations.
-  #
-  # In order to use this module, the target class should implement a
-  # +column+ method that takes the column name and type, both as symbols,
-  # as well as a +remove_column+ method that takes a table and column name,
-  # also both symbols.
+  # Provides helper methods that can be used in migrations.
   module Schema
-    @@columns = {:file_name    => :string,
-                 :content_type => :string,
-                 :file_size    => :integer,
-                 :updated_at   => :datetime}
+    COLUMNS = {:file_name    => :string,
+               :content_type => :string,
+               :file_size    => :integer,
+               :updated_at   => :datetime}
+
+    def self.included(base)
+      ActiveRecord::ConnectionAdapters::Table.send :include, TableDefinition
+      ActiveRecord::ConnectionAdapters::TableDefinition.send :include, TableDefinition
+      ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, Statements
 
-    def has_attached_file(attachment_name)
-      with_columns_for(attachment_name) do |column_name, column_type|
-        column(column_name, column_type)
+      if defined?(ActiveRecord::Migration::CommandRecorder) # Rails 3.1+
+        ActiveRecord::Migration::CommandRecorder.send :include, CommandRecorder
       end
     end
 
-    def drop_attached_file(table_name, attachment_name)
-      with_columns_for(attachment_name) do |column_name, column_type|
-        remove_column(table_name, column_name)
+    module Statements
+      def add_attachment(table_name, *attachment_names)
+        raise ArgumentError, "Please specify attachment name in your add_attachment call in your migration." if attachment_names.empty?
+
+        attachment_names.each do |attachment_name|
+          COLUMNS.each_pair do |column_name, column_type|
+            add_column(table_name, "#{attachment_name}_#{column_name}", column_type)
+          end
+        end
+      end
+
+      def remove_attachment(table_name, *attachment_names)
+        raise ArgumentError, "Please specify attachment name in your remove_attachment call in your migration." if attachment_names.empty?
+
+        attachment_names.each do |attachment_name|
+          COLUMNS.each_pair do |column_name, column_type|
+            remove_column(table_name, "#{attachment_name}_#{column_name}")
+          end
+        end
+      end
+
+      def drop_attached_file(*args)
+        ActiveSupport::Deprecation.warn "Method `drop_attached_file` in the migration has been deprecated and will be replaced by `remove_attachment`."
+        remove_attachment(*args)
       end
     end
 
-    protected
+    module TableDefinition
+      def attachment(*attachment_names)
+        attachment_names.each do |attachment_name|
+          COLUMNS.each_pair do |column_name, column_type|
+            column("#{attachment_name}_#{column_name}", column_type)
+          end
+        end
+      end
 
-    def with_columns_for(attachment_name)
-      @@columns.each do |suffix, column_type|
-        column_name = full_column_name(attachment_name, suffix)
-        yield column_name, column_type
+      def has_attached_file(*attachment_names)
+        ActiveSupport::Deprecation.warn "Method `t.has_attached_file` in the migration has been deprecated and will be replaced by `t.attachment`."
+        attachment(*attachment_names)
       end
     end
 
-    def full_column_name(attachment_name, column_name)
-      "#{attachment_name}_#{column_name}".to_sym
+    module CommandRecorder
+      def add_attachment(*args)
+        record(:add_attachment, args)
+      end
+
+      private
+
+      def invert_add_attachment(args)
+        [:remove_attachment, args]
+      end
     end
   end
 end

data/lib/paperclip/storage/filesystem.rb

@@ -3,7 +3,7 @@ module Paperclip
     # The default place to store attachments is in the filesystem. Files on the local
     # filesystem can be very easily served by Apache without requiring a hit to your app.
     # They also can be processed more easily after they've been saved, as they're just
-    # normal files. There is one Filesystem-specific option for has_attached_file.
+    # normal files. There are two Filesystem-specific options for has_attached_file:
     # * +path+: The location of the repository of attachments on disk. This can (and, in
     #   almost all cases, should) be coordinated with the value of the +url+ option to
     #   allow files to be saved into a place where Apache can serve them without
@@ -15,6 +15,12 @@ module Paperclip
     #   public directory.
     #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
     #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
+    # * +override_file_permissions+: This allows you to override the file permissions for files
+    #   saved by paperclip. If you set this to an explicit octal value (0755, 0644, etc) then
+    #   that value will be used to set the permissions for an uploaded file. The default is 0666.
+    #   If you set :override_file_permissions to false, the chmod will be skipped. This allows
+    #   you to use paperclip on filesystems that don't understand unix file permissions, and has the 
+    #   added benefit of using the storage directories default umask on those that do.
     module Filesystem
       def self.extended base
       end
@@ -30,12 +36,20 @@ module Paperclip
       def flush_writes #:nodoc:
         @queued_for_write.each do |style_name, file|
           FileUtils.mkdir_p(File.dirname(path(style_name)))
-          File.open(path(style_name), "wb") do |new_file|
-            while chunk = file.read(16 * 1024)
-              new_file.write(chunk)
+          begin
+            FileUtils.mv(file.path, path(style_name))
+          rescue SystemCallError
+            File.open(path(style_name), "wb") do |new_file|
+              while chunk = file.read(16 * 1024)
+                new_file.write(chunk)
+              end
             end
           end
-          FileUtils.chmod(0666&~File.umask, path(style_name))
+          unless @options[:override_file_permissions] == false
+            resolved_chmod = (@options[:override_file_permissions] &~ 0111) || (0666 &~ File.umask)
+            FileUtils.chmod( resolved_chmod, path(style_name) )
+          end
+          file.rewind
         end
 
         after_flush_writes # allows attachment to clean up temp files
@@ -66,6 +80,10 @@ module Paperclip
         end
         @queued_for_delete = []
       end
+
+      def copy_to_local_file(style, local_dest_path)
+        FileUtils.cp(path(style), local_dest_path)
+      end
     end
 
   end

data/lib/paperclip/storage/fog.rb

@@ -18,6 +18,8 @@ module Paperclip
     #   store your files.  Remember that the bucket must be unique across
     #   all of Amazon S3. If the bucket does not exist, Paperclip will
     #   attempt to create it.
+    # * +fog_file*: This can be hash or lambda returning hash. The
+    #   value is used as base properties for new uploaded file.
     # * +path+: This is the key under the bucket in which the file will
     #   be stored. The URL will be constructed from the bucket and the
     #   path. This is what you will want to interpolate. Keys should be
@@ -42,7 +44,7 @@ module Paperclip
 
         base.instance_eval do
           unless @options[:url].to_s.match(/^:fog.*url$/)
-            @options[:path]  = @options[:path].gsub(/:url/, @options[:url])
+            @options[:path]  = @options[:path].gsub(/:url/, @options[:url]).gsub(/^:rails_root\/public\/system\//, '')
             @options[:url]   = ':fog_public_url'
           end
           Paperclip.interpolates(:fog_public_url) do |attachment, style|
@@ -66,12 +68,28 @@ module Paperclip
       end
 
       def fog_file
-        @fog_file ||= @options[:fog_file] || {}
+        @fog_file ||= begin
+          value = @options[:fog_file]
+          if !value
+            {}
+          elsif value.respond_to?(:call)
+            value.call(self)
+          else
+            value
+          end
+        end
       end
 
-      def fog_public
-        return @fog_public if defined?(@fog_public)
-        @fog_public = defined?(@options[:fog_public]) ? @options[:fog_public] : true
+      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]
+          else
+            @options[:fog_public]
+          end
+        else
+          true
+        end
       end
 
       def flush_writes
@@ -82,7 +100,7 @@ module Paperclip
             directory.files.create(fog_file.merge(
               :body         => file,
               :key          => path(style),
-              :public       => fog_public,
+              :public       => fog_public(style),
               :content_type => file.content_type
             ))
           rescue Excon::Errors::NotFound
@@ -90,6 +108,8 @@ module Paperclip
             retried = true
             directory.save
             retry
+          ensure
+            file.rewind
           end
         end
 
@@ -108,27 +128,30 @@ module Paperclip
 
       def public_url(style = default_style)
         if @options[:fog_host]
-          host = if @options[:fog_host].respond_to?(:call)
-            @options[:fog_host].call(self)
-          else
-            (@options[:fog_host] =~ /%d/) ? @options[:fog_host] % (path(style).hash % 4) : @options[:fog_host]
-          end
-
-          "#{host}/#{path(style)}"
+          "#{dynamic_fog_host_for_style(style)}/#{path(style)}"
         else
           if fog_credentials[:provider] == 'AWS'
-            if @options[:fog_directory].to_s =~ Fog::AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX
-              "https://#{@options[:fog_directory]}.s3.amazonaws.com/#{path(style)}"
-            else
-              # directory is not a valid subdomain, so use path style for access
-              "https://s3.amazonaws.com/#{@options[:fog_directory]}/#{path(style)}"
-            end
+            "https://#{host_name_for_directory}/#{path(style)}"
           else
             directory.files.new(:key => path(style)).public_url
           end
         end
       end
 
+      def expiring_url(time = (Time.now + 3600), style = default_style)
+        if directory.files.respond_to?(:get_http_url)
+          expiring_url = directory.files.get_http_url(path(style), time)
+
+          if @options[:fog_host]
+            expiring_url.gsub!(/#{host_name_for_directory}/, dynamic_fog_host_for_style(style))
+          end
+        else
+          expiring_url = public_url
+        end
+
+        return expiring_url
+      end
+
       def parse_credentials(creds)
         creds = find_credentials(creds).stringify_keys
         env = Object.const_defined?(:Rails) ? Rails.env : nil
@@ -137,17 +160,33 @@ module Paperclip
 
       def copy_to_local_file(style, local_dest_path)
         log("copying #{path(style)} to local file #{local_dest_path}")
-        local_file = ::File.open(local_dest_path, 'wb')
-        file = directory.files.get(path(style))
-        local_file.write(file.body)
-        local_file.close
-      rescue Fog::Errors::Error => e
+        ::File.open(local_dest_path, 'wb') do |local_file|
+          file = directory.files.get(path(style))
+          local_file.write(file.body)
+        end
+      rescue ::Fog::Errors::Error => e
         warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
         false
       end
 
       private
 
+      def dynamic_fog_host_for_style(style)
+        if @options[:fog_host].respond_to?(:call)
+          @options[:fog_host].call(self)
+        else
+          (@options[:fog_host] =~ /%d/) ? @options[:fog_host] % (path(style).hash % 4) : @options[:fog_host]
+        end
+      end
+
+      def host_name_for_directory
+        if @options[:fog_directory].to_s =~ Fog::AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX
+          "#{@options[:fog_directory]}.s3.amazonaws.com"
+        else
+          "s3.amazonaws.com/#{@options[:fog_directory]}"
+        end
+      end
+
       def find_credentials(creds)
         case creds
         when File
@@ -175,7 +214,7 @@ module Paperclip
         else
           @options[:fog_directory]
         end
-        
+
         @directory ||= connection.directories.new(:key => dir)
       end
     end