active_storage_validations 0.8.2 → 0.9.4

data/config/locales/tr.yml

@@ -0,0 +1,22 @@
+tr:
+  errors:
+    messages:
+      content_type_invalid: "geçersiz dosya tipine sahip"
+      file_size_out_of_range: "dosya boyutu %{file_size} gerekli aralık dışında"
+      limit_out_of_range: "toplam miktar aralık dışında"
+      image_metadata_missing: "geçerli bir imaj değil"
+      dimension_min_inclusion: "%{width} x %{height} piksele eşit ya da büyük olmalı"
+      dimension_max_inclusion: "%{width} x %{height} piksele eşit ya da küçük olmalı"
+      dimension_width_inclusion: "en %{min} ve %{max} piksel aralığı dışında"
+      dimension_height_inclusion: "boy %{min} ve %{max} piksel aralığı dışında"
+      dimension_width_greater_than_or_equal_to: "en %{length} piksele eşit ya da büyük olmalı"
+      dimension_height_greater_than_or_equal_to: "boy %{length} piksele eşit ya da büyük olmalı"
+      dimension_width_less_than_or_equal_to: "en %{length} piksele eşit ya da küçük olmalı"
+      dimension_height_less_than_or_equal_to: "boy %{length} piksele eşit ya da küçük olmalı"
+      dimension_width_equal_to: "en %{length} piksele eşit olmalı"
+      dimension_height_equal_to: "boy %{length} piksele eşit olmalı"
+      aspect_ratio_not_square: "kare bir imaj olmalı"
+      aspect_ratio_not_portrait: "dikey bir imaj olmalı"
+      aspect_ratio_not_landscape: "yatay bir imaj olmalı"
+      aspect_ratio_is_not: "%{aspect_ratio} en boy oranına sahip olmalı"
+      aspect_ratio_unknown: "bilinmeyen en boy oranı"

data/config/locales/uk.yml

@@ -0,0 +1,22 @@
+uk:
+  errors:
+    messages:
+      content_type_invalid: "має неприпустимий тип вмісту"
+      file_size_out_of_range: "розмір %{file_size} більше необхідного"
+      limit_out_of_range: "кількість файлів більше необхідного"
+      image_metadata_missing: "не є допустимим зображенням"
+      dimension_min_inclusion: "мусить бути більше або дорівнювати %{width} x %{height} пікселям"
+      dimension_max_inclusion: "мусить бути менше або дорівнювати %{width} x %{height} пікселям"
+      dimension_width_inclusion: "ширина не включена між %{min} і %{max} пікселям"
+      dimension_height_inclusion: "висота не включена між %{min} і %{max} пікселям"
+      dimension_width_greater_than_or_equal_to: "ширина мусить бути більше або дорівнювати %{length} пікселям"
+      dimension_height_greater_than_or_equal_to: "висота мусить бути більше або дорівнювати %{length} пікселям"
+      dimension_width_less_than_or_equal_to: "ширина мусить бути менше або дорівнювати %{length} пікселям"
+      dimension_height_less_than_or_equal_to: "висота мусить бути менше або дорівнювати %{length} пікселям"
+      dimension_width_equal_to: "ширина мусить дорівнювати %{length} пікселям"
+      dimension_height_equal_to: "висота мусить дорівнювати %{length} пікселям"
+      aspect_ratio_not_square: "мусить бути квадратне зображення"
+      aspect_ratio_not_portrait: "мусить бути портретне зображення"
+      aspect_ratio_not_landscape: "мусить бути пейзажне зображення"
+      aspect_ratio_is_not: "мусить мати співвідношення сторін %{aspect_ratio}"
+      aspect_ratio_unknown: "має невідоме співвідношення сторін"

data/config/locales/vi.yml

@@ -0,0 +1,22 @@
+vi:
+  errors:
+    messages:
+      content_type_invalid: "tệp không hợp lệ"
+      file_size_out_of_range: "kích thước %{file_size} vượt giới hạn"
+      limit_out_of_range: "tổng số tệp vượt giới hạn"
+      image_metadata_missing: "không phải là ảnh"
+      dimension_min_inclusion: "phải lớn hơn hoặc bằng %{width} x %{height} pixel"
+      dimension_max_inclusion: "phải nhỏ hơn hoặc bằng %{width} x %{height} pixel"
+      dimension_width_inclusion: "chiều rộng không nằm trong %{min} và %{max} pixel"
+      dimension_height_inclusion: "chiều cao không nằm trong %{min} và %{max} pixel"
+      dimension_width_greater_than_or_equal_to: "chiều rộng phải lớn hơn hoặc bằng %{length} pixel"
+      dimension_height_greater_than_or_equal_to: "chiều cao phải lớn hơn hoặc bằng %{length} pixel"
+      dimension_width_less_than_or_equal_to: "chiều rộng phải nhỏ hơn hoặc bằng %{length} pixel"
+      dimension_height_less_than_or_equal_to: "chiều cao phải nhỏ hơn hoặc bằng %{length} pixel"
+      dimension_width_equal_to: "chiều rộng phải bằng %{length} pixel"
+      dimension_height_equal_to: "chiều cao phải bằng %{length} pixel"
+      aspect_ratio_not_square: "phải là ảnh hình vuông"
+      aspect_ratio_not_portrait: "phải là ảnh đứng"
+      aspect_ratio_not_landscape: "phải là ảnh ngang"
+      aspect_ratio_is_not: "phải có tỉ lệ ảnh %{aspect_ratio}"
+      aspect_ratio_unknown: "tỉ lệ ảnh không xác định"

data/lib/active_storage_validations/attached_validator.rb

@@ -5,7 +5,10 @@ module ActiveStorageValidations
     def validate_each(record, attribute, _value)
       return if record.send(attribute).attached?
 
-      record.errors.add(attribute, :blank)
+      errors_options = {}
+      errors_options[:message] = options[:message] if options[:message].present?
+
+      record.errors.add(attribute, :blank, **errors_options)
     end
   end
 end

data/lib/active_storage_validations/content_type_validator.rb

@@ -14,19 +14,28 @@ module ActiveStorageValidations
         next if is_valid?(file)
 
         errors_options[:content_type] = content_type(file)
-        record.errors.add(attribute, :content_type_invalid, errors_options)
+        record.errors.add(attribute, :content_type_invalid, **errors_options)
         break
       end
     end
 
     def types
       (Array.wrap(options[:with]) + Array.wrap(options[:in])).compact.map do |type|
-        Mime[type] || type
+        if type.is_a?(Regexp)
+          type
+        elsif type.is_a?(String) && type =~ %r{\A\w+/[-+.\w]+\z} # mime-type-ish string
+          type
+        else
+          Mime[type] || raise(ArgumentError, "content_type must be one of Regxep,"\
+          " supported mime types (e.g. :png, 'jpg'), or mime type String ('image/jpeg')")
+        end
       end
     end
 
     def types_to_human_format
-      types.join(', ')
+      types
+        .map { |type| type.to_s.split('/').last.upcase }
+        .join(', ')
     end
 
     def content_type(file)
@@ -34,10 +43,9 @@ module ActiveStorageValidations
     end
 
     def is_valid?(file)
-      if options[:with].is_a?(Regexp)
-        options[:with].match?(content_type(file).to_s)
-      else
-        content_type(file).in?(types)
+      file_type = content_type(file)
+      types.any? do |type|
+        type == file_type || (type.is_a?(Regexp) && type.match?(file_type.to_s))
       end
     end
   end

data/lib/active_storage_validations/dimension_validator.rb

@@ -52,7 +52,7 @@ module ActiveStorageValidations
       # Rails 5
       def validate_each(record, attribute, _value)
         return true unless record.send(attribute).attached?
-  
+
         files = Array.wrap(record.send(attribute))
         files.each do |file|
           # Analyze file first if not analyzed to get all required metadata.
@@ -110,7 +110,7 @@ module ActiveStorageValidations
           else
             if file_metadata[length] != options[length]
               add_error(record, attribute, options[:message].presence || :"dimension_#{length}_equal_to", length: options[length])
-              return false            
+              return false
             end
           end
         end
@@ -119,11 +119,11 @@ module ActiveStorageValidations
       true # valid file
     end
 
-    def add_error(record, attribute, type, *attrs)
+    def add_error(record, attribute, type, **attrs)
       key = options[:message].presence || type
       return if record.errors.added?(attribute, key)
-      record.errors.add(attribute, key, *attrs)
-    end    
+      record.errors.add(attribute, key, **attrs)
+    end
 
   end
 end

data/lib/active_storage_validations/limit_validator.rb

@@ -10,18 +10,14 @@ module ActiveStorageValidations
       raise ArgumentError, 'You must pass either :max or :min to the validator'
     end
 
-    def validate_each(record, attribute, _value)
+    def validate_each(record, attribute, _)
       return true unless record.send(attribute).attached?
 
-      files = Array.wrap(record.send(attribute))
-
-      errors_options = {}
-      errors_options[:min] = options[:min]
-      errors_options[:max] = options[:max]
+      files = Array.wrap(record.send(attribute)).compact.uniq
+      errors_options = { min: options[:min], max: options[:max] }
 
       return true if files_count_valid?(files.count)
-
-      record.errors.add(attribute, options[:message].presence || :limit_out_of_range, errors_options)
+      record.errors.add(attribute, options[:message].presence || :limit_out_of_range, **errors_options)
     end
 
     def files_count_valid?(count)

data/lib/active_storage_validations/matchers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'active_storage_validations/matchers/attached_validator_matcher'
+require 'active_storage_validations/matchers/content_type_validator_matcher'
+require 'active_storage_validations/matchers/dimension_validator_matcher'
+require 'active_storage_validations/matchers/size_validator_matcher'
+
+module ActiveStorageValidations
+  module Matchers
+    # Helper to stub a method with either RSpec or Minitest (whatever is available)
+    def self.stub_method(object, method, result)
+      if defined?(Minitest::Mock)
+        object.stub(method, result) do
+          yield
+        end
+      elsif defined?(RSpec::Mocks)
+        RSpec::Mocks.allow_message(object, method) { result }
+        yield
+      else
+        raise 'Need either Minitest::Mock or RSpec::Mocks to run this validator matcher'
+      end
+    end
+
+    def self.mock_metadata(attachment, width, height)
+      if Rails::VERSION::MAJOR >= 6
+        # Mock the Metadata class for rails 6
+        mock = OpenStruct.new(metadata: { width: width, height: height })
+        stub_method(ActiveStorageValidations::Metadata, :new, mock) do
+          yield
+        end
+      else
+        # Stub the metadata analysis for rails 5
+        stub_method(attachment, :analyze, true) do
+          stub_method(attachment, :analyzed?, true) do
+            stub_method(attachment, :metadata, { width: width, height: height }) do
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/attached_validator_matcher.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_attached_of(name)
+      AttachedValidatorMatcher.new(name)
+    end
+
+    class AttachedValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+      end
+
+      def description
+        "validate #{@attribute_name} must be attached"
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+        responds_to_methods && valid_when_attached && invalid_when_not_attached
+      end
+
+      def failure_message
+        "is expected to validate attached of #{@attribute_name}"
+      end
+
+      def failure_message_when_negated
+        "is expected to not validate attached of #{@attribute_name}"
+      end
+
+      private
+
+      def responds_to_methods
+        @subject.respond_to?(@attribute_name) &&
+          @subject.public_send(@attribute_name).respond_to?(:attach) &&
+          @subject.public_send(@attribute_name).respond_to?(:detach)
+      end
+
+      def valid_when_attached
+        @subject.public_send(@attribute_name).attach(attachable) unless @subject.public_send(@attribute_name).attached?
+        @subject.validate
+        @subject.errors.details[@attribute_name].exclude?(error: :blank)
+      end
+
+      def invalid_when_not_attached
+        @subject.public_send(@attribute_name).detach
+        # Unset the direct relation since `detach` on an unpersisted record does not set `attached?` to false.
+        @subject.public_send("#{@attribute_name}=", nil)
+
+        @subject.validate
+        @subject.errors.details[@attribute_name].include?(error: :blank)
+      end
+
+      def attachable
+        { io: Tempfile.new('.'), filename: 'dummy.txt', content_type: 'text/plain' }
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Big thank you to the paperclip validation matchers:
+# https://github.com/thoughtbot/paperclip/blob/v6.1.0/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb
+module ActiveStorageValidations
+  module Matchers
+    def validate_content_type_of(name)
+      ContentTypeValidatorMatcher.new(name)
+    end
+
+    class ContentTypeValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+      end
+
+      def description
+        "validate the content types allowed on attachment #{@attribute_name}"
+      end
+
+      def allowing(*types)
+        @allowed_types = types.flatten
+        self
+      end
+
+      def rejecting(*types)
+        @rejected_types = types.flatten
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+        responds_to_methods && allowed_types_allowed? && rejected_types_rejected?
+      end
+
+      def failure_message
+        <<~MESSAGE
+          Expected #{@attribute_name}
+            
+            Accept content types: #{allowed_types.join(", ")}
+              #{accepted_types_and_failures}
+
+            Reject content types: #{rejected_types.join(", ")}
+              #{rejected_types_and_failures}
+        MESSAGE
+      end
+
+      protected
+
+      def responds_to_methods
+        @subject.respond_to?(@attribute_name) &&
+          @subject.public_send(@attribute_name).respond_to?(:attach) &&
+          @subject.public_send(@attribute_name).respond_to?(:detach)
+      end
+
+      def allowed_types
+        @allowed_types || []
+      end
+
+      def rejected_types
+        @rejected_types || (Mime::LOOKUP.keys - allowed_types)
+      end
+
+      def allowed_types_allowed?
+        @missing_allowed_types ||= allowed_types.reject { |type| type_allowed?(type) }
+        @missing_allowed_types.none?
+      end
+
+      def rejected_types_rejected?
+        @missing_rejected_types ||= rejected_types.select { |type| type_allowed?(type) }
+        @missing_rejected_types.none?
+      end
+
+      def accepted_types_and_failures
+        if @missing_allowed_types.present?
+          "#{@missing_allowed_types.join(", ")} were rejected."
+        else
+          "All were accepted successfully."
+        end
+      end
+
+      def rejected_types_and_failures
+        if @missing_rejected_types.present?
+          "#{@missing_rejected_types.join(", ")} were accepted."
+        else
+          "All were rejected successfully."
+        end
+      end
+
+      def type_allowed?(type)
+        @subject.public_send(@attribute_name).attach(attachment_for(type))
+        @subject.validate
+        @subject.errors.details[@attribute_name].all? { |error| error[:error] != :content_type_invalid }
+      end
+
+      def attachment_for(type)
+        suffix = type.to_s.split('/').last
+        { io: Tempfile.new('.'), filename: "test.#{suffix}", content_type: type }
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_dimensions_of(name)
+      DimensionValidatorMatcher.new(name)
+    end
+
+    class DimensionValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+        @width_min = @width_max = @height_min = @height_max = nil
+        @custom_message = nil
+      end
+
+      def description
+        "validate image dimensions of #{@attribute_name}"
+      end
+
+      def width_min(width)
+        @width_min = width
+        self
+      end
+
+      def width_max(width)
+        @width_max = width
+        self
+      end
+
+      def with_message(message)
+        @custom_message = message
+        self
+      end
+
+      def width(width)
+        @width_min = @width_max = width
+        self
+      end
+
+      def height_min(height)
+        @height_min = height
+        self
+      end
+
+      def height_max(height)
+        @height_max = height
+        self
+      end
+
+      def width_between(range)
+        @width_min, @width_max = range.first, range.last
+        self
+      end
+
+      def height_between(range)
+        @height_min, @height_max = range.first, range.last
+        self
+      end
+
+      def height(height)
+        @height_min = @height_max = height
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+        responds_to_methods &&
+          width_smaller_than_min? && width_larger_than_min? && width_smaller_than_max? && width_larger_than_max? && width_equals? &&
+          height_smaller_than_min? && height_larger_than_min? && height_smaller_than_max? && height_larger_than_max? && height_equals?
+      end
+
+      def failure_message
+        <<~MESSAGE
+          is expected to validate dimensions of #{@attribute_name}
+            width between #{@width_min} and #{@width_max}
+            height between #{@height_min} and #{@height_max}
+        MESSAGE
+      end
+
+      protected
+
+      def responds_to_methods
+        @subject.respond_to?(@attribute_name) &&
+          @subject.public_send(@attribute_name).respond_to?(:attach) &&
+          @subject.public_send(@attribute_name).respond_to?(:detach)
+      end
+
+      def valid_width
+        ((@width_min || 0) + (@width_max || 2000)) / 2
+      end
+
+      def valid_height
+        ((@height_min || 0) + (@height_max || 2000)) / 2
+      end
+
+      def width_smaller_than_min?
+        @width_min.nil? || !passes_validation_with_dimensions(@width_min - 1, valid_height, 'width')
+      end
+
+      def width_larger_than_min?
+        @width_min.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_min + 1, valid_height, 'width')
+      end
+
+      def width_smaller_than_max?
+        @width_max.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_max - 1, valid_height, 'width')
+      end
+
+      def width_larger_than_max?
+        @width_max.nil? || !passes_validation_with_dimensions(@width_max + 1, valid_height, 'width')
+      end
+
+      def width_equals?
+        @width_min.nil? || @width_min != @width_max || passes_validation_with_dimensions(@width_min, valid_height, 'width')
+      end
+
+      def height_smaller_than_min?
+        @height_min.nil? || !passes_validation_with_dimensions(valid_width, @height_min - 1, 'height')
+      end
+
+      def height_larger_than_min?
+        @height_min.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_min + 1, 'height')
+      end
+
+      def height_smaller_than_max?
+        @height_max.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_max - 1, 'height')
+      end
+
+      def height_larger_than_max?
+        @height_max.nil? || !passes_validation_with_dimensions(valid_width, @height_max + 1, 'height')
+      end
+
+      def height_equals?
+        @height_min.nil? || @height_min != @height_max || passes_validation_with_dimensions(valid_width, @height_min, 'height')
+      end
+
+      def passes_validation_with_dimensions(width, height, check)
+        @subject.public_send(@attribute_name).attach attachment_for(width, height)
+
+        attachment = @subject.public_send(@attribute_name)
+        Matchers.mock_metadata(attachment, width, height) do
+          @subject.validate
+          exclude_error_message = @custom_message || "dimension_#{check}"
+          @subject.errors.details[@attribute_name].all? { |error| error[:error].to_s.exclude?(exclude_error_message) }
+        end
+      end
+
+      def attachment_for(width, height)
+        { io: Tempfile.new('Hello world!'), filename: 'test.png', content_type: 'image/png' }
+      end
+    end
+  end
+end