jr-paperclip 7.3.0

data/spec/paperclip/validators_spec.rb

@@ -0,0 +1,179 @@
+require "spec_helper"
+
+describe Paperclip::Validators do
+  # required to support a range of rubies
+  def error_attribute_names(error)
+    error.try(:attribute_names) || error.keys
+  end
+
+  context "using the helper" do
+    before do
+      rebuild_class
+      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(error_attribute_names(dummy.errors)).to match_array(
+        %i[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(error_attribute_names(dummy.errors)).to match_array(
+        %i[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(error_attribute_names(dummy.errors)).to match_array(
+        %i[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(error_attribute_names(dummy.errors)).to match_array(
+        %i[avatar avatar_file_name]
+      )
+      assert_raises(RuntimeError) { dummy.valid? }
+    end
+
+    it "allows you to attach a file that does not violate these validations" do
+      dummy = Dummy.new(avatar: File.new(fixture_file("rotated.jpg")))
+      expect(dummy.errors.full_messages).to be_empty
+      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(error_attribute_names(dummy.errors)).to match_array(
+        %i[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 [], error_attribute_names(dummy.errors)
+    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.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,52 @@
+require "rubygems"
+require "rspec"
+require "active_record"
+require "active_record/version"
+require "active_support"
+require "active_support/core_ext"
+require "ostruct"
+require "pathname"
+require "activerecord-import"
+require "yaml"
+
+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::safe_load(IO.read(File.dirname(__FILE__) + "/database.yml"))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config["test"])
+ActiveRecord::Migration.verbose = false
+if ActiveRecord::VERSION::STRING >= "4.2" &&
+   ActiveRecord::VERSION::STRING < "5.0"
+  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"))
+
+# Silence deprecation warnings - handle different Rails versions
+if ActiveSupport::Deprecation.respond_to?(:silenced=)
+  ActiveSupport::Deprecation.silenced = true
+elsif defined?(ActiveSupport.deprecator)
+  ActiveSupport.deprecator.behavior = :silence
+end
+
+RSpec.configure do |config|
+  config.include Assertions
+  config.include ModelReconstruction
+  config.include TestData
+  config.include Reporting
+  config.extend VersionHelper
+
+  config.before(:all) do
+    rebuild_model
+  end
+end

data/spec/support/assertions.rb

@@ -0,0 +1,84 @@
+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)
+    url = "http:#{url}" unless url =~ /http/
+    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)
+    url = "http:#{url}" unless url =~ /http/
+    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_forbidden_response(url)
+    url = "http:#{url}" unless url =~ /http/
+    Net::HTTP.get_response(URI.parse(url)) do |response|
+      assert_equal "403", response.code,
+                   "Expected HTTP response code 403, 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/fake_model.rb

@@ -0,0 +1,24 @@
+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

data/spec/support/fixtures/aws_s3.yml

@@ -0,0 +1,13 @@
+default: &default
+  acl: public-read
+development:
+  <<: *default
+  key: 54321
+production:
+  <<: *default
+  key: 12345
+test:
+  <<: *default
+  bucket: <%= ENV['S3_BUCKET'] %>
+  access_key_id: <%= ENV['S3_KEY'] %>
+  secret_access_key: <%= ENV['S3_SECRET'] %>

data/spec/support/fixtures/bad.png

@@ -0,0 +1 @@
+This is not an image.

data/spec/support/fixtures/empty.html

@@ -0,0 +1 @@
+<html></html>

data/spec/support/fixtures/fog.yml

@@ -0,0 +1,8 @@
+development:
+    provider: AWS
+    aws_access_key_id: AWS_ID
+    aws_secret_access_key: AWS_SECRET
+test:
+    provider: AWS
+    aws_access_key_id: AWS_ID
+    aws_secret_access_key: AWS_SECRET

data/spec/support/fixtures/s3.yml

@@ -0,0 +1,8 @@
+development:
+  key: 54321
+production:
+  key: 12345
+test:
+  bucket: <%= ENV['S3_BUCKET'] %>
+  access_key_id: <%= ENV['S3_KEY'] %>
+  secret_access_key: <%= ENV['S3_SECRET'] %>

data/spec/support/fixtures/text.txt

@@ -0,0 +1 @@
+paperclip!

data/spec/support/matchers/accept.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :accept do |expected|
+  match do |actual|
+    actual.matches?(expected)
+  end
+end

data/spec/support/matchers/exist.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :exist do |_expected|
+  match do |actual|
+    File.exist?(actual)
+  end
+end

data/spec/support/matchers/have_column.rb

@@ -0,0 +1,23 @@
+RSpec::Matchers.define :have_column do |column_name|
+  chain :with_default do |default|
+    @default = default
+  end
+
+  match do |columns|
+    column = columns.detect { |column| column.name == column_name }
+    column && column.default.to_s == @default.to_s
+  end
+
+  failure_message_method =
+    if RSpec::Version::STRING.to_i >= 3
+      :failure_message
+    else
+      :failure_message_for_should
+    end
+
+  send(failure_message_method) do |columns|
+    "expected to find '#{column_name}', " +
+      "default '#{@default}' " +
+      "in #{columns.map { |column| [column.name, column.default] }}"
+  end
+end

data/spec/support/mock_attachment.rb

@@ -0,0 +1,24 @@
+class MockAttachment
+  attr_accessor :updated_at, :original_filename
+  attr_reader :options
+
+  def initialize(options = {})
+    @options = options
+    @model = options[:model]
+    @responds_to_updated_at = options[:responds_to_updated_at]
+    @updated_at = options[:updated_at]
+    @original_filename = options[:original_filename]
+  end
+
+  def instance
+    @model
+  end
+
+  def respond_to?(meth)
+    if meth.to_s == "updated_at"
+      @responds_to_updated_at || @updated_at
+    else
+      super
+    end
+  end
+end

data/spec/support/mock_interpolator.rb

@@ -0,0 +1,24 @@
+class MockInterpolator
+  def initialize(options = {})
+    @options = options
+  end
+
+  def interpolate(pattern, attachment, style_name)
+    @interpolated_pattern = pattern
+    @interpolated_attachment = attachment
+    @interpolated_style_name = style_name
+    @options[:result]
+  end
+
+  def has_interpolated_pattern?(pattern)
+    @interpolated_pattern == pattern
+  end
+
+  def has_interpolated_style_name?(style_name)
+    @interpolated_style_name == style_name
+  end
+
+  def has_interpolated_attachment?(attachment)
+    @interpolated_attachment == attachment
+  end
+end

data/spec/support/mock_url_generator_builder.rb

@@ -0,0 +1,26 @@
+class MockUrlGeneratorBuilder
+  def initializer; end
+
+  def new(attachment)
+    @attachment = attachment
+    @attachment_options = @attachment.options
+    self
+  end
+
+  def for(style_name, options)
+    @generated_url_with_style_name = style_name
+    @generated_url_with_options = options
+    "hello"
+  end
+
+  def has_generated_url_with_options?(options)
+    # options.is_a_subhash_of(@generated_url_with_options)
+    options.inject(true) do |acc, (k, v)|
+      acc && @generated_url_with_options[k] == v
+    end
+  end
+
+  def has_generated_url_with_style_name?(style_name)
+    @generated_url_with_style_name == style_name
+  end
+end

data/spec/support/model_reconstruction.rb

@@ -0,0 +1,72 @@
+module ModelReconstruction
+  def reset_class(class_name)
+    ActiveRecord::Base.include Paperclip::Glue
+    begin
+      Object.send(:remove_const, class_name)
+    rescue StandardError
+      nil
+    end
+    klass = Object.const_set(class_name, Class.new(ActiveRecord::Base))
+
+    klass.class_eval do
+      include Paperclip::Glue
+    end
+
+    klass.reset_column_information
+    klass.connection_pool.clear_table_cache!(klass.table_name) if klass.connection_pool.respond_to?(:clear_table_cache!)
+
+    if klass.connection.respond_to?(:schema_cache)
+      if ActiveRecord::VERSION::STRING >= "5.0"
+        klass.connection.schema_cache.clear_data_source_cache!(klass.table_name)
+      else
+        klass.connection.schema_cache.clear_table_cache!(klass.table_name)
+      end
+    end
+
+    klass
+  end
+
+  def reset_table(_table_name, &block)
+    block ||= lambda { |_table| true }
+    ActiveRecord::Migration.create_table :dummies, **{ force: true }, &block
+  end
+
+  def modify_table(&block)
+    ActiveRecord::Migration.change_table :dummies, &block
+  end
+
+  def rebuild_model(options = {})
+    ActiveRecord::Migration.create_table :dummies, force: true do |table|
+      table.column :title, :string
+      table.column :other, :string
+      table.column :avatar_file_name, :string
+      table.column :avatar_content_type, :string
+      table.column :avatar_file_size, :bigint
+      table.column :avatar_updated_at, :datetime
+      table.column :avatar_fingerprint, :string
+    end
+    rebuild_class options
+  end
+
+  def rebuild_class(options = {})
+    reset_class("Dummy").tap do |klass|
+      klass.has_attached_file :avatar, options
+      klass.do_not_validate_attachment_file_type :avatar
+      Paperclip.reset_duplicate_clash_check!
+    end
+  end
+
+  def rebuild_meta_class_of(obj, options = {})
+    meta_class_of(obj).tap do |metaklass|
+      metaklass.has_attached_file :avatar, options
+      metaklass.do_not_validate_attachment_file_type :avatar
+      Paperclip.reset_duplicate_clash_check!
+    end
+  end
+
+  def meta_class_of(obj)
+    class << obj
+      self
+    end
+  end
+end

data/spec/support/reporting.rb

@@ -0,0 +1,11 @@
+module Reporting
+  def silence_stream(stream)
+    old_stream = stream.dup
+    stream.reopen(RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ ? "NUL:" : "/dev/null")
+    stream.sync = true
+    yield
+  ensure
+    stream.reopen(old_stream)
+    old_stream.close
+  end
+end

data/spec/support/test_data.rb

@@ -0,0 +1,13 @@
+module TestData
+  def attachment(options = {})
+    Paperclip::Attachment.new(:avatar, FakeModel.new, options)
+  end
+
+  def stringy_file
+    StringIO.new('.\n')
+  end
+
+  def fixture_file(filename)
+    File.join(File.dirname(__FILE__), "fixtures", filename)
+  end
+end

data/spec/support/version_helper.rb

@@ -0,0 +1,9 @@
+module VersionHelper
+  def active_support_version
+    ActiveSupport::VERSION::STRING
+  end
+
+  def ruby_version
+    RUBY_VERSION
+  end
+end