paperclip-cloudfiles 2.3.2 → 2.3.8

data/README.rdoc

@@ -16,12 +16,18 @@ See the documentation for +has_attached_file+ in Paperclip::ClassMethods for
 more detailed options.
 
 This fork has support for Rackspace Cloud Files.  It requires the "cloudfiles"
-gem, >= 1.4.4, from Gemcutter.org.  The Thoughtbot guys have indicated that they
+gem, >= 1.4.9, from Gemcutter.org.  The Thoughtbot guys have indicated that they
 don't want to pull any code into the official Paperclip mainline that they don't 
 personally use on projects, so until they discover the joy of Cloud Files, this 
 fork is available as the {paperclip-cloudfiles gem}[http://gemcutter.org/gems/paperclip-cloudfiles]
 on Gemcutter's gem server.
 
+==Installation
+
+Include the gem in your Gemfile:
+
+  gem "paperclip-cloudfiles", "~> 2.3"
+
 ==Quick Start
 
 In your environment.rb:
@@ -150,7 +156,7 @@ For example, assuming we had this definition:
   has_attached_file :scan, :styles => { :text => { :quality => :better } },
                            :processors => [:rotator, :ocr]
 
-then both the :rotator processor and the :ocr processor would receive the 
+then both the :rotator processor and the :ocr processor would receive the
 options "{ :quality => :better }". This parameter may not mean anything to one
 or more or the processors, and they are expected to ignore it.
 
@@ -185,7 +191,8 @@ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
 fix/feature has a high chance of being included, please read the following
 guidelines:
 
-1. Ask on the mailing list, or post a new GitHub Issue.
+1. Ask on the mailing list[http://groups.google.com/group/paperclip-plugin], or 
+   post a new GitHub Issue[http://github.com/thoughtbot/paperclip/issues].
 2. Make sure there are tests! We will not accept any patch that is not tested.
    It's a rare time when explicit tests aren't needed. If you have questions
    about writing tests for paperclip, please ask the mailing list.

data/Rakefile

@@ -1,3 +1,7 @@
+require 'rubygems'
+require 'appraisal'
+require 'bundler/setup'
+
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
@@ -6,11 +10,11 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 require 'paperclip'
 
 desc 'Default: run unit tests.'
-task :default => [:clean, :test]
+task :default => [:clean, :all]
 
 desc 'Test the paperclip plugin under all supported Rails versions.'
 task :all do |t|
-  exec('rake RAILS_VERSION=2.1 && rake RAILS_VERSION=2.3 && rake RAILS_VERSION=3.0')
+  exec('rake appraisal test')
 end
 
 desc 'Test the paperclip plugin.'
@@ -62,13 +66,13 @@ task :manifest => :clean do
     puts file
   end
 end
- 
+
 desc "Generate a gemspec file for GitHub"
 task :gemspec => :clean do
   File.open("#{spec.name}.gemspec", 'w') do |f|
     f.write spec.to_ruby
   end
-end 
+end
 
 desc "Build the gem into the current directory"
 task :gem => :gemspec do

data/generators/paperclip/USAGE

@@ -1,5 +1,5 @@
 Usage:
 
   script/generate paperclip Class attachment1 (attachment2 ...)
-  
-This will create a migration that will add the proper columns to your class's table.
+
+This will create a migration that will add the proper columns to your class's table.

data/generators/paperclip/paperclip_generator.rb

@@ -1,12 +1,12 @@
 class PaperclipGenerator < Rails::Generator::NamedBase
   attr_accessor :attachments, :migration_name
- 
+
   def initialize(args, options = {})
     super
     @class_name, @attachments = args[0], args[1..-1]
   end
- 
-  def manifest    
+
+  def manifest
     file_name = generate_file_name
     @migration_name = file_name.camelize
     record do |m|
@@ -14,14 +14,14 @@ class PaperclipGenerator < Rails::Generator::NamedBase
                            File.join('db', 'migrate'),
                            :migration_file_name => file_name
     end
-  end 
-  
-  private 
-  
+  end
+
+  private
+
   def generate_file_name
     names = attachments.map{|a| a.underscore }
     names = names[0..-2] + ["and", names[-1]] if names.length > 1
     "add_attachments_#{names.join("_")}_to_#{@class_name.underscore}"
   end
- 
+
 end

data/lib/generators/paperclip/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate paperclip Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/paperclip/paperclip_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/active_record'
+
+class PaperclipGenerator < ActiveRecord::Generators::Base
+  desc "Create a migration to add paperclip-specific fields to your model."
+
+  argument :attachment_names, :required => true, :type => :array, :desc => "The names of the attachment(s) to add.",
+           :banner => "attachment_one attachment_two attachment_three ..."
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "paperclip_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+
+  def migration_name
+    "add_attachment_#{attachment_names.join("_")}_to_#{name.underscore}"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+
+end

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

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+<% attachment_names.each do |attachment| -%>
+    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_name, :string
+    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_content_type, :string
+    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_size, :integer
+    add_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at, :datetime
+<% end -%>
+  end
+
+  def self.down
+<% attachment_names.each do |attachment| -%>
+    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_name
+    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_content_type
+    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_file_size
+    remove_column :<%= name.underscore.camelize.tableize %>, :<%= attachment %>_updated_at
+<% end -%>
+  end
+end

data/lib/paperclip/attachment.rb

@@ -4,7 +4,8 @@ module Paperclip
   # when the model saves, deletes when the model is destroyed, and processes
   # the file upon assignment.
   class Attachment
-    
+    include IOStream
+
     def self.default_options
       @default_options ||= {
         :url               => "/system/:attachment/:id/:style/:filename",
@@ -16,6 +17,7 @@ module Paperclip
         :default_style     => :original,
         :validations       => [],
         :storage           => :filesystem,
+        :use_timestamp     => true,
         :whiny             => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails]
       }
     end
@@ -41,6 +43,7 @@ module Paperclip
       @validations       = options[:validations]
       @default_style     = options[:default_style]
       @storage           = options[:storage]
+      @use_timestamp     = options[:use_timestamp]
       @whiny             = options[:whiny_thumbnails] || options[:whiny]
       @convert_options   = options[:convert_options]
       @processors        = options[:processors]
@@ -53,17 +56,17 @@ module Paperclip
 
       initialize_storage
     end
-    
+
     def styles
       unless @normalized_styles
         @normalized_styles = {}
         (@styles.respond_to?(:call) ? @styles.call(self) : @styles).each do |name, args|
-          @normalized_styles[name] = Paperclip::Style.new(name, args, self)
+          @normalized_styles[name] = Paperclip::Style.new(name, args.dup, self)
         end
       end
       @normalized_styles
     end
-    
+
     def processors
       @processors.respond_to?(:call) ? @processors.call(instance) : @processors
     end
@@ -72,7 +75,7 @@ module Paperclip
     # 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: 
+    # another Paperclip attachment:
     #   new_user.avatar = old_user.avatar
     # If the file that is assigned is not valid, the processing (i.e.
     # thumbnailing, etc) will NOT be run.
@@ -91,10 +94,11 @@ module Paperclip
 
       return nil if uploaded_file.nil?
 
-      @queued_for_write[:original]   = uploaded_file.to_tempfile
+      @queued_for_write[:original]   = to_tempfile(uploaded_file)
       instance_write(:file_name,       uploaded_file.original_filename.strip)
       instance_write(:content_type,    uploaded_file.content_type.to_s.strip)
       instance_write(:file_size,       uploaded_file.size.to_i)
+      instance_write(:fingerprint,     generate_fingerprint(uploaded_file))
       instance_write(:updated_at,      Time.now)
 
       @dirty = true
@@ -102,7 +106,8 @@ module Paperclip
       post_process if valid?
  
       # Reset the file size if the original file was reprocessed.
-      instance_write(:file_size, @queued_for_write[:original].size.to_i)
+      instance_write(:file_size,   @queued_for_write[:original].size.to_i)
+      instance_write(:fingerprint, generate_fingerprint(@queued_for_write[:original]))
     ensure
       uploaded_file.close if close_uploaded_file
       validate
@@ -112,12 +117,11 @@ module Paperclip
     # this does not necessarily need to point to a file that your web server
     # can access and can point to an action in your app, if you need fine
     # grained security.  This is not recommended if you don't need the
-    # security, however, for performance reasons.  set
-    # include_updated_timestamp to false if you want to stop the attachment
-    # update time appended to the url
-    def url style_name = default_style, include_updated_timestamp = true
+    # security, however, for performance reasons. Set use_timestamp to false
+    # if you want to stop the attachment update time appended to the url
+    def url(style_name = default_style, use_timestamp = @use_timestamp)
       url = original_filename.nil? ? interpolate(@default_url, style_name) : interpolate(@url, style_name)
-      include_updated_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
+      use_timestamp && updated_at ? [url, updated_at].compact.join(url.include?("?") ? "&" : "?") : url
     end
 
     # Returns the path of the attachment as defined by the :path option. If the
@@ -192,19 +196,31 @@ module Paperclip
       instance_read(:file_size) || (@queued_for_write[:original] && @queued_for_write[:original].size)
     end
 
+    # Returns the hash of the file as originally assigned, and lives in the
+    # <attachment>_fingerprint attribute of the model.
+    def fingerprint
+      instance_read(:fingerprint) || (@queued_for_write[:original] && generate_fingerprint(@queued_for_write[:original]))
+    end
+
     # Returns the content_type of the file as originally assigned, and lives
     # in the <attachment>_content_type attribute of the model.
     def content_type
       instance_read(:content_type)
     end
-    
-    # Returns the last modified time of the file as originally assigned, and 
+
+    # Returns the last modified time of the file as originally assigned, and
     # lives in the <attachment>_updated_at attribute of the model.
     def updated_at
       time = instance_read(:updated_at)
       time && time.to_f.to_i
     end
 
+    def generate_fingerprint(source)
+      data = source.read
+      source.rewind if source.respond_to?(:rewind)
+      Digest::MD5.hexdigest(data)
+    end
+
     # Paths and URLs can have a number of variables interpolated into them
     # to vary the storage location based on name, id, style, class, etc.
     # This method is a deprecated access into supplying and retrieving these
@@ -225,7 +241,7 @@ module Paperclip
       new_original = Tempfile.new("paperclip-reprocess")
       new_original.binmode
       if old_original = to_file(:original)
-        new_original.write( old_original.read )
+        new_original.write( old_original.respond_to?(:get) ? old_original.get : old_original.read )
         new_original.rewind
 
         @queued_for_write = { :original => new_original }
@@ -238,7 +254,7 @@ module Paperclip
         true
       end
     end
-    
+
     # Returns true if a file has been assigned.
     def file?
       !original_filename.blank?
@@ -330,7 +346,12 @@ module Paperclip
     end
 
     def initialize_storage #:nodoc:
-      @storage_module = Paperclip::Storage.const_get(@storage.to_s.classify)
+      storage_class_name = @storage.to_s.capitalize
+      begin
+        @storage_module = Paperclip::Storage.const_get(storage_class_name)
+      rescue NameError
+        raise StorageMethodNotFound, "Cannot load storage module '#{storage_class_name}'"
+      end
       self.extend(@storage_module)
     end
 
@@ -389,4 +410,3 @@ module Paperclip
 
   end
 end
-

data/lib/paperclip/command_line.rb

@@ -0,0 +1,80 @@
+module Paperclip
+  class CommandLine
+    class << self
+      attr_accessor :path
+    end
+
+    def initialize(binary, params = "", options = {})
+      @binary            = binary.dup
+      @params            = params.dup
+      @options           = options.dup
+      @swallow_stderr    = @options.has_key?(:swallow_stderr) ? @options.delete(:swallow_stderr) : Paperclip.options[:swallow_stderr]
+      @expected_outcodes = @options.delete(:expected_outcodes)
+      @expected_outcodes ||= [0]
+    end
+
+    def command
+      cmd = []
+      cmd << full_path(@binary)
+      cmd << interpolate(@params, @options)
+      cmd << bit_bucket if @swallow_stderr
+      cmd.join(" ")
+    end
+
+    def run
+      Paperclip.log(command)
+      begin
+        output = self.class.send(:'`', command)
+      rescue Errno::ENOENT
+        raise Paperclip::CommandNotFoundError
+      end
+      if $?.exitstatus == 127
+        raise Paperclip::CommandNotFoundError
+      end
+      unless @expected_outcodes.include?($?.exitstatus)
+        raise Paperclip::PaperclipCommandLineError, "Command '#{command}' returned #{$?.exitstatus}. Expected #{@expected_outcodes.join(", ")}"
+      end
+      output
+    end
+
+    private
+
+    def full_path(binary)
+      [self.class.path, binary].compact.join("/")
+    end
+
+    def interpolate(pattern, vars)
+      # interpolates :variables and :{variables}
+      pattern.gsub(%r#:(?:\w+|\{\w+\})#) do |match|
+        key = match[1..-1]
+        key = key[1..-2] if key[0,1] == '{'
+        if invalid_variables.include?(key)
+          raise PaperclipCommandLineError,
+            "Interpolation of #{key} isn't allowed."
+        end
+        shell_quote(vars[key.to_sym])
+      end
+    end
+
+    def invalid_variables
+      %w(expected_outcodes swallow_stderr)
+    end
+
+    def shell_quote(string)
+      return "" if string.nil? or string.blank?
+      if self.class.unix?
+        string.split("'").map{|m| "'#{m}'" }.join("\\'")
+      else
+        %{"#{string}"}
+      end
+    end
+
+    def bit_bucket
+      self.class.unix? ? "2>/dev/null" : "2>NUL"
+    end
+
+    def self.unix?
+      File.exist?("/dev/null")
+    end
+  end
+end

data/lib/paperclip/geometry.rb

@@ -16,7 +16,7 @@ module Paperclip
     def self.from_file file
       file = file.path if file.respond_to? "path"
       geometry = begin
-                   Paperclip.run("identify", "-format", "%wx%h", "#{file}[0]")
+                   Paperclip.run("identify", "-format %wx%h :file", :file => "#{file}[0]")
                  rescue PaperclipCommandLineError
                    ""
                  end
@@ -75,12 +75,12 @@ 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

data/lib/paperclip/interpolations.rb

@@ -41,8 +41,9 @@ module Paperclip
     # 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.
+    RIGHT_HERE = "#{__FILE__.gsub(%r{^\./}, "")}:#{__LINE__ + 3}"
     def url attachment, style_name
-      raise InfiniteInterpolationError if attachment.options[:url].include?(":url")
+      raise InfiniteInterpolationError if caller.any?{|b| b.index(RIGHT_HERE) }
       attachment.url(style_name, false)
     end
 
@@ -78,7 +79,7 @@ module Paperclip
     # 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_name 
+    def extension attachment, style_name
       ((style = attachment.styles[style_name]) && style[:format]) ||
         File.extname(attachment.original_filename).gsub(/^\.+/, "")
     end
@@ -88,6 +89,11 @@ module Paperclip
       attachment.instance.id
     end
 
+    # Returns the fingerprint of the instance.
+    def fingerprint attachment, style_name
+      attachment.fingerprint
+    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_name

data/lib/paperclip/iostream.rb

@@ -1,48 +1,34 @@
 # Provides method that can be included on File-type objects (IO, StringIO, Tempfile, etc) to allow stream copying
 # and Tempfile conversion.
 module IOStream
-
   # Returns a Tempfile containing the contents of the readable object.
-  def to_tempfile
-    name = respond_to?(:original_filename) ? original_filename : (respond_to?(:path) ? path : "stream")
-    tempfile = Paperclip::Tempfile.new("stream" + File.extname(name))
+  def to_tempfile(object)
+    return object.to_tempfile if object.respond_to?(:to_tempfile)
+    name = object.respond_to?(:original_filename) ? object.original_filename : (object.respond_to?(:path) ? object.path : "stream")
+    tempfile = Paperclip::Tempfile.new(["stream", File.extname(name)])
     tempfile.binmode
-    self.stream_to(tempfile)
+    stream_to(object, tempfile)
   end
 
   # 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
-  # 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
+  # the whole thing into memory. Defaults to 8k blocks. 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 object, path_or_file, in_blocks_of = 8192
     dstio = case path_or_file
             when String   then File.new(path_or_file, "wb+")
             when IO       then path_or_file
             when Tempfile then path_or_file
             end
     buffer = ""
-    self.rewind
-    while self.read(in_blocks_of, buffer) do
+    object.rewind
+    while object.read(in_blocks_of, buffer) do
       dstio.write(buffer)
     end
-    dstio.rewind    
+    dstio.rewind
     dstio
   end
 end
 
-class IO #:nodoc:
-  include IOStream
-end
-
-%w( Tempfile StringIO ).each do |klass|
-  if Object.const_defined? klass
-    Object.const_get(klass).class_eval do
-      include IOStream
-    end
-  end
-end
-
 # Corrects a bug in Windows when asking for Tempfile size.
 if defined? Tempfile
   class Tempfile

data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb

@@ -42,7 +42,7 @@ module Paperclip
         end
 
         def negative_failure_message
-          "Content types #{@allowed_types.join(", ")} should be rejected" + 
+          "Content types #{@allowed_types.join(", ")} should be rejected" +
           " and #{@rejected_types.join(", ")} accepted by #{@attachment_name}"
         end
 
@@ -57,7 +57,8 @@ module Paperclip
             file = StringIO.new(".")
             file.content_type = type
             (subject = @subject.new).attachment_for(@attachment_name).assign(file)
-            subject.valid? && subject.errors[:"#{@attachment_name}_content_type"].blank?
+            subject.valid?
+            subject.errors[:"#{@attachment_name}_content_type"].blank?
           end
         end
 
@@ -72,4 +73,3 @@ module Paperclip
     end
   end
 end
-

data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb

@@ -52,4 +52,3 @@ module Paperclip
     end
   end
 end
-

data/lib/paperclip/matchers/validate_attachment_size_matcher.rb

@@ -93,4 +93,3 @@ module Paperclip
     end
   end
 end
-

data/lib/paperclip/processor.rb

@@ -6,7 +6,7 @@ module Paperclip
   #
   # 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: 
+  # 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
@@ -33,17 +33,26 @@ module Paperclip
       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)
+    # This is Ruby 1.8.7's implementation.
+    if RUBY_VERSION <= "1.8.6"
+      def make_tmpname(basename, n)
+        case basename
+        when Array
+          prefix, suffix = *basename
+        else
+          prefix, suffix = basename, ''
+        end
+
+        t = Time.now.strftime("%y%m%d")
+        path = "#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}-#{n}#{suffix}"
+      end
     end
   end
 end

data/lib/paperclip/railtie.rb

@@ -0,0 +1,24 @@
+require 'paperclip'
+
+module Paperclip
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'paperclip.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          Paperclip::Railtie.insert
+        end
+      end
+      rake_tasks do
+        load "tasks/paperclip.rake"
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, Paperclip::Glue)
+      File.send(:include, Paperclip::Upfile)
+    end
+  end
+end