paperclip 3.4.2 → 3.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjZlZGIxNTY3NDRlZTkyZjE2NmU4NTk3NDg0YTc5YjczODhjYzA2OA==
+  data.tar.gz: !binary |-
+    NjI1NGVkNTkxNDE2MGZjYWJkYzVhMjZhMWNhNzFhYmYzNTUxNzZhMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2M4M2UyYjBlZTk4MzNlOGMwODdhM2I0YjIyYmI0YmQxODE1MjMwZTY0YTc5
+    ZWUxNDAyNjlhOGNiNGRkOGE4YzNiZjNiMmQ2Mzg2ZmE2OGJhNDEwMDU4MTll
+    MWUyYzkxOThiMmY0MzFkZjFlYzk1YWFhMWVhZTQwZjIyOWZhMjU=
+  data.tar.gz: !binary |-
+    Njk5MTE2NDhkYzk3OWFlOWM2ODUwMjQ2MTIxMmQ1YWIyZDcyZDg5OWQyNTEw
+    ZDczODg2NmRkMzMyMWJmMDY0ZWI3NDljNmJmMTQ0ODJkYTNiMWIyN2EyZTM4
+    YTYyODEwMTE1NzA2ZWFmMjIzMDAwOTZkMjZmYjVjYjZkNDIwYTI=

data/.travis.yml

@@ -17,4 +17,3 @@ matrix:
   allow_failures:
     - rvm: jruby-19mode
     - rvm: rbx-19mode
-    - rvm: 2.0.0

data/Appraisals

@@ -1,7 +1,7 @@
-# appraise "3.0" do
-#   gem "rails", "~> 3.0.15"
-#   gem "paperclip", :path => "../"
-# end
+appraise "3.0" do
+  gem "rails", "~> 3.0.15"
+  gem "paperclip", :path => "../"
+end
 
 appraise "3.1" do
   gem "rails", "~> 3.1.6"

data/NEWS

@@ -1,3 +1,19 @@
+New in 3.5.0:
+
+* Feature: Handle Base64-encoded data URIs as uploads
+* Feature: Add a FilenameCleaner class to allow custom filename sanitation
+* Improvement: Satisfied Mocha deprecation warnings
+* Bug Fix: Allow empty string to be submitted and ignored, as some forms do this
+* Improvement: Make #expiring_url behavior consistent with #url
+* Bug Fix: "Validate" attachments without invoking AR's validations
+* Improvement: Various refactorings for a cleaner codebase
+* Improvement: Be agnostic, use ActiveModel when appropriate
+* Improvement: Add validation errors to the base attachment attribute
+* Improvement: Handle errors in rake tasks
+* Improvement: Largely refactor has_attached_file into a new class
+* Improvement: Added Ruby 2.0.0 as a supported platform and removed 1.8.7
+* Improvement: Fixed some incompatabilities in the test suite
+
 New in 3.4.2:
 
 * Improvement: Use https for Gemfile urls

data/README.md

@@ -1,7 +1,7 @@
 Paperclip
 =========
 
-[![Build Status](https://secure.travis-ci.org/thoughtbot/paperclip.png?branch=master)](http://travis-ci.org/thoughtbot/paperclip) [![Dependency Status](https://gemnasium.com/thoughtbot/paperclip.png?travis)](https://gemnasium.com/thoughtbot/paperclip) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/thoughtbot/paperclip)
+[![Build Status](https://secure.travis-ci.org/thoughtbot/paperclip.png?branch=master)](http://travis-ci.org/thoughtbot/paperclip) [![Dependency Status](https://gemnasium.com/thoughtbot/paperclip.png?travis)](https://gemnasium.com/thoughtbot/paperclip) [![Code Climate](https://codeclimate.com/github/thoughtbot/paperclip.png)](https://codeclimate.com/github/thoughtbot/paperclip)
 
 Paperclip is intended as an easy file attachment library for Active Record. The
 intent behind it was to keep setup as easy as possible and to treat files as
@@ -257,7 +257,7 @@ Defaults
 --------
 Global defaults for all your paperclip attachments can be defined by changing the Paperclip::Attachment.default_options Hash, this can be useful for setting your default storage settings per example so you won't have to define them in every has_attached_file definition.
 
-If you're using Rails you can define a Hash with default options in config/application.rb or in any of the config/environments/*.rb files on config.paperclip_defaults, these well get merged into Paperclip::Attachment.default_options as your Rails app boots. An example:
+If you're using Rails you can define a Hash with default options in config/application.rb or in any of the config/environments/*.rb files on config.paperclip_defaults, these will get merged into Paperclip::Attachment.default_options as your Rails app boots. An example:
 
 ```ruby
 module YourApp
@@ -657,6 +657,25 @@ Paperclip provides rspec-compatible matchers for testing attachments. See the
 documentation on [Paperclip::Shoulda::Matchers](http://rubydoc.info/gems/paperclip/Paperclip/Shoulda/Matchers)
 for more information.
 
+**Parallel Tests**
+
+Because of the default `path` for Paperclip storage, if you try to run tests in
+parallel, you may find that files get overwritten because the same path is being
+calculated for them in each test process. While this fix works for
+parallel_tests, a similar concept should be used for any other mechanism for
+running tests concurrently.
+
+```ruby
+if ENV['PARALLEL_TEST_GROUPS']
+  Paperclip::Attachment.default_options[:path] = ":rails_root/public/system/:rails_env/#{ENV['TEST_ENV_NUMBER'].to_i}/:class/:attachment/:id_partition/:filename"
+else
+  Paperclip::Attachment.default_options[:path] = ":rails_root/public/system/:rails_env/:class/:attachment/:id_partition/:filename"
+end
+```
+
+The important part here being the inclusion of `ENV['TEST_ENV_NUMBER']`, or the
+similar mechanism for whichever parallel testing library you use.
+
 Contributing
 ------------
 

data/features/step_definitions/rails_steps.rb

@@ -3,6 +3,7 @@ Given /^I generate a new rails application$/ do
     When I run `bundle exec #{new_application_command} #{APP_NAME} --skip-bundle`
     And I cd to "#{APP_NAME}"
     And I turn off class caching
+    And I fix the application.rb for 3.0.12
     And I write to "Gemfile" with:
       """
       source "http://rubygems.org"
@@ -20,6 +21,14 @@ Given /^I generate a new rails application$/ do
   }
 end
 
+Given "I fix the application.rb for 3.0.12" do
+  in_current_dir do
+    File.open("config/application.rb", "a") do |f|
+      f << "ActionController::Base.config.relative_url_root = ''"
+    end
+  end
+end
+
 Given /^I run a rails generator to generate a "([^"]*)" scaffold with "([^"]*)"$/ do |model_name, attributes|
   step %[I successfully run `bundle exec #{generator_command} scaffold #{model_name} #{attributes}`]
 end

data/features/step_definitions/s3_steps.rb

@@ -1,5 +1,5 @@
 When /^I attach the file "([^"]*)" to "([^"]*)" on S3$/ do |file_path, field|
-  definition = User.attachment_definitions[field.downcase.to_sym]
+  definition = Paperclip::Tasks::Attachments.definitions_for(User)[field.downcase.to_sym]
   path = "https://paperclip.s3.amazonaws.com#{definition[:path]}"
   path.gsub!(':filename', File.basename(file_path))
   path.gsub!(/:([^\/\.]+)/) do |match|

data/features/support/fakeweb.rb

@@ -4,7 +4,10 @@ FakeWeb.allow_net_connect = false
 
 module FakeWeb
   class StubSocket
-    def read_timeout=(ignored)
+    def read_timeout=(_ignored)
+    end
+
+    def continue_timeout=(_ignored)
     end
   end
 end

data/lib/paperclip.rb

@@ -40,7 +40,6 @@ require 'paperclip/interpolations'
 require 'paperclip/tempfile_factory'
 require 'paperclip/style'
 require 'paperclip/attachment'
-require 'paperclip/attachment_options'
 require 'paperclip/storage'
 require 'paperclip/callbacks'
 require 'paperclip/file_command_content_type_detector'
@@ -49,9 +48,11 @@ 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/has_attached_file'
+require 'paperclip/tasks/attachments'
+require 'paperclip/filename_cleaner'
 require 'mime/types'
 require 'logger'
 require 'cocaine'
@@ -173,46 +174,7 @@ module Paperclip
     #     end
     #   end
     def has_attached_file(name, options = {})
-      include InstanceMethods
-
-      if attachment_definitions.nil?
-        self.attachment_definitions = {}
-      else
-        self.attachment_definitions = self.attachment_definitions.dup
-      end
-
-      attachment_definitions[name] = Paperclip::AttachmentOptions.new(options)
-      Paperclip.classes_with_attachments << self.name
-
-      after_save :save_attached_files
-      before_destroy :prepare_for_destroy
-      after_destroy :destroy_attached_files
-
-      define_paperclip_callbacks :post_process, :"#{name}_post_process"
-
-      define_method name do |*args|
-        a = attachment_for(name)
-        (args.length > 0) ? a.to_s(args.first) : a
-      end
-
-      define_method "#{name}=" do |file|
-        attachment_for(name).assign(file)
-      end
-
-      define_method "#{name}?" do
-        attachment_for(name).file?
-      end
-
-      validates_each(name) do |record, attr, value|
-        attachment = record.attachment_for(name)
-        attachment.send(:flush_errors)
-      end
-    end
-
-    # Returns the attachment definitions defined by each call to
-    # has_attached_file.
-    def attachment_definitions
-      self.attachment_definitions
+      HasAttachedFile.define_on(self, name, options)
     end
   end
 end
@@ -220,9 +182,11 @@ end
 # This stuff needs to be run after Paperclip is defined.
 require 'paperclip/io_adapters/registry'
 require 'paperclip/io_adapters/abstract_adapter'
+require 'paperclip/io_adapters/empty_string_adapter'
 require 'paperclip/io_adapters/identity_adapter'
 require 'paperclip/io_adapters/file_adapter'
 require 'paperclip/io_adapters/stringio_adapter'
+require 'paperclip/io_adapters/data_uri_adapter'
 require 'paperclip/io_adapters/nil_adapter'
 require 'paperclip/io_adapters/attachment_adapter'
 require 'paperclip/io_adapters/uploaded_file_adapter'

data/lib/paperclip/attachment.rb

@@ -14,6 +14,7 @@ module Paperclip
         :default_url           => "/:attachment/:style/missing.png",
         :escape_url            => true,
         :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%# ]/,
+        :filename_cleaner      => nil,
         :hash_data             => ":class/:attachment/:id/:style/:updated_at",
         :hash_digest           => "SHA1",
         :interpolator          => Paperclip::Interpolations,
@@ -28,7 +29,8 @@ module Paperclip
         :url_generator         => Paperclip::UrlGenerator,
         :use_default_time_zone => true,
         :use_timestamp         => true,
-        :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails]
+        :whiny                 => Paperclip.options[:whiny] || Paperclip.options[:whiny_thumbnails],
+        :check_validity_before_processing => true
       }
     end
 
@@ -37,7 +39,7 @@ module Paperclip
     attr_accessor :post_processing
 
     # Creates an Attachment object. +name+ is the name of the attachment,
-    # +instance+ is the ActiveRecord object instance it's attached to, and
+    # +instance+ is the model object instance it's attached to, and
     # +options+ is the same as the hash passed to +has_attached_file+.
     #
     # Options include:
@@ -59,6 +61,7 @@ module Paperclip
     # +source_file_options+ - flags passed to the +convert+ command that controls how the file is read
     # +processors+ - classes that transform the attachment. Defaults to [:thumbnail]
     # +preserve_files+ - whether to keep files on the filesystem when deleting or clearing the attachment. Defaults to false
+    # +filename_cleaner+ - An object that responds to #call(filename) that will strip unacceptable charcters from filename
     # +interpolator+ - the object used to interpolate filenames and URLs. Defaults to Paperclip::Interpolations
     # +url_generator+ - the object used to generate URLs, using the interpolator. Defaults to Paperclip::UrlGenerator
     # +escape_url+ - Perform URI escaping to URLs. Defaults to true
@@ -92,6 +95,7 @@ module Paperclip
       ensure_required_accessors!
       file = Paperclip.io_adapters.for(uploaded_file)
 
+      return nil if not file.assignment?
       self.clear(*only_process)
       return nil if file.nil?
 
@@ -105,7 +109,7 @@ module Paperclip
 
       @dirty = true
 
-      post_process(*only_process) if post_processing && valid_assignment?
+      post_process(*only_process) if post_processing
 
       # Reset the file size if the original file was reprocessed.
       instance_write(:file_size,   @queued_for_write[:original].size)
@@ -376,16 +380,6 @@ module Paperclip
       Paperclip.log(message)
     end
 
-    def valid_assignment? #:nodoc:
-      if instance.valid?
-        true
-      else
-        instance.errors.none? do |attr, message|
-          attr.to_s.start_with?(@name.to_s)
-        end
-      end
-    end
-
     def initialize_storage #:nodoc:
       storage_class_name = @options[:storage].to_s.downcase.camelize
       begin
@@ -397,18 +391,17 @@ module Paperclip
     end
 
     def extra_options_for(style) #:nodoc:
-      all_options   = @options[:convert_options][:all]
-      all_options   = all_options.call(instance)   if all_options.respond_to?(:call)
-      style_options = @options[:convert_options][style]
-      style_options = style_options.call(instance) if style_options.respond_to?(:call)
-
-      [ style_options, all_options ].compact.join(" ")
+      process_options(:convert_options, style)
     end
 
     def extra_source_file_options_for(style) #:nodoc:
-      all_options   = @options[:source_file_options][:all]
+      process_options(:source_file_options, style)
+    end
+
+    def process_options(options_type, style) #:nodoc:
+      all_options   = @options[options_type][:all]
       all_options   = all_options.call(instance)   if all_options.respond_to?(:call)
-      style_options = @options[:source_file_options][style]
+      style_options = @options[options_type][style]
       style_options = style_options.call(instance) if style_options.respond_to?(:call)
 
       [ style_options, all_options ].compact.join(" ")
@@ -419,7 +412,9 @@ module Paperclip
 
       instance.run_paperclip_callbacks(:post_process) do
         instance.run_paperclip_callbacks(:"#{name}_post_process") do
-          post_process_styles(*style_args)
+          unless @options[:check_validity_before_processing] && instance.errors.any?
+            post_process_styles(*style_args)
+          end
         end
       end
     end
@@ -487,12 +482,15 @@ module Paperclip
        end
     end
 
+    # You can either specifiy :restricted_characters or you can define your own
+    # :filename_cleaner object. This object needs to respond to #call and takes
+    # the filename that will be cleaned. It should return the cleaned filenme.
+    def filename_cleaner
+      @options[:filename_cleaner] || FilenameCleaner.new(@options[:restricted_characters])
+    end
+
     def cleanup_filename(filename)
-      if @options[:restricted_characters]
-        filename.gsub(@options[:restricted_characters], '_')
-      else
-        filename
-      end
+      filename_cleaner.call(filename)
     end
 
     # Check if attachment database table has a created_at field

data/lib/paperclip/filename_cleaner.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Paperclip
+  class FilenameCleaner
+    def initialize(invalid_character_regex)
+      @invalid_character_regex = invalid_character_regex
+    end
+
+    def call(filename)
+      if @invalid_character_regex
+        filename.gsub(@invalid_character_regex, "_")
+      else
+        filename
+      end
+    end
+  end
+end

data/lib/paperclip/glue.rb

@@ -9,7 +9,6 @@ module Paperclip
       base.send :include, Callbacks
       base.send :include, Validators
       base.send :include, Schema if defined? ActiveRecord
-      base.class_attribute :attachment_definitions
 
       locale_path = Dir.glob(File.dirname(__FILE__) + "/locales/*.{rb,yml}")
       I18n.load_path += locale_path unless I18n.load_path.include?(locale_path)

data/lib/paperclip/has_attached_file.rb

@@ -0,0 +1,86 @@
+module Paperclip
+  class HasAttachedFile
+    def self.define_on(klass, name, options)
+      new(klass, name, options).define
+    end
+
+    def initialize(klass, name, options)
+      @klass = klass
+      @name = name
+      @options = options
+    end
+
+    def define
+      define_flush_errors
+      define_getter
+      define_setter
+      define_query
+      register_with_rake_tasks
+      add_active_record_callbacks
+      add_paperclip_callbacks
+    end
+
+    private
+
+    def define_flush_errors
+      @klass.send(:validates_each, @name) do |record, attr, value|
+        attachment = record.send(@name)
+        attachment.send(:flush_errors)
+      end
+    end
+
+    def define_getter
+      name = @name
+      options = @options
+
+      @klass.send :define_method, @name do |*args|
+        ivar = "@attachment_#{name}"
+        attachment = instance_variable_get(ivar)
+
+        if attachment.nil?
+          attachment = Attachment.new(name, self, options)
+          instance_variable_set(ivar, attachment)
+        end
+
+        if args.length > 0
+          attachment.to_s(args.first)
+        else
+          attachment
+        end
+      end
+    end
+
+    def define_setter
+      name = @name
+
+      @klass.send :define_method, "#{@name}=" do |file|
+        send(name).assign(file)
+      end
+    end
+
+    def define_query
+      name = @name
+
+      @klass.send :define_method, "#{@name}?" do
+        send(name).file?
+      end
+    end
+
+    def register_with_rake_tasks
+      Paperclip::Tasks::Attachments.add(@klass, @name, @options)
+    end
+
+    def add_active_record_callbacks
+      name = @name
+      @klass.send(:after_save) { send(name).send(:save) }
+      @klass.send(:before_destroy) { send(name).send(:queue_all_for_delete) }
+      @klass.send(:after_destroy) { send(name).send(:flush_deletes) }
+    end
+
+    def add_paperclip_callbacks
+      @klass.send(
+        :define_paperclip_callbacks,
+        :post_process, :"#{@name}_post_process")
+    end
+  end
+end