paperclip 2.1.2 → 2.1.5

data/lib/paperclip/geometry.rb

@@ -1,15 +1,13 @@
 module Paperclip
-  
+
   # Defines the geometry of an image.
   class Geometry
     attr_accessor :height, :width, :modifier
 
     # Gives a Geometry representing the given height and width
     def initialize width = nil, height = nil, modifier = nil
-      height = nil if height == ""
-      width  = nil if width  == ""
-      @height = (height || width).to_f
-      @width  = (width  || height).to_f
+      @height = height.to_f
+      @width  = width.to_f
       @modifier = modifier
     end
 
@@ -17,13 +15,18 @@ module Paperclip
     # File or path.
     def self.from_file file
       file = file.path if file.respond_to? "path"
-      parse(`#{Paperclip.path_for_command('identify')} "#{file}"`) ||
+      geometry = begin
+                   Paperclip.run("identify", %Q[-format "%wx%h" "#{file}"])
+                 rescue PaperclipCommandLineError
+                   ""
+                 end
+      parse(geometry) ||
         raise(NotIdentifiedByImageMagickError.new("#{file} 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([\>\<\#\@\%^!])?/))
+      if match = (string && string.match(/\b(\d*)x?(\d*)\b([\>\<\#\@\%^!])?/))
         Geometry.new(*match[1,3])
       end
     end
@@ -60,7 +63,11 @@ module Paperclip
 
     # Returns the width and height in a format suitable to be passed to Geometry.parse
     def to_s
-      "%dx%d%s" % [width, height, modifier]
+      s = ""
+      s << width.to_i.to_s if width > 0
+      s << "x#{height.to_i}" if height > 0
+      s << modifier.to_s
+      s
     end
 
     # Same as to_s
@@ -76,15 +83,14 @@ module Paperclip
     # overhanging image would be cropped. Useful for square thumbnail images. The cropping 
     # is weighted at the center of the Geometry.
     def transformation_to dst, crop = false
-      ratio = Geometry.new( dst.width / self.width, dst.height / self.height )
-
       if crop
+        ratio = Geometry.new( dst.width / self.width, dst.height / self.height )
         scale_geometry, scale = scaling(dst, ratio)
         crop_geometry         = cropping(dst, ratio, scale)
       else
         scale_geometry        = dst.to_s
       end
-      
+
       [ scale_geometry, crop_geometry ]
     end
 

data/lib/paperclip/iostream.rb

@@ -11,7 +11,7 @@ module IOStream
 
   # Copies one read-able object from one place to another in blocks, obviating the need to load
   # the whole thing into memory. Defaults to 8k blocks. If this module is included in both
-  # both StringIO and Tempfile, then either can have its data copied anywhere else without typing
+  # StringIO and Tempfile, then either can have its data copied anywhere else without typing
   # worries or memory overhead worries. Returns a File if a String is passed in as the destination
   # and returns the IO or Tempfile as passed in if one is sent as the destination.
   def stream_to path_or_file, in_blocks_of = 8192
@@ -41,3 +41,18 @@ end
     end
   end
 end
+
+# Corrects a bug in Windows when asking for Tempfile size.
+if defined? Tempfile
+  class Tempfile
+    def size
+      if @tmpfile
+        @tmpfile.fsync
+        @tmpfile.flush
+        @tmpfile.stat.size
+      else
+        0
+      end
+    end
+  end
+end

data/lib/paperclip/storage.rb

@@ -1,6 +1,21 @@
 module Paperclip
   module Storage
 
+    # 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.
+    # * +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
+    #   hitting your app. Defaults to 
+    #   ":rails_root/public/:attachment/:id/:style/:basename.:extension"
+    #   By default this places the files in the app's public directory which can be served 
+    #   directly. If you are using capistrano for deployment, a good idea would be to 
+    #   make a symlink to the capistrano-created system directory from inside your app's 
+    #   public directory.
+    #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
+    #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
     module Filesystem
       def self.extended base
       end
@@ -16,23 +31,27 @@ module Paperclip
       # Returns representation of the data of the file assigned to the given
       # style, in the format most representative of the current storage.
       def to_file style = default_style
-        @queued_for_write[style] || (File.new(path(style)) if exists?(style))
+        @queued_for_write[style] || (File.new(path(style), 'rb') if exists?(style))
       end
       alias_method :to_io, :to_file
 
       def flush_writes #:nodoc:
+        logger.info("[paperclip] Writing files for #{name}")
         @queued_for_write.each do |style, file|
           FileUtils.mkdir_p(File.dirname(path(style)))
-          result = file.stream_to(path(style))
+          logger.info("[paperclip] -> #{path(style)}")
+          FileUtils.mv(file.path, path(style))
+          FileUtils.chmod(0644, path(style))
           file.close
-          result.close
         end
         @queued_for_write = {}
       end
 
       def flush_deletes #:nodoc:
+        logger.info("[paperclip] Deleting files for #{name}")
         @queued_for_delete.each do |path|
           begin
+            logger.info("[paperclip] -> #{path}")
             FileUtils.rm(path) if File.exist?(path)
           rescue Errno::ENOENT => e
             # ignore file-not-found, let everything else pass
@@ -42,19 +61,67 @@ module Paperclip
       end
     end
 
+    # Amazon's S3 file hosting service is a scalable, easy place to store files for
+    # distribution. You can find out more about it at http://aws.amazon.com/s3
+    # There are a few S3-specific options for has_attached_file:
+    # * +s3_credentials+: Takes a path, a File, or a Hash. The path (or File) must point
+    #   to a YAML file containing the +access_key_id+ and +secret_access_key+ that Amazon
+    #   gives you. You can 'environment-space' this just like you do to your
+    #   database.yml file, so different environments can use different accounts:
+    #     development:
+    #       access_key_id: 123...
+    #       secret_access_key: 123... 
+    #     test:
+    #       access_key_id: abc...
+    #       secret_access_key: abc... 
+    #     production:
+    #       access_key_id: 456...
+    #       secret_access_key: 456... 
+    #   This is not required, however, and the file may simply look like this:
+    #     access_key_id: 456...
+    #     secret_access_key: 456... 
+    #   In which case, those access keys will be used in all environments. You can also
+    #   put your bucket name in this file, instead of adding it to the code directly.
+    #   This is useful when you want the same account but a different bucket for 
+    #   development versus production.
+    # * +s3_permissions+: This is a String that should be one of the "canned" access
+    #   policies that S3 provides (more information can be found here:
+    #   http://docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies)
+    #   The default for Paperclip is "public-read".
+    # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either 
+    #   'http' or 'https'. Defaults to 'http' when your :s3_permissions are 'public-read' (the
+    #   default), and 'https' when your :s3_permissions are anything else.
+    # * +bucket+: This is the name of the S3 bucket that will 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. The bucket name will not be interpolated.
+    # * +url+: There are two 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).
+    #   Normally, this won't matter in the slightest and you can leave the default (which is
+    #   path-style, or :s3_path_url). But in some cases paths don't work and you need to use
+    #   the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
+    # * +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 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.
     module S3
       def self.extended base
         require 'right_aws'
         base.instance_eval do
-          @bucket             = @options[:bucket]
-          @s3_credentials     = parse_credentials(@options[:s3_credentials])
-          @s3_options         = @options[:s3_options] || {}
-          @s3_permissions     = @options[:s3_permissions] || 'public-read'
-          @url                = ":s3_url"
+          @s3_credentials = parse_credentials(@options[:s3_credentials])
+          @bucket         = @options[:bucket] || @s3_credentials[:bucket]
+          @s3_options     = @options[:s3_options] || {}
+          @s3_permissions = @options[:s3_permissions] || 'public-read'
+          @s3_protocol    = @options[:s3_protocol] || (@s3_permissions == 'public-read' ? 'http' : 'https')
+          @url            = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
         end
-        base.class.interpolations[:s3_url] = lambda do |attachment, style|
-          "https://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        base.class.interpolations[:s3_path_url] = lambda do |attachment, style|
+          "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
         end
+        base.class.interpolations[:s3_domain_url] = lambda do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+        ActiveRecord::Base.logger.info("[paperclip] S3 Storage Initalized.")
       end
 
       def s3
@@ -80,6 +147,10 @@ module Paperclip
         s3_bucket.key(path(style)) ? true : false
       end
 
+      def s3_protocol
+        @s3_protocol
+      end
+
       # Returns representation of the data of the file assigned to the given
       # style, in the format most representative of the current storage.
       def to_file style = default_style
@@ -88,11 +159,13 @@ module Paperclip
       alias_method :to_io, :to_file
 
       def flush_writes #:nodoc:
+        logger.info("[paperclip] Writing files for #{name}")
         @queued_for_write.each do |style, file|
           begin
+            logger.info("[paperclip] -> #{path(style)}")
             key = s3_bucket.key(path(style))
             key.data = file
-            key.put(nil, @s3_permissions)
+            key.put(nil, @s3_permissions, {'Content-type' => instance_read(:content_type)})
           rescue RightAws::AwsError => e
             raise
           end
@@ -101,8 +174,10 @@ module Paperclip
       end
 
       def flush_deletes #:nodoc:
+        logger.info("[paperclip] Writing files for #{name}")
         @queued_for_delete.each do |path|
           begin
+            logger.info("[paperclip] -> #{path}")
             if file = s3_bucket.key(path)
               file.delete
             end

data/lib/paperclip/thumbnail.rb

@@ -2,18 +2,20 @@ module Paperclip
   # Handles thumbnailing images that are uploaded.
   class Thumbnail
 
-    attr_accessor :file, :current_geometry, :target_geometry, :format, :whiny_thumbnails
+    attr_accessor :file, :current_geometry, :target_geometry, :format, :whiny_thumbnails, :convert_options
 
     # Creates a Thumbnail object set to work on the +file+ given. It
     # will attempt to transform the image into one defined by +target_geometry+
     # which is a "WxH"-style string. +format+ will be inferred from the +file+
     # unless specified. Thumbnail creation will raise no errors unless
-    # +whiny_thumbnails+ is true (which it is, by default.
-    def initialize file, target_geometry, format = nil, whiny_thumbnails = true
+    # +whiny_thumbnails+ is true (which it is, by default. If +convert_options+ is
+    # set, the options will be appended to the convert command upon image conversion 
+    def initialize file, target_geometry, format = nil, convert_options = nil, whiny_thumbnails = true
       @file             = file
       @crop             = target_geometry[-1,1] == '#'
       @target_geometry  = Geometry.parse target_geometry
       @current_geometry = Geometry.from_file file
+      @convert_options  = convert_options
       @whiny_thumbnails = whiny_thumbnails
 
       @current_format   = File.extname(@file.path)
@@ -24,14 +26,19 @@ module Paperclip
 
     # Creates a thumbnail, as specified in +initialize+, +make+s it, and returns the
     # resulting Tempfile.
-    def self.make file, dimensions, format = nil, whiny_thumbnails = true
-      new(file, dimensions, format, whiny_thumbnails).make
+    def self.make file, dimensions, format = nil, convert_options = nil, whiny_thumbnails = true
+      new(file, dimensions, format, convert_options, whiny_thumbnails).make
     end
 
     # Returns true if the +target_geometry+ is meant to crop.
     def crop?
       @crop
     end
+    
+    # Returns true if the image is meant to make use of additional convert options.
+    def convert_options?
+      not @convert_options.blank?
+    end
 
     # Performs the conversion of the +file+ into a thumbnail. Returns the Tempfile
     # that contains the new image.
@@ -41,15 +48,15 @@ module Paperclip
       dst.binmode
 
       command = <<-end_command
-        #{ Paperclip.path_for_command('convert') }
-        "#{ File.expand_path(src.path) }"
+        "#{ File.expand_path(src.path) }[0]"
         #{ transformation_command }
         "#{ File.expand_path(dst.path) }"
       end_command
-      success = system(command.gsub(/\s+/, " "))
 
-      if success && $?.exitstatus != 0 && @whiny_thumbnails
-        raise PaperclipError, "There was an error processing this thumbnail"
+      begin
+        success = Paperclip.run("convert", command.gsub(/\s+/, " "))
+      rescue PaperclipCommandLineError
+        raise PaperclipError, "There was an error processing the thumbnail for #{@basename}" if @whiny_thumbnails
       end
 
       dst
@@ -59,8 +66,9 @@ module Paperclip
     # into the thumbnail.
     def transformation_command
       scale, crop = @current_geometry.transformation_to(@target_geometry, crop?)
-      trans = "-scale \"#{scale}\""
+      trans = "-resize \"#{scale}\""
       trans << " -crop \"#{crop}\" +repage" if crop
+      trans << " #{convert_options}" if convert_options?
       trans
     end
   end

data/lib/paperclip/upfile.rb

@@ -6,12 +6,15 @@ module Paperclip
 
     # Infer the MIME-type of the file from the extension.
     def content_type
-      type = self.path.match(/\.(\w+)$/)[1] rescue "octet-stream"
+      type = (self.path.match(/\.(\w+)$/)[1] rescue "octet-stream").downcase
       case type
-      when "jpg", "png", "gif" then "image/#{type}"
-      when "txt" then "text/plain"
-      when "csv", "xml", "html", "htm", "css", "js" then "text/#{type}"
-      else "x-application/#{type}"
+      when %r"jpe?g"                 then "image/jpeg"
+      when %r"tiff?"                 then "image/tiff"
+      when %r"png", "gif", "bmp"     then "image/#{type}"
+      when "txt"                     then "text/plain"
+      when %r"html?"                 then "text/html"
+      when "csv", "xml", "css", "js" then "text/#{type}"
+      else "application/x-#{type}"
       end
     end
 
@@ -25,9 +28,21 @@ module Paperclip
       File.size(self)
     end
   end
+end
 
+if defined? StringIO
+  class StringIO
+    attr_accessor :original_filename, :content_type
+    def original_filename
+      @original_filename ||= "stringio.txt"
+    end
+    def content_type
+      @content_type ||= "text/plain"
+    end
+  end
 end
 
 class File #:nodoc:
   include Paperclip::Upfile
 end
+

data/shoulda_macros/paperclip.rb

@@ -0,0 +1,32 @@
+module Paperclip
+  module Shoulda
+    def should_have_attached_file name, options = {}
+      klass = self.name.gsub(/Test$/, '').constantize
+      context "Class #{klass.name} with attachment #{name}" do
+        should "respond to all the right methods" do
+          ["#{name}", "#{name}=", "#{name}?"].each do |meth|
+            assert klass.instance_methods.include?(meth), "#{klass.name} does not respond to #{name}."
+          end
+        end
+
+        should "have the correct definition" do
+          expected = options
+          actual   = klass.attachment_definitions[name]
+          expected.delete(:validations)      if not options.key?(:validations)
+          expected.delete(:whiny_thumbnails) if not options.key?(:whiny_thumbnails)
+
+          assert_equal expected, actual
+        end
+
+        should "ensure that ImageMagick is available" do
+          %w( convert identify ).each do |command|
+            `#{Paperclip.path_for_command(command)}`
+            assert_equal 0, $?, "ImageMagick's #{command} returned with an error. Make sure that #{command} is available at #{Paperclip.path_for_command(command)}"
+          end
+        end
+      end
+    end
+  end
+end
+
+Test::Unit::TestCase.extend(Paperclip::Shoulda)

data/tasks/paperclip_tasks.rake

@@ -14,25 +14,66 @@ def obtain_attachments
   end
 end
 
+def for_all_attachments
+  klass = obtain_class
+  names = obtain_attachments
+  ids   = klass.connection.select_values("SELECT #{klass.primary_key} FROM #{klass.table_name}")
+
+  ids.each do |id|
+    instance = klass.find(id)
+    names.each do |name|
+      result = if instance.send("#{ name }?")
+                 yield(instance, name)
+               else
+                 true
+               end
+      print result ? "." : "x"; $stdout.flush
+    end
+  end
+  puts " Done."
+end
+
 namespace :paperclip do
-  desc "Regenerates thumbnails for a given CLASS (and optional ATTACHMENT)"
-  task :refresh => :environment do
-    klass     = obtain_class
-    names     = obtain_attachments
-    instances = klass.find(:all)
-    
-    puts "Regenerating thumbnails for #{instances.length} instances of #{klass.name}:"
-    instances.each do |instance|
-      names.each do |name|
-        result = if instance.send("#{ name }?")
-          instance.send(name).reprocess!
-          instance.send(name).save
+  desc "Refreshes both metadata and thumbnails."
+  task :refresh => ["paperclip:refresh:metadata", "paperclip:refresh:thumbnails"]
+
+  namespace :refresh do
+    desc "Regenerates thumbnails for a given CLASS (and optional ATTACHMENT)."
+    task :thumbnails => :environment do
+      errors = []
+      for_all_attachments do |instance, name|
+        result = instance.send(name).reprocess!
+        errors << [instance.id, instance.errors] unless instance.errors.blank?
+        result
+      end
+      errors.each{|e| puts "#{e.first}: #{e.last.full_messages.inspect}" }
+    end
+
+    desc "Regenerates content_type/size metadata for a given CLASS (and optional ATTACHMENT)."
+    task :metadata => :environment do
+      for_all_attachments do |instance, name|
+        if file = instance.send(name).to_file
+          instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
+          instance.send("#{name}_content_type=", file.content_type.strip)
+          instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
+          instance.save(false)
         else
           true
         end
-        print result ? "." : "x"; $stdout.flush
       end
     end
-    puts " Done."
+  end
+
+  desc "Cleans out invalid attachments. Useful after you've added new validations."
+  task :clean => :environment do
+    for_all_attachments do |instance, name|
+      instance.send(name).send(:validate)
+      if instance.send(name).valid?
+        true
+      else
+        instance.send("#{name}=", nil)
+        instance.save
+      end
+    end
   end
 end