thoughtbot-paperclip 2.2.6 → 2.2.7

data/lib/paperclip.rb

@@ -43,7 +43,7 @@ end
 # documentation for Paperclip::ClassMethods for more useful information.
 module Paperclip
 
-  VERSION = "2.2.6"
+  VERSION = "2.2.7"
 
   class << self
     # Provides configurability to Paperclip. There are a number of options available, such as:

data/lib/paperclip/attachment.rb

@@ -62,6 +62,9 @@ module Paperclip
     # If the file that is assigned is not valid, the processing (i.e.
     # thumbnailing, etc) will NOT be run.
     def assign uploaded_file
+      # This is because of changes in Rails 2.3 that cause blank fields to send nil
+      return nil if uploaded_file.nil?
+
       %w(file_name).each do |field|
         unless @instance.class.column_names.include?("#{name}_#{field}")
           raise PaperclipError.new("#{@instance.class} model does not have required column '#{name}_#{field}'")
@@ -92,7 +95,6 @@ module Paperclip
 
       @dirty = true
 
-      solidify_style_definitions
       post_process if valid?
  
       # Reset the file size if the original file was reprocessed.
@@ -159,6 +161,23 @@ module Paperclip
       end
     end
 
+    # 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
+      @errors            = {}
+      @validation_errors = nil
+    end
+
+    # Destroys the attachment. Has the same effect as previously assigning
+    # 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
+      clear
+      save
+    end
+
     # Returns the name of the file as originally assigned, and lives in the
     # <attachment>_file_name attribute of the model.
     def original_filename
@@ -274,7 +293,7 @@ module Paperclip
     end
 
     def valid_assignment? file #:nodoc:
-      file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
+      file.respond_to?(:original_filename) && file.respond_to?(:content_type)
     end
 
     def validate #:nodoc:
@@ -314,9 +333,8 @@ module Paperclip
 
     def solidify_style_definitions #:nodoc:
       @styles.each do |name, args|
-        if @styles[name][:geometry].respond_to?(:call)
-          @styles[name][:geometry] = @styles[name][:geometry].call(instance) 
-        end
+        @styles[name][:geometry] = @styles[name][:geometry].call(instance) if @styles[name][:geometry].respond_to?(:call)
+        @styles[name][:processors] = @styles[name][:processors].call(instance) if @styles[name][:processors].respond_to?(:call)
       end
     end
 
@@ -336,6 +354,7 @@ module Paperclip
 
     def post_process #:nodoc:
       return if @queued_for_write[:original].nil?
+      solidify_style_definitions
       return if fire_events(:before)
       post_process_styles
       return if fire_events(:after)
@@ -346,6 +365,10 @@ module Paperclip
       return true if callback(:"#{which}_#{name}_post_process") == false
     end
 
+    def callback which #:nodoc:
+      instance.run_callbacks(which, @queued_for_write){|result, obj| result == false }
+    end
+
     def post_process_styles
       log("Post-processing #{name}")
       @styles.each do |name, args|
@@ -362,10 +385,6 @@ module Paperclip
       end
     end
 
-    def callback which #:nodoc:
-      instance.run_callbacks(which, @queued_for_write){|result, obj| result == false }
-    end
-
     def interpolate pattern, style = default_style #:nodoc:
       interpolations = self.class.interpolations.sort{|a,b| a.first.to_s <=> b.first.to_s }
       interpolations.reverse.inject( pattern.dup ) do |result, interpolation|

data/lib/paperclip/storage.rb

@@ -108,11 +108,21 @@ module Paperclip
     #   Paperclip will attempt to create it. The bucket name will not be interpolated.
     #   You can define the bucket as a Proc if you want to determine it's name at runtime.
     #   Paperclip will call that Proc with attachment as the only argument.
-    # * +url+: There are two options for the S3 url. You can choose to have the bucket's name
+    # * +s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the
+    #   S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the
+    #   link in the +url+ entry for more information about S3 domains and buckets.
+    # * +url+: There are three options for the S3 url. You can choose to have the bucket's name
     #   placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
+    #   Lastly, you can specify a CNAME (which requires the CNAME to be specified as
+    #   :s3_alias_url. You can read more about CNAMEs and S3 at 
+    #   http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
     #   Normally, this won't matter in the slightest and you can leave the default (which is
     #   path-style, or :s3_path_url). But in some cases paths don't work and you need to use
     #   the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
+    #   NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
+    #   :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
+    #   alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
+    #   by S3.
     # * +path+: This is the key under the bucket in which the file will be stored. The
     #   URL will be constructed from the bucket and the path. This is what you will want
     #   to interpolate. Keys should be unique, like filenames, and despite the fact that
@@ -129,8 +139,12 @@ module Paperclip
           @s3_permissions = @options[:s3_permissions] || 'public-read'
           @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == 'public-read' ? 'http' : 'https')
           @s3_headers     = @options[:s3_headers]     || {}
+          @s3_host_alias  = @options[:s3_host_alias]
           @url            = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
         end
+        base.class.interpolations[:s3_alias_url] = lambda do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
         base.class.interpolations[:s3_path_url] = lambda do |attachment, style|
           "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
         end
@@ -154,6 +168,10 @@ module Paperclip
         @bucket
       end
 
+      def s3_host_alias
+        @s3_host_alias
+      end
+
       def parse_credentials creds
         creds = find_credentials(creds).stringify_keys
         (creds[ENV['RAILS_ENV']] || creds).symbolize_keys

data/shoulda_macros/paperclip.rb

@@ -38,7 +38,7 @@ module Paperclip
       klass   = self.name.gsub(/Test$/, '').constantize
       valid   = [options[:valid]].flatten
       invalid = [options[:invalid]].flatten
-      matcher = validate_attachment_presence(name).allows(valid).rejects(invalid)
+      matcher = validate_attachment_content_type(name).allowing(valid).rejecting(invalid)
       should matcher.description do
         assert_accepts(matcher, klass)
       end

data/test/attachment_test.rb

@@ -265,7 +265,28 @@ class AttachmentTest < Test::Unit::TestCase
       end
     end
   end
-  
+
+  context "An attachment with :processors that is a proc" do
+    setup do
+      rebuild_model :styles => { :normal => '' }, :processors => lambda { |a| [ :test ] }
+      @attachment = Dummy.new.avatar
+    end
+
+    should "not run the proc immediately" do
+      assert_kind_of Proc, @attachment.styles[:normal][:processors]
+    end
+
+    context "when assigned" do
+      setup do
+        @attachment.assign(StringIO.new("."))
+      end
+
+      should "have the correct processors" do
+        assert_equal [ :test ], @attachment.styles[:normal][:processors]
+      end
+    end
+  end
+
   context "An attachment with erroring processor" do
     setup do
       rebuild_model :processor => [:thumbnail], :styles => { :small => '' }, :whiny_thumbnails => true
@@ -571,20 +592,39 @@ class AttachmentTest < Test::Unit::TestCase
               file.close
             end
 
-            context "and deleted" do
+            context "and trying to delete" do
               setup do
                 @existing_names = @attachment.styles.keys.collect do |style|
                   @attachment.path(style)
                 end
+              end
+
+              should "not delete the files saving in a deprecated manner" do
+                @attachment.expects(:instance_write).with(:file_name, nil).never
+                @attachment.expects(:instance_write).with(:content_type, nil).never
+                @attachment.expects(:instance_write).with(:file_size, nil).never
+                @attachment.expects(:instance_write).with(:updated_at, nil).never
+                @attachment.assign nil
+                @attachment.save
+                @existing_names.each{|f| assert File.exists?(f) }
+              end
+
+              should "delete the files when you call #clear and #save" do
                 @attachment.expects(:instance_write).with(:file_name, nil)
                 @attachment.expects(:instance_write).with(:content_type, nil)
                 @attachment.expects(:instance_write).with(:file_size, nil)
                 @attachment.expects(:instance_write).with(:updated_at, nil)
-                @attachment.assign nil
+                @attachment.clear
                 @attachment.save
+                @existing_names.each{|f| assert ! File.exists?(f) }
               end
 
-              should "delete the files" do
+              should "delete the files when you call #delete" do
+                @attachment.expects(:instance_write).with(:file_name, nil)
+                @attachment.expects(:instance_write).with(:content_type, nil)
+                @attachment.expects(:instance_write).with(:file_size, nil)
+                @attachment.expects(:instance_write).with(:updated_at, nil)
+                @attachment.destroy
                 @existing_names.each{|f| assert ! File.exists?(f) }
               end
             end

data/test/integration_test.rb

@@ -39,6 +39,7 @@ class IntegrationTest < Test::Unit::TestCase
       setup do
         Dummy.class_eval do
           has_attached_file :avatar, :styles => { :thumb => "150x25#" }
+          has_attached_file :avatar, :styles => { :thumb => "150x25#", :dynamic => lambda { |a| '50x50#' } }
         end
         @d2 = Dummy.find(@dummy.id)
         @d2.avatar.reprocess!
@@ -47,6 +48,7 @@ class IntegrationTest < Test::Unit::TestCase
 
       should "create its thumbnails properly" do
         assert_match /\b150x25\b/, `identify "#{@dummy.avatar.path(:thumb)}"`
+        assert_match /\b50x50\b/, `identify "#{@dummy.avatar.path(:dynamic)}"`
       end
     end
   end
@@ -94,7 +96,7 @@ class IntegrationTest < Test::Unit::TestCase
 
       context "and deleted" do
         setup do
-          @dummy.avatar = nil
+          @dummy.avatar.clear
           @dummy.save
         end
 
@@ -233,7 +235,7 @@ class IntegrationTest < Test::Unit::TestCase
         assert File.exists?(p)
       end
 
-      @dummy.avatar = nil
+      @dummy.avatar.clear
       assert_nil @dummy.avatar_file_name
       assert @dummy.valid?
       assert @dummy.save
@@ -256,7 +258,7 @@ class IntegrationTest < Test::Unit::TestCase
 
       saved_paths = [:thumb, :medium, :large, :original].collect{|s| @dummy.avatar.path(s) }
 
-      @d2.avatar = nil
+      @d2.avatar.clear
       assert @d2.save
 
       saved_paths.each do |p|
@@ -264,7 +266,7 @@ class IntegrationTest < Test::Unit::TestCase
       end
     end
 
-    should "know the difference between good files, bad files, not files, and nil" do
+    should "know the difference between good files, bad files, and not files" do
       expected = @dummy.avatar.to_file
       @dummy.avatar = "not a file"
       assert @dummy.valid?
@@ -273,25 +275,21 @@ class IntegrationTest < Test::Unit::TestCase
 
       @dummy.avatar = @bad_file
       assert ! @dummy.valid?
-      @dummy.avatar = nil
-      assert @dummy.valid?, @dummy.errors.inspect 
     end
 
-    should "know the difference between good files, bad files, not files, and nil when validating" do
+    should "know the difference between good files, bad files, and not files when validating" do
       Dummy.validates_attachment_presence :avatar
       @d2 = Dummy.find(@dummy.id)
       @d2.avatar = @file
       assert   @d2.valid?, @d2.errors.full_messages.inspect 
       @d2.avatar = @bad_file
       assert ! @d2.valid?
-      @d2.avatar = nil
-      assert ! @d2.valid?
     end
 
     should "be able to reload without saving and not have the file disappear" do
       @dummy.avatar = @file
       assert @dummy.save
-      @dummy.avatar = nil
+      @dummy.avatar.clear
       assert_nil @dummy.avatar_file_name
       @dummy.reload
       assert_equal "5k.png", @dummy.avatar_file_name
@@ -314,16 +312,6 @@ class IntegrationTest < Test::Unit::TestCase
         assert_equal `identify -format "%wx%h" "#{@dummy.avatar.path(:original)}"`,
                      `identify -format "%wx%h" "#{@dummy2.avatar.path(:original)}"`
       end
-      
-      should "work when assigned a nil file" do
-        @dummy2.avatar = nil
-        @dummy2.save
-
-        @dummy.avatar = @dummy2.avatar
-        @dummy.save
-        
-        assert !@dummy.avatar?
-      end
     end    
 
   end
@@ -421,7 +409,7 @@ class IntegrationTest < Test::Unit::TestCase
           assert key.exists?
         end
 
-        @dummy.avatar = nil
+        @dummy.avatar.clear
         assert_nil @dummy.avatar_file_name
         assert @dummy.valid?
         assert @dummy.save
@@ -444,7 +432,7 @@ class IntegrationTest < Test::Unit::TestCase
 
         saved_keys = [:thumb, :medium, :large, :original].collect{|s| @dummy.avatar.to_file(s) }
 
-        @d2.avatar = nil
+        @d2.avatar.clear
         assert @d2.save
 
         saved_keys.each do |key|

data/test/storage_test.rb

@@ -37,6 +37,55 @@ class StorageTest < Test::Unit::TestCase
     end
   end
 
+  context "" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {},
+                    :bucket => "bucket",
+                    :path => ":attachment/:basename.:extension",
+                    :url => ":s3_path_url"
+      @dummy = Dummy.new
+      @dummy.avatar = StringIO.new(".")
+    end
+
+    should "return a url based on an S3 path" do
+      assert_match %r{^http://s3.amazonaws.com/bucket/avatars/stringio.txt}, @dummy.avatar.url
+    end
+  end
+  context "" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {},
+                    :bucket => "bucket",
+                    :path => ":attachment/:basename.:extension",
+                    :url => ":s3_domain_url"
+      @dummy = Dummy.new
+      @dummy.avatar = StringIO.new(".")
+    end
+
+    should "return a url based on an S3 subdomain" do
+      assert_match %r{^http://bucket.s3.amazonaws.com/avatars/stringio.txt}, @dummy.avatar.url
+    end
+  end
+  context "" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {
+                      :production   => { :bucket => "prod_bucket" },
+                      :development  => { :bucket => "dev_bucket" }
+                    },
+                    :s3_host_alias => "something.something.com",
+                    :path => ":attachment/:basename.:extension",
+                    :url => ":s3_alias_url"
+      @dummy = Dummy.new
+      @dummy.avatar = StringIO.new(".")
+    end
+
+    should "return a url based on the host_alias" do
+      assert_match %r{^http://something.something.com/avatars/stringio.txt}, @dummy.avatar.url
+    end
+  end
+
   context "Parsing S3 credentials with a bucket in them" do
     setup do
       rebuild_model :storage => :s3,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-paperclip
 version: !ruby/object:Gem::Version 
-  version: 2.2.6
+  version: 2.2.7
 platform: ruby
 authors: 
 - Jon Yurek
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-17 00:00:00 -08:00
+date: 2009-03-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency