dm-paperclip 2.1.4 → 2.3.0

data/lib/dm-paperclip/callback_compatability.rb

@@ -0,0 +1,33 @@
+module Paperclip
+  # This module is intended as a compatability shim for the differences in
+  # callbacks between Rails 2.0 and Rails 2.1.
+  module CallbackCompatability
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+      # The implementation of this method is taken from the Rails 1.2.6 source,
+      # from rails/activerecord/lib/active_record/callbacks.rb, line 192.
+      def define_callbacks(*args)
+        args.each do |method|
+          self.class_eval <<-"end_eval"
+            def self.#{method}(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(#{method.to_sym.inspect}, callbacks)
+            end
+          end_eval
+        end
+      end
+    end
+
+    module InstanceMethods
+      # The callbacks in < 2.1 don't worry about the extra options or the
+      # block, so just run what we have available.
+      def run_callbacks(meth, opts = nil, &blk)
+        callback(meth)
+      end
+    end
+  end
+end

data/lib/dm-paperclip/geometry.rb

@@ -1,13 +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 = nil if height == ''
+      width  = nil if width  == ''
       @height = (height || width).to_f
       @width  = (width  || height).to_f
       @modifier = modifier
@@ -17,13 +17,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}"[0]])
+                 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([\>\<\#\@\%^!])?/i))
         Geometry.new(*match[1,3])
       end
     end
@@ -60,7 +65,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
@@ -68,15 +77,14 @@ module Paperclip
       to_s
     end
 
-    # Returns the scaling and cropping geometries (in string-based ImageMagick format) 
-    # neccessary to transform this Geometry into the Geometry given. If crop is true, 
-    # then it is assumed the destination Geometry will be the exact final resolution. 
-    # In this case, the source Geometry is scaled so that an image containing the 
-    # destination Geometry would be completely filled by the source image, and any 
-    # overhanging image would be cropped. Useful for square thumbnail images. The cropping 
+    # Returns the scaling and cropping geometries (in string-based ImageMagick format)
+    # neccessary to transform this Geometry into the Geometry given. If crop is true,
+    # then it is assumed the destination Geometry will be the exact final resolution.
+    # In this case, the source Geometry is scaled so that an image containing the
+    # destination Geometry would be completely filled by the source image, and any
+    # 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
-
       if crop
         ratio = Geometry.new( dst.width / self.width, dst.height / self.height )
         scale_geometry, scale = scaling(dst, ratio)
@@ -84,7 +92,7 @@ module Paperclip
       else
         scale_geometry        = dst.to_s
       end
-      
+
       [ scale_geometry, crop_geometry ]
     end
 

data/lib/dm-paperclip/interpolations.rb

@@ -0,0 +1,123 @@
+module Paperclip
+  # This module contains all the methods that are available for interpolation
+  # in paths and urls. To add your own (or override an existing one), you
+  # can either open this module and define it, or call the
+  # Paperclip.interpolates method.
+  module Interpolations
+    extend self
+
+    # Hash assignment of interpolations. Included only for compatability,
+    # and is not intended for normal use.
+    def self.[]= name, block
+      define_method(name, &block)
+    end
+
+    # Hash access of interpolations. Included only for compatability,
+    # and is not intended for normal use.
+    def self.[] name
+      method(name)
+    end
+
+    # Returns a sorted list of all interpolations.
+    def self.all
+      self.instance_methods(false).sort
+    end
+
+    # Perform the actual interpolation. Takes the pattern to interpolate
+    # and the arguments to pass, which are the attachment and style name.
+    def self.interpolate pattern, *args
+      all.reverse.inject( pattern.dup ) do |result, tag|
+        result.gsub(/:#{tag}/) do |match|
+          send( tag, *args )
+        end
+      end
+    end
+
+    # Returns the filename, the same way as ":basename.:extension" would.
+    def filename attachment, style
+      "#{basename(attachment, style)}.#{extension(attachment, style)}"
+    end
+
+    # Returns the interpolated URL. Will raise an error if the url itself
+    # contains ":url" to prevent infinite recursion. This interpolation
+    # is used in the default :path to ease default specifications.
+    def url attachment, style
+      raise InfiniteInterpolationError if attachment.options[:url].include?(":url")
+      attachment.url(style, false)
+    end
+
+    # Returns the timestamp as defined by the <attachment>_updated_at field
+    def timestamp attachment, style
+      attachment.instance_read(:updated_at).to_s
+    end
+
+    def web_root attachment, style
+      if Object.const_defined?('Merb')
+        merb_root(attachment, style)
+      elsif Object.const_defined("RAILS_ROOT")
+        rails_root(attachment, style)
+      else
+        ""
+      end
+    end
+
+    # Returns the RAILS_ROOT constant.
+    def rails_root attachment, style
+      Object.const_defined?('RAILS_ROOT') ? RAILS_ROOT : nil
+    end
+
+    # Returns the RAILS_ENV constant.
+    def rails_env attachment, style
+      Object.const_defined?('RAILS_ENV') ? RAILS_ENV : nil
+    end
+
+    def merb_root attachment, style
+      Object.const_defined?('Merb') ? Merb.root : nil
+    end
+
+    def merb_env attachment, style
+      Object.const_defined?('Merb') ? Merb.env : nil
+    end
+
+    # Returns the snake cased, pluralized version of the class name.
+    # e.g. "users" for the User class.
+    def class attachment, style
+      attachment.instance.class.to_s.snake_case.pluralize
+    end
+
+    # Returns the basename of the file. e.g. "file" for "file.jpg"
+    def basename attachment, style
+      attachment.original_filename.gsub(/#{File.extname(attachment.original_filename)}$/, "")
+    end
+
+    # Returns the extension of the file. e.g. "jpg" for "file.jpg"
+    # If the style has a format defined, it will return the format instead
+    # of the actual extension.
+    def extension attachment, style
+      ((style = attachment.styles[style]) && style[:format]) ||
+        File.extname(attachment.original_filename).gsub(/^\.+/, "")
+    end
+
+    # Returns the id of the instance.
+    def id attachment, style
+      attachment.instance.id
+    end
+
+    # Returns the id of the instance in a split path form. e.g. returns
+    # 000/001/234 for an id of 1234.
+    def id_partition attachment, style
+      ("%09d" % attachment.instance.id).scan(/\d{3}/).join("/")
+    end
+
+    # Returns the pluralized form of the attachment name. e.g.
+    # "avatars" for an attachment of :avatar
+    def attachment attachment, style
+      attachment.name.to_s.downcase.pluralize
+    end
+
+    # Returns the style, or the default style if nil is supplied.
+    def style attachment, style
+      style || attachment.default_style
+    end
+  end
+end

data/lib/dm-paperclip/iostream.rb

@@ -25,12 +25,12 @@ module IOStream
     while self.read(in_blocks_of, buffer) do
       dstio.write(buffer)
     end
-    dstio.rewind    
+    dstio.rewind
     dstio
   end
 end
 
-class IO
+class IO #:nodoc:
   include IOStream
 end
 
@@ -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/dm-paperclip/processor.rb

@@ -0,0 +1,49 @@
+module Paperclip
+  # Paperclip processors allow you to modify attached files when they are
+  # attached in any way you are able. Paperclip itself uses command-line
+  # programs for its included Thumbnail processor, but custom processors
+  # are not required to follow suit.
+  #
+  # Processors are required to be defined inside the Paperclip module and
+  # are also required to be a subclass of Paperclip::Processor. There is
+  # only one method you *must* implement to properly be a subclass:
+  # #make, but #initialize may also be of use. Both methods accept 3
+  # arguments: the file that will be operated on (which is an instance of
+  # File), a hash of options that were defined in has_attached_file's
+  # style hash, and the Paperclip::Attachment itself.
+  #
+  # All #make needs to return is an instance of File (Tempfile is
+  # acceptable) which contains the results of the processing.
+  #
+  # See Paperclip.run for more information about using command-line
+  # utilities from within Processors.
+  class Processor
+    attr_accessor :file, :options, :attachment
+
+    def initialize file, options = {}, attachment = nil
+      @file = file
+      @options = options
+      @attachment = attachment
+    end
+
+    def make
+    end
+
+    def self.make file, options = {}, attachment = nil
+      new(file, options, attachment).make
+    end
+  end
+
+  # Due to how ImageMagick handles its image format conversion and how Tempfile
+  # handles its naming scheme, it is necessary to override how Tempfile makes
+  # its names so as to allow for file extensions. Idea taken from the comments
+  # on this blog post:
+  # http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions
+  class Tempfile < ::Tempfile
+    # Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
+    def make_tmpname(basename, n)
+      extension = File.extname(basename)
+      sprintf("%s,%d,%d%s", File.basename(basename, extension), $$, n, extension)
+    end
+  end
+end

data/lib/dm-paperclip/storage.rb

@@ -8,18 +8,18 @@ module Paperclip
     # * +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 
+    #   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 
+    #   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/:filename"
+    #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
     module Filesystem
       def self.extended base
       end
-      
+
       def exists?(style = default_style)
         if original_filename
           File.exist?(path(style))
@@ -31,31 +31,40 @@ 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)))
-          #logger.info("[paperclip] -> #{path(style)}")
-          result = file.stream_to(path(style))
           file.close
-          result.close
+          FileUtils.mkdir_p(File.dirname(path(style)))
+          log("saving #{path(style)}")
+          FileUtils.mv(file.path, path(style))
+          FileUtils.chmod(0644, path(style))
         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}")
+            log("deleting #{path}")
             FileUtils.rm(path) if File.exist?(path)
           rescue Errno::ENOENT => e
             # ignore file-not-found, let everything else pass
           end
+          begin
+            while(true)
+              path = File.dirname(path)
+              FileUtils.rmdir(path)
+            end
+          rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
+            # Stop trying to remove parent directories
+          rescue SystemCallError => e
+            log("There was an unexpected error while deleting directories: #{e.class}")
+            # Ignore it
+          end
         end
         @queued_for_delete = []
       end
@@ -70,35 +79,48 @@ module Paperclip
     #   database.yml file, so different environments can use different accounts:
     #     development:
     #       access_key_id: 123...
-    #       secret_access_key: 123... 
+    #       secret_access_key: 123...
     #     test:
     #       access_key_id: abc...
-    #       secret_access_key: abc... 
+    #       secret_access_key: abc...
     #     production:
     #       access_key_id: 456...
-    #       secret_access_key: 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... 
+    #     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 
+    #   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 
+    # * +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.
+    # * +s3_headers+: A hash of headers such as {'Expires' => 1.year.from_now.httpdate}
     # * +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
+    #   You can define the bucket as a Proc if you want to determine it's name at runtime.
+    #   Paperclip will call that Proc with attachment as the only argument.
+    # * +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.
+    # * +url+: There are three 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).
+    #   Lastly, you can specify a CNAME (which requires the CNAME to be specified as
+    #   :s3_alias_url. You can read more about CNAMEs and S3 at
+    #   http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
     #   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.
+    #   NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
+    #   :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
+    #   alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
+    #   by S3.
     # * +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
@@ -109,19 +131,24 @@ module Paperclip
         require 'right_aws'
         base.instance_eval do
           @s3_credentials = parse_credentials(@options[:s3_credentials])
-          @bucket         = @options[:bucket] || @s3_credentials[:bucket]
-          @s3_options     = @options[:s3_options] || {}
+          @bucket         = @options[:bucket]         || @s3_credentials[:bucket]
+          @bucket         = @bucket.call(self) if @bucket.is_a?(Proc)
+          @s3_options     = @options[:s3_options]     || {}
           @s3_permissions = @options[:s3_permissions] || 'public-read'
-          @s3_protocol    = @options[:s3_protocol] || (@s3_permissions == 'public-read' ? 'http' : 'https')
+          @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == 'public-read' ? 'http' : 'https')
+          @s3_headers     = @options[:s3_headers]     || {}
+          @s3_host_alias  = @options[:s3_host_alias]
           @url            = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
         end
-        base.class.interpolations[:s3_path_url] = lambda do |attachment, style|
+        Paperclip.interpolates(:s3_alias_url) do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+        Paperclip.interpolates(:s3_path_url) 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|
+        Paperclip.interpolates(:s3_domain_url) 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
@@ -138,11 +165,19 @@ module Paperclip
         @bucket
       end
 
+      def s3_host_alias
+        @s3_host_alias
+      end
+
       def parse_credentials creds
-        creds = stringify_keys(find_credentials(creds))
-        symbolize_keys((creds[Merb.env] || creds))
+        creds = find_credentials(creds).to_mash
+        if defined? Merb && Merb.respond_to?(:env)
+          (creds[Merb.env] || creds)
+        else
+          (creds[RAILS_ENV] || creds)
+        end
       end
-      
+
       def exists?(style = default_style)
         s3_bucket.key(path(style)) ? true : false
       end
@@ -159,13 +194,12 @@ 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)}")
+            log("saving #{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)}.merge(@s3_headers))
           rescue RightAws::AwsError => e
             raise
           end
@@ -174,10 +208,9 @@ 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}")
+            log("deleting #{path}")
             if file = s3_bucket.key(path)
               file.delete
             end
@@ -187,14 +220,14 @@ module Paperclip
         end
         @queued_for_delete = []
       end
-      
+
       def find_credentials creds
         case creds
-        when File:
+        when File
           YAML.load_file(creds.path)
-        when String:
+        when String
           YAML.load_file(creds)
-        when Hash:
+        when Hash
           creds
         else
           raise ArgumentError, "Credentials are not a path, file, or hash."
@@ -202,22 +235,6 @@ module Paperclip
       end
       private :find_credentials
 
-      private
-
-      def stringify_keys(hash)
-        hash.inject({}) do |options, (key, value)|
-          options[key.to_s] = value
-          options
-        end
-      end
-
-      def symbolize_keys(hash)
-        hash.inject({}) do |options, (key, value)|
-          options[key.to_sym || key] = value
-          options
-        end
-      end
-
     end
   end
 end