paperclip 2.8.0 → 3.0.2

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module Paperclip
-  VERSION = "2.8.0" unless defined? Paperclip::VERSION
+  VERSION = "3.0.2" unless defined? Paperclip::VERSION
 end

data/lib/tasks/paperclip.rake

@@ -45,15 +45,11 @@ namespace :paperclip do
       names = Paperclip::Task.obtain_attachments(klass)
       names.each do |name|
         Paperclip.each_instance_with_attachment(klass, name) do |instance|
-          if file = instance.send(name).to_file(:original)
+          if file = Paperclip.io_adapters.for(instance.send(name))
             instance.send("#{name}_file_name=", instance.send("#{name}_file_name").strip)
             instance.send("#{name}_content_type=", file.content_type.to_s.strip)
             instance.send("#{name}_file_size=", file.size) if instance.respond_to?("#{name}_file_size")
-            if Rails.version >= "3.0.0"
-              instance.save(:validate => false)
-            else
-              instance.save(false)
-            end
+            instance.save(:validate => false)
           else
             true
           end
@@ -88,11 +84,7 @@ namespace :paperclip do
           attributes = %w(file_size file_name content_type).map{ |suffix| "#{name}_#{suffix}".to_sym }
           if attributes.any?{ |attribute| instance.errors[attribute].present? }
             instance.send("#{name}=", nil)
-            if Rails.version >= "3.0.0"
-              instance.save(:validate => false)
-            else
-              instance.save(false)
-            end
+            instance.save(:validate => false)
           end
         end
       end

data/paperclip.gemspec

@@ -18,24 +18,34 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  if File.exists?('UPGRADING')
+    s.post_install_message = File.read("UPGRADING")
+  end
+
   s.requirements << "ImageMagick"
+  s.required_ruby_version = ">= 1.9.2"
 
-  s.add_dependency('activerecord', '>= 2.3.0')
-  s.add_dependency('activesupport', '>= 2.3.2')
+  s.add_dependency('activerecord', '>= 3.0.0')
+  s.add_dependency('activemodel', '>= 3.0.0')
+  s.add_dependency('activesupport', '>= 3.0.0')
   s.add_dependency('cocaine', '>= 0.0.2')
   s.add_dependency('mime-types')
 
   s.add_development_dependency('shoulda')
   s.add_development_dependency('appraisal', '~> 0.4.0')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk')
-  s.add_development_dependency('sqlite3', '~> 1.3.5')
+  s.add_development_dependency('aws-sdk', '~> 1.3.8')
+  s.add_development_dependency('bourne')
+  s.add_development_dependency('sqlite3', '~> 1.3.4')
   s.add_development_dependency('cucumber', '~> 1.1.0')
   s.add_development_dependency('aruba')
+  s.add_development_dependency('nokogiri', '~> 1.4.7')
   s.add_development_dependency('capybara')
   s.add_development_dependency('bundler')
-  s.add_development_dependency('cocaine', '~> 0.4.0')
+  s.add_development_dependency('cocaine', '~> 0.2')
   s.add_development_dependency('fog')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('launchy')
   s.add_development_dependency('rake')
   s.add_development_dependency('fakeweb')
 end

data/test/adapter_registry_test.rb

@@ -0,0 +1,32 @@
+require './test/helper'
+
+class AdapterRegistryTest < Test::Unit::TestCase
+  context "for" do
+    setup do
+      class AdapterTest
+        def initialize(target); end
+      end
+      @subject = Paperclip::AdapterRegistry.new
+      @subject.register(AdapterTest){|t| Symbol === t }
+    end
+    should "return the class registered for the adapted type" do
+      assert_equal AdapterTest, @subject.for(:target).class
+    end
+  end
+
+  context "registered?" do
+    setup do
+      class AdapterTest
+        def initialize(target); end
+      end
+      @subject = Paperclip::AdapterRegistry.new
+      @subject.register(AdapterTest){|t| Symbol === t }
+    end
+    should "return true when the class of this adapter has been registered" do
+      assert @subject.registered?(AdapterTest.new(:target))
+    end
+    should "return false when the adapter has not been registered" do
+      assert ! @subject.registered?(Object)
+    end
+  end
+end

data/test/attachment_adapter_test.rb

@@ -0,0 +1,48 @@
+require './test/helper'
+
+class AttachmentAdapterTest < Test::Unit::TestCase
+  def setup
+    rebuild_model :path => "tmp/:class/:attachment/:style/:filename"
+    @attachment = Dummy.new.avatar
+    @file = File.new(fixture_file("5k.png"))
+    @file.binmode
+
+    @attachment.assign(@file)
+    @attachment.save
+    @subject = Paperclip.io_adapters.for(@attachment)
+  end
+
+  should "get the right filename" do
+    assert_equal "5k.png", @subject.original_filename
+  end
+
+  should "force binmode on tempfile" do
+    assert @subject.instance_variable_get("@tempfile").binmode?
+  end
+
+  should "get the content type" do
+    assert_equal "image/png", @subject.content_type
+  end
+
+  should "get the file's size" do
+    assert_equal 4456, @subject.size
+  end
+
+  should "return false for a call to nil?" do
+    assert ! @subject.nil?
+  end
+
+  should "generate a MD5 hash of the contents" do
+    expected = Digest::MD5.file(@file.path).to_s
+    assert_equal expected, @subject.fingerprint
+  end
+
+  should "read the contents of the file" do
+    expected = @file.read
+    actual = @subject.read
+    assert expected.length > 0
+    assert_equal expected.length, actual.length
+    assert_equal expected, actual
+  end
+
+end

data/test/attachment_options_test.rb

@@ -5,19 +5,6 @@ class AttachmentOptionsTest < Test::Unit::TestCase
     assert_kind_of Hash, Paperclip::AttachmentOptions.new({})
   end
 
-  should "add a default empty validations" do
-    options = {:arbi => :trary}
-    expected = {:validations => []}.merge(options)
-    actual = Paperclip::AttachmentOptions.new(options).to_hash
-    assert_equal expected, actual
-  end
-
-  should "not override validations if passed to initializer" do
-    options = {:validations => "something"}
-    attachment_options = Paperclip::AttachmentOptions.new(options)
-    assert_equal "something", attachment_options[:validations]
-  end
-
   should "respond to []" do
     assert Paperclip::AttachmentOptions.new({}).respond_to?(:[])
   end

data/test/attachment_test.rb

@@ -103,6 +103,15 @@ class AttachmentTest < Test::Unit::TestCase
     assert_equal "#{Rails.root}/public/fake_models/1234/fake", @attachment.path
   end
 
+  should "default to a path that scales" do
+    avatar_attachment = attachment
+    model = avatar_attachment.instance
+    model.id = 1234
+    model.avatar_file_name = "fake.jpg"
+    expected_path = "#{Rails.root}/public/system/fake_models/avatars/000/001/234/original/fake.jpg"
+    assert_equal expected_path, avatar_attachment.path
+  end
+
   context "Attachment default_options" do
     setup do
       rebuild_model
@@ -503,7 +512,7 @@ class AttachmentTest < Test::Unit::TestCase
     setup do
       rebuild_model :processor => [:thumbnail], :styles => { :small => '' }, :whiny_thumbnails => true
       @dummy = Dummy.new
-      Paperclip::Thumbnail.expects(:make).raises(Paperclip::PaperclipError, "cannot be processed.")
+      Paperclip::Thumbnail.expects(:make).raises(Paperclip::Error, "cannot be processed.")
       @file = StringIO.new("...")
       @file.stubs(:to_tempfile).returns(@file)
       @dummy.avatar = @file
@@ -570,7 +579,7 @@ class AttachmentTest < Test::Unit::TestCase
   should "convert underscored storage name to camelcase" do
     rebuild_model :storage => :not_here
     @dummy = Dummy.new
-    exception = assert_raises(Paperclip::StorageMethodNotFound) do
+    exception = assert_raises(Paperclip::Errors::StorageMethodNotFound) do
       @dummy.avatar
     end
     assert exception.message.include?("NotHere")
@@ -579,7 +588,7 @@ class AttachmentTest < Test::Unit::TestCase
   should "raise an error if you try to include a storage module that doesn't exist" do
     rebuild_model :storage => :not_here
     @dummy = Dummy.new
-    assert_raises(Paperclip::StorageMethodNotFound) do
+    assert_raises(Paperclip::Errors::StorageMethodNotFound) do
       @dummy.avatar
     end
   end
@@ -669,10 +678,7 @@ class AttachmentTest < Test::Unit::TestCase
       @file = StringIO.new(".")
       @file.stubs(:original_filename).returns("5k.png\n\n")
       @file.stubs(:content_type).returns("image/png\n\n")
-      @file.stubs(:to_tempfile).returns(@file)
       @dummy = Dummy.new
-      Paperclip::Thumbnail.expects(:make).returns(@file)
-      @attachment = @dummy.avatar
       @dummy.avatar = @file
     end
 
@@ -689,23 +695,12 @@ class AttachmentTest < Test::Unit::TestCase
     setup do
       rebuild_model
 
-      @not_file = mock("not_file")
-      @tempfile = mock("tempfile")
-      @not_file.stubs(:nil?).returns(false)
-      @not_file.expects(:size).returns(10)
-      @tempfile.expects(:size).returns(10)
-      @not_file.expects(:original_filename).returns("sheep_say_bæ.png\r\n")
-      @not_file.expects(:content_type).returns("image/png\r\n")
+      @file  = StringIO.new(".")
+      @file.stubs(:original_filename).returns("sheep_say_bæ.png\r\n")
+      @file.stubs(:content_type).returns("image/png\r\n")
 
       @dummy = Dummy.new
-      @attachment = @dummy.avatar
-      @attachment.expects(:valid_assignment?).with(@not_file).returns(true)
-      @attachment.expects(:queue_existing_for_delete)
-      @attachment.expects(:post_process)
-      @attachment.expects(:to_tempfile).returns(@tempfile)
-      @attachment.expects(:generate_fingerprint).with(@tempfile).returns("12345")
-      @attachment.expects(:generate_fingerprint).with(@not_file).returns("12345")
-      @dummy.avatar = @not_file
+      @dummy.avatar = @file
     end
 
     should "not remove strange letters" do
@@ -716,14 +711,14 @@ class AttachmentTest < Test::Unit::TestCase
   context "Attachment with reserved filename" do
     setup do
       rebuild_model
-      @file = StringIO.new(".")
+      @file = Paperclip.io_adapters.for(StringIO.new("."))
     end
 
     context "with default configuration" do
       "&$+,/:;=?@<>[]{}|\^~%# ".split(//).each do |character|
         context "with character #{character}" do
           setup do
-            @file.stubs(:original_filename).returns("file#{character}name.png")
+            @file.original_filename = "file#{character}name.png"
             @dummy = Dummy.new
             @dummy.avatar = @file
           end
@@ -787,11 +782,8 @@ class AttachmentTest < Test::Unit::TestCase
     end
 
     should "should have matching to_s and url methods" do
-      file = @attachment.to_file
-      assert file
       assert_match @attachment.to_s, @attachment.url
       assert_match @attachment.to_s(:small), @attachment.url(:small)
-      file.close
     end
   end
 
@@ -816,13 +808,12 @@ class AttachmentTest < Test::Unit::TestCase
 
     should "raise if there are not the correct columns when you try to assign" do
       @other_attachment = Paperclip::Attachment.new(:not_here, @instance)
-      assert_raises(Paperclip::PaperclipError) do
+      assert_raises(Paperclip::Error) do
         @other_attachment.assign(@file)
       end
     end
 
     should "return nil as path when no file assigned" do
-      assert @attachment.to_file.nil?
       assert_equal nil, @attachment.path
       assert_equal nil, @attachment.path(:blah)
     end
@@ -877,10 +868,6 @@ class AttachmentTest < Test::Unit::TestCase
             assert @attachment.dirty?
           end
 
-          should "set uploaded_file for access beyond the paperclip lifecycle" do
-            assert_equal @file, @attachment.uploaded_file
-          end
-
           context "and saved" do
             setup do
               @attachment.save
@@ -888,11 +875,7 @@ class AttachmentTest < Test::Unit::TestCase
 
             should "commit the files to disk" do
               [:large, :medium, :small].each do |style|
-                io = @attachment.to_file(style)
-                # p "in commit to disk test, io is #{io.inspect} and @instance.id is #{@instance.id}"
-                assert File.exists?(io.path)
-                assert ! io.is_a?(::Tempfile)
-                io.close
+                assert File.exists?(@attachment.path(style))
               end
             end
 
@@ -909,11 +892,6 @@ class AttachmentTest < Test::Unit::TestCase
               end
             end
 
-            should "still have its #file attribute not be nil" do
-              assert ! (file = @attachment.to_file).nil?
-              file.close
-            end
-
             context "and trying to delete" do
               setup do
                 @existing_names = @attachment.styles.keys.collect do |style|
@@ -1002,7 +980,7 @@ class AttachmentTest < Test::Unit::TestCase
       end
 
       should "not be able to find the module" do
-        assert_raise(Paperclip::StorageMethodNotFound){ Dummy.new.avatar }
+        assert_raise(Paperclip::Errors::StorageMethodNotFound){ Dummy.new.avatar }
       end
     end
   end
@@ -1038,7 +1016,7 @@ class AttachmentTest < Test::Unit::TestCase
 
     should "return the right value when sent #avatar_file_size" do
       @dummy.avatar = @file
-      assert_equal @file.size, @dummy.avatar.size
+      assert_equal File.size(@file), @dummy.avatar.size
     end
 
     context "and avatar_updated_at column" do
@@ -1059,18 +1037,12 @@ class AttachmentTest < Test::Unit::TestCase
         assert_equal now.to_i, @dummy.avatar.updated_at
       end
     end
-    
-    should "not calculate fingerprint after save" do
-      @dummy.avatar = @file
-      @dummy.save
-      assert_nil @dummy.avatar.fingerprint
-    end
-    
-    should "not calculate fingerprint before saving" do
+
+    should "not calculate fingerprint" do
       @dummy.avatar = @file
       assert_nil @dummy.avatar.fingerprint
     end
-    
+
     context "and avatar_content_type column" do
       setup do
         ActiveRecord::Base.connection.add_column :dummies, :avatar_content_type, :string
@@ -1101,14 +1073,14 @@ class AttachmentTest < Test::Unit::TestCase
 
       should "return the right value when sent #avatar_file_size" do
         @dummy.avatar = @file
-        assert_equal @file.size, @dummy.avatar.size
+        assert_equal File.size(@file), @dummy.avatar.size
       end
 
       should "return the right value when saved, reloaded, and sent #avatar_file_size" do
         @dummy.avatar = @file
         @dummy.save
         @dummy = Dummy.find(@dummy.id)
-        assert_equal @file.size, @dummy.avatar.size
+        assert_equal File.size(@file), @dummy.avatar.size
       end
     end
 

data/test/file_adapter_test.rb

@@ -0,0 +1,43 @@
+require './test/helper'
+
+class FileAdapterTest < Test::Unit::TestCase
+  context "a new instance" do
+    setup do
+      @file = File.new(fixture_file("5k.png"))
+      @file.binmode
+      @subject = Paperclip.io_adapters.for(@file)
+    end
+
+    should "get the right filename" do
+      assert_equal "5k.png", @subject.original_filename
+    end
+
+    should "force binmode on tempfile" do
+      assert @subject.instance_variable_get("@tempfile").binmode?
+    end
+
+    should "get the content type" do
+      assert_equal "image/png", @subject.content_type
+    end
+
+    should "get the file's size" do
+      assert_equal 4456, @subject.size
+    end
+
+    should "return false for a call to nil?" do
+      assert ! @subject.nil?
+    end
+
+    should "generate a MD5 hash of the contents" do
+      expected = Digest::MD5.file(@file.path).to_s
+      assert_equal expected, @subject.fingerprint
+    end
+
+    should "read the contents of the file" do
+      expected = @file.read
+      assert expected.length > 0
+      assert_equal expected, @subject.read
+    end
+
+  end
+end

data/test/generator_test.rb

@@ -0,0 +1,78 @@
+require './test/helper'
+require 'rails/generators'
+require 'generators/paperclip/paperclip_generator'
+
+class GeneratorTest < Rails::Generators::TestCase
+  tests PaperclipGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  context 'running migration' do
+    context 'with single attachment name' do
+      setup do
+        run_generator %w(user avatar)
+      end
+
+      should 'create a correct migration file' do
+        assert_migration 'db/migrate/add_attachment_avatar_to_users.rb' do |migration|
+          assert_match /class AddAttachmentAvatarToUsers/, migration
+
+          assert_class_method :up, migration do |up|
+            assert_match /add_column :users, :avatar_file_name, :string/, up
+            assert_match /add_column :users, :avatar_content_type, :string/, up
+            assert_match /add_column :users, :avatar_file_size, :integer/, up
+            assert_match /add_column :users, :avatar_updated_at, :datetime/, up
+          end
+
+          assert_class_method :down, migration do |down|
+            assert_match /remove_column :users, :avatar_file_name/, down
+            assert_match /remove_column :users, :avatar_content_type/, down
+            assert_match /remove_column :users, :avatar_file_size/, down
+            assert_match /remove_column :users, :avatar_updated_at/, down
+          end
+        end
+      end
+    end
+
+    context 'with multiple attachment names' do
+      setup do
+        run_generator %w(user avatar photo)
+      end
+
+      should 'create a correct migration file' do
+        assert_migration 'db/migrate/add_attachment_avatar_photo_to_users.rb' do |migration|
+          assert_match /class AddAttachmentAvatarPhotoToUsers/, migration
+
+          assert_class_method :up, migration do |up|
+            assert_match /add_column :users, :avatar_file_name, :string/, up
+            assert_match /add_column :users, :avatar_content_type, :string/, up
+            assert_match /add_column :users, :avatar_file_size, :integer/, up
+            assert_match /add_column :users, :avatar_updated_at, :datetime/, up
+            assert_match /add_column :users, :photo_file_name, :string/, up
+            assert_match /add_column :users, :photo_content_type, :string/, up
+            assert_match /add_column :users, :photo_file_size, :integer/, up
+            assert_match /add_column :users, :photo_updated_at, :datetime/, up
+          end
+
+          assert_class_method :down, migration do |down|
+            assert_match /remove_column :users, :avatar_file_name/, down
+            assert_match /remove_column :users, :avatar_content_type/, down
+            assert_match /remove_column :users, :avatar_file_size/, down
+            assert_match /remove_column :users, :avatar_updated_at/, down
+            assert_match /remove_column :users, :photo_file_name/, down
+            assert_match /remove_column :users, :photo_content_type/, down
+            assert_match /remove_column :users, :photo_file_size/, down
+            assert_match /remove_column :users, :photo_updated_at/, down
+          end
+        end
+      end
+    end
+
+    context 'without required arguments' do
+      should 'not create the migration' do
+        silence_stream(STDERR) { run_generator %w() }
+        assert_no_migration 'db/migrate/add_attachment_avatar_to_users.rb'
+      end
+    end
+  end
+end