paperclip 3.3.1 → 3.4.0

data/.gitignore

@@ -5,8 +5,9 @@
 tmp
 .DS_Store
 
+*.log
+
 test/s3.yml
-test/debug.log
 test/paperclip.db
 test/doc
 test/pkg

data/.travis.yml

@@ -2,6 +2,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - jruby-19mode
+  - rbx-19mode
 
 before_script: "sudo ntpdate -ub ntp.ubuntu.com pool.ntp.org; true"
 script: "bundle exec rake clean test cucumber"
@@ -14,3 +15,4 @@ gemfile:
 matrix:
   allow_failures:
     - rvm: jruby-19mode
+    - rvm: rbx-19mode

data/NEWS

@@ -123,6 +123,7 @@ New in 3.0.1:
 
 * Feature: Introduce Paperlip IO adapter.
 * Bug fix: Regression in AttachmentContentTypeValidator has been fixed.
+* API CHANGE: #to_file has been removed. Use the #copy_to_local_file method instead.
 
 New in 3.0.0:
 

data/README.md

@@ -615,7 +615,7 @@ Please see `CONTRIBUTING.md` for more details on contributing and running test.
 Credits
 -------
 
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+![thoughtbot](http://thoughtbot.com/assets/tm/logo.png)
 
 Paperclip is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
 

data/lib/generators/paperclip/templates/paperclip_migration.rb.erb

@@ -2,7 +2,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
   def self.up
     change_table :<%= table_name %> do |t|
 <% attachment_names.each do |attachment| -%>
-      t.has_attached_file :<%= attachment %>
+      t.attachment :<%= attachment %>
 <% end -%>
     end
   end

data/lib/paperclip.rb

@@ -29,6 +29,8 @@ require 'erb'
 require 'digest'
 require 'tempfile'
 require 'paperclip/version'
+require 'paperclip/geometry_parser_factory'
+require 'paperclip/geometry_detector_factory'
 require 'paperclip/geometry'
 require 'paperclip/processor'
 require 'paperclip/tempfile'
@@ -40,6 +42,7 @@ require 'paperclip/attachment'
 require 'paperclip/attachment_options'
 require 'paperclip/storage'
 require 'paperclip/callbacks'
+require 'paperclip/file_command_content_type_detector'
 require 'paperclip/content_type_detector'
 require 'paperclip/glue'
 require 'paperclip/errors'
@@ -179,7 +182,7 @@ module Paperclip
 
       attachment_definitions[name] = Paperclip::AttachmentOptions.new(options)
       Paperclip.classes_with_attachments << self.name
-      Paperclip.check_for_url_clash(name,attachment_definitions[name][:url],self.name)
+      Paperclip.check_for_path_clash(name,attachment_definitions[name][:path],self.name)
 
       after_save :save_attached_files
       before_destroy :prepare_for_destroy

data/lib/paperclip/attachment.rb

@@ -12,6 +12,7 @@ module Paperclip
         :convert_options       => {},
         :default_style         => :original,
         :default_url           => "/:attachment/:style/missing.png",
+        :escape_url            => true,
         :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/,
         :hash_data             => ":class/:attachment/:id/:style/:updated_at",
         :hash_digest           => "SHA1",
@@ -60,6 +61,7 @@ module Paperclip
     # +preserve_files+ - whether to keep files on the filesystem when deleting or clearing the attachment. Defaults to false
     # +interpolator+ - the object used to interpolate filenames and URLs. Defaults to Paperclip::Interpolations
     # +url_generator+ - the object used to generate URLs, using the interpolator. Defaults to Paperclip::UrlGenerator
+    # +escape_url+ - Perform URI escaping to URLs. Defaults to true
     def initialize(name, instance, options = {})
       @name              = name
       @instance          = instance
@@ -90,8 +92,7 @@ module Paperclip
       ensure_required_accessors!
       file = Paperclip.io_adapters.for(uploaded_file)
 
-      @options[:only_process].map!(&:to_sym)
-      self.clear(*@options[:only_process])
+      self.clear(*only_process)
       return nil if file.nil?
 
       @queued_for_write[:original]   = file
@@ -104,7 +105,7 @@ module Paperclip
 
       @dirty = true
 
-      post_process(*@options[:only_process]) if post_processing
+      post_process(*only_process) if post_processing && valid_assignment?
 
       # Reset the file size if the original file was reprocessed.
       instance_write(:file_size,   @queued_for_write[:original].size)
@@ -134,7 +135,7 @@ module Paperclip
     # +#new(Paperclip::Attachment, options_hash)+
     # +#for(style_name, options_hash)+
     def url(style_name = default_style, options = {})
-      default_options = {:timestamp => @options[:use_timestamp], :escape => true}
+      default_options = {:timestamp => @options[:use_timestamp], :escape => @options[:escape_url]}
 
       if options == true || options == false # Backwards compatibility.
         @url_generator.for(style_name, default_options.merge(:timestamp => options))
@@ -157,6 +158,10 @@ module Paperclip
       url(style_name)
     end
 
+    def as_json(options = nil)
+      to_s((options && options[:style]) || default_style)
+    end
+
     def default_style
       @options[:default_style]
     end
@@ -174,6 +179,12 @@ module Paperclip
       @normalized_styles
     end
 
+    def only_process
+      only_process = @options[:only_process].dup
+      only_process = only_process.call(self) if only_process.respond_to?(:call)
+      only_process.map(&:to_sym)
+    end
+
     def processors
       processing_option = @options[:processors]
 
@@ -311,6 +322,10 @@ module Paperclip
 
     alias :present? :file?
 
+    def blank?
+      not present?
+    end
+
     # Determines whether the instance responds to this attribute. Used to prevent
     # calculations on fields we won't even store.
     def instance_respond_to?(attr)
@@ -354,8 +369,14 @@ module Paperclip
       Paperclip.log(message)
     end
 
-    def valid_assignment? file #:nodoc:
-      file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
+    def valid_assignment? #:nodoc:
+      if instance.valid?
+        true
+      else
+        instance.errors.none? do |attr, message|
+          attr.to_s.start_with?(@name.to_s)
+        end
+      end
     end
 
     def initialize_storage #:nodoc:

data/lib/paperclip/callbacks.rb

@@ -22,8 +22,8 @@ module Paperclip
     end
 
     module Running
-      def run_paperclip_callbacks(callback, opts = nil, &block)
-        run_callbacks(callback, opts, &block)
+      def run_paperclip_callbacks(callback, &block)
+        run_callbacks(callback, &block)
       end
     end
   end

data/lib/paperclip/content_type_detector.rb

@@ -49,18 +49,7 @@ module Paperclip
     end
 
     def type_from_file_command
-      type = begin
-        # On BSDs, `file` doesn't give a result code of 1 if the file doesn't exist.
-        Paperclip.run("file", "-b --mime :file", :file => @filename)
-      rescue Cocaine::CommandLineError => e
-        Paperclip.log("Error while determining content type: #{e}")
-        SENSIBLE_DEFAULT
-      end
-
-      if type.match(/\(.*?\)/)
-        type = SENSIBLE_DEFAULT
-      end
-      type.split(/[:;\s]+/)[0]
+      FileCommandContentTypeDetector.new(@filename).detect
     end
 
   end

data/lib/paperclip/file_command_content_type_detector.rb

@@ -0,0 +1,32 @@
+module Paperclip
+  class FileCommandContentTypeDetector
+    SENSIBLE_DEFAULT = "application/octet-stream"
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def detect
+      type_from_file_command
+    end
+
+    private
+
+    def type_from_file_command
+      type = begin
+        # On BSDs, `file` doesn't give a result code of 1 if the file doesn't exist.
+        Paperclip.run("file", "-b --mime :file", :file => @filename)
+      rescue Cocaine::CommandLineError => e
+        Paperclip.log("Error while determining content type: #{e}")
+        SENSIBLE_DEFAULT
+      end
+
+      if type.nil? || type.match(/\(.*?\)/)
+        type = SENSIBLE_DEFAULT
+      end
+      type.split(/[:;\s]+/)[0]
+    end
+
+  end
+end
+

data/lib/paperclip/geometry.rb

@@ -4,37 +4,40 @@ module Paperclip
   class Geometry
     attr_accessor :height, :width, :modifier
 
+    EXIF_ROTATED_ORIENTATION_VALUES = [5, 6, 7, 8]
+
     # Gives a Geometry representing the given height and width
-    def initialize width = nil, height = nil, modifier = nil
-      @height = height.to_f
-      @width  = width.to_f
-      @modifier = modifier
-    end
-
-    # Uses ImageMagick to determing the dimensions of a file, passed in as either a
-    # File or path.
-    # NOTE: (race cond) Do not reassign the 'file' variable inside this method as it is likely to be
-    # a Tempfile object, which would be eligible for file deletion when no longer referenced.
-    def self.from_file file
-      file_path = file.respond_to?(:path) ? file.path : file
-      raise(Errors::NotIdentifiedByImageMagickError.new("Cannot find the geometry of a file with a blank name")) if file_path.blank?
-      geometry = begin
-                   silence_stream(STDERR) do
-                     Paperclip.run("identify", "-format %wx%h :file", :file => "#{file_path}[0]")
-                   end
-                 rescue Cocaine::ExitStatusError
-                   ""
-                 rescue Cocaine::CommandNotFoundError => e
-                   raise Errors::CommandNotFoundError.new("Could not run the `identify` command. Please install ImageMagick.")
-                 end
-      parse(geometry) ||
-        raise(Errors::NotIdentifiedByImageMagickError.new("#{file_path} is not recognized by the 'identify' command."))
-    end
-
-    # Parses a "WxH" formatted string, where W is the width and H is the height.
-    def self.parse string
-      if match = (string && string.match(/\b(\d*)x?(\d*)\b([\>\<\#\@\%^!])?/i))
-        Geometry.new(*match[1,3])
+    def initialize(width = nil, height = nil, modifier = nil)
+      if width.is_a?(Hash)
+        options = width
+        @height = options[:height].to_f
+        @width = options[:width].to_f
+        @modifier = options[:modifier]
+        @orientation = options[:orientation].to_i
+      else
+        @height = height.to_f
+        @width  = width.to_f
+        @modifier = modifier
+      end
+    end
+
+    # Extracts the Geometry from a file (or path to a file)
+    def self.from_file(file)
+      GeometryDetector.new(file).make
+    end
+
+    # Extracts the Geometry from a "WxH,O" string
+    # Where W is the width, H is the height,
+    # and O is the EXIF orientation
+    def self.parse(string)
+      GeometryParser.new(string).make
+    end
+
+    # Swaps the height and width if necessary
+    def auto_orient
+      if EXIF_ROTATED_ORIENTATION_VALUES.include?(@orientation)
+        @height, @width = @width, @height
+        @orientation -= 4
       end
     end
 

data/lib/paperclip/geometry_detector_factory.rb

@@ -0,0 +1,41 @@
+module Paperclip
+  class GeometryDetector
+    def initialize(file)
+      @file = file
+      raise_if_blank_file
+    end
+
+    def make
+      geometry = GeometryParser.new(geometry_string.strip).make
+      geometry || raise(Errors::NotIdentifiedByImageMagickError.new)
+    end
+
+    private
+
+    def geometry_string
+      begin
+        silence_stream(STDERR) do
+          Paperclip.run("identify", "-format '%wx%h,%[exif:orientation]' :file", :file => "#{path}[0]")
+        end
+      rescue Cocaine::ExitStatusError
+        ""
+      rescue Cocaine::CommandNotFoundError => e
+        raise_because_imagemagick_missing
+      end
+    end
+
+    def path
+      @file.respond_to?(:path) ? @file.path : @file
+    end
+
+    def raise_if_blank_file
+      if path.blank?
+        raise Errors::NotIdentifiedByImageMagickError.new("Cannot find the geometry of a file with a blank name")
+      end
+    end
+
+    def raise_because_imagemagick_missing
+      raise Errors::CommandNotFoundError.new("Could not run the `identify` command. Please install ImageMagick.")
+    end
+  end
+end

data/lib/paperclip/geometry_parser_factory.rb

@@ -0,0 +1,31 @@
+module Paperclip
+  class GeometryParser
+    FORMAT = /\b(\d*)x?(\d*)\b(?:,(\d?))?([\>\<\#\@\%^!])?/i
+    def initialize(string)
+      @string = string
+    end
+
+    def make
+      if match
+        Geometry.new(
+          :height => @height,
+          :width => @width,
+          :modifier => @modifier,
+          :orientation => @orientation
+        )
+      end
+    end
+
+    private
+
+    def match
+      if actual_match = @string && @string.match(FORMAT)
+        @width = actual_match[1]
+        @height = actual_match[2]
+        @orientation = actual_match[3]
+        @modifier = actual_match[4]
+      end
+      actual_match
+    end
+  end
+end

data/lib/paperclip/helpers.rb

@@ -17,7 +17,7 @@ module Paperclip
     #   :expected_outcodes -> An array of integers that defines the expected exit codes
     #                         of the binary. Defaults to [0].
     #
-    #   :log_command -> Log the command being run when set to true (defaults to false).
+    #   :log_command -> Log the command being run when set to true (defaults to true).
     #                   This will only log if logging in general is set to true as well.
     #
     #   :swallow_stderr -> Set to true if you don't care what happens on STDERR.
@@ -49,13 +49,13 @@ module Paperclip
       end
     end
 
-    def check_for_url_clash(name,url,klass)
-      @names_url ||= {}
-      default_url = url || Attachment.default_options[:url]
-      if @names_url[name] && @names_url[name][:url] == default_url && @names_url[name][:class] != klass && @names_url[name][:url] !~ /:class/
-        log("Duplicate URL for #{name} with #{default_url}. This will clash with attachment defined in #{@names_url[name][:class]} class")
+    def check_for_path_clash(name,path,klass)
+      @names_path ||= {}
+      default_path = path || Attachment.default_options[:path]
+      if @names_path[name] && @names_path[name][:path] == default_path && @names_path[name][:class] != klass && @names_path[name][:path] !~ /:class/
+        log("Duplicate path for #{name} with #{default_path}. This will clash with attachment defined in #{@names_path[name][:class]} class")
       end
-      @names_url[name] = {:url => default_url, :class => klass}
+      @names_path[name] = {:path => default_path, :class => klass}
     end
 
     def reset_duplicate_clash_check!

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -11,13 +11,29 @@ module Paperclip
       end
     end
 
+    class << self
+      attr_accessor :content_type_detector
+    end
+
     private
 
     def cache_current_values
       @original_filename = @target.original_filename
-      @content_type = @target.content_type.to_s.strip
+      @content_type = determine_content_type
       @size = File.size(@target.path)
     end
+
+    def content_type_detector
+      self.class.content_type_detector
+    end
+
+    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

@@ -32,6 +32,7 @@ module Paperclip
       while data = src.read(16*1024)
         destination.write(data)
       end
+      src.close
       destination.rewind
       destination
     end