paperclip 3.0.2 → 3.0.3

data/CONTRIBUTING.md

@@ -1,3 +1,6 @@
+Contributing
+============
+
 We love pull requests. Here's a quick guide:
 
 1. Fork the repo.
@@ -13,7 +16,6 @@ a test!
 
 5. Push to your fork and submit a pull request.
 
-
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within three business days (and, typically, one business
 day). We may suggest some changes or improvements or alternatives.
@@ -26,7 +28,37 @@ taken straight from the Ruby on Rails guide:
 * Update the documentation, the surrounding one, examples elsewhere, guides,
   whatever is affected by your contribution
 
-Syntax:
+Running Tests
+-------------
+
+Paperclip uses [Appraisal](https://github.com/thoughtbot/appraisal) to aid
+testing against multiple version of Ruby on Rails. This helps us to make sure
+that Paperclip performs correctly with them.
+
+### Bootstrapping your test suite:
+
+    bundle install
+    bundle exec rake appraisal:install
+
+This will install all the required gems that requires to test against each
+version of Rails, which defined in `gemfiles/*.gemfile`.
+
+### To run a full test suite:
+
+    bundle exec rake
+
+This will run Test::Unit and Cucumber against all version of Rails
+
+### To run single Test::Unit or Cucumber test
+
+You need to specify a `BUNDLE_GEMFILE` pointing to the gemfile before running
+the normal test command:
+
+    BUNDLE_GEMFILE=gemfiles/3.2.gemfile ruby -Itest test/schema_test.rb
+    BUNDLE_GEMFILE=gemfiles/3.2.gemfile cucumber features/basic_integration.feature
+
+Syntax
+------
 
 * Two spaces, no tabs.
 * No trailing whitespace. Blank lines should not have any space.

data/NEWS

@@ -1,4 +1,36 @@
-New in 3.0.1
+New in 3.0.3:
+
+* Bug fix: ThumbnailProcessor now correctly detects and preserve animated GIF.
+* Bug fix: File extension is now preserved in generated Tempfile from adapter.
+* Bug fix: Uploading file with unicode file name now won't raise an error when
+  logging in the AWS is turned on.
+* Bug fix: Task "paperclip:refresh:missing_styles" now work correctly.
+* Bug fix: Handle the case when :restricted_characters is nil.
+* Bug fix: Don't delete all the existing styles if we reprocess.
+* Bug fix: Content type is now ensured to not having a new line character.
+* API CHANGE: Non-Rails usage should include Paperclip::Glue directly.
+
+  `Paperclip::Railtie` was intended to be used with Ruby on Rails only. If you're
+  using Paperclip without Rails, you should include `Paperclip::Glue` into
+  `ActiveRecord::Base` instead of requiring `paperclip/railtie`:
+
+      ActiveRecord::Base.send :include, Paperclip::Glue
+
+* Bug fix: AttachmentContentTypeValidator now allow you to specify :allow_blank/:allow_nil
+* Bug fix: Make sure content type always a String.
+* Bug fix: Fix attachment.reprocess! when using storage providers fog and s3.
+* Bug fix: Fix a problem with incorrect content_type detected with 'file' command for an empty file on Mac.
+
+New in 3.0.2:
+
+* API CHANGE: Generated migration class name is now plural (AddAttachmentToUsers instead of AddAttachmentToUser)
+* API CHANGE: Remove Rails plugin initialization code.
+* API CHANGE: Explicitly require Ruby 1.9.2 in the Gemfile.
+* Bug fix: Fixes AWS::S3::Errors::RequestTimeout on Model#save.
+* Bug fix: Fix a problem when there's no logger specified.
+* Bug fix: Fix a problem when attaching Rack::Test::UploadedFile instance.
+
+New in 3.0.1:
 
 * Feature: Introduce Paperlip IO adapter.
 * Bug fix: Regression in AttachmentContentTypeValidator has been fixed.

data/README.md

@@ -183,6 +183,19 @@ Lastly, you can also define multiple validations on a single attachment using `v
 Storage
 -------
 
+Paperclip ships with 3 storage adapters:
+
+* File Storage
+* S3 Storage (via `aws-sdk`)
+* Fog Storage
+
+If you would like to use Paperclip with another storage, you can install these
+gems along side with Paperclip:
+
+* [Windows Azure](https://github.com/gmontard/paperclip-azure-storage)
+
+### Understanding Storage
+
 The files that are assigned as attachments are, by default, placed in the
 directory specified by the `:path` option to `has_attached_file`. By default, this
 location is `:rails_root/public/system/:attachment/:id/:style/:filename`. This
@@ -191,7 +204,7 @@ location was chosen because on standard Capistrano deployments, the
 will survive between deployments. For example, using that `:path`, you may have a
 file at
 
-    /data/myapp/releases/20081229172410/public/system/avatars/13/small/my_pic.png
+    /data/myapp/releases/20081229172410/public/system/user/avatar/000/000/013/small/my_pic.png
 
 _**NOTE**: This is a change from previous versions of Paperclip, but is overall a
 safer choice for the default file store._
@@ -240,7 +253,7 @@ geometry and a format, which the file will be converted to, like so:
 This will convert the "thumb" style to a 32x32 square in png format, regardless
 of what was uploaded. If the format is not specified, it is kept the same (i.e.
 jpgs will remain jpgs). For more information on the accepted style formats, see
-[http://www.imagemagick.org/script/command-line-processing.php#geometry](here).
+[here](http://www.imagemagick.org/script/command-line-processing.php#geometry).
 
 Multiple processors can be specified, and they will be invoked in the order
 they are defined in the :processors array. Each successive processor will
@@ -451,13 +464,13 @@ 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[http://groups.google.com/group/paperclip-plugin], or
-   post a new GitHub Issue[http://github.com/thoughtbot/paperclip/issues].
+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.
 
-Please see CONTRIBUTING.md for details.
+Please see `CONTRIBUTING.md` for more details on contributing and running test.
 
 Credits
 -------
@@ -473,4 +486,5 @@ The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 License
 -------
 
-Paperclip is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Paperclip is Copyright © 2008-2011 thoughtbot. It is free software, and may be
+redistributed under the terms specified in the MIT-LICENSE file.

data/RUNNING_TESTS.md

@@ -0,0 +1,4 @@
+Running Tests
+=============
+
+Please see `CONTRIBUTING.md` in "Running Tests" section for more information.

data/features/basic_integration.feature

@@ -12,7 +12,8 @@ Feature: Rails integration
     Given I add this snippet to the User model:
       """
       attr_accessible :name, :attachment
-      has_attached_file :attachment, :url => "/system/:attachment/:style/:filename"
+      has_attached_file :attachment, :url => "/system/:attachment/:style/:filename",
+                                     :styles => { :square => "100x100#" }
       """
     And I start the rails application
     When I go to the new user page
@@ -30,7 +31,8 @@ Feature: Rails integration
       has_attached_file :attachment,
                         :storage => :s3,
                         :path => "/:attachment/:style/:filename",
-                        :s3_credentials => Rails.root.join("config/s3.yml")
+                        :s3_credentials => Rails.root.join("config/s3.yml"),
+                        :styles => { :square => "100x100#" }
       """
     And I write to "config/s3.yml" with:
       """

data/features/support/fakeweb.rb

@@ -1,3 +1,10 @@
 require 'fake_web'
 
 FakeWeb.allow_net_connect = false
+
+module FakeWeb
+  class StubSocket
+    def read_timeout=(ignored)
+    end
+  end
+end

data/lib/paperclip.rb

@@ -46,11 +46,12 @@ require 'paperclip/validators'
 require 'paperclip/instance_methods'
 require 'paperclip/logger'
 require 'paperclip/helpers'
-require 'paperclip/railtie'
 require 'mime/types'
 require 'logger'
 require 'cocaine'
 
+require 'paperclip/railtie' if defined?(Rails)
+
 # The base module that gets included in ActiveRecord::Base. See the
 # documentation for Paperclip::ClassMethods for more useful information.
 module Paperclip

data/lib/paperclip/attachment.rb

@@ -90,12 +90,13 @@ module Paperclip
       ensure_required_accessors!
       file = Paperclip.io_adapters.for(uploaded_file)
 
-      self.clear
+      @options[:only_process].map!(&:to_sym)
+      self.clear(*@options[:only_process])
       return nil if file.nil?
 
       @queued_for_write[:original]   = file
       instance_write(:file_name,       cleanup_filename(file.original_filename))
-      instance_write(:content_type,    file.content_type)
+      instance_write(:content_type,    file.content_type.to_s.strip)
       instance_write(:file_size,       file.size)
       instance_write(:fingerprint,     file.fingerprint) if instance_respond_to?(:fingerprint)
       instance_write(:updated_at,      Time.now)
@@ -160,11 +161,13 @@ module Paperclip
     end
 
     def styles
-      styling_option = @options[:styles]
-      if styling_option.respond_to?(:call) || !@normalized_styles
-        @normalized_styles = ActiveSupport::OrderedHash.new
-        (styling_option.respond_to?(:call) ? styling_option.call(self) : styling_option).each do |name, args|
-          @normalized_styles[name] = Paperclip::Style.new(name, args.dup, self)
+      if @options[:styles].respond_to?(:call) || @normalized_styles.nil?
+        styles = @options[:styles]
+        styles = styles.call(self) if styles.respond_to?(:call)
+
+        @normalized_styles = styles.dup
+        @normalized_styles.each_pair do |name, options|
+          @normalized_styles[name.to_sym] = Paperclip::Style.new(name.to_sym, options.dup, self)
         end
       end
       @normalized_styles
@@ -202,10 +205,14 @@ module Paperclip
     # Clears out the attachment. Has the same effect as previously assigning
     # nil to the attachment. Does NOT save. If you wish to clear AND save,
     # use #destroy.
-    def clear
-      queue_existing_for_delete
-      @queued_for_write  = {}
-      @errors            = {}
+    def clear(*styles_to_clear)
+      if styles_to_clear.any?
+        queue_some_for_delete(*styles_to_clear)
+      else
+        queue_all_for_delete
+        @queued_for_write  = {}
+        @errors            = {}
+      end
     end
 
     # Destroys the attachment. Has the same effect as previously assigning
@@ -371,6 +378,7 @@ module Paperclip
 
     def post_process(*style_args) #:nodoc:
       return if @queued_for_write[:original].nil?
+
       instance.run_paperclip_callbacks(:post_process) do
         instance.run_paperclip_callbacks(:"#{name}_post_process") do
           post_process_styles(*style_args)
@@ -406,7 +414,13 @@ module Paperclip
       interpolator.interpolate(pattern, self, style_name)
     end
 
-    def queue_existing_for_delete #:nodoc:
+    def queue_some_for_delete(*styles)
+      @queued_for_delete += styles.uniq.map do |style|
+        path(style) if exists?(style)
+      end.compact
+    end
+
+    def queue_all_for_delete #:nodoc:
       return if @options[:preserve_files] || !file?
       @queued_for_delete += [:original, *styles.keys].uniq.map do |style|
         path(style) if exists?(style)
@@ -426,15 +440,13 @@ module Paperclip
 
     # called by storage after the writes are flushed and before @queued_for_writes is cleared
     def after_flush_writes
-      @queued_for_write.each do |style, file|
-        # file.close unless file.closed?
-        # file.unlink if file.respond_to?(:unlink) && file.path.present? && File.exist?(file.path)
-      end
     end
 
     def cleanup_filename(filename)
       if @options[:restricted_characters]
         filename.gsub(@options[:restricted_characters], '_')
+      else
+        filename
       end
     end
   end

data/lib/paperclip/glue.rb

@@ -1,4 +1,6 @@
 require 'paperclip/callbacks'
+require 'paperclip/validators'
+require 'paperclip/schema'
 
 module Paperclip
   module Glue
@@ -8,6 +10,12 @@ module Paperclip
       base.send :include, Validators
       base.class_attribute :attachment_definitions
 
+      if defined?(ActiveRecord)
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, Paperclip::Schema)
+        ActiveRecord::ConnectionAdapters::Table.send(:include, Paperclip::Schema)
+        ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Paperclip::Schema)
+      end
+
       locale_path = Dir.glob(File.dirname(__FILE__) + "/locales/*.{rb,yml}")
       I18n.load_path += locale_path unless I18n.load_path.include?(locale_path)
     end

data/lib/paperclip/helpers.rb

@@ -32,26 +32,14 @@ module Paperclip
     # 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_each(:conditions => "#{name}_file_name is not null") do |instance|
-          yield(instance)
-        end
+      class_for(klass).unscoped.where("#{name}_file_name IS NOT NULL").find_each do |instance|
+        yield(instance)
       end
     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
+      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
 

data/lib/paperclip/instance_methods.rb

@@ -28,7 +28,7 @@ module Paperclip
     def prepare_for_destroy
       Paperclip.log("Scheduling attachments for deletion.")
       each_attachment do |name, attachment|
-        attachment.send(:queue_existing_for_delete)
+        attachment.send(:queue_all_for_delete)
       end
     end
   end

data/lib/paperclip/io_adapters/attachment_adapter.rb

@@ -1,6 +1,5 @@
 module Paperclip
   class AttachmentAdapter
-
     def initialize(target)
       @target = target
       cache_current_values
@@ -30,6 +29,11 @@ module Paperclip
       @tempfile.read(length, buffer)
     end
 
+    # We don't use this directly, but aws/sdk does.
+    def rewind
+      @tempfile.rewind
+    end
+
     def eof?
       @tempfile.eof?
     end
@@ -48,12 +52,17 @@ module Paperclip
     end
 
     def copy_to_tempfile(src)
-      dest = Tempfile.new(src.original_filename)
+      extension = File.extname(src.original_filename)
+      basename = File.basename(src.original_filename, extension)
+      dest = Tempfile.new([basename, extension])
       dest.binmode
-      FileUtils.cp(src.path(:original), dest.path)
+      if src.respond_to? :copy_to_local_file
+        src.copy_to_local_file(:original, dest.path)
+      else
+        FileUtils.cp(src.path(:original), dest.path)
+      end
       dest
     end
-
   end
 end
 

data/lib/paperclip/io_adapters/file_adapter.rb

@@ -56,20 +56,22 @@ module Paperclip
     private
 
     def copy_to_tempfile(src)
-      dest = Tempfile.new(original_filename)
+      extension = File.extname(original_filename)
+      basename = File.basename(original_filename, extension)
+      dest = Tempfile.new([basename, extension])
       dest.binmode
       FileUtils.cp(src.path, dest.path)
       dest
     end
 
     def best_content_type_option(types)
-      types.reject {|type| type.content_type.match(/\/x-/) }.first
+      types.reject {|type| type.content_type.match(/\/x-/) }.first.content_type
     end
 
     def type_from_file_command
       # On BSDs, `file` doesn't give a result code of 1 if the file doesn't exist.
       type = (self.original_filename.match(/\.(\w+)$/)[1] rescue "octet-stream").downcase
-      mime_type = (Paperclip.run("file", "-b --mime :file", :file => self.path).split(/[:;]\s+/)[0] rescue "application/x-#{type}")
+      mime_type = (Paperclip.run("file", "-b --mime :file", :file => self.path).split(/[:;\s]+/)[0] rescue "application/x-#{type}")
       mime_type = "application/x-#{type}" if mime_type.match(/\(.*?\)/)
       mime_type
     end

data/lib/paperclip/io_adapters/stringio_adapter.rb

@@ -16,7 +16,7 @@ module Paperclip
     def content_type
       @content_type ||= @target.content_type if @target.respond_to?(:content_type)
       @content_type ||= "text/plain"
-      @content_type.strip
+      @content_type
     end
 
     def size
@@ -47,7 +47,9 @@ module Paperclip
     private
 
     def copy_to_tempfile(src)
-      dest = Tempfile.new(original_filename)
+      extension = File.extname(original_filename)
+      basename = File.basename(original_filename, extension)
+      dest = Tempfile.new([basename, extension])
       dest.binmode
       while data = src.read(16*1024)
         dest.write(data)

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -50,7 +50,9 @@ module Paperclip
     private
 
     def copy_to_tempfile(src)
-      dest = Tempfile.new(original_filename)
+      extension = File.extname(original_filename)
+      basename = File.basename(original_filename, extension)
+      dest = Tempfile.new([basename, extension])
       dest.binmode
       FileUtils.cp(src.path, dest.path)
       dest