paperclip 2.8.0 → 3.0.2

data/features/support/env.rb

@@ -1,6 +1,9 @@
 require 'aruba/cucumber'
 require 'capybara/cucumber'
 require 'test/unit/assertions'
+
+$CUCUMBER=1
+
 World(Test::Unit::Assertions)
 
 Before do

data/features/support/file_helpers.rb

@@ -0,0 +1,24 @@
+module FileHelpers
+  def append_to(path, contents)
+    in_current_dir do
+      File.open(path, "a") do |file|
+        file.puts
+        file.puts contents
+      end
+    end
+  end
+
+  def append_to_gemfile(contents)
+    append_to('Gemfile', contents)
+  end
+
+  def comment_out_gem_in_gemfile(gemname)
+    in_current_dir do
+      gemfile = File.read("Gemfile")
+      gemfile.sub!(/^(\s*)(gem\s*['"]#{gemname})/, "\\1# \\2")
+      File.open("Gemfile", 'w'){ |file| file.write(gemfile) }
+    end
+  end
+end
+
+World(FileHelpers)

data/features/support/rails.rb

@@ -32,15 +32,15 @@ module RailsCommandHelpers
   end
 
   def new_application_command
-    framework_version?("3") ? "rails new" : "rails"
+    "rails new"
   end
 
   def generator_command
-    framework_version?("3") ? "script/rails generate" : "script/generate"
+    "script/rails generate"
   end
 
   def runner_command
-    framework_version?("3") ? "script/rails runner" : "script/runner"
+    "script/rails runner"
   end
 end
 World(RailsCommandHelpers)

data/gemfiles/{rails3_1.gemfile → 3.0.gemfile}

@@ -3,7 +3,9 @@
 source "http://rubygems.org"
 
 gem "jruby-openssl", :platform=>:jruby
-gem "rails", "~> 3.1.0"
+gem "activerecord-jdbcsqlite3-adapter", :platform=>:jruby
+gem "sqlite3", :platform=>:ruby
+gem "rails", "~> 3.0.12"
 gem "paperclip", :path=>"../"
 
 gemspec :path=>"../"

data/gemfiles/{rails2.gemfile → 3.1.gemfile}

@@ -3,7 +3,9 @@
 source "http://rubygems.org"
 
 gem "jruby-openssl", :platform=>:jruby
-gem "rails", "~> 2.3.14"
+gem "activerecord-jdbcsqlite3-adapter", :platform=>:jruby
+gem "sqlite3", :platform=>:ruby
+gem "rails", "~> 3.1.4"
 gem "paperclip", :path=>"../"
 
 gemspec :path=>"../"

data/gemfiles/{rails3.gemfile → 3.2.gemfile}

@@ -3,7 +3,9 @@
 source "http://rubygems.org"
 
 gem "jruby-openssl", :platform=>:jruby
-gem "rails", "~> 3.0.10"
+gem "activerecord-jdbcsqlite3-adapter", :platform=>:jruby
+gem "sqlite3", :platform=>:ruby
+gem "rails", "~> 3.2.2"
 gem "paperclip", :path=>"../"
 
 gemspec :path=>"../"

data/images.rake

@@ -0,0 +1,21 @@
+namespace :images do
+  desc "Regenerate images"
+  task :regenerate => :environment do
+    require 'open-uri'
+    OpportunityPhoto.all.each do |photo|
+      begin
+        old_name = photo.image_file_name
+        new_image = open(photo.image.url(:original, escape: false))
+        class << new_image
+          def original_filename; @original_filename; end
+          def original_filename=(name); @original_filename = name; end
+        end
+        new_image.original_filename = old_name
+        photo.image = new_image
+        photo.save
+      rescue => e
+        puts "ERROR: #{e.message} while processing #{photo.id}"
+      end
+    end
+  end
+end

data/lib/generators/paperclip/paperclip_generator.rb

@@ -19,7 +19,7 @@ class PaperclipGenerator < ActiveRecord::Generators::Base
   protected
 
   def migration_name
-    "add_attachment_#{attachment_names.join("_")}_to_#{name.underscore}"
+    "add_attachment_#{attachment_names.join("_")}_to_#{name.underscore.pluralize}"
   end
 
   def migration_file_name
@@ -29,5 +29,4 @@ class PaperclipGenerator < ActiveRecord::Generators::Base
   def migration_class_name
     migration_name.camelize
   end
-
 end

data/lib/paperclip.rb

@@ -29,207 +29,60 @@ require 'erb'
 require 'digest'
 require 'tempfile'
 require 'paperclip/version'
-require 'paperclip/upfile'
-require 'paperclip/iostream'
 require 'paperclip/geometry'
 require 'paperclip/processor'
+require 'paperclip/tempfile'
 require 'paperclip/thumbnail'
 require 'paperclip/interpolations'
 require 'paperclip/style'
 require 'paperclip/attachment'
 require 'paperclip/attachment_options'
 require 'paperclip/storage'
-require 'paperclip/callback_compatibility'
+require 'paperclip/callbacks'
+require 'paperclip/glue'
+require 'paperclip/errors'
 require 'paperclip/missing_attachment_styles'
+require 'paperclip/validators'
+require 'paperclip/instance_methods'
+require 'paperclip/logger'
+require 'paperclip/helpers'
 require 'paperclip/railtie'
+require 'mime/types'
 require 'logger'
 require 'cocaine'
 
 # The base module that gets included in ActiveRecord::Base. See the
 # documentation for Paperclip::ClassMethods for more useful information.
 module Paperclip
-
-  class << self
-    # Provides configurability to Paperclip. The options available are:
-    # * whiny: Will raise an error if Paperclip cannot process thumbnails of
-    #   an uploaded image. Defaults to true.
-    # * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
-    #   log levels, etc. Defaults to true.
-    # * command_path: Defines the path at which to find the command line
-    #   programs if they are not visible to Rails the system's search path. Defaults to
-    #   nil, which uses the first executable found in the user's search path.
-    # * image_magick_path: Deprecated alias of command_path.
-    def options
-      @options ||= {
-        :whiny             => true,
-        :image_magick_path => nil,
-        :command_path      => nil,
-        :log               => true,
-        :log_command       => true,
-        :swallow_stderr    => true
-      }
-    end
-
-    def configure
-      yield(self) if block_given?
-    end
-
-    def interpolates key, &block
-      Paperclip::Interpolations[key] = block
-    end
-
-    # The run method takes the name of a binary to run, the arguments to that binary
-    # and some options:
-    #
-    #   :command_path -> A $PATH-like variable that defines where to look for the binary
-    #                    on the filesystem. Colon-separated, just like $PATH.
-    #
-    #   :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).
-    #                   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.
-    #
-    def run(cmd, arguments = "", interpolation_values = {}, local_options = {})
-      if options[:image_magick_path]
-        Paperclip.log("[DEPRECATION] :image_magick_path is deprecated and will be removed. Use :command_path instead")
-      end
-      command_path = options[:command_path] || options[:image_magick_path]
-      Cocaine::CommandLine.path = [Cocaine::CommandLine.path, command_path].flatten.compact.uniq
-      local_options = local_options.merge(:logger => logger) if logging? && (options[:log_command] || local_options[:log_command])
-      Cocaine::CommandLine.new(cmd, arguments, local_options).run(interpolation_values)
-    end
-
-    def processor(name) #:nodoc:
-      @known_processors ||= {}
-      if @known_processors[name.to_s]
-        @known_processors[name.to_s]
-      else
-        name = name.to_s.camelize
-        load_processor(name) unless Paperclip.const_defined?(name)
-        processor = Paperclip.const_get(name)
-        @known_processors[name.to_s] = processor
-      end
-    end
-
-    def load_processor(name)
-      if defined?(Rails.root) && Rails.root
-        require File.expand_path(Rails.root.join("lib", "paperclip_processors", "#{name.underscore}.rb"))
-      end
-    end
-
-    def clear_processors!
-      @known_processors.try(:clear)
-    end
-
-    # You can add your own processor via the Paperclip configuration. Normally
-    # Paperclip will load all processors from the
-    # Rails.root/lib/paperclip_processors directory, but here you can add any
-    # existing class using this mechanism.
-    #
-    #   Paperclip.configure do |c|
-    #     c.register_processor :watermarker, WatermarkingProcessor.new
-    #   end
-    def register_processor(name, processor)
-      @known_processors ||= {}
-      @known_processors[name.to_s] = processor
-    end
-
-    # Find all instances of the given Active Record model +klass+ with attachment +name+.
-    # This method is used by the refresh rake tasks.
-    def each_instance_with_attachment(klass, name)
-      unscope_method = class_for(klass).respond_to?(:unscoped) ? :unscoped : :with_exclusive_scope
-      class_for(klass).send(unscope_method) do
-        class_for(klass).find(:all, :order => 'id').each do |instance|
-          yield(instance) if instance.send(:"#{name}?")
-        end
-      end
-    end
-
-    # Log a paperclip-specific line. This will logs to STDOUT
-    # by default. Set Paperclip.options[:log] to false to turn off.
-    def log message
-      logger.info("[paperclip] #{message}") if logging?
-    end
-
-    def logger #:nodoc:
-      @logger ||= options[:logger] || Logger.new(STDOUT)
-    end
-
-    def logger=(logger)
-      @logger = logger
-    end
-
-    def logging? #:nodoc:
-      options[:log]
-    end
-
-    def class_for(class_name)
-      # Ruby 1.9 introduces an inherit argument for Module#const_get and
-      # #const_defined? and changes their default behavior.
-      # https://github.com/rails/rails/blob/v3.0.9/activesupport/lib/active_support/inflector/methods.rb#L89
-      if Module.method(:const_get).arity == 1
-        class_name.split('::').inject(Object) do |klass, partial_class_name|
-          klass.const_defined?(partial_class_name) ? klass.const_get(partial_class_name) : klass.const_missing(partial_class_name)
-        end
-      else
-        class_name.split('::').inject(Object) do |klass, partial_class_name|
-          klass.const_defined?(partial_class_name) ? klass.const_get(partial_class_name, false) : klass.const_missing(partial_class_name)
-        end
-      end
-    rescue ArgumentError => e
-      # Sadly, we need to capture ArgumentError here because Rails 2.3.x
-      # ActiveSupport dependency management will try to the constant inherited
-      # from Object, and fail miserably with "Object is not missing constant X" error
-      # https://github.com/rails/rails/blob/v2.3.12/activesupport/lib/active_support/dependencies.rb#L124
-      if e.message =~ /is not missing constant/
-        raise NameError, "uninitialized constant #{class_name}"
-      else
-        raise e
-      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")
-      end
-      @names_url[name] = {:url => default_url, :class => klass}
-    end
-
-    def reset_duplicate_clash_check!
-      @names_url = nil
-    end
-  end
-
-  class PaperclipError < StandardError #:nodoc:
-  end
-
-  class StorageMethodNotFound < PaperclipError
-  end
-
-  class CommandNotFoundError < PaperclipError
+  extend Helpers
+  extend Logger
+  extend ProcessorHelpers
+
+  # Provides configurability to Paperclip. The options available are:
+  # * whiny: Will raise an error if Paperclip cannot process thumbnails of
+  #   an uploaded image. Defaults to true.
+  # * log: Logs progress to the Rails log. Uses ActiveRecord's logger, so honors
+  #   log levels, etc. Defaults to true.
+  # * command_path: Defines the path at which to find the command line
+  #   programs if they are not visible to Rails the system's search path. Defaults to
+  #   nil, which uses the first executable found in the user's search path.
+  def self.options
+    @options ||= {
+      :whiny             => true,
+      :image_magick_path => nil,
+      :command_path      => nil,
+      :log               => true,
+      :log_command       => true,
+      :swallow_stderr    => true
+    }
   end
 
-  class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
+  def self.io_adapters=(new_registry)
+    @io_adapters = new_registry
   end
 
-  class InfiniteInterpolationError < PaperclipError #:nodoc:
-  end
-
-  module Glue
-    def self.included base #:nodoc:
-      base.extend ClassMethods
-      base.class_attribute :attachment_definitions if base.respond_to?(:class_attribute)
-      if base.respond_to?(:set_callback)
-        base.send :include, Paperclip::CallbackCompatability::Rails3
-      else
-        base.send :include, Paperclip::CallbackCompatability::Rails21
-      end
-    end
+  def self.io_adapters
+    @io_adapters ||= Paperclip::AdapterRegistry.new
   end
 
   module ClassMethods
@@ -272,8 +125,7 @@ module Paperclip
     #   Defaults to +false+.#
     # * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
     #   to a command line error. This will override the global setting for this attachment.
-    #   Defaults to true. This option used to be called :whiny_thumbanils, but this is
-    #   deprecated.
+    #   Defaults to true.
     # * +convert_options+: When creating thumbnails, use this free-form options
     #   array 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
@@ -313,21 +165,13 @@ module Paperclip
     #       "/assets/avatars/default_#{gender}.png"
     #     end
     #   end
-    def has_attached_file name, options = {}
+    def has_attached_file(name, options = {})
       include InstanceMethods
 
       if attachment_definitions.nil?
-        if respond_to?(:class_attribute)
-          self.attachment_definitions = {}
-        else
-          write_inheritable_attribute(:attachment_definitions, {})
-        end
+        self.attachment_definitions = {}
       else
-        if respond_to?(:class_attribute)
-          self.attachment_definitions = self.attachment_definitions.dup
-        else
-          write_inheritable_attribute(:attachment_definitions, self.attachment_definitions.dup)
-        end
+        self.attachment_definitions = self.attachment_definitions.dup
       end
 
       attachment_definitions[name] = Paperclip::AttachmentOptions.new(options)
@@ -359,134 +203,19 @@ module Paperclip
       end
     end
 
-    # Places ActiveRecord-style validations on the size of the file assigned. The
-    # possible options are:
-    # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
-    # * +less_than+: equivalent to :in => 0..options[:less_than]
-    # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
-    # * +message+: error message to display, use :min and :max as replacements
-    # * +if+: A lambda or name of an instance method. Validation will only
-    #   be run if this lambda or method returns true.
-    # * +unless+: Same as +if+ but validates if lambda or method returns false.
-    def validates_attachment_size name, options = {}
-      min     = options[:greater_than] || (options[:in] && options[:in].first) || 0
-      max     = options[:less_than]    || (options[:in] && options[:in].last)  || (1.0/0)
-      range   = (min..max)
-      message = options[:message] || "must be between :min and :max bytes"
-      message = message.call if message.respond_to?(:call)
-      message = message.gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
-
-      validates_inclusion_of :"#{name}_file_size",
-                             :in        => range,
-                             :message   => message,
-                             :if        => options[:if],
-                             :unless    => options[:unless],
-                             :allow_nil => true
-    end
-
-    # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
-    def validates_attachment_thumbnails name, options = {}
-      warn('[DEPRECATION] validates_attachment_thumbnail is deprecated. ' +
-           'This validation is on by default and will be removed from future versions. ' +
-           'If you wish to turn it off, supply :whiny => false in your definition.')
-      attachment_definitions[name][:whiny_thumbnails] = true
-    end
-
-    # Places ActiveRecord-style validations on the presence of a file.
-    # Options:
-    # * +if+: A lambda or name of an instance method. Validation will only
-    #   be run if this lambda or method returns true.
-    # * +unless+: Same as +if+ but validates if lambda or method returns false.
-    def validates_attachment_presence name, options = {}
-      message = options[:message] || :empty
-      validates_each :"#{name}_file_name" do |record, attr, value|
-        if_clause_passed = options[:if].nil? || (options[:if].respond_to?(:call) ? options[:if].call(record) != false : record.send(options[:if]))
-        unless_clause_passed = options[:unless].nil? || (options[:unless].respond_to?(:call) ? !!options[:unless].call(record) == false : !record.send(options[:unless]))
-        if if_clause_passed && unless_clause_passed && value.blank?
-          record.errors.add(name, message)
-          record.errors.add("#{name}_file_name", message)
-        end
-      end
-    end
-
-    # Places ActiveRecord-style validations on the content type of the file
-    # assigned. The possible options are:
-    # * +content_type+: Allowed content types.  Can be a single content type
-    #   or an array.  Each type can be a String or a Regexp. It should be
-    #   noted that Internet Explorer uploads files with content_types that you
-    #   may not expect. For example, JPEG images are given image/pjpeg and
-    #   PNGs are image/x-png, so keep that in mind when determining how you
-    #   match.  Allows all by default.
-    # * +message+: The message to display when the uploaded file has an invalid
-    #   content type.
-    # * +if+: A lambda or name of an instance method. Validation will only
-    #   be run is this lambda or method returns true.
-    # * +unless+: Same as +if+ but validates if lambda or method returns false.
-    # NOTE: If you do not specify an [attachment]_content_type field on your
-    # model, content_type validation will work _ONLY upon assignment_ and
-    # re-validation after the instance has been reloaded will always succeed.
-    # You'll still need to have a virtual attribute (created by +attr_accessor+)
-    # name +[attachment]_content_type+ to be able to use this validator.
-    def validates_attachment_content_type name, options = {}
-      validation_options = options.dup
-      allowed_types = [validation_options[:content_type]].flatten
-      validates_each(:"#{name}_content_type", validation_options) do |record, attr, value|
-        if !allowed_types.any?{|t| t === value } && !(value.nil? || value.blank?)
-          if record.errors.method(:add).arity == -2
-            message = options[:message] || "is not one of #{allowed_types.join(", ")}"
-            message = message.call if message.respond_to?(:call)
-            record.errors.add(:"#{name}_content_type", message)
-          else
-            record.errors.add(:"#{name}_content_type", :inclusion, :default => options[:message], :value => value)
-          end
-        end
-      end
-    end
-
     # Returns the attachment definitions defined by each call to
     # has_attached_file.
     def attachment_definitions
-      if respond_to?(:class_attribute)
-        self.attachment_definitions
-      else
-        read_inheritable_attribute(:attachment_definitions)
-      end
-    end
-  end
-
-  module InstanceMethods #:nodoc:
-    def attachment_for name
-      @_paperclip_attachments ||= {}
-      @_paperclip_attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
-    end
-
-    def each_attachment
-      self.class.attachment_definitions.each do |name, definition|
-        yield(name, attachment_for(name))
-      end
-    end
-
-    def save_attached_files
-      Paperclip.log("Saving attachments.")
-      each_attachment do |name, attachment|
-        attachment.send(:save)
-      end
-    end
-
-    def destroy_attached_files
-      Paperclip.log("Deleting attachments.")
-      each_attachment do |name, attachment|
-        attachment.send(:flush_deletes)
-      end
+      self.attachment_definitions
     end
-
-    def prepare_for_destroy
-      Paperclip.log("Scheduling attachments for deletion.")
-      each_attachment do |name, attachment|
-        attachment.send(:queue_existing_for_delete)
-      end
-    end
-
   end
-
 end
+
+# This stuff needs to be run after Paperclip is defined.
+require 'paperclip/io_adapters/registry'
+require 'paperclip/io_adapters/identity_adapter'
+require 'paperclip/io_adapters/file_adapter'
+require 'paperclip/io_adapters/stringio_adapter'
+require 'paperclip/io_adapters/nil_adapter'
+require 'paperclip/io_adapters/attachment_adapter'
+require 'paperclip/io_adapters/uploaded_file_adapter'