joshpuetz-paperclip 2.3.0

data/test/matchers/validate_attachment_content_type_matcher_test.rb

@@ -0,0 +1,30 @@
+require 'test/helper'
+
+class ValidateAttachmentContentTypeMatcherTest < Test::Unit::TestCase
+  context "validate_attachment_content_type" do
+    setup do
+      reset_table("dummies") do |d|
+        d.string :avatar_file_name
+      end
+      @dummy_class = reset_class "Dummy"
+      @dummy_class.has_attached_file :avatar
+      @matcher     = self.class.validate_attachment_content_type(:avatar).
+                       allowing(%w(image/png image/jpeg)).
+                       rejecting(%w(audio/mp3 application/octet-stream))
+    end
+
+    should "reject a class with no validation" do
+      assert_rejects @matcher, @dummy_class
+    end
+
+    should "reject a class with a validation that doesn't match" do
+      @dummy_class.validates_attachment_content_type :avatar, :content_type => %r{audio/.*}
+      assert_rejects @matcher, @dummy_class
+    end
+
+    should "accept a class with a validation" do
+      @dummy_class.validates_attachment_content_type :avatar, :content_type => %r{image/.*}
+      assert_accepts @matcher, @dummy_class
+    end
+  end
+end

data/test/matchers/validate_attachment_presence_matcher_test.rb

@@ -0,0 +1,21 @@
+require 'test/helper'
+
+class ValidateAttachmentPresenceMatcherTest < Test::Unit::TestCase
+  context "validate_attachment_presence" do
+    setup do
+      reset_table("dummies"){|d| d.string :avatar_file_name }
+      @dummy_class = reset_class "Dummy"
+      @dummy_class.has_attached_file :avatar
+      @matcher     = self.class.validate_attachment_presence(:avatar)
+    end
+
+    should "reject a class with no validation" do
+      assert_rejects @matcher, @dummy_class
+    end
+
+    should "accept a class with a validation" do
+      @dummy_class.validates_attachment_presence :avatar
+      assert_accepts @matcher, @dummy_class
+    end
+  end
+end

data/test/matchers/validate_attachment_size_matcher_test.rb

@@ -0,0 +1,50 @@
+require 'test/helper'
+
+class ValidateAttachmentSizeMatcherTest < Test::Unit::TestCase
+  context "validate_attachment_size" do
+    setup do
+      reset_table("dummies") do |d|
+        d.string :avatar_file_name
+      end
+      @dummy_class = reset_class "Dummy"
+      @dummy_class.has_attached_file :avatar
+    end
+
+    context "of limited size" do
+      setup{ @matcher = self.class.validate_attachment_size(:avatar).in(256..1024) }
+
+      should "reject a class with no validation" do
+        assert_rejects @matcher, @dummy_class
+      end
+
+      should "reject a class with a validation that's too high" do
+        @dummy_class.validates_attachment_size :avatar, :in => 256..2048
+        assert_rejects @matcher, @dummy_class
+      end
+
+      should "reject a class with a validation that's too low" do
+        @dummy_class.validates_attachment_size :avatar, :in => 0..1024
+        assert_rejects @matcher, @dummy_class
+      end
+
+      should "accept a class with a validation that matches" do
+        @dummy_class.validates_attachment_size :avatar, :in => 256..1024
+        assert_accepts @matcher, @dummy_class
+      end
+    end
+
+    context "validates_attachment_size with infinite range" do
+      setup{ @matcher = self.class.validate_attachment_size(:avatar) }
+
+      should "accept a class with an upper limit" do
+        @dummy_class.validates_attachment_size :avatar, :less_than => 1
+        assert_accepts @matcher, @dummy_class
+      end
+
+      should "accept a class with no upper limit" do
+        @dummy_class.validates_attachment_size :avatar, :greater_than => 1
+        assert_accepts @matcher, @dummy_class
+      end
+    end
+  end
+end

data/test/paperclip_test.rb

@@ -0,0 +1,291 @@
+require 'test/helper'
+
+class PaperclipTest < Test::Unit::TestCase
+  [:image_magick_path, :convert_path].each do |path|
+    context "Calling Paperclip.run with an #{path} specified" do
+      setup do
+        Paperclip.options[:image_magick_path] = nil
+        Paperclip.options[:convert_path]      = nil
+        Paperclip.options[path]               = "/usr/bin"
+      end
+
+      should "execute the right command" do
+        Paperclip.expects(:path_for_command).with("convert").returns("/usr/bin/convert")
+        Paperclip.expects(:bit_bucket).returns("/dev/null")
+        Paperclip.expects(:"`").with("/usr/bin/convert one.jpg two.jpg 2>/dev/null")
+        Paperclip.run("convert", "one.jpg two.jpg")
+      end
+    end
+  end
+
+  context "Calling Paperclip.run with no path specified" do
+    setup do
+      Paperclip.options[:image_magick_path] = nil
+      Paperclip.options[:convert_path]      = nil
+    end
+
+    should "execute the right command" do
+      Paperclip.expects(:path_for_command).with("convert").returns("convert")
+      Paperclip.expects(:bit_bucket).returns("/dev/null")
+      Paperclip.expects(:"`").with("convert one.jpg two.jpg 2>/dev/null")
+      Paperclip.run("convert", "one.jpg two.jpg")
+    end
+
+    should "log the command when :log_command is set" do
+      Paperclip.options[:log_command] = true
+      Paperclip.expects(:bit_bucket).returns("/dev/null")
+      Paperclip.expects(:log).with("this is the command 2>/dev/null")
+      Paperclip.expects(:"`").with("this is the command 2>/dev/null")
+      Paperclip.run("this","is the command")
+    end
+  end
+
+  should "raise when sent #processor and the name of a class that exists but isn't a subclass of Processor" do
+    assert_raises(Paperclip::PaperclipError){ Paperclip.processor(:attachment) }
+  end
+
+  should "raise when sent #processor and the name of a class that doesn't exist" do
+    assert_raises(NameError){ Paperclip.processor(:boogey_man) }
+  end
+
+  should "return a class when sent #processor and the name of a class under Paperclip" do
+    assert_equal ::Paperclip::Thumbnail, Paperclip.processor(:thumbnail)
+  end
+
+  should "call a proc sent to check_guard" do
+    @dummy = Dummy.new
+    @dummy.expects(:one).returns(:one)
+    assert_equal :one, @dummy.avatar.send(:check_guard, lambda{|x| x.one })
+  end
+
+  should "call a method name sent to check_guard" do
+    @dummy = Dummy.new
+    @dummy.expects(:one).returns(:one)
+    assert_equal :one, @dummy.avatar.send(:check_guard, :one)
+  end
+
+  context "Paperclip.bit_bucket" do
+    context "on systems without /dev/null" do
+      setup do
+        File.expects(:exists?).with("/dev/null").returns(false)
+      end
+      
+      should "return 'NUL'" do
+        assert_equal "NUL", Paperclip.bit_bucket
+      end
+    end
+
+    context "on systems with /dev/null" do
+      setup do
+        File.expects(:exists?).with("/dev/null").returns(true)
+      end
+      
+      should "return '/dev/null'" do
+        assert_equal "/dev/null", Paperclip.bit_bucket
+      end
+    end
+  end
+
+  context "An ActiveRecord model with an 'avatar' attachment" do
+    setup do
+      rebuild_model :path => "tmp/:class/omg/:style.:extension"
+      @file = File.new(File.join(FIXTURES_DIR, "5k.png"), 'rb')
+    end
+
+    teardown { @file.close }
+
+    should "not error when trying to also create a 'blah' attachment" do
+      assert_nothing_raised do
+        Dummy.class_eval do
+          has_attached_file :blah
+        end
+      end
+    end
+
+    context "that is attr_protected" do
+      setup do
+        Dummy.class_eval do
+          attr_protected :avatar
+        end
+        @dummy = Dummy.new
+      end
+
+      should "not assign the avatar on mass-set" do
+        @dummy.attributes = { :other => "I'm set!",
+                              :avatar => @file }
+        
+        assert_equal "I'm set!", @dummy.other
+        assert ! @dummy.avatar?
+      end
+
+      should "still allow assigment on normal set" do
+        @dummy.other  = "I'm set!"
+        @dummy.avatar = @file
+        
+        assert_equal "I'm set!", @dummy.other
+        assert @dummy.avatar?
+      end
+    end
+
+    context "with a subclass" do
+      setup do
+        class ::SubDummy < Dummy; end
+      end
+
+      should "be able to use the attachment from the subclass" do
+        assert_nothing_raised do
+          @subdummy = SubDummy.create(:avatar => @file)
+        end
+      end
+
+      should "be able to see the attachment definition from the subclass's class" do
+        assert_equal "tmp/:class/omg/:style.:extension", SubDummy.attachment_definitions[:avatar][:path]
+      end
+
+      teardown do
+        Object.send(:remove_const, "SubDummy") rescue nil
+      end
+    end
+
+    should "have an #avatar method" do
+      assert Dummy.new.respond_to?(:avatar)
+    end
+
+    should "have an #avatar= method" do
+      assert Dummy.new.respond_to?(:avatar=)
+    end
+
+    context "that is valid" do
+      setup do
+        @dummy = Dummy.new
+        @dummy.avatar = @file
+      end
+
+      should "be valid" do
+        assert @dummy.valid?
+      end
+
+      context "then has a validation added that makes it invalid" do
+        setup do
+          assert @dummy.save
+          Dummy.class_eval do
+            validates_attachment_content_type :avatar, :content_type => ["text/plain"]
+          end
+          @dummy2 = Dummy.find(@dummy.id)
+        end
+
+        should "be invalid when reloaded" do
+          assert ! @dummy2.valid?, @dummy2.errors.inspect
+        end
+
+        should "be able to call #valid? twice without having duplicate errors" do
+          @dummy2.avatar.valid?
+          first_errors = @dummy2.avatar.errors
+          @dummy2.avatar.valid?
+          assert_equal first_errors, @dummy2.avatar.errors
+        end
+      end
+    end
+
+    context "a validation with an if guard clause" do
+      setup do
+        Dummy.send(:"validates_attachment_presence", :avatar, :if => lambda{|i| i.foo })
+        @dummy = Dummy.new
+      end
+
+      should "attempt validation if the guard returns true" do
+        @dummy.expects(:foo).returns(true)
+        @dummy.avatar.expects(:validate_presence).returns(nil)
+        @dummy.valid?
+      end
+
+      should "not attempt validation if the guard returns false" do
+        @dummy.expects(:foo).returns(false)
+        @dummy.avatar.expects(:validate_presence).never
+        @dummy.valid?
+      end
+    end
+
+    context "a validation with an unless guard clause" do
+      setup do
+        Dummy.send(:"validates_attachment_presence", :avatar, :unless => lambda{|i| i.foo })
+        @dummy = Dummy.new
+      end
+
+      should "attempt validation if the guard returns true" do
+        @dummy.expects(:foo).returns(false)
+        @dummy.avatar.expects(:validate_presence).returns(nil)
+        @dummy.valid?
+      end
+
+      should "not attempt validation if the guard returns false" do
+        @dummy.expects(:foo).returns(true)
+        @dummy.avatar.expects(:validate_presence).never
+        @dummy.valid?
+      end
+    end
+
+    def self.should_validate validation, options, valid_file, invalid_file
+      context "with #{validation} validation and #{options.inspect} options" do
+        setup do
+          Dummy.send(:"validates_attachment_#{validation}", :avatar, options)
+          @dummy = Dummy.new
+        end
+        context "and assigning nil" do
+          setup do
+            @dummy.avatar = nil
+            @dummy.valid?
+          end
+          if validation == :presence
+            should "have an error on the attachment" do
+              assert @dummy.errors.on(:avatar)
+            end
+          else
+            should "not have an error on the attachment" do
+              assert_nil @dummy.errors.on(:avatar)
+            end
+          end
+        end
+        context "and assigned a valid file" do
+          setup do
+            @dummy.avatar = valid_file
+            @dummy.valid?
+          end
+          should "not have an error when assigned a valid file" do
+            assert ! @dummy.avatar.errors.key?(validation)
+          end
+          should "not have an error on the attachment" do
+            assert_nil @dummy.errors.on(:avatar)
+          end
+        end
+        context "and assigned an invalid file" do
+          setup do
+            @dummy.avatar = invalid_file
+            @dummy.valid?
+          end
+          should "have an error when assigned a valid file" do
+            assert_not_nil @dummy.avatar.errors[validation]
+          end
+          should "have an error on the attachment" do
+            assert @dummy.errors.on(:avatar)
+          end
+        end
+      end
+    end
+
+    [[:presence,      {},                              "5k.png",   nil],
+     [:size,          {:in => 1..10240},               nil,        "12k.png"],
+     [:size,          {:less_than => 10240},           "5k.png",   "12k.png"],
+     [:size,          {:greater_than => 8096},         "12k.png",  "5k.png"],
+     [:content_type,  {:content_type => "image/png"},  "5k.png",   "text.txt"],
+     [:content_type,  {:content_type => "text/plain"}, "text.txt", "5k.png"],
+     [:content_type,  {:content_type => %r{image/.*}}, "5k.png",   "text.txt"]].each do |args|
+      validation, options, valid_file, invalid_file = args
+      valid_file   &&= File.open(File.join(FIXTURES_DIR, valid_file), "rb")
+      invalid_file &&= File.open(File.join(FIXTURES_DIR, invalid_file), "rb")
+      
+      should_validate validation, options, valid_file, invalid_file
+    end
+
+  end
+end

data/test/processor_test.rb

@@ -0,0 +1,10 @@
+require 'test/helper'
+
+class ProcessorTest < Test::Unit::TestCase
+  should "instantiate and call #make when sent #make to the class" do
+    processor = mock
+    processor.expects(:make).with()
+    Paperclip::Processor.expects(:new).with(:one, :two, :three).returns(processor)
+    Paperclip::Processor.make(:one, :two, :three)
+  end
+end

data/test/storage_test.rb

@@ -0,0 +1,282 @@
+require 'test/helper'
+
+class StorageTest < Test::Unit::TestCase
+  context "Parsing S3 credentials" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :bucket => "testing",
+                    :s3_credentials => {:not => :important}
+
+      @dummy = Dummy.new
+      @avatar = @dummy.avatar
+
+      @current_env = RAILS_ENV
+    end
+
+    teardown do
+      Object.const_set("RAILS_ENV", @current_env)
+    end
+
+    should "get the correct credentials when RAILS_ENV is production" do
+      Object.const_set('RAILS_ENV', "production")
+      assert_equal({:key => "12345"},
+                   @avatar.parse_credentials('production' => {:key => '12345'},
+                                             :development => {:key => "54321"}))
+    end
+
+    should "get the correct credentials when RAILS_ENV is development" do
+      Object.const_set('RAILS_ENV', "development")
+      assert_equal({:key => "54321"},
+                   @avatar.parse_credentials('production' => {:key => '12345'},
+                                             :development => {:key => "54321"}))
+    end
+
+    should "return the argument if the key does not exist" do
+      Object.const_set('RAILS_ENV', "not really an env")
+      assert_equal({:test => "12345"}, @avatar.parse_credentials(:test => "12345"))
+    end
+  end
+
+  context "" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {},
+                    :bucket => "bucket",
+                    :path => ":attachment/:basename.:extension",
+                    :url => ":s3_path_url"
+      @dummy = Dummy.new
+      @dummy.avatar = StringIO.new(".")
+    end
+
+    should "return a url based on an S3 path" do
+      assert_match %r{^http://s3.amazonaws.com/bucket/avatars/stringio.txt}, @dummy.avatar.url
+    end
+  end
+  context "" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {},
+                    :bucket => "bucket",
+                    :path => ":attachment/:basename.:extension",
+                    :url => ":s3_domain_url"
+      @dummy = Dummy.new
+      @dummy.avatar = StringIO.new(".")
+    end
+
+    should "return a url based on an S3 subdomain" do
+      assert_match %r{^http://bucket.s3.amazonaws.com/avatars/stringio.txt}, @dummy.avatar.url
+    end
+  end
+  context "" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {
+                      :production   => { :bucket => "prod_bucket" },
+                      :development  => { :bucket => "dev_bucket" }
+                    },
+                    :s3_host_alias => "something.something.com",
+                    :path => ":attachment/:basename.:extension",
+                    :url => ":s3_alias_url"
+      @dummy = Dummy.new
+      @dummy.avatar = StringIO.new(".")
+    end
+
+    should "return a url based on the host_alias" do
+      assert_match %r{^http://something.something.com/avatars/stringio.txt}, @dummy.avatar.url
+    end
+  end
+
+  context "Parsing S3 credentials with a bucket in them" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :s3_credentials => {
+                      :production   => { :bucket => "prod_bucket" },
+                      :development  => { :bucket => "dev_bucket" }
+                    }
+      @dummy = Dummy.new
+      @old_env = RAILS_ENV
+    end
+
+    teardown{ Object.const_set("RAILS_ENV", @old_env) }
+
+    should "get the right bucket in production" do
+      Object.const_set("RAILS_ENV", "production")
+      assert_equal "prod_bucket", @dummy.avatar.bucket_name
+    end
+
+    should "get the right bucket in development" do
+      Object.const_set("RAILS_ENV", "development")
+      assert_equal "dev_bucket", @dummy.avatar.bucket_name
+    end
+  end
+
+  context "An attachment with S3 storage" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :bucket => "testing",
+                    :path => ":attachment/:style/:basename.:extension",
+                    :s3_credentials => {
+                      'access_key_id' => "12345",
+                      'secret_access_key' => "54321"
+                    }
+    end
+
+    should "be extended by the S3 module" do
+      assert Dummy.new.avatar.is_a?(Paperclip::Storage::S3)
+    end
+
+    should "not be extended by the Filesystem module" do
+      assert ! Dummy.new.avatar.is_a?(Paperclip::Storage::Filesystem)
+    end
+
+    context "when assigned" do
+      setup do
+        @file = File.new(File.join(File.dirname(__FILE__), 'fixtures', '5k.png'), 'rb')
+        @dummy = Dummy.new
+        @dummy.avatar = @file
+      end
+
+      teardown { @file.close }
+
+      should "not get a bucket to get a URL" do
+        @dummy.avatar.expects(:s3).never
+        @dummy.avatar.expects(:s3_bucket).never
+        assert_match %r{^http://s3\.amazonaws\.com/testing/avatars/original/5k\.png}, @dummy.avatar.url
+      end
+
+      context "and saved" do
+        setup do
+          @s3_mock     = stub
+          @bucket_mock = stub
+          RightAws::S3.expects(:new).with("12345", "54321", {}).returns(@s3_mock)
+          @s3_mock.expects(:bucket).with("testing", true, "public-read").returns(@bucket_mock)
+          @key_mock = stub
+          @bucket_mock.expects(:key).returns(@key_mock)
+          @key_mock.expects(:data=)
+          @key_mock.expects(:put).with(nil, 'public-read', 'Content-type' => 'image/png')
+          @dummy.save
+        end
+
+        should "succeed" do
+          assert true
+        end
+      end
+      
+      context "and remove" do
+        setup do
+          @s3_mock     = stub
+          @bucket_mock = stub
+          RightAws::S3.expects(:new).with("12345", "54321", {}).returns(@s3_mock)
+          @s3_mock.expects(:bucket).with("testing", true, "public-read").returns(@bucket_mock)
+          @key_mock = stub
+          @bucket_mock.expects(:key).at_least(2).returns(@key_mock)
+          @key_mock.expects(:delete)
+          @dummy.destroy_attached_files
+        end
+
+        should "succeed" do
+          assert true
+        end
+      end
+    end
+  end
+  
+  context "An attachment with S3 storage and bucket defined as a Proc" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :bucket => lambda { |attachment| "bucket_#{attachment.instance.other}" },
+                    :s3_credentials => {:not => :important}
+    end
+    
+    should "get the right bucket name" do
+      assert "bucket_a", Dummy.new(:other => 'a').avatar.bucket_name
+      assert "bucket_b", Dummy.new(:other => 'b').avatar.bucket_name
+    end
+  end
+
+  context "An attachment with S3 storage and specific s3 headers set" do
+    setup do
+      rebuild_model :storage => :s3,
+                    :bucket => "testing",
+                    :path => ":attachment/:style/:basename.:extension",
+                    :s3_credentials => {
+                      'access_key_id' => "12345",
+                      'secret_access_key' => "54321"
+                    },
+                    :s3_headers => {'Cache-Control' => 'max-age=31557600'}
+    end
+
+    context "when assigned" do
+      setup do
+        @file = File.new(File.join(File.dirname(__FILE__), 'fixtures', '5k.png'), 'rb')
+        @dummy = Dummy.new
+        @dummy.avatar = @file
+      end
+
+      teardown { @file.close }
+
+      context "and saved" do
+        setup do
+          @s3_mock     = stub
+          @bucket_mock = stub
+          RightAws::S3.expects(:new).with("12345", "54321", {}).returns(@s3_mock)
+          @s3_mock.expects(:bucket).with("testing", true, "public-read").returns(@bucket_mock)
+          @key_mock = stub
+          @bucket_mock.expects(:key).returns(@key_mock)
+          @key_mock.expects(:data=)
+          @key_mock.expects(:put).with(nil,
+                                       'public-read',
+                                       'Content-type' => 'image/png',
+                                       'Cache-Control' => 'max-age=31557600')
+          @dummy.save
+        end
+
+        should "succeed" do
+          assert true
+        end
+      end
+    end
+  end
+
+  unless ENV["S3_TEST_BUCKET"].blank?
+    context "Using S3 for real, an attachment with S3 storage" do
+      setup do
+        rebuild_model :styles => { :thumb => "100x100", :square => "32x32#" },
+                      :storage => :s3,
+                      :bucket => ENV["S3_TEST_BUCKET"],
+                      :path => ":class/:attachment/:id/:style.:extension",
+                      :s3_credentials => File.new(File.join(File.dirname(__FILE__), "s3.yml"))
+
+        Dummy.delete_all
+        @dummy = Dummy.new
+      end
+
+      should "be extended by the S3 module" do
+        assert Dummy.new.avatar.is_a?(Paperclip::Storage::S3)
+      end
+
+      context "when assigned" do
+        setup do
+          @file = File.new(File.join(File.dirname(__FILE__), 'fixtures', '5k.png'), 'rb')
+          @dummy.avatar = @file
+        end
+
+        teardown { @file.close }
+
+        should "still return a Tempfile when sent #to_io" do
+          assert_equal Tempfile, @dummy.avatar.to_io.class
+        end
+
+        context "and saved" do
+          setup do
+            @dummy.save
+          end
+
+          should "be on S3" do
+            assert true
+          end
+        end
+      end
+    end
+  end
+end