paperclip 3.4.0 → 3.4.1

data/LICENSE

@@ -3,7 +3,7 @@ LICENSE
 
 The MIT License
 
-Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+Copyright (c) 2008-2013 Jon Yurek and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS

@@ -1,6 +1,45 @@
+New in 3.4.1:
+
+* Improvement: Various documentation fixes and improvements
+* Bug Fix: Clearing an attachment with `perserve_files` on should still clear the attachment
+* Bug Fix: Instances are #changed? when a new file is assigned
+* Bug Fix: Correctly deal with S3 styles when using a lambda
+* Improvement: Accept and pass :credential_provider option to AWS-SDK
+* Bug Fix: Sanitize original_filename more correctly in IO Adapters
+* Improvement: s3_host_name can be a lambda
+* Improvement: Cache some interpolations for speed
+* Improvement: Update to latest cocaine
+* Improvement: Update copyrights, various typos
+
+New in 3.4.0:
+
+* Bug Fix: Allow UploadedFileAdapter to force the use of `file`
+* Bug Fix: Close the file handle when dealing with URIs
+* Bug Fix: Ensure files are closed for writing when we're done.
+* Bug Fix: Fixed 'type' being nil on Windows 7 error.
+* Bug Fix: Fixed nil access when no s3 headers are defined
+* Bug Fix: Fixes auto_orientation
+* Bug Fix: Prevent a missing method error when switching from aws_sdk to fog
+* Bug Fix: Properly fail to process invalid attachments
+* Bug Fix: Server-side encryption is specified correctly
+* Bug Fix: fog_public returned to true by default
+* Bug Fix: Check attachment paths for duplicates, not URLs
+* Feature: Add Attachment#blank?
+* Feature: Add support for blacklisting certain content_types
+* Feature: Add support for style-specific s3 headers and meta data
+* Feature: Allow only_process to be a lambda
+* Feature: Allow setting of escape url as a default option
+* Feature: Create :override_file_permissions option for filesystem attachments
+* Improvement: Add Attachment#as_json
+* Improvement: Evaluate lambdas for fog_file properties
+* Improvement: Extract geometry parsing into factories
+* Improvement: Fixed various typos
+* Improvement: Refactored some tests
+* Improvement: Reuse S3 connections
+
 New In 3.3.1:
 
-* Bug fix: Moved Filesystem's copy_to_local_file to the right place.
+* Bug Fix: Moved Filesystem's copy_to_local_file to the right place.
 
 New in 3.3.0:
 
@@ -8,41 +47,41 @@ New in 3.3.0:
 
 New in 3.2.0:
 
-* Bug fix: Use the new correct Amazon S3 encryption header.
-* Bug fix: The rake task respects the updated_at column.
-* Bug fix: Strip newline from content type.
+* Bug Fix: Use the new correct Amazon S3 encryption header.
+* Bug Fix: The rake task respects the updated_at column.
+* Bug Fix: Strip newline from content type.
 * Feature: Fog file visibility can be specified per style.
 * Feature: Automatically rotate images.
 * Feature: Reduce class-oriented programming of the attachment definitions.
 
 New in 3.1.4:
 
-* Bug fix: Allow user to be able to set path without `:style` attribute and not raising an error.
+* Bug Fix: Allow user to be able to set path without `:style` attribute and not raising an error.
   This is a regression introduced in 3.1.3, and that feature will be postponed to another minor
   release instead.
 * Feature: Allow for URI Adapter as an optional paperclip io adapter.
 
 New in 3.1.3:
 
-* Bug fix: Copy empty attachment between instances is now working.
-* Bug fix: Correctly rescue Fog error.
-* Bug fix: Using default path and url options in Fog storage now work as expected.
-* Bug fix: `Attachment#s3_protocol` now returns a protocol without colon suffix.
+* Bug Fix: Copy empty attachment between instances is now working.
+* Bug Fix: Correctly rescue Fog error.
+* Bug Fix: Using default path and url options in Fog storage now work as expected.
+* Bug Fix: `Attachment#s3_protocol` now returns a protocol without colon suffix.
 * Feature: Paperclip will now raise an error if multiple styles are defined but no `:style`
   interpolation exists in `:path`.
 * Feature: Add support for `#{attachment}_created_at` field
-* Bug fix: Paperclip now gracefully handles msising file command.
-* Bug fix: `StringIOAdapter` now accepts content type.
+* Bug Fix: Paperclip now gracefully handles msising file command.
+* Bug Fix: `StringIOAdapter` now accepts content type.
 
 New in 3.1.2:
 
-* Bug fix: #remove_attachment on 3.1.0 and 3.1.1 mistakenly trying to remove the column that has
+* Bug Fix: #remove_attachment on 3.1.0 and 3.1.1 mistakenly trying to remove the column that has
   the same name as data type (such as :string, :datetime, :interger.) You're advised to update to
   Paperclip 3.1.2 as soon as possible.
 
 New in 3.1.1:
 
-* Bug fix: Paperclip will only load Paperclip::Schema only when Active Record is available.
+* Bug Fix: Paperclip will only load Paperclip::Schema only when Active Record is available.
 
 New in 3.1.0:
 
@@ -64,24 +103,24 @@ New in 3.1.0:
 * Feature: Migration now support Rails 3.2+ `change` method.
 * API CHANGE: Old `t.has_attached_file` and `drop_attached_file` are now deprecated. You're advised
   to update your migration file before the next MAJOR version.
-* Bug fix: Tempfile now rewinded before generating fingerprint
+* Bug Fix: Tempfile now rewinded before generating fingerprint
 * API CHANGE: Tempfiles are now unlinked after `after_flush_writes`
 
   If you need to interact with the generated tempfiles, please define an `after_flush_writes` method
   in your model. You'll be able to access files via `@queue_for_write` instance variable.
 
-* Bug fix: `:s3_protocol` can now be defined as either String or Symbol
-* Bug fix: Tempfiles are now rewinded before get passed into `after_flush_writes`
+* Bug Fix: `:s3_protocol` can now be defined as either String or Symbol
+* Bug Fix: Tempfiles are now rewinded before get passed into `after_flush_writes`
 * Feature: Added expiring_url method to Fog Storage
 * API CHANGE: Paperclip now tested against AWS::SDK 1.5.2 onward
-* Bug fix: Improved the output of the content_type validator so the actual failure is displayed
+* Bug Fix: Improved the output of the content_type validator so the actual failure is displayed
 * Feature: Animated formats now identified using ImageMagick.
 * Feature: AttachmentAdapter now support fetching attachment with specific style.
 * Feature: Paperclip default options can now be configured in Rails.configuration.
 * Feature: add Geometry#resize_to to calculate dimensions of new source.
-* Bug fix: Fixed a bug whereby a file type with multiple mime types but no official type would cause
+* Bug Fix: Fixed a bug whereby a file type with multiple mime types but no official type would cause
   the best_content_type to throw an error on trying nil.content_type.
-* Bug fix: Fix problem when the gem cannot be installed on the system that has Asepsis installed.
+* Bug Fix: Fix problem when the gem cannot be installed on the system that has Asepsis installed.
 
 New in 3.0.4:
 
@@ -89,14 +128,14 @@ New in 3.0.4:
 
 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
+* 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.
+* 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
@@ -105,24 +144,24 @@ New in 3.0.3:
 
       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.
+* 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.
+* 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.
+* Bug Fix: Regression in AttachmentContentTypeValidator has been fixed.
 * API CHANGE: #to_file has been removed. Use the #copy_to_local_file method instead.
 
 New in 3.0.0:
@@ -139,29 +178,29 @@ New in 3.0.0:
         :url => "/system/:attachment/:id/:style/:filename"
 
 * Feature: Adding Rails 3 style validators, and adding `validates_attachment` method as a shorthand.
-* Bug fix: Paperclip's rake tasks now loading records in batch.
-* Bug fix: Attachment style name with leading number now not raising an error.
-* Bug fix: File given to S3 and Fog storage will now be rewinded after flush_write.
+* Bug Fix: Paperclip's rake tasks now loading records in batch.
+* Bug Fix: Attachment style name with leading number now not raising an error.
+* Bug Fix: File given to S3 and Fog storage will now be rewinded after flush_write.
 * Feature: You can now pass addional parameter to S3 expiring URL, such as :content_type.
 
 New in 2.7.0:
 
-* Bug fix: Checking the existence of a file on S3 handles all AWS errors.
-* Bug fix: Clear the fingerprint when removing an attachment.
-* Bug fix: Attachment size validation message reads more nicely now.
+* Bug Fix: Checking the existence of a file on S3 handles all AWS errors.
+* Bug Fix: Clear the fingerprint when removing an attachment.
+* Bug Fix: Attachment size validation message reads more nicely now.
 * Feature: Style names can be either symbols or strings.
 * Compatibility: Support for ActiveSupport < 2.3.12.
 * Compatibility: Support for Rails 3.2.
 
 New in 2.6.0:
 
-* Bug fix: Files are re-wound after reading.
+* Bug Fix: Files are re-wound after reading.
 * Feature: Remove Rails dependency from specs that need Paperclip.
 * Feature: Validation matchers support conditionals.
 
 New in 2.5.2:
 
-* Bug fix: Can be installed on Windows.
+* Bug Fix: Can be installed on Windows.
 * Feature: The Fog bucket name, authentication, and host can be determined at runtime via Proc.
 * Feature: Special characters are replaced with underscores in #url and #path.
 
@@ -174,23 +213,23 @@ New in 2.5.1:
 New in 2.5.0:
 
 * Performance: Only connect to S3 when absolutely needed.
-* Bug fix: STI with cached classes respect new options.
-* Bug fix: conditional validations broke, and now work again.
+* Bug Fix: STI with cached classes respect new options.
+* Bug Fix: conditional validations broke, and now work again.
 * Feature: URL generation is now parameterized and can be changed with plugins or custom code.
 * Feature: :convert_options and :source_file_options to control the ImageMagick processing.
 * Performance: String geometry specifications now parse more quickly.
-* Bug fix: Handle files with question marks in the filename.
-* Bug fix: Don't raise an error when generating an expiring URL on an unassigned attachment.
-* Bug fix: The rake task runs over all instances of an ActiveRecord model, ignoring default scopes.
+* Bug Fix: Handle files with question marks in the filename.
+* Bug Fix: Don't raise an error when generating an expiring URL on an unassigned attachment.
+* Bug Fix: The rake task runs over all instances of an ActiveRecord model, ignoring default scopes.
 * Feature: DB migration has_attached_file and drop_attached_file methods.
-* Bug fix: Switch from AWS::S3 to AWS::SDK for the S3 backend.
-* Bug fix: URL generator uses '?' in the URL unless it already appears and there is no prior '='.
-* Bug fix: Always convert the content type to a string before stripping blanks.
+* Bug Fix: Switch from AWS::S3 to AWS::SDK for the S3 backend.
+* Bug Fix: URL generator uses '?' in the URL unless it already appears and there is no prior '='.
+* Bug Fix: Always convert the content type to a string before stripping blanks.
 * Feature: The :keep_old_files option preserves the files in storage even when the attachment is cleared or changed.
 * Performance: Optimize Fog's public_url access by avoiding it when possible.
-* Bug fix: Avoid a runtime error when generating the ID partition for an unsaved attachment.
+* Bug Fix: Avoid a runtime error when generating the ID partition for an unsaved attachment.
 * Performance: Do not calculate the fingerprint if it is never persisted.
-* Bug fix: Process the :original style before all others, in case of a dependency.
+* Bug Fix: Process the :original style before all others, in case of a dependency.
 * Feature: S3 headers can be set at runtime by passing a proc object as the value.
-* Bug fix: Generating missing attachment styles for a model which has had its attachment changed should not raise.
-* Bug fix: Do not collide with the built-in Ruby hashing method.
+* Bug Fix: Generating missing attachment styles for a model which has had its attachment changed should not raise.
+* Bug Fix: Do not collide with the built-in Ruby hashing method.

data/README.md

@@ -101,7 +101,7 @@ In your model:
 ```ruby
 class User < ActiveRecord::Base
   attr_accessible :avatar
-  has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+  has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }, :default_url => "/images/:style/missing.png"
 end
 ```
 
@@ -615,7 +615,7 @@ Please see `CONTRIBUTING.md` for more details on contributing and running test.
 Credits
 -------
 
-![thoughtbot](http://thoughtbot.com/assets/tm/logo.png)
+![thoughtbot](http://thoughtbot.com/logo.png)
 
 Paperclip is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
 
@@ -626,5 +626,5 @@ The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 License
 -------
 
-Paperclip is Copyright © 2008-2012 thoughtbot. It is free software, and may be
+Paperclip is Copyright © 2008-2013 thoughtbot, inc. It is free software, and may be
 redistributed under the terms specified in the MIT-LICENSE file.

data/lib/paperclip.rb

@@ -35,6 +35,7 @@ require 'paperclip/geometry'
 require 'paperclip/processor'
 require 'paperclip/tempfile'
 require 'paperclip/thumbnail'
+require 'paperclip/interpolations/plural_cache'
 require 'paperclip/interpolations'
 require 'paperclip/tempfile_factory'
 require 'paperclip/style'

data/lib/paperclip/attachment.rb

@@ -110,6 +110,8 @@ module Paperclip
       # Reset the file size if the original file was reprocessed.
       instance_write(:file_size,   @queued_for_write[:original].size)
       instance_write(:fingerprint, @queued_for_write[:original].fingerprint) if instance_respond_to?(:fingerprint)
+      updater = :"#{name}_file_name_will_change!"
+      instance.send updater if instance.respond_to? updater
     end
 
     # Returns the public URL of the attachment with a given style. This does
@@ -231,10 +233,8 @@ module Paperclip
     # nil to the attachment *and saving*. This is permanent. If you wish to
     # wipe out the existing attachment but not save, use #clear.
     def destroy
-      unless @options[:preserve_files]
-        clear
-        save
-      end
+      clear
+      save
     end
 
     # Returns the uploaded file if present.
@@ -452,10 +452,12 @@ module Paperclip
     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)
-      end.compact
+      return if !file?
+      unless @options[:preserve_files]
+        @queued_for_delete += [:original, *styles.keys].uniq.map do |style|
+          path(style) if exists?(style)
+        end.compact
+      end
       instance_write(:file_name, nil)
       instance_write(:content_type, nil)
       instance_write(:file_size, nil)

data/lib/paperclip/interpolations.rb

@@ -36,6 +36,10 @@ module Paperclip
       end
     end
 
+    def self.plural_cache
+      @plural_cache ||= PluralCache.new
+    end
+
     # Returns the filename, the same way as ":basename.:extension" would.
     def filename attachment, style_name
       [ basename(attachment, style_name), extension(attachment, style_name) ].reject(&:blank?).join(".")
@@ -81,7 +85,7 @@ module Paperclip
     # all class names. Calling #class will return the expected class.
     def class attachment = nil, style_name = nil
       return super() if attachment.nil? && style_name.nil?
-      attachment.instance.class.to_s.underscore.pluralize
+      plural_cache.underscore_and_pluralize(attachment.instance.class.to_s)
     end
 
     # Returns the basename of the file. e.g. "file" for "file.jpg"
@@ -169,7 +173,7 @@ module Paperclip
     # Returns the pluralized form of the attachment name. e.g.
     # "avatars" for an attachment of :avatar
     def attachment attachment, style_name
-      attachment.name.to_s.downcase.pluralize
+      plural_cache.pluralize(attachment.name.to_s.downcase)
     end
 
     # Returns the style, or the default style if nil is supplied.

data/lib/paperclip/interpolations/plural_cache.rb

@@ -0,0 +1,17 @@
+module Paperclip
+  module Interpolations
+    class PluralCache
+      def initialize
+        @cache = {}
+      end
+
+      def pluralize(word)
+        @cache[word] ||= word.pluralize
+      end
+
+      def underscore_and_pluralize(word)
+        @cache[word] ||= word.underscore.pluralize
+      end
+    end
+  end
+end

data/lib/paperclip/io_adapters/attachment_adapter.rb

@@ -14,7 +14,7 @@ module Paperclip
     private
 
     def cache_current_values
-      @original_filename = @target.original_filename
+      self.original_filename = @target.original_filename
       @content_type = @target.content_type
       @tempfile = copy_to_tempfile(@target)
       @size = @tempfile.size || @target.size

data/lib/paperclip/io_adapters/file_adapter.rb

@@ -8,8 +8,8 @@ module Paperclip
     private
 
     def cache_current_values
-      @original_filename = @target.original_filename if @target.respond_to?(:original_filename)
-      @original_filename ||= File.basename(@target.path)
+      self.original_filename = @target.original_filename if @target.respond_to?(:original_filename)
+      self.original_filename ||= File.basename(@target.path)
       @tempfile = copy_to_tempfile(@target)
       @content_type = ContentTypeDetector.new(@target.path).detect
       @size = File.size(@target)

data/lib/paperclip/io_adapters/stringio_adapter.rb

@@ -13,7 +13,7 @@ module Paperclip
     def cache_current_values
       @original_filename = @target.original_filename if @target.respond_to?(:original_filename)
       @original_filename ||= "stringio.txt"
-      @original_filename = @original_filename.strip
+      self.original_filename = @original_filename.strip
 
       @content_type = @target.content_type if @target.respond_to?(:content_type)
       @content_type ||= "text/plain"

data/lib/paperclip/io_adapters/uploaded_file_adapter.rb

@@ -18,7 +18,7 @@ module Paperclip
     private
 
     def cache_current_values
-      @original_filename = @target.original_filename
+      self.original_filename = @target.original_filename
       @content_type = determine_content_type
       @size = File.size(@target.path)
     end

data/lib/paperclip/io_adapters/uri_adapter.rb

@@ -20,7 +20,7 @@ module Paperclip
     def cache_current_values
       @original_filename = @target.path.split("/").last
       @original_filename ||= "index.html"
-      @original_filename = @original_filename.strip
+      self.original_filename = @original_filename.strip
 
       @content_type = @content.content_type if @content.respond_to?(:content_type)
       @content_type ||= "text/html"

data/lib/paperclip/storage/s3.rb

@@ -172,7 +172,10 @@ module Paperclip
       end
 
       def s3_host_name
-        @options[:s3_host_name] || s3_credentials[:s3_host_name] || "s3.amazonaws.com"
+        host_name = @options[:s3_host_name]
+        host_name = host_name.call(self) if host_name.is_a?(Proc)
+
+        host_name || s3_credentials[:s3_host_name] || "s3.amazonaws.com"
       end
 
       def s3_host_alias
@@ -209,7 +212,7 @@ module Paperclip
             config[:proxy_uri] = URI::HTTP.build(proxy_opts)
           end
 
-          [:access_key_id, :secret_access_key].each do |opt|
+          [:access_key_id, :secret_access_key, :credential_provider].each do |opt|
             config[opt] = s3_credentials[opt] if s3_credentials[opt]
           end
 
@@ -307,10 +310,11 @@ module Paperclip
               write_options[:server_side_encryption] = @s3_server_side_encryption
             end
 
-            style_specific_options = @options[:styles][style]
-            if style_specific_options.is_a?(Hash)
-              merge_s3_headers( style_specific_options[:s3_headers], @s3_headers, @s3_metadata) if style_specific_options.has_key?(:s3_headers)
-              @s3_metadata.merge!(style_specific_options[:s3_metadata]) if style_specific_options.has_key?(:s3_metadata)
+            style_specific_options = styles[style]
+
+            if style_specific_options
+              merge_s3_headers( style_specific_options[:s3_headers], @s3_headers, @s3_metadata) if style_specific_options[:s3_headers]
+              @s3_metadata.merge!(style_specific_options[:s3_metadata]) if style_specific_options[:s3_metadata]
             end
 
             write_options[:metadata] = @s3_metadata unless @s3_metadata.empty?
@@ -363,8 +367,10 @@ module Paperclip
           YAML::load(ERB.new(File.read(creds)).result)
         when Hash
           creds
+        when NilClass
+          {}
         else
-          raise ArgumentError, "Credentials are not a path, file, proc, or hash."
+          raise ArgumentError, "Credentials given are not a path, file, proc, or hash."
         end
       end