active_storage_validations 3.0.5 → 4.1.0

data/lib/active_storage_validations/content_type_validator.rb

@@ -6,7 +6,6 @@ require_relative "shared/asv_attachable"
 require_relative "shared/asv_errorable"
 require_relative "shared/asv_optionable"
 require_relative "shared/asv_symbolizable"
-require_relative "analyzer/content_type_analyzer"
 
 module ActiveStorageValidations
   class ContentTypeValidator < ActiveModel::EachValidator # :nodoc:
@@ -18,6 +17,7 @@ module ActiveStorageValidations
     include ASVSymbolizable
 
     AVAILABLE_CHECKS = %i[with in].freeze
+    AVAILABLE_SPOOFING_PROTECTION_VALUES = [ true, false, :file, :magika ].freeze
     ERROR_TYPES = %i[
       content_type_invalid
       content_type_spoofed
@@ -27,6 +27,7 @@ module ActiveStorageValidations
     def check_validity!
       ensure_exactly_one_validator_option
       ensure_content_types_validity
+      ensure_spoofing_protection_validity
     end
 
     def validate_each(record, attribute, _value)
@@ -125,7 +126,25 @@ module ActiveStorageValidations
     end
 
     def enable_spoofing_protection?
-      options[:spoofing_protection] == true
+      spoofing_protection_backend.present?
+    end
+
+    # +true+ and +:file+ both select the UNIX +file+ CLI; +:magika+ selects Magika.
+    def spoofing_protection_backend
+      case options[:spoofing_protection]
+      when true, :file then :file
+      when :magika then :magika
+      end
+    end
+
+    def ensure_spoofing_protection_validity
+      return unless options.key?(:spoofing_protection)
+      return if AVAILABLE_SPOOFING_PROTECTION_VALUES.include?(options[:spoofing_protection])
+
+      raise ArgumentError, <<~ERROR_MESSAGE
+        Unknown spoofing_protection option: #{options[:spoofing_protection].inspect}.
+        Allowed values: #{AVAILABLE_SPOOFING_PROTECTION_VALUES.map(&:inspect).join(", ")}
+      ERROR_MESSAGE
     end
 
     def attachable_content_type_vs_detected_content_type_mismatch?
@@ -134,10 +153,9 @@ module ActiveStorageValidations
     end
 
     def attachable_content_type_intersects_detected_content_type?
-      # Ruby intersects? method is only available from 3.1
-      enlarged_content_type(content_type_without_parameters(@attachable_content_type)).any? do |item|
-        enlarged_content_type(content_type_without_parameters(@detected_content_type)).include?(item)
-      end
+      enlarged_content_type(content_type_without_parameters(@attachable_content_type)).intersect?(
+        enlarged_content_type(content_type_without_parameters(@detected_content_type))
+      )
     end
 
     def enlarged_content_type(content_type)

data/lib/active_storage_validations/dimension_validator.rb

@@ -215,8 +215,10 @@ module ActiveStorageValidations
 
       %i[min max].each do |bound|
         if (range = flat_options[bound])
-          flat_options[:width] = { bound => range.first }
-          flat_options[:height] = { bound => range.last }
+          flat_options[:width] ||= {}
+          flat_options[:height] ||= {}
+          flat_options[:width][bound] = range.first
+          flat_options[:height][bound] = range.last
         end
       end
 

data/lib/active_storage_validations/form_builder.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  module FormBuilder
+    def file_field(method, options = {})
+      options = options.symbolize_keys
+      infer_accept = options.delete(:infer_accept)
+      infer_accept = ActiveStorageValidations.infer_file_field_accept if infer_accept.nil?
+
+      if infer_accept && !options.key?(:accept)
+        accept = inferred_accept_types(method)
+        options[:accept] = accept.join(",") if accept.any?
+      end
+
+      super(method, options)
+    end
+
+    private
+
+    def inferred_accept_types(method)
+      return [] unless @object.class.respond_to?(:validators_on)
+
+      content_type_validators = @object.class.validators_on(method).select do |v|
+        v.is_a?(ActiveStorageValidations::ContentTypeValidator)
+      end
+
+      content_type_validators.flat_map do |validator|
+        types = Array(validator.options[:with]) + Array(validator.options[:in])
+        types.filter_map do |type|
+          case type
+          when String
+            type.include?("/") ? type : Marcel::MimeType.for(declared_type: type, extension: type)
+          when Symbol
+            Marcel::MimeType.for(declared_type: type.to_s, extension: type.to_s)
+          when Regexp
+            match = type.source.match(%r{\A\\A([a-z]+)/\.\*\\z\z})
+            "#{match[1]}/*" if match
+          end
+        end
+      end.uniq
+    end
+  end
+end

data/lib/active_storage_validations/matchers/aspect_ratio_validator_matcher.rb

@@ -4,8 +4,10 @@ require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_allow_blankable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
+require_relative "shared/asv_timeoutable"
 require_relative "shared/asv_validatable"
 
 module ActiveStorageValidations
@@ -19,15 +21,19 @@ module ActiveStorageValidations
       include ASVAllowBlankable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
+      include ASVTimeoutable
       include ASVValidatable
 
       def initialize(attribute_name)
         initialize_allow_blankable
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
+        initialize_timeoutable
         @attribute_name = attribute_name
         @allowed_aspect_ratios = @rejected_aspect_ratios = []
       end
@@ -55,7 +61,9 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
           is_allowing_blank? &&
+          is_timeout_valid? &&
           is_custom_message_valid? &&
           all_allowed_aspect_ratios_allowed? &&
           all_rejected_aspect_ratios_rejected?

data/lib/active_storage_validations/matchers/attached_validator_matcher.rb

@@ -3,6 +3,7 @@
 require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
 require_relative "shared/asv_validatable"
@@ -17,12 +18,14 @@ module ActiveStorageValidations
       include ASVActiveStorageable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
       include ASVValidatable
 
       def initialize(attribute_name)
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
         @attribute_name = attribute_name
@@ -41,6 +44,7 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
           is_custom_message_valid? &&
           is_valid_when_file_attached? &&
           is_invalid_when_file_not_attached?

data/lib/active_storage_validations/matchers/base_comparison_validator_matcher.rb

@@ -7,6 +7,7 @@ require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_allow_blankable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
 require_relative "shared/asv_validatable"
@@ -20,6 +21,7 @@ module ActiveStorageValidations
       include ASVAllowBlankable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
       include ASVValidatable
@@ -27,6 +29,7 @@ module ActiveStorageValidations
       def initialize(attribute_name)
         initialize_allow_blankable
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
         @attribute_name = attribute_name
@@ -68,17 +71,24 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
           is_allowing_blank? &&
           is_custom_message_valid? &&
           not_lower_than_min? &&
           higher_than_min? &&
           lower_than_max? &&
           not_higher_than_max? &&
-          equal_to_exact?
+          equal_to_exact? &&
+          is_timeout_valid?
       end
 
       protected
 
+      # Hook for ASVTimeoutable (Duration / Pages). Size / TotalSize leave this as-is.
+      def is_timeout_valid?
+        true
+      end
+
       def build_failure_message(message)
         return unless @failure_message_artefacts.present?
 

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -7,8 +7,11 @@ require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_allow_blankable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
+require_relative "shared/asv_spoofing_protectable"
+require_relative "shared/asv_timeoutable"
 require_relative "shared/asv_validatable"
 
 module ActiveStorageValidations
@@ -22,15 +25,21 @@ module ActiveStorageValidations
       include ASVAllowBlankable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
+      include ASVSpoofingProtectable
+      include ASVTimeoutable
       include ASVValidatable
 
       def initialize(attribute_name)
         initialize_allow_blankable
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
+        initialize_spoofing_protectable
+        initialize_timeoutable
         @attribute_name = attribute_name
         @allowed_content_types = @rejected_content_types = []
       end
@@ -62,7 +71,10 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
           is_allowing_blank? &&
+          is_timeout_valid? &&
+          is_spoofing_protection_valid? &&
           is_custom_message_valid? &&
           all_allowed_content_types_allowed? &&
           all_rejected_content_types_rejected?

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -4,8 +4,10 @@ require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_allow_blankable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
+require_relative "shared/asv_timeoutable"
 require_relative "shared/asv_validatable"
 
 module ActiveStorageValidations
@@ -19,15 +21,19 @@ module ActiveStorageValidations
       include ASVAllowBlankable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
+      include ASVTimeoutable
       include ASVValidatable
 
       def initialize(attribute_name)
         initialize_allow_blankable
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
+        initialize_timeoutable
         @attribute_name = attribute_name
         @width_min = @width_max = @height_min = @height_max = nil
       end
@@ -87,7 +93,9 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
           is_allowing_blank? &&
+          is_timeout_valid? &&
           is_custom_message_valid? &&
           width_not_smaller_than_min? &&
           width_larger_than_min? &&

data/lib/active_storage_validations/matchers/duration_validator_matcher.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "base_comparison_validator_matcher"
+require_relative "shared/asv_timeoutable"
 
 module ActiveStorageValidations
   module Matchers
@@ -9,6 +10,13 @@ module ActiveStorageValidations
     end
 
     class DurationValidatorMatcher < BaseComparisonValidatorMatcher
+      include ASVTimeoutable
+
+      def initialize(attribute_name)
+        super
+        initialize_timeoutable
+      end
+
       def description
         "validate file duration of :#{@attribute_name}"
       end

data/lib/active_storage_validations/matchers/limit_validator_matcher.rb

@@ -4,6 +4,7 @@ require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_allow_blankable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
 require_relative "shared/asv_validatable"
@@ -19,6 +20,7 @@ module ActiveStorageValidations
       include ASVAllowBlankable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
       include ASVValidatable
@@ -26,6 +28,7 @@ module ActiveStorageValidations
       def initialize(attribute_name)
         initialize_allow_blankable
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
         @attribute_name = attribute_name
@@ -57,6 +60,7 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
           is_custom_message_valid? &&
           file_count_not_smaller_than_min? &&
           file_count_equal_min? &&

data/lib/active_storage_validations/matchers/pages_validator_matcher.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "base_comparison_validator_matcher"
+require_relative "shared/asv_timeoutable"
 
 module ActiveStorageValidations
   module Matchers
@@ -9,6 +10,13 @@ module ActiveStorageValidations
     end
 
     class PagesValidatorMatcher < BaseComparisonValidatorMatcher
+      include ASVTimeoutable
+
+      def initialize(attribute_name)
+        super
+        initialize_timeoutable
+      end
+
       def description
         "validate file number of pages of :#{@attribute_name}"
       end

data/lib/active_storage_validations/matchers/processable_file_validator_matcher.rb

@@ -4,8 +4,10 @@ require_relative "shared/asv_active_storageable"
 require_relative "shared/asv_allow_blankable"
 require_relative "shared/asv_attachable"
 require_relative "shared/asv_contextable"
+require_relative "shared/asv_except_onable"
 require_relative "shared/asv_messageable"
 require_relative "shared/asv_rspecable"
+require_relative "shared/asv_timeoutable"
 require_relative "shared/asv_validatable"
 
 module ActiveStorageValidations
@@ -19,15 +21,19 @@ module ActiveStorageValidations
       include ASVAllowBlankable
       include ASVAttachable
       include ASVContextable
+      include ASVExceptOnable
       include ASVMessageable
       include ASVRspecable
+      include ASVTimeoutable
       include ASVValidatable
 
       def initialize(attribute_name)
         initialize_allow_blankable
         initialize_contextable
+        initialize_except_onable
         initialize_messageable
         initialize_rspecable
+        initialize_timeoutable
         @attribute_name = attribute_name
       end
 
@@ -44,6 +50,8 @@ module ActiveStorageValidations
 
         is_a_valid_active_storage_attribute? &&
           is_context_valid? &&
+          is_except_on_valid? &&
+          is_timeout_valid? &&
           is_custom_message_valid? &&
           is_valid_when_image_processable? &&
           is_invalid_when_file_not_processable?

data/lib/active_storage_validations/matchers/shared/asv_except_onable.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVExceptOnable
+      extend ActiveSupport::Concern
+
+      def initialize_except_onable
+        @except_on = nil
+      end
+
+      def except_on(context)
+        @except_on = context
+        self
+      end
+
+      private
+
+      def is_except_on_valid?
+        return true if !@except_on && attribute_validators.none? { |validator| validator.options[:except_on] }
+
+        ensure_except_on_present!
+        ensure_except_on_valid!
+
+        if @except_on.is_a?(Array)
+          (validator_except_on_contexts & @except_on.map(&:to_s)) == validator_except_on_contexts || raise_except_on_not_listed_error
+        elsif @except_on.is_a?(Symbol)
+          validator_except_on_contexts.include?(@except_on.to_s) || raise_except_on_not_listed_error
+        end
+      end
+
+      def ensure_except_on_present!
+        raise ArgumentError, "This validator matcher needs the #except_on option to work since its validator has one" if !@except_on && attribute_validators.all? { |validator| validator.options[:except_on] }
+      end
+
+      def ensure_except_on_valid!
+        raise ArgumentError, "This validator matcher option only allows a symbol or an array" if !(@except_on.is_a?(Symbol) || @except_on.is_a?(Array))
+      end
+
+      def validator_except_on_contexts
+        attribute_validators.map do |validator|
+          case validator.options[:except_on]
+          when Array then validator.options[:except_on].map { |context| context.to_s }
+          when NilClass then nil
+          else validator.options[:except_on].to_s
+          end
+        end.flatten.compact
+      end
+
+      def raise_except_on_not_listed_error
+        raise ArgumentError, "One of the provided contexts to the #except_on method is not found in any of the listed contexts for this attribute"
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/shared/asv_spoofing_protectable.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVSpoofingProtectable
+      extend ActiveSupport::Concern
+
+      UNSET = Object.new.freeze
+
+      def initialize_spoofing_protectable
+        @spoofing_protection = UNSET
+      end
+
+      def spoofing_protection(value = true)
+        @spoofing_protection = value
+        self
+      end
+
+      private
+
+      def is_spoofing_protection_valid?
+        return true if @spoofing_protection.equal?(UNSET)
+
+        expected = normalize_spoofing_protection(@spoofing_protection)
+        attribute_validators.any? do |validator|
+          next false unless validator.options.key?(:spoofing_protection)
+
+          normalize_spoofing_protection(validator.options[:spoofing_protection]) == expected
+        end
+      end
+
+      def normalize_spoofing_protection(value)
+        case value
+        when true, :file then :file
+        when :magika then :magika
+        when false then false
+        else value
+        end
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/shared/asv_timeoutable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVTimeoutable
+      extend ActiveSupport::Concern
+
+      UNSET = Object.new.freeze
+
+      def initialize_timeoutable
+        @timeout = UNSET
+      end
+
+      def timeout(value)
+        @timeout = value
+        self
+      end
+
+      private
+
+      def is_timeout_valid?
+        return true if @timeout.equal?(UNSET)
+
+        attribute_validators.any? do |validator|
+          validator.options.key?(:timeout) && validator.options[:timeout] == @timeout
+        end
+      end
+    end
+  end
+end