paperclip 4.2.4 → 5.2.0

data/paperclip.gemspec

@@ -12,40 +12,43 @@ Gem::Specification.new do |s|
   s.description       = "Easy upload management for ActiveRecord"
   s.license           = "MIT"
 
-  s.rubyforge_project = "paperclip"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  if File.exist?('UPGRADING')
+    s.post_install_message = File.read("UPGRADING")
+  end
+
   s.requirements << "ImageMagick"
-  s.required_ruby_version = ">= 1.9.2"
+  s.required_ruby_version = ">= 2.1.0"
 
-  s.add_dependency('activemodel', '>= 3.2.0')
-  s.add_dependency('activesupport', '>= 3.2.0')
+  s.add_dependency('activemodel', '>= 4.2.0')
+  s.add_dependency('activesupport', '>= 4.2.0')
   s.add_dependency('cocaine', '~> 0.5.5')
   s.add_dependency('mime-types')
+  s.add_dependency('mimemagic', '~> 0.3.0')
 
-  s.add_development_dependency('activerecord', '>= 3.2.0')
+  s.add_development_dependency('activerecord', '>= 4.2.0')
   s.add_development_dependency('shoulda')
-  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('appraisal')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk', '>= 1.5.7', "<= 2.0")
+  s.add_development_dependency('aws-sdk', '>= 2.3.0', '< 3.0')
   s.add_development_dependency('bourne')
-  s.add_development_dependency('cucumber', '~> 1.3.11')
-  s.add_development_dependency('aruba')
+  s.add_development_dependency('cucumber-rails')
+  s.add_development_dependency('cucumber-expressions', '4.0.3') # TODO: investigate failures on 4.0.4
+  s.add_development_dependency('aruba', '~> 0.9.0')
   s.add_development_dependency('nokogiri')
-  # Ruby version < 1.9.3 can't install capybara > 2.0.3.
-  s.add_development_dependency('capybara', '= 2.0.3')
+  s.add_development_dependency('capybara')
   s.add_development_dependency('bundler')
-  s.add_development_dependency('fog', '~> 1.0')
+  s.add_development_dependency('fog-aws')
+  s.add_development_dependency('fog-local')
   s.add_development_dependency('launchy')
   s.add_development_dependency('rake')
   s.add_development_dependency('fakeweb')
   s.add_development_dependency('railties')
-  s.add_development_dependency('actionmailer', '>= 3.2.0')
   s.add_development_dependency('generator_spec')
   s.add_development_dependency('timecop')
 end

data/spec/paperclip/attachment_definitions_spec.rb

@@ -8,6 +8,6 @@ describe "Attachment Definitions" do
     Dummy.do_not_validate_attachment_file_type :avatar
     expected = {avatar: {path: "abc"}, other_attachment: {url: "123"}}
 
-    assert_equal expected, Dummy.attachment_definitions
+    expect(Dummy.attachment_definitions).to eq expected
   end
 end

data/spec/paperclip/attachment_processing_spec.rb

@@ -2,11 +2,9 @@
 require 'spec_helper'
 
 describe 'Attachment Processing' do
-  context 'using validates_attachment_content_type' do
-    before do
-      rebuild_class
-    end
+  before { rebuild_class }
 
+  context 'using validates_attachment_content_type' do
     it 'processes attachments given a valid assignment' do
       file = File.new(fixture_file("5k.png"))
       Dummy.validates_attachment_content_type :avatar, content_type: "image/png"

data/spec/paperclip/attachment_registry_spec.rb

@@ -31,8 +31,8 @@ describe 'Attachment Registry' do
     it 'calls the block with the class, attachment name, and options' do
       foo = Class.new
       expected_accumulations = [
-        [foo, :avatar, { yo: 'greeting' }],
-        [foo, :greeter, { ciao: 'greeting' }]
+        [foo, :avatar, { yo: "greeting" }],
+        [foo, :greeter, { ciao: "greeting" }]
       ]
       expected_accumulations.each do |args|
         Paperclip::AttachmentRegistry.register(*args)
@@ -50,25 +50,92 @@ describe 'Attachment Registry' do
   context '.definitions_for' do
     it 'produces the attachment name and options' do
       expected_definitions = {
-        avatar: { yo: 'greeting' },
-        greeter: { ciao: 'greeting' }
+        avatar: { yo: "greeting" },
+        greeter: { ciao: "greeting" }
       }
       foo = Class.new
-      Paperclip::AttachmentRegistry.register(foo, :avatar, { yo: 'greeting' })
-      Paperclip::AttachmentRegistry.register(foo, :greeter, { ciao: 'greeting' })
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        yo: "greeting"
+      )
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :greeter,
+        ciao: "greeting"
+      )
 
       definitions = Paperclip::AttachmentRegistry.definitions_for(foo)
 
       assert_equal expected_definitions, definitions
     end
 
-    it "produces defintions for subclasses" do
-      expected_definitions = { avatar: { yo: 'greeting' } }
-      Foo = Class.new
-      Bar = Class.new(Foo)
-      Paperclip::AttachmentRegistry.register(Foo, :avatar, expected_definitions[:avatar])
+    it 'produces defintions for subclasses' do
+      expected_definitions = { avatar: { yo: "greeting" } }
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        expected_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
+
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'produces defintions for subclasses but deep merging them' do
+      foo_definitions = { avatar: { yo: "greeting" } }
+      bar_definitions = { avatar: { ciao: "greeting" } }
+      expected_definitions = {
+        avatar: {
+          yo: "greeting",
+          ciao: "greeting"
+        }
+      }
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        foo_definitions[:avatar]
+      )
+      Paperclip::AttachmentRegistry.register(
+        bar,
+        :avatar,
+        bar_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
 
-      definitions = Paperclip::AttachmentRegistry.definitions_for(Bar)
+      assert_equal expected_definitions, definitions
+    end
+
+    it 'allows subclasses to override attachment defitions' do
+      foo_definitions = { avatar: { yo: "greeting" } }
+      bar_definitions = { avatar: { yo: "hello" } }
+
+      expected_definitions = {
+        avatar: {
+          yo: "hello"
+        }
+      }
+
+      foo = Class.new
+      bar = Class.new(foo)
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :avatar,
+        foo_definitions[:avatar]
+      )
+      Paperclip::AttachmentRegistry.register(
+        bar,
+        :avatar,
+        bar_definitions[:avatar]
+      )
+
+      definitions = Paperclip::AttachmentRegistry.definitions_for(bar)
 
       assert_equal expected_definitions, definitions
     end
@@ -77,7 +144,11 @@ describe 'Attachment Registry' do
   context '.clear' do
     it 'removes all of the existing attachment definitions' do
       foo = Class.new
-      Paperclip::AttachmentRegistry.register(foo, :greeter, { ciao: 'greeting' })
+      Paperclip::AttachmentRegistry.register(
+        foo,
+        :greeter,
+        ciao: "greeting"
+      )
 
       Paperclip::AttachmentRegistry.clear
 

data/spec/paperclip/attachment_spec.rb

@@ -13,7 +13,7 @@ describe Paperclip::Attachment do
   it "is present when the file is set" do
     rebuild_class
     dummy = Dummy.new
-    dummy.avatar = File.new(fixture_file("50x50.png"), "rb") 
+    dummy.avatar = File.new(fixture_file("50x50.png"), "rb")
     expect(dummy.avatar).to_not be_blank
     expect(dummy.avatar).to be_present
   end
@@ -34,9 +34,9 @@ describe Paperclip::Attachment do
   it "does not delete styles that don't get reprocessed" do
     file = File.new(fixture_file("50x50.png"), 'rb')
     rebuild_class styles: {
-      small: '100x>',
-      large: '500x>',
-      original: '42x42#' 
+      small: "100x>",
+      large: "500x>",
+      original: "42x42#"
     }
 
     dummy = Dummy.new
@@ -75,7 +75,11 @@ describe Paperclip::Attachment do
 
   it "handles a boolean second argument to #url" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
-    attachment = Paperclip::Attachment.new(:name, :instance, url_generator: mock_url_generator_builder)
+    attachment = Paperclip::Attachment.new(
+      :name,
+      FakeModel.new,
+      url_generator: mock_url_generator_builder
+      )
 
     attachment.url(:style_name, true)
     expect(mock_url_generator_builder.has_generated_url_with_options?(timestamp: true, escape: true)).to eq true
@@ -86,7 +90,11 @@ describe Paperclip::Attachment do
 
   it "passes the style and options through to the URL generator on #url" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
-    attachment = Paperclip::Attachment.new(:name, :instance, url_generator: mock_url_generator_builder)
+    attachment = Paperclip::Attachment.new(
+      :name,
+      FakeModel.new,
+      url_generator: mock_url_generator_builder
+      )
 
     attachment.url(:style_name, options: :values)
     expect(mock_url_generator_builder.has_generated_url_with_options?(options: :values)).to eq true
@@ -95,7 +103,7 @@ describe Paperclip::Attachment do
   it "passes default options through when #url is given one argument" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            url_generator: mock_url_generator_builder,
                                            use_timestamp: true)
 
@@ -106,7 +114,7 @@ describe Paperclip::Attachment do
   it "passes default style and options through when #url is given no arguments" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            default_style: 'default style',
                                            url_generator: mock_url_generator_builder,
                                            use_timestamp: true)
@@ -119,7 +127,7 @@ describe Paperclip::Attachment do
   it "passes the option timestamp: true if :use_timestamp is true and :timestamp is not passed" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            url_generator: mock_url_generator_builder,
                                            use_timestamp: true)
 
@@ -130,7 +138,7 @@ describe Paperclip::Attachment do
   it "passes the option timestamp: false if :use_timestamp is false and :timestamp is not passed" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            url_generator: mock_url_generator_builder,
                                            use_timestamp: false)
 
@@ -141,7 +149,7 @@ describe Paperclip::Attachment do
   it "does not change the :timestamp if :timestamp is passed" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            url_generator: mock_url_generator_builder,
                                            use_timestamp: false)
 
@@ -152,7 +160,7 @@ describe Paperclip::Attachment do
   it "renders JSON as default style" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            default_style: 'default style',
                                            url_generator: mock_url_generator_builder)
 
@@ -163,7 +171,7 @@ describe Paperclip::Attachment do
   it "passes the option escape: true if :escape_url is true and :escape is not passed" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            url_generator: mock_url_generator_builder,
                                            escape_url: true)
 
@@ -174,7 +182,7 @@ describe Paperclip::Attachment do
   it "passes the option escape: false if :escape_url is false and :escape is not passed" do
     mock_url_generator_builder = MockUrlGeneratorBuilder.new
     attachment = Paperclip::Attachment.new(:name,
-                                           :instance,
+                                           FakeModel.new,
                                            url_generator: mock_url_generator_builder,
                                            escape_url: false)
 
@@ -212,10 +220,8 @@ describe Paperclip::Attachment do
     dummy = Dummy.new
     dummy.id = 1234
     dummy.avatar_file_name = "fake.jpg"
+    dummy.stubs(:new_record?).returns(false)
     expected_string = '{"avatar":"/system/dummies/avatars/000/001/234/original/fake.jpg"}'
-    if ActiveRecord::Base.include_root_in_json # This is true by default in Rails 3, and false in 4
-      expected_string = %({"dummy":#{expected_string}})
-    end
     # active_model pre-3.2 checks only by calling any? on it, thus it doesn't work if it is empty
     assert_equal expected_string, dummy.to_json(only: [:dummy_key_for_old_active_model], methods: [:avatar])
   end
@@ -245,12 +251,17 @@ describe Paperclip::Attachment do
 
     context "without an Attachment" do
       before do
+        rebuild_model default_url: "default.url"
         @dummy = Dummy.new
       end
 
       it "returns false when asked exists?" do
         assert !@dummy.avatar.exists?
       end
+
+      it "#url returns the default_url" do
+        expect(@dummy.avatar.url).to eq "default.url"
+      end
     end
 
     context "on an Attachment" do
@@ -489,6 +500,7 @@ describe Paperclip::Attachment do
       @attachment.expects(:post_process).with(:thumb)
       @attachment.expects(:post_process).with(:large).never
       @attachment.assign(@file)
+      @attachment.save
     end
   end
 
@@ -635,15 +647,40 @@ describe Paperclip::Attachment do
     before do
       rebuild_model processor: [:thumbnail], styles: { small: '' }, whiny_thumbnails: true
       @dummy = Dummy.new
-      Paperclip::Thumbnail.expects(:make).raises(Paperclip::Error, "cannot be processed.")
       @file = StringIO.new("...")
       @file.stubs(:to_tempfile).returns(@file)
-      @dummy.avatar = @file
     end
 
-    it "correctly forwards processing error message to the instance" do
-      @dummy.valid?
-      assert_contains @dummy.errors.full_messages, "Avatar cannot be processed."
+    context "when error is meaningful for the end user" do
+      before do
+        Paperclip::Thumbnail.expects(:make).raises(
+          Paperclip::Errors::NotIdentifiedByImageMagickError,
+          "cannot be processed."
+        )
+      end
+
+      it "correctly forwards processing error message to the instance" do
+        @dummy.avatar = @file
+        @dummy.valid?
+        assert_contains(
+          @dummy.errors.full_messages,
+          "Avatar cannot be processed."
+        )
+      end
+    end
+
+    context "when error is intended for the developer" do
+      before do
+        Paperclip::Thumbnail.expects(:make).raises(
+          Paperclip::Errors::CommandNotFoundError
+        )
+      end
+
+      it "propagates the error" do
+        assert_raises(Paperclip::Errors::CommandNotFoundError) do
+          @dummy.avatar = @file
+        end
+      end
     end
   end
 
@@ -661,9 +698,6 @@ describe Paperclip::Attachment do
 
     context "when assigned" do
       it "calls #make on all specified processors" do
-        Paperclip::Thumbnail.stubs(:make).with(any_parameters).returns(@file)
-        Paperclip::Test.stubs(:make).with(any_parameters).returns(@file)
-
         @dummy.avatar = @file
 
         expect(Paperclip::Thumbnail).to have_received(:make)
@@ -678,7 +712,6 @@ describe Paperclip::Attachment do
           convert_options: "",
           source_file_options: ""
         })
-        Paperclip::Thumbnail.stubs(:make).returns(@file)
 
         @dummy.avatar = @file
 
@@ -686,12 +719,36 @@ describe Paperclip::Attachment do
       end
 
       it "calls #make with attachment passed as third argument" do
-        Paperclip::Test.expects(:make).returns(@file)
-
         @dummy.avatar = @file
 
         expect(Paperclip::Test).to have_received(:make).with(anything, anything, @dummy.avatar)
       end
+
+      it "calls #make and unlinks intermediary files afterward" do
+        @dummy.avatar.expects(:unlink_files).with([@file, @file])
+
+        @dummy.avatar = @file
+      end
+    end
+  end
+
+  context "An attachment with a processor that returns original file" do
+    before do
+      class Paperclip::Test < Paperclip::Processor
+        def make; @file; end
+      end
+      rebuild_model processors: [:test], styles: { once: "100x100" }
+      @file = StringIO.new("...")
+      @file.stubs(:close)
+      @dummy = Dummy.new
+    end
+
+    context "when assigned" do
+      it "#calls #make and doesn't unlink the original file" do
+        @dummy.avatar.expects(:unlink_files).with([])
+
+        @dummy.avatar = @file
+      end
     end
   end
 
@@ -1065,7 +1122,7 @@ describe Paperclip::Attachment do
     context "with a file assigned but not saved yet" do
       it "clears out any attached files" do
         @attachment.assign(@file)
-        assert !@attachment.queued_for_write.blank?
+        assert @attachment.queued_for_write.present?
         @attachment.clear
         assert @attachment.queued_for_write.blank?
       end
@@ -1315,6 +1372,12 @@ describe Paperclip::Attachment do
     end
 
     it "does not calculate fingerprint" do
+      Digest::MD5.stubs(:file)
+      @dummy.avatar = @file
+      expect(Digest::MD5).to have_received(:file).never
+    end
+
+    it "does not assign fingerprint" do
       @dummy.avatar = @file
       assert_nil @dummy.avatar.fingerprint
     end
@@ -1371,16 +1434,46 @@ describe Paperclip::Attachment do
         assert_nothing_raised { @dummy.avatar = @file }
       end
 
-      it "returns the right value when sent #avatar_fingerprint" do
-        @dummy.avatar = @file
-        assert_equal 'aec488126c3b33c08a10c3fa303acf27', @dummy.avatar_fingerprint
+      context "with explicitly set digest" do
+        before do
+          rebuild_class adapter_options: { hash_digest: Digest::SHA256 }
+          @dummy = Dummy.new
+        end
+
+        it "returns the right value when sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          assert_equal "734016d801a497f5579cdd4ef2ae1d020088c1db754dc434482d76dd5486520a",
+                       @dummy.avatar_fingerprint
+        end
+
+        it "returns the right value when saved, reloaded, and sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          @dummy.save
+          @dummy = Dummy.find(@dummy.id)
+          assert_equal "734016d801a497f5579cdd4ef2ae1d020088c1db754dc434482d76dd5486520a",
+                       @dummy.avatar_fingerprint
+        end
       end
 
-      it "returns the right value when saved, reloaded, and sent #avatar_fingerprint" do
-        @dummy.avatar = @file
-        @dummy.save
-        @dummy = Dummy.find(@dummy.id)
-        assert_equal 'aec488126c3b33c08a10c3fa303acf27', @dummy.avatar_fingerprint
+      context "with the default digest" do
+        before do
+          rebuild_class # MD5 is the default
+          @dummy = Dummy.new
+        end
+
+        it "returns the right value when sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          assert_equal "aec488126c3b33c08a10c3fa303acf27",
+                       @dummy.avatar_fingerprint
+        end
+
+        it "returns the right value when saved, reloaded, and sent #avatar_fingerprint" do
+          @dummy.avatar = @file
+          @dummy.save
+          @dummy = Dummy.find(@dummy.id)
+          assert_equal "aec488126c3b33c08a10c3fa303acf27",
+                       @dummy.avatar_fingerprint
+        end
       end
     end
   end
@@ -1452,6 +1545,4 @@ describe Paperclip::Attachment do
       assert_file_exists(@path)
     end
   end
-
 end
-

data/spec/paperclip/content_type_detector_spec.rb

@@ -1,6 +1,12 @@
 require 'spec_helper'
 
 describe Paperclip::ContentTypeDetector do
+  it 'returns a meaningful content type for open xml spreadsheets' do
+    file = File.new(fixture_file("empty.xlsx"))
+    assert_equal "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+                 Paperclip::ContentTypeDetector.new(file.path).detect
+  end
+
   it 'gives a sensible default when the name is empty' do
     assert_equal "application/octet-stream", Paperclip::ContentTypeDetector.new("").detect
   end
@@ -13,7 +19,8 @@ describe Paperclip::ContentTypeDetector do
 
   it 'returns content type of file if it is an acceptable type' do
     MIME::Types.stubs(:type_for).returns([MIME::Type.new('application/mp4'), MIME::Type.new('video/mp4'), MIME::Type.new('audio/mp4')])
-    Paperclip.stubs(:run).returns("video/mp4")
+    Paperclip::ContentTypeDetector.any_instance
+      .stubs(:type_from_file_contents).returns("video/mp4")
     @filename = "my_file.mp4"
     assert_equal "video/mp4", Paperclip::ContentTypeDetector.new(@filename).detect
   end

data/spec/paperclip/file_command_content_type_detector_spec.rb

@@ -24,4 +24,3 @@ describe Paperclip::FileCommandContentTypeDetector do
       Paperclip::FileCommandContentTypeDetector.new("windows").detect
   end
 end
-

data/spec/paperclip/geometry_spec.rb

@@ -82,7 +82,7 @@ describe Paperclip::Geometry do
       assert_equal 456, @upper.height
     end
 
-    ['>', '<', '#', '@', '%', '^', '!', nil].each do |mod|
+    ['>', '<', '#', '@', '@>', '>@', '%', '^', '!', nil].each do |mod|
       it "ensures the modifier #{description} is preserved" do
         assert @geo = Paperclip::Geometry.parse("123x456#{mod}")
         assert_equal mod, @geo.modifier

data/spec/paperclip/glue_spec.rb

@@ -0,0 +1,44 @@
+# require "spec_helper"
+
+describe Paperclip::Glue do
+  describe "when ActiveRecord does not exist" do
+    before do
+      ActiveRecordSaved = ActiveRecord
+      Object.send :remove_const, "ActiveRecord"
+    end
+
+    after do
+      ActiveRecord = ActiveRecordSaved
+      Object.send :remove_const, "ActiveRecordSaved"
+    end
+
+    it "does not fail" do
+      NonActiveRecordModel = Class.new
+      NonActiveRecordModel.send :include, Paperclip::Glue
+      Object.send :remove_const, "NonActiveRecordModel"
+    end
+  end
+
+  describe "when ActiveRecord does exist" do
+    before do
+      if Object.const_defined?("ActiveRecord")
+        @defined_active_record = false
+      else
+        ActiveRecord = :defined
+        @defined_active_record = true
+      end
+    end
+
+    after do
+      if @defined_active_record
+        Object.send :remove_const, "ActiveRecord"
+      end
+    end
+
+    it "does not fail" do
+      NonActiveRecordModel = Class.new
+      NonActiveRecordModel.send :include, Paperclip::Glue
+      Object.send :remove_const, "NonActiveRecordModel"
+    end
+  end
+end