paperclip 3.0.3 → 3.5.1

data/test/schema_test.rb

@@ -1,98 +1,200 @@
 require './test/helper'
 require 'paperclip/schema'
+require 'active_support/testing/deprecation'
 
-class MockSchema
-  include Paperclip::Schema
-
-  def initialize(table_name = nil)
-    @table_name = table_name
-    @columns = {}
-    @deleted_columns = []
-  end
-
-  def column(name, type)
-    @columns[name] = type
-  end
-
-  def remove_column(table_name, column_name)
-    return if @table_name && @table_name != table_name
-    @columns.delete(column_name)
-    @deleted_columns.push(column_name)
-  end
-
-  def has_column?(column_name)
-    @columns.key?(column_name)
-  end
+class SchemaTest < Test::Unit::TestCase
+  include ActiveSupport::Testing::Deprecation
 
-  def deleted_column?(column_name)
-    @deleted_columns.include?(column_name)
+  def setup
+    rebuild_class
   end
 
-  def type_of(column_name)
-    @columns[column_name]
+  def teardown
+    Dummy.connection.drop_table :dummies rescue nil
   end
-end
-
-class SchemaTest < Test::Unit::TestCase
-  context "Migrating up" do
-    setup do
-      @schema = MockSchema.new
-      @schema.has_attached_file :avatar
-    end
-
-    should "create the file_name column" do
-      assert @schema.has_column?(:avatar_file_name)
-    end
-
-    should "create the content_type column" do
-      assert @schema.has_column?(:avatar_content_type)
-    end
-
-    should "create the file_size column" do
-      assert @schema.has_column?(:avatar_file_size)
-    end
-
-    should "create the updated_at column" do
-      assert @schema.has_column?(:avatar_updated_at)
-    end
 
-    should "make the file_name column a string" do
-      assert_equal :string, @schema.type_of(:avatar_file_name)
+  context "within table definition" do
+    context "using #has_attached_file" do
+      should "create attachment columns" do
+        Dummy.connection.create_table :dummies, :force => true do |t|
+          ActiveSupport::Deprecation.silence do
+            t.has_attached_file :avatar
+          end
+        end
+        rebuild_class
+
+        columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+        assert_includes columns, ['avatar_file_name', :string]
+        assert_includes columns, ['avatar_content_type', :string]
+        assert_includes columns, ['avatar_file_size', :integer]
+        assert_includes columns, ['avatar_updated_at', :datetime]
+      end
+
+      should "display deprecation warning" do
+        Dummy.connection.create_table :dummies, :force => true do |t|
+          assert_deprecated do
+            t.has_attached_file :avatar
+          end
+        end
+      end
     end
 
-    should "make the content_type column a string" do
-      assert_equal :string, @schema.type_of(:avatar_content_type)
-    end
-
-    should "make the file_size column an integer" do
-      assert_equal :integer, @schema.type_of(:avatar_file_size)
-    end
-
-    should "make the updated_at column a datetime" do
-      assert_equal :datetime, @schema.type_of(:avatar_updated_at)
+    context "using #attachment" do
+      setup do
+        Dummy.connection.create_table :dummies, :force => true do |t|
+          t.attachment :avatar
+        end
+        rebuild_class
+      end
+
+      should "create attachment columns" do
+        columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+        assert_includes columns, ['avatar_file_name', :string]
+        assert_includes columns, ['avatar_content_type', :string]
+        assert_includes columns, ['avatar_file_size', :integer]
+        assert_includes columns, ['avatar_updated_at', :datetime]
+      end
     end
   end
 
-  context "Migrating down" do
+  context "within schema statement" do
     setup do
-      @schema = MockSchema.new(:users)
-      @schema.drop_attached_file :users, :avatar
-    end
-
-    should "remove the file_name column" do
-      assert @schema.deleted_column?(:avatar_file_name)
-    end
-
-    should "remove the content_type column" do
-      assert @schema.deleted_column?(:avatar_content_type)
+      Dummy.connection.create_table :dummies, :force => true
     end
 
-    should "remove the file_size column" do
-      assert @schema.deleted_column?(:avatar_file_size)
+    context "migrating up" do
+      context "with single attachment" do
+        setup do
+          Dummy.connection.add_attachment :dummies, :avatar
+          rebuild_class
+        end
+
+        should "create attachment columns" do
+          columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+          assert_includes columns, ['avatar_file_name', :string]
+          assert_includes columns, ['avatar_content_type', :string]
+          assert_includes columns, ['avatar_file_size', :integer]
+          assert_includes columns, ['avatar_updated_at', :datetime]
+        end
+      end
+
+      context "with multiple attachments" do
+        setup do
+          Dummy.connection.add_attachment :dummies, :avatar, :photo
+          rebuild_class
+        end
+
+        should "create attachment columns" do
+          columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+          assert_includes columns, ['avatar_file_name', :string]
+          assert_includes columns, ['avatar_content_type', :string]
+          assert_includes columns, ['avatar_file_size', :integer]
+          assert_includes columns, ['avatar_updated_at', :datetime]
+          assert_includes columns, ['photo_file_name', :string]
+          assert_includes columns, ['photo_content_type', :string]
+          assert_includes columns, ['photo_file_size', :integer]
+          assert_includes columns, ['photo_updated_at', :datetime]
+        end
+      end
+
+      context "with no attachment" do
+        should "raise an error" do
+          assert_raise ArgumentError do
+            Dummy.connection.add_attachment :dummies
+          rebuild_class
+          end
+        end
+      end
     end
 
-    should "remove the updated_at column" do
-      assert @schema.deleted_column?(:avatar_updated_at)
+    context "migrating down" do
+      setup do
+        Dummy.connection.change_table :dummies do |t|
+          t.column :avatar_file_name, :string
+          t.column :avatar_content_type, :string
+          t.column :avatar_file_size, :integer
+          t.column :avatar_updated_at, :datetime
+        end
+      end
+
+      context "using #drop_attached_file" do
+        should "remove the attachment columns" do
+          ActiveSupport::Deprecation.silence do
+            Dummy.connection.drop_attached_file :dummies, :avatar
+          end
+          rebuild_class
+
+          columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+          assert_not_includes columns, ['avatar_file_name', :string]
+          assert_not_includes columns, ['avatar_content_type', :string]
+          assert_not_includes columns, ['avatar_file_size', :integer]
+          assert_not_includes columns, ['avatar_updated_at', :datetime]
+        end
+
+        should "display a deprecation warning" do
+          assert_deprecated do
+            Dummy.connection.drop_attached_file :dummies, :avatar
+          end
+        end
+      end
+
+      context "using #remove_attachment" do
+        context "with single attachment" do
+          setup do
+            Dummy.connection.remove_attachment :dummies, :avatar
+            rebuild_class
+          end
+
+          should "remove the attachment columns" do
+            columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+            assert_not_includes columns, ['avatar_file_name', :string]
+            assert_not_includes columns, ['avatar_content_type', :string]
+            assert_not_includes columns, ['avatar_file_size', :integer]
+            assert_not_includes columns, ['avatar_updated_at', :datetime]
+          end
+        end
+
+        context "with multiple attachments" do
+          setup do
+            Dummy.connection.change_table :dummies do |t|
+              t.column :photo_file_name, :string
+              t.column :photo_content_type, :string
+              t.column :photo_file_size, :integer
+              t.column :photo_updated_at, :datetime
+            end
+
+            Dummy.connection.remove_attachment :dummies, :avatar, :photo
+            rebuild_class
+          end
+
+          should "remove the attachment columns" do
+            columns = Dummy.columns.map{ |column| [column.name, column.type] }
+
+            assert_not_includes columns, ['avatar_file_name', :string]
+            assert_not_includes columns, ['avatar_content_type', :string]
+            assert_not_includes columns, ['avatar_file_size', :integer]
+            assert_not_includes columns, ['avatar_updated_at', :datetime]
+            assert_not_includes columns, ['photo_file_name', :string]
+            assert_not_includes columns, ['photo_content_type', :string]
+            assert_not_includes columns, ['photo_file_size', :integer]
+            assert_not_includes columns, ['photo_updated_at', :datetime]
+          end
+        end
+
+        context "with no attachment" do
+          should "raise an error" do
+            assert_raise ArgumentError do
+              Dummy.connection.remove_attachment :dummies
+            end
+          end
+        end
+      end
     end
   end
 end

data/test/storage/filesystem_test.rb

@@ -19,12 +19,35 @@ class FileSystemTest < Test::Unit::TestCase
 
       should "store the original" do
         @dummy.save
-        assert File.exists?(@dummy.avatar.path)
+        assert_file_exists(@dummy.avatar.path)
       end
 
       should "store the thumbnail" do
         @dummy.save
-        assert File.exists?(@dummy.avatar.path(:thumbnail))
+        assert_file_exists(@dummy.avatar.path(:thumbnail))
+      end
+
+      should "be rewinded after flush_writes" do
+        @dummy.avatar.instance_eval "def after_flush_writes; end"
+
+        files = @dummy.avatar.queued_for_write.values
+        @dummy.save
+        assert files.none?(&:eof?), "Expect all the files to be rewinded."
+      end
+
+      should "be removed after after_flush_writes" do
+        paths = @dummy.avatar.queued_for_write.values.map(&:path)
+        @dummy.save
+        assert paths.none?{ |path| File.exists?(path) },
+          "Expect all the files to be deleted."
+      end
+
+      should 'copy the file to a known location with copy_to_local_file' do
+        tempfile = Tempfile.new("known_location")
+        @dummy.avatar.copy_to_local_file(:original, tempfile.path)
+        tempfile.rewind
+        assert_equal @file.read, tempfile.read
+        tempfile.close
       end
     end
 
@@ -41,7 +64,7 @@ class FileSystemTest < Test::Unit::TestCase
       teardown { @file.close }
 
       should "store the file" do
-        assert File.exists?(@dummy.avatar.path)
+        assert_file_exists(@dummy.avatar.path)
       end
 
       should "return a replaced version for path" do

data/test/storage/fog_test.rb

@@ -1,10 +1,10 @@
 require './test/helper'
 require 'fog'
 
-Fog.mock!
-
 class FogTest < Test::Unit::TestCase
   context "" do
+    setup { Fog.mock! }
+
     context "with credentials provided in a path string" do
       setup do
         rebuild_model :styles => { :medium => "300x300>", :thumb => "100x100>" },
@@ -67,6 +67,50 @@ class FogTest < Test::Unit::TestCase
       end
     end
 
+    context "with no path or url given and using defaults" do
+      setup do
+        rebuild_model :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                      :storage => :fog,
+                      :fog_directory => "paperclip",
+                      :fog_credentials => {
+                        :provider => 'AWS',
+                        :aws_access_key_id => 'AWS_ID',
+                        :aws_secret_access_key => 'AWS_SECRET'
+                      }
+        @file = File.new(fixture_file('5k.png'), 'rb')
+        @dummy = Dummy.new
+        @dummy.id = 1
+        @dummy.avatar = @file
+      end
+
+      teardown { @file.close }
+
+      should "have correct path and url from interpolated defaults" do
+        assert_equal "dummies/avatars/000/000/001/original/5k.png", @dummy.avatar.path
+      end
+    end
+
+    context "with file params provided as lambda" do
+      setup do
+        fog_file = lambda{ |a| { :custom_header => a.instance.custom_method }}
+        klass = rebuild_model :storage => :fog,
+                              :fog_file => fog_file
+
+        klass.class_eval do
+          def custom_method
+            'foobar'
+          end
+        end
+
+
+        @dummy = Dummy.new
+      end
+
+      should "be able to evaluate correct values for file headers" do
+        assert_equal @dummy.avatar.send(:fog_file), { :custom_header => 'foobar' }
+      end
+    end
+
     setup do
       @fog_directory = 'papercliptests'
 
@@ -111,6 +155,32 @@ class FogTest < Test::Unit::TestCase
         directory.destroy
       end
 
+      should "be rewinded after flush_writes" do
+        @dummy.avatar.instance_eval "def after_flush_writes; end"
+
+        files = @dummy.avatar.queued_for_write.values
+        @dummy.save
+        assert files.none?(&:eof?), "Expect all the files to be rewinded."
+      end
+
+      should "be removed after after_flush_writes" do
+        paths = @dummy.avatar.queued_for_write.values.map(&:path)
+        @dummy.save
+        assert paths.none?{ |path| File.exists?(path) },
+          "Expect all the files to be deleted."
+      end
+
+      should 'be able to be copied to a local file' do
+        @dummy.save
+        tempfile = Tempfile.new("known_location")
+        tempfile.binmode
+        @dummy.avatar.copy_to_local_file(:original, tempfile.path)
+        tempfile.rewind
+        assert_equal @connection.directories.get(@fog_directory).files.get(@dummy.avatar.path).body,
+                     tempfile.read
+        tempfile.close
+      end
+
       should "pass the content type to the Fog::Storage::AWS::Files instance" do
         Fog::Storage::AWS::Files.any_instance.expects(:create).with do |hash|
           hash[:content_type]
@@ -194,9 +264,56 @@ class FogTest < Test::Unit::TestCase
         end
       end
 
+      context "with styles set and fog_public set to false" do
+        setup do
+          rebuild_model(@options.merge(:fog_public => false, :styles => { :medium => "300x300>", :thumb => "100x100>" }))
+          @file = File.new(fixture_file('5k.png'), 'rb')
+          @dummy = Dummy.new
+          @dummy.avatar = @file
+          @dummy.save
+        end
+
+        should 'set the @fog_public for a particular style to false' do
+          assert_equal false, @dummy.avatar.instance_variable_get('@options')[:fog_public]
+          assert_equal false, @dummy.avatar.fog_public(:thumb)
+        end
+      end
+
+      context "with styles set and fog_public set per-style" do
+        setup do
+          rebuild_model(@options.merge(:fog_public => { :medium => false, :thumb => true}, :styles => { :medium => "300x300>", :thumb => "100x100>" }))
+          @file = File.new(fixture_file('5k.png'), 'rb')
+          @dummy = Dummy.new
+          @dummy.avatar = @file
+          @dummy.save
+        end
+
+        should 'set the fog_public for a particular style to correct value' do
+          assert_equal false, @dummy.avatar.fog_public(:medium)
+          assert_equal true, @dummy.avatar.fog_public(:thumb)
+        end
+      end
+
+      context "with fog_public not set" do
+        setup do
+          rebuild_model(@options)
+          @dummy = Dummy.new
+          @dummy.avatar = StringIO.new('.')
+          @dummy.save
+        end
+
+        should "default fog_public to true" do
+          assert_equal true, @dummy.avatar.fog_public
+        end
+      end
+
       context "with a valid bucket name for a subdomain" do
         should "provide an url in subdomain style" do
-          assert_match /^https:\/\/papercliptests.s3.amazonaws.com\/avatars\/5k.png\?\d*$/, @dummy.avatar.url
+          assert_match /^https:\/\/papercliptests.s3.amazonaws.com\/avatars\/5k.png/, @dummy.avatar.url
+        end
+
+        should "provide an url that expires in subdomain style" do
+          assert_match /^http:\/\/papercliptests.s3.amazonaws.com\/avatars\/5k.png\?AWSAccessKeyId=.+$/, @dummy.avatar.expiring_url
         end
       end
 
@@ -219,6 +336,10 @@ class FogTest < Test::Unit::TestCase
           assert_match /^https:\/\/s3.amazonaws.com\/this_is_invalid\/avatars\/5k.png\?\d*$/, @dummy.avatar.url
         end
 
+        should "provide a url that expires in folder style" do
+          assert_match /^http:\/\/s3.amazonaws.com\/this_is_invalid\/avatars\/5k.png\?AWSAccessKeyId=.+$/, @dummy.avatar.expiring_url
+        end
+
       end
 
       context "with a proc for a bucket name evaluating a model method" do
@@ -249,6 +370,38 @@ class FogTest < Test::Unit::TestCase
         should "provide a public url" do
           assert_match /http:\/\/dynamicfoghost\.com/, @dummy.avatar.url
         end
+
+      end
+
+      context "with a custom fog_host" do
+        setup do
+          rebuild_model(@options.merge(:fog_host => "http://dynamicfoghost.com"))
+          @dummy = Dummy.new
+          @dummy.avatar = @file
+          @dummy.save
+        end
+
+        should "provide a public url" do
+          assert_match /http:\/\/dynamicfoghost\.com/, @dummy.avatar.url
+        end
+
+        should "provide an expiring url" do
+          assert_match /http:\/\/dynamicfoghost\.com/, @dummy.avatar.expiring_url
+        end
+
+        context "with an invalid bucket name for a subdomain" do
+          setup do
+            rebuild_model(@options.merge({:fog_directory => "this_is_invalid", :fog_host => "http://dynamicfoghost.com"}))
+            @dummy = Dummy.new
+            @dummy.avatar = @file
+            @dummy.save
+          end
+
+          should "provide an expiring url" do
+            assert_match /http:\/\/dynamicfoghost\.com/, @dummy.avatar.expiring_url
+          end
+        end
+
       end
 
       context "with a proc for the fog_credentials evaluating a model method" do
@@ -272,4 +425,29 @@ class FogTest < Test::Unit::TestCase
     end
 
   end
+
+  context "when using local storage" do
+    setup do
+      Fog.unmock!
+      rebuild_model :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                    :storage => :fog,
+                    :url => '/:attachment/:filename',
+                    :fog_directory => "paperclip",
+                    :fog_credentials => { :provider => :local, :local_root => "." },
+                    :fog_host => 'localhost'
+
+      @file = File.new(fixture_file('5k.png'), 'rb')
+      @dummy = Dummy.new
+      @dummy.avatar = @file
+    end
+
+    teardown do
+      @file.close
+      Fog.mock!
+    end
+
+    should "return the public url in place of the expiring url" do
+      assert_match @dummy.avatar.public_url, @dummy.avatar.expiring_url
+    end
+  end
 end