paperclip 3.5.4 → 6.1.0

data/{test/io_adapters/uploaded_file_adapter_test.rb → spec/paperclip/io_adapters/uploaded_file_adapter_spec.rb}

@@ -1,9 +1,9 @@
-require './test/helper'
+require 'spec_helper'
 
-class UploadedFileAdapterTest < Test::Unit::TestCase
+describe Paperclip::UploadedFileAdapter do
   context "a new instance" do
     context "with UploadedFile responding to #tempfile" do
-      setup do
+      before do
         Paperclip::UploadedFileAdapter.content_type_detector = nil
 
         class UploadedFile < OpenStruct; end
@@ -11,41 +11,41 @@ class UploadedFileAdapterTest < Test::Unit::TestCase
         tempfile.binmode
 
         @file = UploadedFile.new(
-          :original_filename => "5k.png",
-          :content_type => "image/x-png-by-browser\r",
-          :head => "",
-          :tempfile => tempfile,
-          :path => tempfile.path
+          original_filename: "5k.png",
+          content_type: "image/x-png-by-browser\r",
+          head: "",
+          tempfile: tempfile,
+          path: tempfile.path
         )
-        @subject = Paperclip.io_adapters.for(@file)
+        @subject = Paperclip.io_adapters.for(@file, hash_digest: Digest::MD5)
       end
 
-      should "get the right filename" do
+      it "gets the right filename" do
         assert_equal "5k.png", @subject.original_filename
       end
 
-      should "force binmode on tempfile" do
+      it "forces binmode on tempfile" do
         assert @subject.instance_variable_get("@tempfile").binmode?
       end
 
-      should "get the content type" do
-        assert_equal "image/x-png-by-browser", @subject.content_type
+      it "gets the content type" do
+        assert_equal "image/png", @subject.content_type
       end
 
-      should "get the file's size" do
+      it "gets the file's size" do
         assert_equal 4456, @subject.size
       end
 
-      should "return false for a call to nil?" do
+      it "returns false for a call to nil?" do
         assert ! @subject.nil?
       end
 
-      should "generate a MD5 hash of the contents" do
+      it "generates a MD5 hash of the contents" do
         expected = Digest::MD5.file(@file.tempfile.path).to_s
         assert_equal expected, @subject.fingerprint
       end
 
-      should "read the contents of the file" do
+      it "reads the contents of the file" do
         expected = @file.tempfile.read
         assert expected.length > 0
         assert_equal expected, @subject.read
@@ -53,68 +53,68 @@ class UploadedFileAdapterTest < Test::Unit::TestCase
     end
 
     context "with UploadedFile that has restricted characters" do
-      setup do
+      before do
         Paperclip::UploadedFileAdapter.content_type_detector = nil
 
         class UploadedFile < OpenStruct; end
         @file = UploadedFile.new(
-          :original_filename => "image:restricted.gif",
-          :content_type => "image/x-png-by-browser",
-          :head => "",
-          :path => fixture_file("5k.png")
+          original_filename: "image:restricted.gif",
+          content_type: "image/x-png-by-browser",
+          head: "",
+          path: fixture_file("5k.png")
         )
-        @subject = Paperclip.io_adapters.for(@file)
+        @subject = Paperclip.io_adapters.for(@file, hash_digest: Digest::MD5)
       end
 
-      should "not generate paths that include restricted characters" do
-        assert_no_match /:/, @subject.path
+      it "does not generate paths that include restricted characters" do
+        expect(@subject.path).to_not match(/:/)
       end
 
-      should "not generate filenames that include restricted characters" do
+      it "does not generate filenames that include restricted characters" do
         assert_equal 'image_restricted.gif', @subject.original_filename
       end
     end
 
     context "with UploadFile responding to #path" do
-      setup do
+      before do
         Paperclip::UploadedFileAdapter.content_type_detector = nil
 
         class UploadedFile < OpenStruct; end
         @file = UploadedFile.new(
-          :original_filename => "5k.png",
-          :content_type => "image/x-png-by-browser",
-          :head => "",
-          :path => fixture_file("5k.png")
+          original_filename: "5k.png",
+          content_type: "image/x-png-by-browser",
+          head: "",
+          path: fixture_file("5k.png")
         )
-        @subject = Paperclip.io_adapters.for(@file)
+        @subject = Paperclip.io_adapters.for(@file, hash_digest: Digest::MD5)
       end
 
-      should "get the right filename" do
+      it "gets the right filename" do
         assert_equal "5k.png", @subject.original_filename
       end
 
-      should "force binmode on tempfile" do
+      it "forces binmode on tempfile" do
         assert @subject.instance_variable_get("@tempfile").binmode?
       end
 
-      should "get the content type" do
-        assert_equal "image/x-png-by-browser", @subject.content_type
+      it "gets the content type" do
+        assert_equal "image/png", @subject.content_type
       end
 
-      should "get the file's size" do
+      it "gets the file's size" do
         assert_equal 4456, @subject.size
       end
 
-      should "return false for a call to nil?" do
+      it "returns false for a call to nil?" do
         assert ! @subject.nil?
       end
 
-      should "generate a MD5 hash of the contents" do
+      it "generates 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
+      it "reads the contents of the file" do
         expected_file = File.new(@file.path)
         expected_file.binmode
         expected = expected_file.read
@@ -123,21 +123,21 @@ class UploadedFileAdapterTest < Test::Unit::TestCase
       end
 
       context "don't trust client-given MIME type" do
-        setup do
+        before do
           Paperclip::UploadedFileAdapter.content_type_detector =
             Paperclip::FileCommandContentTypeDetector
 
           class UploadedFile < OpenStruct; end
           @file = UploadedFile.new(
-            :original_filename => "5k.png",
-            :content_type => "image/x-png-by-browser",
-            :head => "",
-            :path => fixture_file("5k.png")
+            original_filename: "5k.png",
+            content_type: "image/x-png-by-browser",
+            head: "",
+            path: fixture_file("5k.png")
           )
           @subject = Paperclip.io_adapters.for(@file)
         end
 
-        should "get the content type" do
+        it "gets the content type" do
           assert_equal "image/png", @subject.content_type
         end
       end

data/spec/paperclip/io_adapters/uri_adapter_spec.rb

@@ -0,0 +1,220 @@
+require 'spec_helper'
+
+describe Paperclip::UriAdapter do
+  let(:content_type) { "image/png" }
+  let(:meta) { {} }
+
+  before do
+    @open_return = StringIO.new("xxx")
+    @open_return.stubs(:content_type).returns(content_type)
+    @open_return.stubs(:meta).returns(meta)
+    Paperclip::UriAdapter.register
+  end
+
+  after do
+    Paperclip.io_adapters.unregister(described_class)
+  end
+
+  context "a new instance" do
+    let(:meta) { { "content-type" => "image/png" } }
+
+    before do
+      Paperclip::UriAdapter.any_instance.
+        stubs(:download_content).returns(@open_return)
+
+      @uri = URI.parse("http://thoughtbot.com/images/thoughtbot-logo.png")
+      @subject = Paperclip.io_adapters.for(@uri, hash_digest: Digest::MD5)
+    end
+
+    it "returns a file name" do
+      assert_equal "thoughtbot-logo.png", @subject.original_filename
+    end
+
+    it 'closes open handle after reading' do
+      assert_equal true, @open_return.closed?
+    end
+
+    it "returns a content type" do
+      assert_equal "image/png", @subject.content_type
+    end
+
+    it "returns the size of the data" do
+      assert_equal @open_return.size, @subject.size
+    end
+
+    it "generates an MD5 hash of the contents" do
+      assert_equal Digest::MD5.hexdigest("xxx"), @subject.fingerprint
+    end
+
+    it "generates correct fingerprint after read" do
+      fingerprint = Digest::MD5.hexdigest(@subject.read)
+      assert_equal fingerprint, @subject.fingerprint
+    end
+
+    it "generates same fingerprint" do
+      assert_equal @subject.fingerprint, @subject.fingerprint
+    end
+
+    it "returns the data contained in the StringIO" do
+      assert_equal "xxx", @subject.read
+    end
+
+    it 'accepts a content_type' do
+      @subject.content_type = 'image/png'
+      assert_equal 'image/png', @subject.content_type
+    end
+
+    it "accepts an original_filename" do
+      @subject.original_filename = 'image.png'
+      assert_equal 'image.png', @subject.original_filename
+    end
+
+  end
+
+  context "a directory index url" do
+    let(:content_type) { "text/html" }
+    let(:meta) { { "content-type" => "text/html" } }
+
+    before do
+      Paperclip::UriAdapter.any_instance.
+        stubs(:download_content).returns(@open_return)
+
+      @uri = URI.parse("http://thoughtbot.com")
+      @subject = Paperclip.io_adapters.for(@uri)
+    end
+
+    it "returns a file name" do
+      assert_equal "index.html", @subject.original_filename
+    end
+
+    it "returns a content type" do
+      assert_equal "text/html", @subject.content_type
+    end
+  end
+
+  context "a url with query params" do
+    before do
+      Paperclip::UriAdapter.any_instance.
+        stubs(:download_content).returns(@open_return)
+
+      @uri = URI.parse("https://github.com/thoughtbot/paperclip?file=test")
+      @subject = Paperclip.io_adapters.for(@uri)
+    end
+
+    it "returns a file name" do
+      assert_equal "paperclip", @subject.original_filename
+    end
+  end
+
+  context "a url with content disposition headers" do
+    let(:file_name) { "test_document.pdf" }
+    let(:filename_from_path) { "paperclip" }
+
+    before do
+      Paperclip::UriAdapter.any_instance.
+        stubs(:download_content).returns(@open_return)
+
+      @uri = URI.parse(
+        "https://github.com/thoughtbot/#{filename_from_path}?file=test")
+    end
+
+    it "returns file name from path" do
+      meta["content-disposition"] = "inline;"
+
+      @subject = Paperclip.io_adapters.for(@uri)
+
+      assert_equal filename_from_path, @subject.original_filename
+    end
+
+    it "returns a file name enclosed in double quotes" do
+      file_name = "john's test document.pdf"
+      meta["content-disposition"] = "attachment; filename=\"#{file_name}\";"
+
+      @subject = Paperclip.io_adapters.for(@uri)
+
+      assert_equal file_name, @subject.original_filename
+    end
+
+    it "returns a file name not enclosed in double quotes" do
+      meta["content-disposition"] = "ATTACHMENT; FILENAME=#{file_name};"
+
+      @subject = Paperclip.io_adapters.for(@uri)
+
+      assert_equal file_name, @subject.original_filename
+    end
+
+    it "does not crash when an empty filename is given" do
+      meta["content-disposition"] = "ATTACHMENT; FILENAME=\"\";"
+
+      @subject = Paperclip.io_adapters.for(@uri)
+
+      assert_equal "", @subject.original_filename
+    end
+
+    it "returns a file name ignoring RFC 5987 encoding" do
+      meta["content-disposition"] =
+        "attachment; filename=#{file_name}; filename* = utf-8''%e2%82%ac%20rates"
+
+      @subject = Paperclip.io_adapters.for(@uri)
+
+      assert_equal file_name, @subject.original_filename
+    end
+
+    context "when file name has consecutive periods" do
+      let(:file_name) { "test_document..pdf" }
+
+      it "returns a file name" do
+        @uri = URI.parse(
+          "https://github.com/thoughtbot/#{file_name}?file=test")
+        @subject = Paperclip.io_adapters.for(@uri)
+        assert_equal file_name, @subject.original_filename
+      end
+    end
+  end
+
+  context "a url with restricted characters in the filename" do
+    before do
+      Paperclip::UriAdapter.any_instance.
+        stubs(:download_content).returns(@open_return)
+
+      @uri = URI.parse("https://github.com/thoughtbot/paper:clip.jpg")
+      @subject = Paperclip.io_adapters.for(@uri)
+    end
+
+    it "does not generate filenames that include restricted characters" do
+      assert_equal "paper_clip.jpg", @subject.original_filename
+    end
+
+    it "does not generate paths that include restricted characters" do
+      expect(@subject.path).to_not match(/:/)
+    end
+  end
+
+  describe "#download_content" do
+    before do
+      Paperclip::UriAdapter.any_instance.stubs(:open).returns(@open_return)
+      @uri = URI.parse("https://github.com/thoughtbot/paper:clip.jpg")
+      @subject = Paperclip.io_adapters.for(@uri)
+    end
+
+    after do
+      @subject.send(:download_content)
+    end
+
+    context "with default read_timeout" do
+      it "calls open without options" do
+        @subject.expects(:open).with(@uri, {}).at_least_once
+      end
+    end
+
+    context "with custom read_timeout" do
+      before do
+        Paperclip.options[:read_timeout] = 120
+      end
+
+      it "calls open with read_timeout option" do
+        @subject.expects(:open).with(@uri, read_timeout: 120).at_least_once
+      end
+    end
+  end
+end

data/spec/paperclip/matchers/have_attached_file_matcher_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'paperclip/matchers'
+
+describe Paperclip::Shoulda::Matchers::HaveAttachedFileMatcher do
+  extend Paperclip::Shoulda::Matchers
+
+  it "rejects the dummy class if it has no attachment" do
+    reset_table "dummies"
+    reset_class "Dummy"
+    matcher = self.class.have_attached_file(:avatar)
+    expect(matcher).to_not accept(Dummy)
+  end
+
+  it 'accepts the dummy class if it has an attachment' do
+    rebuild_model
+    matcher = self.class.have_attached_file(:avatar)
+    expect(matcher).to accept(Dummy)
+  end
+end

data/spec/paperclip/matchers/validate_attachment_content_type_matcher_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'paperclip/matchers'
+
+describe Paperclip::Shoulda::Matchers::ValidateAttachmentContentTypeMatcher do
+  extend Paperclip::Shoulda::Matchers
+
+  before do
+    reset_table("dummies") do |d|
+      d.string :title
+      d.string :avatar_file_name
+      d.string :avatar_content_type
+    end
+    reset_class "Dummy"
+    Dummy.do_not_validate_attachment_file_type :avatar
+    Dummy.has_attached_file :avatar
+  end
+
+  it "rejects a class with no validation" do
+    expect(matcher).to_not accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it 'rejects a class when the validation fails' do
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{audio/.*}
+    expect(matcher).to_not accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it "accepts a class with a matching validation" do
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{image/.*}
+    expect(matcher).to accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it "accepts a class with other validations but matching types" do
+    Dummy.validates_presence_of :title
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{image/.*}
+    expect(matcher).to accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it "accepts a class that matches and a matcher that only specifies 'allowing'" do
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{image/.*}
+    matcher = plain_matcher.allowing(%w(image/png image/jpeg))
+
+    expect(matcher).to accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it "rejects a class that does not match and a matcher that only specifies 'allowing'" do
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{audio/.*}
+    matcher = plain_matcher.allowing(%w(image/png image/jpeg))
+
+    expect(matcher).to_not accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it "accepts a class that matches and a matcher that only specifies 'rejecting'" do
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{image/.*}
+    matcher = plain_matcher.rejecting(%w(audio/mp3 application/octet-stream))
+
+    expect(matcher).to accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  it "rejects a class that does not match and a matcher that only specifies 'rejecting'" do
+    Dummy.validates_attachment_content_type :avatar, content_type: %r{audio/.*}
+    matcher = plain_matcher.rejecting(%w(audio/mp3 application/octet-stream))
+
+    expect(matcher).to_not accept(Dummy)
+    expect { matcher.failure_message }.to_not raise_error
+  end
+
+  context "using an :if to control the validation" do
+    before do
+      Dummy.class_eval do
+        validates_attachment_content_type :avatar, content_type: %r{image/*} , if: :go
+        attr_accessor :go
+      end
+    end
+
+    it "runs the validation if the control is true" do
+      dummy = Dummy.new
+      dummy.go = true
+      expect(matcher).to accept(dummy)
+      expect { matcher.failure_message }.to_not raise_error
+    end
+
+    it "does not run the validation if the control is false" do
+      dummy = Dummy.new
+      dummy.go = false
+      expect(matcher).to_not accept(dummy)
+      expect { matcher.failure_message }.to_not raise_error
+    end
+  end
+
+  private
+
+  def plain_matcher
+    self.class.validate_attachment_content_type(:avatar)
+  end
+
+  def matcher
+    plain_matcher.
+      allowing(%w(image/png image/jpeg)).
+      rejecting(%w(audio/mp3 application/octet-stream))
+  end
+
+end

data/spec/paperclip/matchers/validate_attachment_presence_matcher_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'paperclip/matchers'
+
+describe Paperclip::Shoulda::Matchers::ValidateAttachmentPresenceMatcher do
+  extend Paperclip::Shoulda::Matchers
+
+  before do
+    reset_table("dummies") do |d|
+      d.string :avatar_file_name
+    end
+    reset_class "Dummy"
+    Dummy.has_attached_file :avatar
+    Dummy.do_not_validate_attachment_file_type :avatar
+  end
+
+  it "rejects a class with no validation" do
+    expect(matcher).to_not accept(Dummy)
+  end
+
+  it "accepts a class with a matching validation" do
+    Dummy.validates_attachment_presence :avatar
+    expect(matcher).to accept(Dummy)
+  end
+
+  it "accepts an instance with other attachment validations" do
+    reset_table("dummies") do |d|
+      d.string :avatar_file_name
+      d.string :avatar_content_type
+    end
+    Dummy.class_eval do
+      validates_attachment_presence :avatar
+      validates_attachment_content_type :avatar, content_type: 'image/gif'
+    end
+    dummy = Dummy.new
+
+    dummy.avatar = File.new fixture_file('5k.png')
+
+    expect(matcher).to accept(dummy)
+  end
+
+  context "using an :if to control the validation" do
+    before do
+      Dummy.class_eval do
+        validates_attachment_presence :avatar, if: :go
+        attr_accessor :go
+      end
+    end
+
+    it "runs the validation if the control is true" do
+      dummy = Dummy.new
+      dummy.avatar = nil
+      dummy.go = true
+      expect(matcher).to accept(dummy)
+    end
+
+    it "does not run the validation if the control is false" do
+      dummy = Dummy.new
+      dummy.avatar = nil
+      dummy.go = false
+      expect(matcher).to_not accept(dummy)
+    end
+  end
+
+  private
+
+  def matcher
+    self.class.validate_attachment_presence(:avatar)
+  end
+end

data/spec/paperclip/matchers/validate_attachment_size_matcher_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'paperclip/matchers'
+
+describe Paperclip::Shoulda::Matchers::ValidateAttachmentSizeMatcher do
+  extend Paperclip::Shoulda::Matchers
+
+  before do
+    reset_table("dummies") do |d|
+      d.string :avatar_file_name
+      d.bigint :avatar_file_size
+    end
+    reset_class "Dummy"
+    Dummy.do_not_validate_attachment_file_type :avatar
+    Dummy.has_attached_file :avatar
+  end
+
+  context "Limiting size" do
+    it "rejects a class with no validation" do
+      expect(matcher.in(256..1024)).to_not accept(Dummy)
+    end
+
+    it "rejects a class with a validation that's too high" do
+      Dummy.validates_attachment_size :avatar, in: 256..2048
+      expect(matcher.in(256..1024)).to_not accept(Dummy)
+    end
+
+    it "accepts a class with a validation that's too low" do
+      Dummy.validates_attachment_size :avatar, in: 0..1024
+      expect(matcher.in(256..1024)).to_not accept(Dummy)
+    end
+
+    it "accepts a class with a validation that matches" do
+      Dummy.validates_attachment_size :avatar, in: 256..1024
+      expect(matcher.in(256..1024)).to accept(Dummy)
+    end
+  end
+
+  context "allowing anything" do
+    it "given a class with an upper limit" do
+      Dummy.validates_attachment_size :avatar, less_than: 1
+      expect(matcher).to accept(Dummy)
+    end
+
+    it "given a class with a lower limit" do
+      Dummy.validates_attachment_size :avatar, greater_than: 1
+      expect(matcher).to accept(Dummy)
+    end
+  end
+
+  context "using an :if to control the validation" do
+    before do
+      Dummy.class_eval do
+        validates_attachment_size :avatar, greater_than: 1024, if: :go
+        attr_accessor :go
+      end
+    end
+
+    it "run the validation if the control is true" do
+      dummy = Dummy.new
+      dummy.go = true
+      expect(matcher.greater_than(1024)).to accept(dummy)
+    end
+
+    it "not run the validation if the control is false" do
+      dummy = Dummy.new
+      dummy.go = false
+      expect(matcher.greater_than(1024)).to_not accept(dummy)
+    end
+  end
+
+  context "post processing" do
+    before do
+      Dummy.validates_attachment_size :avatar, greater_than: 1024
+    end
+
+    it "be skipped" do
+      dummy = Dummy.new
+      dummy.avatar.expects(:post_process).never
+      expect(matcher.greater_than(1024)).to accept(dummy)
+    end
+  end
+
+  private
+
+  def matcher
+    self.class.validate_attachment_size(:avatar)
+  end
+end