paperclip 3.4.0 → 6.1.0

data/{test/interpolations_test.rb → spec/paperclip/interpolations_spec.rb}

@@ -1,7 +1,7 @@
-require './test/helper'
+require 'spec_helper'
 
-class InterpolationsTest < Test::Unit::TestCase
-  should "return all methods but the infrastructure when sent #all" do
+describe Paperclip::Interpolations do
+  it "returns all methods but the infrastructure when sent #all" do
     methods = Paperclip::Interpolations.all
     assert ! methods.include?(:[])
     assert ! methods.include?(:[]=)
@@ -11,58 +11,59 @@ class InterpolationsTest < Test::Unit::TestCase
     end
   end
 
-  should "return the Rails.root" do
+  it "returns the Rails.root" do
     assert_equal Rails.root, Paperclip::Interpolations.rails_root(:attachment, :style)
   end
 
-  should "return the Rails.env" do
+  it "returns the Rails.env" do
     assert_equal Rails.env, Paperclip::Interpolations.rails_env(:attachment, :style)
   end
 
-  should "return the class of the Interpolations module when called with no params" do
+  it "returns the class of the Interpolations module when called with no params" do
     assert_equal Module, Paperclip::Interpolations.class
   end
 
-  should "return the class of the instance" do
+  it "returns the class of the instance" do
+    class Thing ; end
     attachment = mock
     attachment.expects(:instance).returns(attachment)
-    attachment.expects(:class).returns("Thing")
+    attachment.expects(:class).returns(Thing)
     assert_equal "things", Paperclip::Interpolations.class(attachment, :style)
   end
 
-  should "return the basename of the file" do
+  it "returns the basename of the file" do
     attachment = mock
-    attachment.expects(:original_filename).returns("one.jpg").times(2)
+    attachment.expects(:original_filename).returns("one.jpg").times(1)
     assert_equal "one", Paperclip::Interpolations.basename(attachment, :style)
   end
 
-  should "return the extension of the file" do
+  it "returns the extension of the file" do
     attachment = mock
     attachment.expects(:original_filename).returns("one.jpg")
     attachment.expects(:styles).returns({})
     assert_equal "jpg", Paperclip::Interpolations.extension(attachment, :style)
   end
 
-  should "return the extension of the file as the format if defined in the style" do
+  it "returns the extension of the file as the format if defined in the style" do
     attachment = mock
     attachment.expects(:original_filename).never
-    attachment.expects(:styles).twice.returns({:style => {:format => "png"}})
+    attachment.expects(:styles).twice.returns({style: {format: "png"}})
 
     [:style, 'style'].each do |style|
       assert_equal "png", Paperclip::Interpolations.extension(attachment, style)
     end
   end
 
-  should "return the extension of the file based on the content type" do
+  it "returns the extension of the file based on the content type" do
     attachment = mock
-    attachment.expects(:content_type).returns('image/jpeg')
+    attachment.expects(:content_type).returns('image/png')
     attachment.expects(:styles).returns({})
     interpolations = Paperclip::Interpolations
     interpolations.expects(:extension).returns('random')
-    assert_equal "jpeg", interpolations.content_type_extension(attachment, :style)
+    assert_equal "png", interpolations.content_type_extension(attachment, :style)
   end
 
-  should "return the original extension of the file if it matches a content type extension" do
+  it "returns the original extension of the file if it matches a content type extension" do
     attachment = mock
     attachment.expects(:content_type).returns('image/jpeg')
     attachment.expects(:styles).returns({})
@@ -71,7 +72,21 @@ class InterpolationsTest < Test::Unit::TestCase
     assert_equal "jpe", interpolations.content_type_extension(attachment, :style)
   end
 
-  should "return the latter half of the content type of the extension if no match found" do
+  it "returns the extension of the file with a dot" do
+    attachment = mock
+    attachment.expects(:original_filename).returns("one.jpg")
+    attachment.expects(:styles).returns({})
+    assert_equal ".jpg", Paperclip::Interpolations.dotextension(attachment, :style)
+  end
+
+  it "returns the extension of the file without a dot if the extension is empty" do
+    attachment = mock
+    attachment.expects(:original_filename).returns("one")
+    attachment.expects(:styles).returns({})
+    assert_equal "", Paperclip::Interpolations.dotextension(attachment, :style)
+  end
+
+  it "returns the latter half of the content type of the extension if no match found" do
     attachment = mock
     attachment.expects(:content_type).at_least_once().returns('not/found')
     attachment.expects(:styles).returns({})
@@ -80,87 +95,96 @@ class InterpolationsTest < Test::Unit::TestCase
     assert_equal "found", interpolations.content_type_extension(attachment, :style)
   end
 
-  should "return the format if defined in the style, ignoring the content type" do
+  it "returns the format if defined in the style, ignoring the content type" do
     attachment = mock
     attachment.expects(:content_type).returns('image/jpeg')
-    attachment.expects(:styles).returns({:style => {:format => "png"}})
+    attachment.expects(:styles).returns({style: {format: "png"}})
     interpolations = Paperclip::Interpolations
     interpolations.expects(:extension).returns('random')
     assert_equal "png", interpolations.content_type_extension(attachment, :style)
   end
 
-  should "be able to handle numeric style names" do
+  it "is able to handle numeric style names" do
     attachment = mock(
-      :styles => {:"4" => {:format => :expected_extension}}
+      styles: {:"4" => {format: :expected_extension}}
     )
     assert_equal :expected_extension, Paperclip::Interpolations.extension(attachment, 4)
   end
 
-  should "return the #to_param of the attachment" do
+  it "returns the #to_param of the attachment" do
     attachment = mock
     attachment.expects(:to_param).returns("23-awesome")
     attachment.expects(:instance).returns(attachment)
     assert_equal "23-awesome", Paperclip::Interpolations.param(attachment, :style)
   end
 
-  should "return the id of the attachment" do
+  it "returns the id of the attachment" do
     attachment = mock
     attachment.expects(:id).returns(23)
     attachment.expects(:instance).returns(attachment)
     assert_equal 23, Paperclip::Interpolations.id(attachment, :style)
   end
 
-  should "return nil for attachments to new records" do
+  it "returns nil for attachments to new records" do
     attachment = mock
     attachment.expects(:id).returns(nil)
     attachment.expects(:instance).returns(attachment)
     assert_nil Paperclip::Interpolations.id(attachment, :style)
   end
 
-  should "return the partitioned id of the attachment when the id is an integer" do
+  it "returns the partitioned id of the attachment when the id is an integer" do
     attachment = mock
     attachment.expects(:id).returns(23)
     attachment.expects(:instance).returns(attachment)
     assert_equal "000/000/023", Paperclip::Interpolations.id_partition(attachment, :style)
   end
 
-  should "return the partitioned id of the attachment when the id is a string" do
+  it "returns the partitioned id when the id is above 999_999_999" do
+    attachment = mock
+    attachment.expects(:id).
+      returns(Paperclip::Interpolations::ID_PARTITION_LIMIT)
+    attachment.expects(:instance).returns(attachment)
+    assert_equal "001/000/000/000",
+      Paperclip::Interpolations.id_partition(attachment, :style)
+  end
+
+  it "returns the partitioned id of the attachment when the id is a string" do
     attachment = mock
     attachment.expects(:id).returns("32fnj23oio2f")
     attachment.expects(:instance).returns(attachment)
     assert_equal "32f/nj2/3oi", Paperclip::Interpolations.id_partition(attachment, :style)
   end
 
-  should "return nil for the partitioned id of an attachment to a new record (when the id is nil)" do
+  it "returns nil for the partitioned id of an attachment to a new record (when the id is nil)" do
     attachment = mock
     attachment.expects(:id).returns(nil)
     attachment.expects(:instance).returns(attachment)
     assert_nil Paperclip::Interpolations.id_partition(attachment, :style)
   end
 
-  should "return the name of the attachment" do
+  it "returns the name of the attachment" do
     attachment = mock
     attachment.expects(:name).returns("file")
     assert_equal "files", Paperclip::Interpolations.attachment(attachment, :style)
   end
 
-  should "return the style" do
+  it "returns the style" do
     assert_equal :style, Paperclip::Interpolations.style(:attachment, :style)
   end
 
-  should "return the default style" do
+  it "returns the default style" do
     attachment = mock
     attachment.expects(:default_style).returns(:default_style)
     assert_equal :default_style, Paperclip::Interpolations.style(attachment, nil)
   end
 
-  should "reinterpolate :url" do
+  it "reinterpolates :url" do
     attachment = mock
-    attachment.expects(:url).with(:style, :timestamp => false, :escape => false).returns("1234")
+    attachment.expects(:url).with(:style, timestamp: false, escape: false).returns("1234")
     assert_equal "1234", Paperclip::Interpolations.url(attachment, :style)
   end
 
-  should "raise if infinite loop detcted reinterpolating :url" do
+  it "raises if infinite loop detcted reinterpolating :url" do
     attachment = Object.new
     class << attachment
       def url(*args)
@@ -170,35 +194,35 @@ class InterpolationsTest < Test::Unit::TestCase
     assert_raises(Paperclip::Errors::InfiniteInterpolationError){ Paperclip::Interpolations.url(attachment, :style) }
   end
 
-  should "return the filename as basename.extension" do
+  it "returns the filename as basename.extension" do
     attachment = mock
     attachment.expects(:styles).returns({})
-    attachment.expects(:original_filename).returns("one.jpg").times(3)
+    attachment.expects(:original_filename).returns("one.jpg").times(2)
     assert_equal "one.jpg", Paperclip::Interpolations.filename(attachment, :style)
   end
 
-  should "return the filename as basename.extension when format supplied" do
+  it "returns the filename as basename.extension when format supplied" do
     attachment = mock
-    attachment.expects(:styles).returns({:style => {:format => :png}})
-    attachment.expects(:original_filename).returns("one.jpg").times(2)
+    attachment.expects(:styles).returns({style: {format: :png}})
+    attachment.expects(:original_filename).returns("one.jpg").times(1)
     assert_equal "one.png", Paperclip::Interpolations.filename(attachment, :style)
   end
 
-  should "return the filename as basename when extension is blank" do
+  it "returns the filename as basename when extension is blank" do
     attachment = mock
     attachment.stubs(:styles).returns({})
     attachment.stubs(:original_filename).returns("one")
     assert_equal "one", Paperclip::Interpolations.filename(attachment, :style)
   end
   
-  should "return the basename when the extension contains regexp special characters" do
+  it "returns the basename when the extension contains regexp special characters" do
     attachment = mock
     attachment.stubs(:styles).returns({})
     attachment.stubs(:original_filename).returns("one.ab)")
     assert_equal "one", Paperclip::Interpolations.basename(attachment, :style)
   end
 
-  should "return the timestamp" do
+  it "returns the timestamp" do
     now = Time.now
     zone = 'UTC'
     attachment = mock
@@ -207,32 +231,41 @@ class InterpolationsTest < Test::Unit::TestCase
     assert_equal now.in_time_zone(zone).to_s, Paperclip::Interpolations.timestamp(attachment, :style)
   end
 
-  should "return updated_at" do
+  it "returns updated_at" do
     attachment = mock
     seconds_since_epoch = 1234567890
     attachment.expects(:updated_at).returns(seconds_since_epoch)
     assert_equal seconds_since_epoch, Paperclip::Interpolations.updated_at(attachment, :style)
   end
 
-  should "return attachment's hash when passing both arguments" do
+  it "returns attachment's hash when passing both arguments" do
     attachment = mock
     fake_hash = "a_wicked_secure_hash"
     attachment.expects(:hash_key).returns(fake_hash)
     assert_equal fake_hash, Paperclip::Interpolations.hash(attachment, :style)
   end
 
-  should "return Object#hash when passing no argument" do
+  it "returns Object#hash when passing no argument" do
     attachment = mock
     fake_hash = "a_wicked_secure_hash"
     attachment.expects(:hash_key).never.returns(fake_hash)
     assert_not_equal fake_hash, Paperclip::Interpolations.hash
   end
 
-  should "call all expected interpolations with the given arguments" do
+  it "calls all expected interpolations with the given arguments" do
     Paperclip::Interpolations.expects(:id).with(:attachment, :style).returns(1234)
     Paperclip::Interpolations.expects(:attachment).with(:attachment, :style).returns("attachments")
     Paperclip::Interpolations.expects(:notreal).never
     value = Paperclip::Interpolations.interpolate(":notreal/:id/:attachment", :attachment, :style)
     assert_equal ":notreal/1234/attachments", value
   end
+
+  it "handles question marks" do
+    Paperclip.interpolates :foo? do
+      "bar"
+    end
+    Paperclip::Interpolations.expects(:fool).never
+    value = Paperclip::Interpolations.interpolate(":fo/:foo?")
+    assert_equal ":fo/bar", value
+  end
 end

data/spec/paperclip/io_adapters/abstract_adapter_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe Paperclip::AbstractAdapter do
+  class TestAdapter < Paperclip::AbstractAdapter
+    attr_accessor :tempfile
+
+    def content_type
+      Paperclip::ContentTypeDetector.new(path).detect
+    end
+  end
+
+  subject { TestAdapter.new(nil) }
+
+  context "content type from file contents" do
+    before do
+      subject.stubs(:path).returns("image.png")
+      Paperclip.stubs(:run).returns("image/png\n")
+      Paperclip::ContentTypeDetector.any_instance.stubs(:type_from_mime_magic).returns("image/png")
+    end
+
+    it "returns the content type without newline" do
+      assert_equal "image/png", subject.content_type
+    end
+  end
+
+  context "nil?" do
+    it "returns false" do
+      assert !subject.nil?
+    end
+  end
+
+  context "delegation" do
+    before do
+      subject.tempfile = stub("Tempfile")
+    end
+
+    [:binmode, :binmode?, :close, :close!, :closed?, :eof?, :path, :readbyte, :rewind, :unlink].each do |method|
+      it "delegates #{method} to @tempfile" do
+        subject.tempfile.stubs(method)
+        subject.public_send(method)
+        assert_received subject.tempfile, method
+      end
+    end
+  end
+
+  it 'gets rid of slashes and colons in filenames' do
+    subject.original_filename = "awesome/file:name.png"
+
+    assert_equal "awesome_file_name.png", subject.original_filename
+  end
+
+  it 'is an assignment' do
+    assert subject.assignment?
+  end
+
+  it 'is not nil' do
+    assert !subject.nil?
+  end
+
+  it "generates a destination filename with no original filename" do
+    expect(subject.send(:destination).path).to_not be_nil
+  end
+
+  it 'uses the original filename to generate the tempfile' do
+    subject.original_filename = "file.png"
+    expect(subject.send(:destination).path).to end_with(".png")
+  end
+
+  context "generates a fingerprint" do
+    subject { TestAdapter.new(nil, options) }
+
+    before do
+      subject.stubs(:path).returns(fixture_file("50x50.png"))
+    end
+
+    context "MD5" do
+      let(:options) { { hash_digest: Digest::MD5 } }
+
+      it "returns a fingerprint" do
+        expect(subject.fingerprint).to be_a String
+        expect(subject.fingerprint).to eq "a790b00c9b5d58a8fd17a1ec5a187129"
+      end
+    end
+
+    context "SHA256" do
+      let(:options) { { hash_digest: Digest::SHA256 } }
+
+      it "returns a fingerprint" do
+        expect(subject.fingerprint).to be_a String
+        expect(subject.fingerprint).
+          to eq "243d7ce1099719df25f600f1c369c629fb979f88d5a01dbe7d0d48c8e6715bb1"
+      end
+    end
+  end
+
+  context "#copy_to_tempfile" do
+    around do |example|
+      FileUtils.module_eval do
+        class << self
+          alias paperclip_ln ln
+
+          def ln(*)
+            raise Errno::EXDEV
+          end
+        end
+      end
+
+      example.run
+
+      FileUtils.module_eval do
+        class << self
+          alias ln paperclip_ln
+          undef paperclip_ln
+        end
+      end
+    end
+
+    it "should return a readable file even when linking fails" do
+      src = open(fixture_file("5k.png"), "rb")
+      expect(subject.send(:copy_to_tempfile, src).read).to eq src.read
+    end
+  end
+
+  context "#original_filename=" do
+    it "should not fail with a nil original filename" do
+      expect { subject.original_filename = nil }.not_to raise_error
+    end
+  end
+
+  context "#link_or_copy_file" do
+    class TestLinkOrCopyAdapter < Paperclip::AbstractAdapter
+      public :copy_to_tempfile, :destination
+    end
+
+    subject { TestLinkOrCopyAdapter.new(nil) }
+    let(:body) { "body" }
+
+    let(:file) do
+      t = Tempfile.new("destination")
+      t.print(body)
+      t.rewind
+      t
+    end
+
+    after do
+      file.close
+      file.unlink
+    end
+
+    it "should be able to read the file" do
+      expect(subject.copy_to_tempfile(file).read).to eq(body)
+    end
+
+    it "should be able to reopen the file after symlink has failed" do
+      FileUtils.expects(:ln).raises(Errno::EXDEV)
+
+      expect(subject.copy_to_tempfile(file).read).to eq(body)
+    end
+  end
+end

data/{test/io_adapters/attachment_adapter_test.rb → spec/paperclip/io_adapters/attachment_adapter_spec.rb}

@@ -1,52 +1,53 @@
-require './test/helper'
+require 'spec_helper'
 
-class AttachmentAdapterTest < Test::Unit::TestCase
-
-  def setup
-    rebuild_model :path => "tmp/:class/:attachment/:style/:filename", :styles => {:thumb => '50x50'}
+describe Paperclip::AttachmentAdapter do
+  before do
+    rebuild_model path: "tmp/:class/:attachment/:style/:filename", styles: {thumb: '50x50'}
     @attachment = Dummy.new.avatar
   end
 
   context "for an attachment" do
-    setup do
+    before do
       @file = File.new(fixture_file("5k.png"))
       @file.binmode
 
       @attachment.assign(@file)
       @attachment.save
-      @subject = Paperclip.io_adapters.for(@attachment)
+      @subject = Paperclip.io_adapters.for(@attachment,
+                                           hash_digest: Digest::MD5)
     end
 
-    teardown do
+    after do
       @file.close
+      @subject.close
     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
+    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.read
       actual = @subject.read
       assert expected.length > 0
@@ -56,8 +57,34 @@ class AttachmentAdapterTest < Test::Unit::TestCase
 
   end
 
+  context "for a file with restricted characters in the name" do
+    before do
+      file_contents = IO.read(fixture_file("animated.gif"))
+      @file = StringIO.new(file_contents)
+      @file.stubs(:original_filename).returns('image:restricted.gif')
+      @file.binmode
+
+      @attachment.assign(@file)
+      @attachment.save
+      @subject = Paperclip.io_adapters.for(@attachment,
+                                           hash_digest: Digest::MD5)
+    end
+
+    after do
+      @subject.close
+    end
+
+    it "does not generate paths that include restricted characters" do
+      expect(@subject.path).to_not match(/:/)
+    end
+
+    it "does not generate filenames that include restricted characters" do
+      assert_equal 'image_restricted.gif', @subject.original_filename
+    end
+  end
+
   context "for a style" do
-    setup do
+    before do
       @file = File.new(fixture_file("5k.png"))
       @file.binmode
 
@@ -67,40 +94,42 @@ class AttachmentAdapterTest < Test::Unit::TestCase
       FileUtils.cp @attachment.queued_for_write[:thumb].path, @thumb.path
 
       @attachment.save
-      @subject = Paperclip.io_adapters.for(@attachment.styles[:thumb])
+      @subject = Paperclip.io_adapters.for(@attachment.styles[:thumb],
+                                           hash_digest: Digest::MD5)
     end
 
-    teardown do
+    after do
       @file.close
       @thumb.close
+      @subject.close
     end
 
-    should "get the original filename" do
+    it "gets the original 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
+    it "gets the content type" do
       assert_equal "image/png", @subject.content_type
     end
 
-    should "get the thumbnail's file size" do
+    it "gets the thumbnail's file size" do
       assert_equal @thumb.size, @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(@thumb.path).to_s
       assert_equal expected, @subject.fingerprint
     end
 
-    should "read the contents of the thumbnail" do
+    it "reads the contents of the thumbnail" do
       @thumb.rewind
       expected = @thumb.read
       actual = @subject.read