kt-paperclip 4.4.0

data/spec/paperclip/validators/attachment_presence_validator_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Paperclip::Validators::AttachmentPresenceValidator do
+  before do
+    rebuild_model
+    @dummy = Dummy.new
+  end
+
+  def build_validator(options={})
+    @validator = Paperclip::Validators::AttachmentPresenceValidator.new(options.merge(
+      attributes: :avatar
+    ))
+  end
+
+  context "nil attachment" do
+    before do
+      @dummy.avatar = nil
+    end
+
+    context "with default options" do
+      before do
+        build_validator
+        @validator.validate(@dummy)
+      end
+
+      it "adds error on the attachment" do
+        assert @dummy.errors[:avatar].present?
+      end
+
+      it "does not add an error on the file_name attribute" do
+        assert @dummy.errors[:avatar_file_name].blank?
+      end
+    end
+
+    context "with :if option" do
+      context "returning true" do
+        before do
+          build_validator if: true
+          @validator.validate(@dummy)
+        end
+
+        it "performs a validation" do
+          assert @dummy.errors[:avatar].present?
+        end
+      end
+
+      context "returning false" do
+        before do
+          build_validator if: false
+          @validator.validate(@dummy)
+        end
+
+        it "performs a validation" do
+          assert @dummy.errors[:avatar].present?
+        end
+      end
+    end
+  end
+
+  context "with attachment" do
+    before do
+      build_validator
+      @dummy.avatar = StringIO.new('.\n')
+      @validator.validate(@dummy)
+    end
+
+    it "does not add error on the attachment" do
+      assert @dummy.errors[:avatar].blank?
+    end
+
+    it "does not add an error on the file_name attribute" do
+      assert @dummy.errors[:avatar_file_name].blank?
+    end
+  end
+
+  context "using the helper" do
+    before do
+      Dummy.validates_attachment_presence :avatar
+    end
+
+    it "adds the validator to the class" do
+      assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :attachment_presence }
+    end
+  end
+end

data/spec/paperclip/validators/attachment_size_validator_spec.rb

@@ -0,0 +1,229 @@
+require 'spec_helper'
+
+describe Paperclip::Validators::AttachmentSizeValidator do
+  before do
+    rebuild_model
+    @dummy = Dummy.new
+  end
+
+  def build_validator(options)
+    @validator = Paperclip::Validators::AttachmentSizeValidator.new(options.merge(
+      attributes: :avatar
+    ))
+  end
+
+  def self.storage_units
+    if defined?(ActiveSupport::NumberHelper) # Rails 4.0+
+      { 5120 => '5 KB',       10240 => '10 KB' }
+    else
+      { 5120 => '5120 Bytes', 10240 => '10240 Bytes' }
+    end
+  end
+
+  def self.should_allow_attachment_file_size(size)
+    context "when the attachment size is #{size}" do
+      it "adds error to dummy object" do
+        @dummy.stubs(:avatar_file_size).returns(size)
+        @validator.validate(@dummy)
+        assert @dummy.errors[:avatar_file_size].blank?,
+          "Expect an error message on :avatar_file_size, got none."
+      end
+
+      it "does not add error to the base dummy object" do
+        assert @dummy.errors[:avatar].blank?,
+          "Error added to base attribute"
+      end
+    end
+  end
+
+  def self.should_not_allow_attachment_file_size(size, options = {})
+    context "when the attachment size is #{size}" do
+      before do
+        @dummy.stubs(:avatar_file_size).returns(size)
+        @validator.validate(@dummy)
+      end
+
+      it "adds error to dummy object" do
+        assert @dummy.errors[:avatar_file_size].present?,
+          "Unexpected error message on :avatar_file_size"
+      end
+
+      it "adds error to the base dummy object" do
+        assert @dummy.errors[:avatar].present?,
+          "Error not added to base attribute"
+      end
+
+      it "adds error to base object as a string" do
+        expect(@dummy.errors[:avatar].first).to be_a String
+      end
+
+      if options[:message]
+        it "returns a correct error message" do
+          expect(@dummy.errors[:avatar_file_size]).to include options[:message]
+        end
+      end
+    end
+  end
+
+  context "with :in option" do
+    context "as a range" do
+      before do
+        build_validator in: (5.kilobytes..10.kilobytes)
+      end
+
+      should_allow_attachment_file_size(7.kilobytes)
+      should_not_allow_attachment_file_size(4.kilobytes)
+      should_not_allow_attachment_file_size(11.kilobytes)
+    end
+
+    context "as a proc" do
+      before do
+        build_validator in: lambda { |avatar| (5.kilobytes..10.kilobytes) }
+      end
+
+      should_allow_attachment_file_size(7.kilobytes)
+      should_not_allow_attachment_file_size(4.kilobytes)
+      should_not_allow_attachment_file_size(11.kilobytes)
+    end
+  end
+
+  context "with :greater_than option" do
+    context "as number" do
+      before do
+        build_validator greater_than: 10.kilobytes
+      end
+
+      should_allow_attachment_file_size 11.kilobytes
+      should_not_allow_attachment_file_size 10.kilobytes
+    end
+
+    context "as a proc" do
+      before do
+        build_validator greater_than: lambda { |avatar| 10.kilobytes }
+      end
+
+      should_allow_attachment_file_size 11.kilobytes
+      should_not_allow_attachment_file_size 10.kilobytes
+    end
+  end
+
+  context "with :less_than option" do
+    context "as number" do
+      before do
+        build_validator less_than: 10.kilobytes
+      end
+
+      should_allow_attachment_file_size 9.kilobytes
+      should_not_allow_attachment_file_size 10.kilobytes
+    end
+
+    context "as a proc" do
+      before do
+        build_validator less_than: lambda { |avatar| 10.kilobytes }
+      end
+
+      should_allow_attachment_file_size 9.kilobytes
+      should_not_allow_attachment_file_size 10.kilobytes
+    end
+  end
+
+  context "with :greater_than and :less_than option" do
+    context "as numbers" do
+      before do
+        build_validator greater_than: 5.kilobytes,
+          less_than: 10.kilobytes
+      end
+
+      should_allow_attachment_file_size 7.kilobytes
+      should_not_allow_attachment_file_size 5.kilobytes
+      should_not_allow_attachment_file_size 10.kilobytes
+    end
+
+    context "as a proc" do
+      before do
+        build_validator greater_than: lambda { |avatar| 5.kilobytes },
+          less_than: lambda { |avatar| 10.kilobytes }
+      end
+
+      should_allow_attachment_file_size 7.kilobytes
+      should_not_allow_attachment_file_size 5.kilobytes
+      should_not_allow_attachment_file_size 10.kilobytes
+    end
+  end
+
+  context "with :message option" do
+    context "given a range" do
+      before do
+        build_validator in: (5.kilobytes..10.kilobytes),
+          message: "is invalid. (Between %{min} and %{max} please.)"
+      end
+
+      should_not_allow_attachment_file_size 11.kilobytes,
+        message: "is invalid. (Between #{storage_units[5120]} and #{storage_units[10240]} please.)"
+    end
+
+    context "given :less_than and :greater_than" do
+      before do
+        build_validator less_than: 10.kilobytes,
+          greater_than: 5.kilobytes,
+          message: "is invalid. (Between %{min} and %{max} please.)"
+      end
+
+      should_not_allow_attachment_file_size 11.kilobytes,
+        message: "is invalid. (Between #{storage_units[5120]} and #{storage_units[10240]} please.)"
+    end
+  end
+
+  context "default error messages" do
+    context "given :less_than and :greater_than" do
+      before do
+        build_validator greater_than: 5.kilobytes,
+          less_than: 10.kilobytes
+      end
+
+      should_not_allow_attachment_file_size 11.kilobytes,
+        message: "must be less than #{storage_units[10240]}"
+      should_not_allow_attachment_file_size 4.kilobytes,
+        message: "must be greater than #{storage_units[5120]}"
+    end
+
+    context "given a size range" do
+      before do
+        build_validator in: (5.kilobytes..10.kilobytes)
+      end
+
+      should_not_allow_attachment_file_size 11.kilobytes,
+        message: "must be in between #{storage_units[5120]} and #{storage_units[10240]}"
+      should_not_allow_attachment_file_size 4.kilobytes,
+        message: "must be in between #{storage_units[5120]} and #{storage_units[10240]}"
+    end
+  end
+
+  context "using the helper" do
+    before do
+      Dummy.validates_attachment_size :avatar, in: (5.kilobytes..10.kilobytes)
+    end
+
+    it "adds the validator to the class" do
+      assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :attachment_size }
+    end
+  end
+
+  context "given options" do
+    it "raises argument error if no required argument was given" do
+      assert_raises(ArgumentError) do
+        build_validator message: "Some message"
+      end
+    end
+
+    (Paperclip::Validators::AttachmentSizeValidator::AVAILABLE_CHECKS).each do |argument|
+      it "does not raise arguemnt error if #{argument} was given" do
+        build_validator argument => 5.kilobytes
+      end
+    end
+
+    it "does not raise argument error if :in was given" do
+      build_validator in: (5.kilobytes..10.kilobytes)
+    end
+  end
+end

data/spec/paperclip/validators/media_type_spoof_detection_validator_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Paperclip::Validators::MediaTypeSpoofDetectionValidator do
+  before do
+    rebuild_model
+    @dummy = Dummy.new
+  end
+
+  def build_validator(options = {})
+    @validator = Paperclip::Validators::MediaTypeSpoofDetectionValidator.new(options.merge(
+      attributes: :avatar
+    ))
+  end
+
+  it "is on the attachment without being explicitly added" do
+    assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :media_type_spoof_detection }
+  end
+
+  it "is not on the attachment when explicitly rejected" do
+    rebuild_model validate_media_type: false
+    assert Dummy.validators_on(:avatar).none?{ |validator| validator.kind == :media_type_spoof_detection }
+  end
+
+  it "returns default error message for spoofed media type" do
+    build_validator
+    file = File.new(fixture_file("5k.png"), "rb")
+    @dummy.avatar.assign(file)
+
+    detector = mock("detector", :spoofed? => true)
+    Paperclip::MediaTypeSpoofDetector.stubs(:using).returns(detector)
+    @validator.validate(@dummy)
+
+    assert_equal I18n.t("errors.messages.spoofed_media_type"), @dummy.errors[:avatar].first
+  end
+
+  it "runs when attachment is dirty" do
+    build_validator
+    file = File.new(fixture_file("5k.png"), "rb")
+    @dummy.avatar.assign(file)
+    Paperclip::MediaTypeSpoofDetector.stubs(:using).returns(stub(:spoofed? => false))
+
+    @dummy.valid?
+
+    assert_received(Paperclip::MediaTypeSpoofDetector, :using){|e| e.once }
+  end
+
+  it "does not run when attachment is not dirty" do
+    Paperclip::MediaTypeSpoofDetector.stubs(:using).never
+    @dummy.valid?
+    assert_received(Paperclip::MediaTypeSpoofDetector, :using){|e| e.never }
+  end
+end

data/spec/paperclip/validators_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe Paperclip::Validators do
+  context "using the helper" do
+    before do
+      Dummy.validates_attachment :avatar, presence: true, content_type: { content_type: "image/jpeg" }, size: { in: 0..10240 }
+    end
+
+    it "adds the attachment_presence validator to the class" do
+      assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :attachment_presence }
+    end
+
+    it "adds the attachment_content_type validator to the class" do
+      assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :attachment_content_type }
+    end
+
+    it "adds the attachment_size validator to the class" do
+      assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :attachment_size }
+    end
+
+    it 'prevents you from attaching a file that violates that validation' do
+      Dummy.class_eval{ validate(:name) { raise "DO NOT RUN THIS" } }
+      dummy = Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      expect(dummy.errors.keys).to match_array [:avatar_content_type, :avatar, :avatar_file_size]
+      assert_raises(RuntimeError){ dummy.valid? }
+    end
+  end
+
+  context 'using the helper with array of validations' do
+    before do
+      rebuild_class
+      Dummy.validates_attachment :avatar, file_type_ignorance: true, file_name: [
+          { matches: /\A.*\.jpe?g\Z/i, message: :invalid_extension },
+          { matches: /\A.{,8}\..+\Z/i, message: [:too_long, count: 8] },
+      ]
+    end
+
+    it 'adds the attachment_file_name validator to the class' do
+      assert Dummy.validators_on(:avatar).any?{ |validator| validator.kind == :attachment_file_name }
+    end
+
+    it 'adds the attachment_file_name validator with two validations' do
+      assert_equal 2, Dummy.validators_on(:avatar).select{ |validator| validator.kind == :attachment_file_name }.size
+    end
+
+    it 'prevents you from attaching a file that violates all of these validations' do
+      Dummy.class_eval{ validate(:name) { raise 'DO NOT RUN THIS' } }
+      dummy = Dummy.new(avatar: File.new(fixture_file('spaced file.png')))
+      expect(dummy.errors.keys).to match_array [:avatar, :avatar_file_name]
+      assert_raises(RuntimeError){ dummy.valid? }
+    end
+
+    it 'prevents you from attaching a file that violates only first of these validations' do
+      Dummy.class_eval{ validate(:name) { raise 'DO NOT RUN THIS' } }
+      dummy = Dummy.new(avatar: File.new(fixture_file('5k.png')))
+      expect(dummy.errors.keys).to match_array [:avatar, :avatar_file_name]
+      assert_raises(RuntimeError){ dummy.valid? }
+    end
+
+    it 'prevents you from attaching a file that violates only second of these validations' do
+      Dummy.class_eval{ validate(:name) { raise 'DO NOT RUN THIS' } }
+      dummy = Dummy.new(avatar: File.new(fixture_file('spaced file.jpg')))
+      expect(dummy.errors.keys).to match_array [:avatar, :avatar_file_name]
+      assert_raises(RuntimeError){ dummy.valid? }
+    end
+
+    it 'allows you to attach a file that does not violates these validations' do
+      dummy = Dummy.new(avatar: File.new(fixture_file('rotated.jpg')))
+      expect(dummy.errors.keys).to match_array []
+      assert dummy.valid?
+    end
+
+  end
+
+  context "using the helper with a conditional" do
+    before do
+      rebuild_class
+      Dummy.validates_attachment :avatar, presence: true,
+        content_type: { content_type: "image/jpeg" },
+        size: { in: 0..10240 },
+        if: :title_present?
+    end
+
+    it "validates the attachment if title is present" do
+      Dummy.class_eval do
+        def title_present?
+          true
+        end
+      end
+      dummy = Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      expect(dummy.errors.keys).to match_array [:avatar_content_type, :avatar, :avatar_file_size]
+    end
+
+    it "does not validate attachment if title is not present" do
+      Dummy.class_eval do
+        def title_present?
+          false
+        end
+      end
+      dummy = Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      assert_equal [], dummy.errors.keys
+    end
+  end
+
+  context 'with no other validations on the Dummy#avatar attachment' do
+    before do
+      reset_class("Dummy")
+      Dummy.has_attached_file :avatar
+      Paperclip.reset_duplicate_clash_check!
+    end
+
+    it 'raises an error when no content_type validation exists' do
+      assert_raises(Paperclip::Errors::MissingRequiredValidatorError) do
+        Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      end
+    end
+
+    it 'does not raise an error when a content_type validation exists' do
+      Dummy.validates_attachment :avatar, content_type: { content_type: "image/jpeg" }
+
+      assert_nothing_raised do
+        Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      end
+    end
+
+    it 'does not raise an error when a content_type validation exists using validates_with' do
+      Dummy.validates_with Paperclip::Validators::AttachmentContentTypeValidator, attributes: :attachment, content_type: 'images/jpeg'
+
+      assert_nothing_raised do
+        Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      end
+    end
+
+    it 'does not raise an error when an inherited validator is used' do
+      class MyValidator < Paperclip::Validators::AttachmentContentTypeValidator
+        def initialize(options)
+          options[:content_type] = "images/jpeg" unless options.has_key?(:content_type)
+          super
+        end
+      end
+      Dummy.validates_with MyValidator, attributes: :attachment
+
+      assert_nothing_raised do
+        Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      end
+    end
+
+    it 'does not raise an error when a file_name validation exists' do
+      Dummy.validates_attachment :avatar, file_name: { matches: /png$/ }
+
+      assert_nothing_raised do
+        Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      end
+    end
+
+    it 'does not raise an error when a the validation has been explicitly rejected' do
+      Dummy.validates_attachment :avatar, file_type_ignorance: true
+
+      assert_nothing_raised do
+        Dummy.new(avatar: File.new(fixture_file("12k.png")))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rspec'
+require 'active_record'
+require 'active_record/version'
+require 'active_support'
+require 'active_support/core_ext'
+require 'mocha/api'
+require 'bourne'
+require 'ostruct'
+
+ROOT = Pathname(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+
+puts "Testing against version #{ActiveRecord::VERSION::STRING}"
+
+$LOAD_PATH << File.join(ROOT, 'lib')
+$LOAD_PATH << File.join(ROOT, 'lib', 'paperclip')
+require File.join(ROOT, 'lib', 'paperclip.rb')
+
+FIXTURES_DIR = File.join(File.dirname(__FILE__), "fixtures")
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config['test'])
+unless ActiveRecord::VERSION::STRING < "4.2"
+  ActiveRecord::Base.raise_in_transactional_callbacks = true
+end
+Paperclip.options[:logger] = ActiveRecord::Base.logger
+
+Dir[File.join(ROOT, 'spec', 'support', '**', '*.rb')].each{|f| require f }
+
+Rails = FakeRails.new('test', Pathname.new(ROOT).join('tmp'))
+ActiveSupport::Deprecation.silenced = true
+
+RSpec.configure do |config|
+  config.include Assertions
+  config.include ModelReconstruction
+  config.include TestData
+  config.extend VersionHelper
+  config.extend RailsHelpers::ClassMethods
+  config.mock_framework = :mocha
+  config.before(:all) do
+    rebuild_model
+  end
+end

data/spec/support/assertions.rb

@@ -0,0 +1,71 @@
+module Assertions
+  def assert(truthy, message = nil)
+    expect(!!truthy).to(eq(true), message)
+  end
+
+  def assert_equal(expected, actual, message = nil)
+    expect(actual).to(eq(expected), message)
+  end
+
+  def assert_not_equal(expected, actual, message = nil)
+    expect(actual).to_not(eq(expected), message)
+  end
+
+  def assert_raises(exception_class, message = nil, &block)
+    expect(&block).to raise_error(exception_class, message)
+  end
+
+  def assert_nothing_raised(&block)
+    expect(&block).to_not raise_error
+  end
+
+  def assert_nil(thing)
+    expect(thing).to be_nil
+  end
+
+  def assert_contains(haystack, needle)
+    expect(haystack).to include(needle)
+  end
+
+  def assert_match(pattern, value)
+    expect(value).to match(pattern)
+  end
+
+  def assert_no_match(pattern, value)
+    expect(value).to_not match(pattern)
+  end
+
+  def assert_file_exists(path_to_file)
+    expect(path_to_file).to exist
+  end
+
+  def assert_file_not_exists(path_to_file)
+    expect(path_to_file).to_not exist
+  end
+
+  def assert_empty(object)
+    expect(object).to be_empty
+  end
+
+  def assert_success_response(url)
+    Net::HTTP.get_response(URI.parse(url)) do |response|
+      assert_equal "200", response.code,
+        "Expected HTTP response code 200, got #{response.code}"
+    end
+  end
+
+  def assert_not_found_response(url)
+    Net::HTTP.get_response(URI.parse(url)) do |response|
+      assert_equal "404", response.code,
+        "Expected HTTP response code 404, got #{response.code}"
+    end
+  end
+
+  def assert_frame_dimensions(range, frames)
+    frames.each_with_index do |frame, frame_index|
+      frame.split('x').each_with_index do |dimension, dimension_index |
+        assert range.include?(dimension.to_i), "Frame #{frame_index}[#{dimension_index}] should have been within #{range.inspect}, but was #{dimension}"
+      end
+    end
+  end
+end

data/spec/support/deprecations.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:all) do
+    ActiveSupport::Deprecation.silenced = true
+  end
+  config.before(:each) do
+    Paperclip::Deprecations.stubs(:active_model_version).returns("4.2")
+    Paperclip::Deprecations.stubs(:aws_sdk_version).returns("2.0.0")
+  end
+end

data/spec/support/fake_model.rb

@@ -0,0 +1,25 @@
+class FakeModel
+  attr_accessor(
+    :avatar_file_name,
+    :avatar_file_size,
+    :avatar_updated_at,
+    :avatar_content_type,
+    :avatar_fingerprint,
+    :id
+  )
+
+  def errors
+    @errors ||= []
+  end
+
+  def run_paperclip_callbacks name, *args
+  end
+
+  def valid?
+    errors.empty?
+  end
+
+  def new_record?
+    false
+  end
+end

data/spec/support/fake_rails.rb

@@ -0,0 +1,12 @@
+class FakeRails
+  def initialize(env, root)
+    @env = env
+    @root = root
+  end
+
+  attr_accessor :env, :root
+
+  def const_defined?(const)
+    false
+  end
+end