dm-paperclip 2.1.2.1 → 2.1.4

data/{README.textile → README.rdoc}

@@ -1,4 +1,4 @@
-h1. DataMapper Paperclip
+=DataMapper Paperclip
 
 DM-Paperclip is a port of Thoughtbot's Paperclip plugin to work with DataMapper 0.9.  This plugin is fully compatible with
 the original ActiveRecord-oriented Paperclip.  You could take an existing ActiveRecord database and use it with DataMapper.
@@ -14,11 +14,11 @@ It processes the thumbnails through the command-line applications instead of usi
 
 See the documentation for the +has_attached_file+ method for options.
 
-h2. Code
+==Code
 
 The code DM-Paperclip is available at Github:
 
-  git clone git://github.com/krobertson/paperclip.git
+  git clone git://github.com/krobertson/dm-paperclip.git
 
 It is regularly updated to keep in sync with the latest from Thoughtbot.
 
@@ -27,7 +27,7 @@ packaged as a gem through Rubyforge:
 
   sudo gem install dm-paperclip
 
-h2. Usage
+==Usage
 
 In your model:
 
@@ -41,8 +41,9 @@ In your model:
                                    :thumb => "100x100>" }
   end
 
-Your database will need to add three columns, +avatar_file_name+ (varchar), +avatar_content_type+ (varchar), and
-+avatar_file_size+ (integer).  You can either add these manually, auto-migrate, or use the following migration:
+Your database will need to add four columns, avatar_file_name (varchar), avatar_content_type (varchar), and
+avatar_file_size (integer), and avatar_updated_at (datetime).  You can either add these manually, auto-
+migrate, or use the following migration:
 
   migration( 1, :add_user_paperclip_fields ) do
   up do
@@ -50,11 +51,12 @@ Your database will need to add three columns, +avatar_file_name+ (varchar), +ava
         add_column :avatar_file_name, "varchar(255)"
         add_column :avatar_content_type, "varchar(255)"
         add_column :avatar_file_size, "integer"
+        add_column :avatar_updated_at, "datetime"
       end
     end
     down do
       modify_table :users do
-        drop_columns :avatar_file_name, :avatar_content_type, :avatar_file_size
+        drop_columns :avatar_file_name, :avatar_content_type, :avatar_file_size, :avatar_updated_at
       end
     end
   end

data/Rakefile

@@ -14,7 +14,7 @@ task :default => [:clean, :test]
 desc 'Test the DM-Paperclip library.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'dm-paperclip'
-  t.pattern = 'test/**/test_*.rb'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
@@ -30,7 +30,7 @@ Rake::RDocTask.new(:doc) do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = 'DM-Paperclip'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
  
@@ -55,11 +55,11 @@ spec = Gem::Specification.new do |s|
   s.name              = "dm-paperclip"
   s.version           = Paperclip::VERSION
   s.author            = "Ken Robertson"
-  s.email             = "ken@invalidlogic.com jyurek@thoughtbot.com"
+  s.email             = "ken@invalidlogic.com"
   s.homepage          = "http://invalidlogic.com/dm-paperclip/"
   s.platform          = Gem::Platform::RUBY
   s.summary           = "File attachments as attributes for DataMapper, based on the original Paperclip by Jon Yurek at Thoughtbot"
-  s.files             = FileList["README.textile",
+  s.files             = FileList["README.rdoc",
                                  "LICENSE",
                                  "Rakefile",
                                  "init.rb",
@@ -68,7 +68,7 @@ spec = Gem::Specification.new do |s|
   s.test_files        = FileList["test/**/test_*.rb"].to_a
   s.rubyforge_project = "dm-paperclip"
   s.has_rdoc          = true
-  s.extra_rdoc_files  = ["README.textile"]
+  s.extra_rdoc_files  = ["README.rdoc"]
   s.rdoc_options << '--line-numbers' << '--inline-source'
   s.requirements << "ImageMagick"
   s.requirements << "data_mapper"

data/lib/dm-paperclip.rb

@@ -37,7 +37,7 @@ require File.join(File.dirname(__FILE__), 'dm-paperclip', 'attachment')
 require File.join(File.dirname(__FILE__), 'dm-paperclip', 'validations') unless defined?(DataMapper::Validate).nil?
 
 module Paperclip
-  VERSION = "2.1.2.1"
+  VERSION = "2.1.4"
   class << self
     # Provides configurability to Paperclip. There are a number of options available, such as:
     # * whiny_thumbnails: Will raise an error if Paperclip cannot process thumbnails of 
@@ -66,12 +66,21 @@ module Paperclip
 
   module Resource
     def self.included(base)
+      base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        class_variable_set(:@@attachment_definitions,nil) unless class_variable_defined?(:@@attachment_definitions)
+        def self.attachment_definitions
+          @@attachment_definitions
+        end
+
+        def self.attachment_definitions=(obj)
+          @@attachment_definitions = obj
+        end
+      RUBY
       base.extend Paperclip::ClassMethods
     end
   end
 
   module ClassMethods
-    @@attachment_definitions = {}
 
     # +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
     # is typically a file stored somewhere on the filesystem and has been uploaded by a user. 
@@ -106,30 +115,40 @@ module Paperclip
     #     has_attached_file :avatar, :styles => { :normal => "100x100#" },
     #                       :default_style => :normal
     #     user.avatar.url # => "/avatars/23/normal_me.png"
-    # * +path+: The location of the repository of attachments on disk. This can 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 
-    #   ":merb_root/public/:class/:attachment/:id/:style_:filename". 
-    #   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"
     # * +whiny_thumbnails+: Will raise an error if Paperclip cannot process thumbnails of an
     #   uploaded image. This will ovrride the global setting for this attachment. 
     #   Defaults to true. 
+    # * +convert_options+: When creating thumbnails, use this free-form options
+    #   field to pass in various convert command options.  Typical options are "-strip" to
+    #   remove all Exif data from the image (save space for thumbnails and avatars) or
+    #   "-depth 8" to specify the bit depth of the resulting conversion.  See ImageMagick
+    #   convert documentation for more options: (http://www.imagemagick.org/script/convert.php)
+    #   Note that this option takes a hash of options, each of which correspond to the style
+    #   of thumbnail being generated. You can also specify :all as a key, which will apply
+    #   to all of the thumbnails being generated. If you specify options for the :original,
+    #   it would be best if you did not specify destructive options, as the intent of keeping
+    #   the original around is to regenerate all the thumbnails then requirements change.
+    #     has_attached_file :avatar, :styles => { :large => "300x300", :negative => "100x100" }
+    #                                :convert_options => {
+    #                                  :all => "-strip",
+    #                                  :negative => "-negate"
+    #                                }
+    # * +storage+: Chooses the storage backend where the files will be stored. The current
+    #   choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
+    #   documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
+    #   for backend-specific options.
     def has_attached_file name, options = {}
       include InstanceMethods
 
-      @@attachment_definitions = {} if @@attachment_definitions.nil?
-      @@attachment_definitions[name] = {:validations => []}.merge(options)
+      self.attachment_definitions = {} if self.attachment_definitions.nil?
+      self.attachment_definitions[name] = {:validations => []}.merge(options)
       
       property_options = options.delete_if { |k,v| ![ :public, :protected, :private, :accessor, :reader, :writer ].include?(key) }
 
       property "#{name}_file_name".to_sym, String, property_options
       property "#{name}_content_type".to_sym, String, property_options
       property "#{name}_file_size".to_sym, Integer, property_options
+      property "#{name}_updated_at".to_sym, DateTime, property_options
 
       after :save, :save_attached_files
       before :destroy, :destroy_attached_files
@@ -167,7 +186,7 @@ module Paperclip
 
     # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
     def validates_attachment_thumbnails name, options = {}
-      @@attachment_definitions[name][:whiny_thumbnails] = true
+      self.attachment_definitions[name][:whiny_thumbnails] = true
     end
 
     # Places ActiveRecord-style validations on the presence of a file.
@@ -187,11 +206,6 @@ module Paperclip
 
     end
 
-    # Returns the attachment definitions defined by each call to has_attached_file.
-    def attachment_definitions
-      @@attachment_definitions
-    end
-
   end
 
   module InstanceMethods #:nodoc:
@@ -207,12 +221,14 @@ module Paperclip
     end
 
     def save_attached_files
+      #logger.info("[paperclip] Saving attachments.")
       each_attachment do |name, attachment|
         attachment.send(:save)
       end
     end
 
     def destroy_attached_files
+      #logger.info("[paperclip] Deleting attachments.")
       each_attachment do |name, attachment|
         attachment.send(:queue_existing_for_delete)
         attachment.send(:flush_deletes)

data/lib/dm-paperclip/attachment.rb

@@ -15,7 +15,7 @@ module Paperclip
       }
     end
 
-    attr_reader :name, :instance, :styles, :default_style
+    attr_reader :name, :instance, :styles, :default_style, :convert_options
 
     # Creates an Attachment object. +name+ is the name of the attachment, +instance+ is the
     # ActiveRecord object instance it's attached to, and +options+ is the same as the hash
@@ -34,6 +34,7 @@ module Paperclip
       @default_style     = options[:default_style]
       @storage           = options[:storage]
       @whiny_thumbnails  = options[:whiny_thumbnails]
+      @convert_options   = options[:convert_options] || {}
       @options           = options
       @queued_for_delete = []
       @queued_for_write  = {}
@@ -43,13 +44,22 @@ module Paperclip
 
       normalize_style_definition
       initialize_storage
+
+      #logger.info("[paperclip] Paperclip attachment #{name} on #{instance.class} initialized.")
     end
 
     # What gets called when you call instance.attachment = File. It clears errors,
     # assigns attributes, processes the file, and runs validations. It also queues up
     # the previous file for deletion, to be flushed away on #save of its host.
+    # In addition to form uploads, you can also assign another Paperclip attachment:
+    #   new_user.avatar = old_user.avatar
     def assign uploaded_file
+      if uploaded_file.is_a?(Paperclip::Attachment)
+        uploaded_file = uploaded_file.to_file(:original)
+      end
+
       return nil unless valid_assignment?(uploaded_file)
+      #logger.info("[paperclip] Assigning #{uploaded_file.inspect} to #{name}")
 
       queue_existing_for_delete
       @errors            = []
@@ -57,23 +67,36 @@ module Paperclip
 
       return nil if uploaded_file.nil?
 
+      #logger.info("[paperclip] Writing attributes for #{name}")
+      newvals = {}
       if uploaded_file.is_a?(Mash)
         @queued_for_write[:original]          = uploaded_file['tempfile']
-        newvals = { :"#{@name}_file_name"    => uploaded_file['filename'],
-                    :"#{@name}_content_type" => uploaded_file['content_type'],
-                    :"#{@name}_file_size"    => uploaded_file['size'] }
-        @instance.update_attributes(newvals)
+        newvals = { :"#{@name}_file_name"    => uploaded_file['filename'].strip.gsub(/[^\w\d\.\-]+/, '_'),
+                    :"#{@name}_content_type" => uploaded_file['content_type'].strip,
+                    :"#{@name}_file_size"    => uploaded_file['size'],
+                    :"#{@name}_updated_at"   => Time.now }
       else
         @queued_for_write[:original]          = uploaded_file.to_tempfile
-        newvals = { :"#{@name}_file_name"    => uploaded_file.original_filename,
-                    :"#{@name}_content_type" => uploaded_file.content_type,
-                    :"#{@name}_file_size"    => uploaded_file.size }
-        @instance.update_attributes(newvals)
+        newvals = { :"#{@name}_file_name"    => uploaded_file.original_filename.strip.gsub(/[^\w\d\.\-]+/, '_'),
+                    :"#{@name}_content_type" => uploaded_file.content_type.strip,
+                    :"#{@name}_file_size"    => uploaded_file.size,
+                    :"#{@name}_updated_at"   => Time.now }
       end
 
+      post_process
       @dirty = true
 
-      post_process
+      # Reset the file size if the original file was reprocessed.
+      #newvals[:"#{@name}_file_size"] = uploaded_file.size.to_i
+      if @styles[:original]
+        newvals[:"#{@name}_file_size"] = @queued_for_write[:original].size.to_i
+      end
+
+      begin
+        @instance.attributes = newvals
+      rescue NameError
+        raise PaperclipError, "There was an error processing this attachment"
+      end
     ensure
       validate
     end
@@ -84,12 +107,13 @@ module Paperclip
     # This is not recommended if you don't need the security, however, for
     # performance reasons.
     def url style = default_style
-      original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style)
+      url = original_filename.nil? ? interpolate(@default_url, style) : interpolate(@url, style)
+      updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
     end
 
-    # Returns the path of the attachment as defined by the :path optionn. If the
+    # Returns the path of the attachment as defined by the :path option. If the
     # file is stored in the filesystem the path refers to the path of the file on
-    # disk. If the file is stored in S3, the path is the "key" part of th URL,
+    # disk. If the file is stored in S3, the path is the "key" part of the URL,
     # and the :bucket option refers to the S3 bucket.
     def path style = nil #:nodoc:
       interpolate(@path, style)
@@ -100,7 +124,7 @@ module Paperclip
       url(style)
     end
 
-    # Returns true if there are any errors on this attachment.
+    # Returns true if there are no errors on this attachment.
     def valid?
       @errors.length == 0
     end
@@ -119,11 +143,13 @@ module Paperclip
     # the instance's errors and returns false, cancelling the save.
     def save
       if valid?
+        #logger.info("[paperclip] Saving files for #{name}")
         flush_deletes
         flush_writes
         @dirty = false
         true
       else
+        #logger.info("[paperclip] Errors on #{name}. Not saving.")
         flush_errors
         false
       end
@@ -132,7 +158,16 @@ module Paperclip
     # Returns the name of the file as originally assigned, and as lives in the
     # <attachment>_file_name attribute of the model.
     def original_filename
-      @instance.attribute_get(:"#{name}_file_name")
+      begin
+        @instance.attribute_get(:"#{name}_file_name")
+      rescue ArgumentError
+        nil
+      end
+    end
+    
+    def updated_at
+      time = @instance.attribute_get(:"#{name}_updated_at")
+      time && "#{time.year}#{time.month}#{time.day}#{time.hour}#{time.min}#{time.sec}"
     end
 
     # A hash of procs that are run during the interpolation of a path or url.
@@ -143,6 +178,7 @@ module Paperclip
     def self.interpolations
       @interpolations ||= {
         :merb_root => lambda{|attachment,style| Merb.root },
+        :merb_env    => lambda{|attachment,style| Merb.env },
         :class        => lambda do |attachment,style|
                            underscore(attachment.instance.class.name.pluralize)
                          end,
@@ -168,14 +204,23 @@ module Paperclip
     # again.
     def reprocess!
       new_original = Tempfile.new("paperclip-reprocess")
-      old_original = to_file(:original)
-      new_original.write( old_original.read )
-      new_original.rewind
+      if old_original = to_file(:original)
+        new_original.write( old_original.read )
+        new_original.rewind
 
-      @queued_for_write = { :original => new_original }
-      post_process
+        @queued_for_write = { :original => new_original }
+        post_process
+
+        old_original.close if old_original.respond_to?(:close)
 
-      old_original.close if old_original.respond_to?(:close)
+        save
+      else
+        true
+      end
+    end
+    
+    def file?
+      !original_filename.blank?
     end
 
     private
@@ -188,6 +233,10 @@ module Paperclip
       downcase
     end
 
+    def logger
+      instance.logger
+    end
+
     def valid_assignment? file #:nodoc:
       return true if file.nil?
       if(file.is_a?(File))
@@ -204,6 +253,7 @@ module Paperclip
         end.flatten.compact.uniq
         @errors += @validation_errors
       end
+      @validation_errors
     end
 
     def normalize_style_definition
@@ -219,14 +269,21 @@ module Paperclip
       self.extend(@storage_module)
     end
 
+    def extra_options_for(style) #:nodoc:
+      [ convert_options[style], convert_options[:all] ].compact.join(" ")
+    end
+
     def post_process #:nodoc:
       return if @queued_for_write[:original].nil?
+      #logger.info("[paperclip] Post-processing #{name}")
       @styles.each do |name, args|
         begin
           dimensions, format = args
+          dimensions = dimensions.call(instance) if dimensions.respond_to? :call
           @queued_for_write[name] = Thumbnail.make(@queued_for_write[:original], 
                                                    dimensions,
                                                    format, 
+                                                   extra_options_for(name),
                                                    @whiny_thumnails)
         rescue PaperclipError => e
           @errors << e.message if @whiny_thumbnails
@@ -245,14 +302,15 @@ module Paperclip
     end
 
     def queue_existing_for_delete #:nodoc:
-      return if original_filename.blank?
+      return unless file?
+      #logger.info("[paperclip] Queueing the existing files for #{name} for deletion.")
       @queued_for_delete += [:original, *@styles.keys].uniq.map do |style|
         path(style) if exists?(style)
       end.compact
       newvals = { :"#{@name}_file_name"    => nil,
                   :"#{@name}_content_type" => nil,
                   :"#{@name}_file_size"    => nil }
-      @instance.update_attributes(newvals)
+      @instance.attributes = newvals
     end
 
     def flush_errors #:nodoc:

data/lib/dm-paperclip/geometry.rb

@@ -76,9 +76,9 @@ 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