active_storage_validations 1.0.4 → 1.1.4

data/lib/active_storage_validations/aspect_ratio_validator.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
 require_relative 'metadata.rb'
 
 module ActiveStorageValidations
   class AspectRatioValidator < ActiveModel::EachValidator # :nodoc
     include OptionProcUnfolding
+    include Errorable
+    include Symbolizable
 
     AVAILABLE_CHECKS = %i[with].freeze
-    PRECISION = 3
+    NAMED_ASPECT_RATIOS = %i[square portrait landscape].freeze
+    ASPECT_RATIO_REGEX = /is_([1-9]\d*)_([1-9]\d*)/.freeze
+    ERROR_TYPES = %i[
+      image_metadata_missing
+      aspect_ratio_not_square
+      aspect_ratio_not_portrait
+      aspect_ratio_not_landscape
+      aspect_ratio_is_not
+      aspect_ratio_unknown
+    ].freeze
+    PRECISION = 3.freeze
 
     def check_validity!
-      return true if AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
-      raise ArgumentError, 'You must pass :with to the validator'
+      ensure_at_least_one_validator_option
+      ensure_aspect_ratio_validity
     end
 
     if Rails.gem_version >= Gem::Version.new('6.0.0')
@@ -25,7 +39,7 @@ module ActiveStorageValidations
 
         files.each do |file|
           metadata = Metadata.new(file).metadata
-          next if is_valid?(record, attribute, metadata)
+          next if is_valid?(record, attribute, file, metadata)
           break
         end
       end
@@ -41,57 +55,73 @@ module ActiveStorageValidations
           file.analyze; file.reload unless file.analyzed?
           metadata = file.metadata
 
-          next if is_valid?(record, attribute, metadata)
+          next if is_valid?(record, attribute, file, metadata)
           break
         end
       end
     end
 
-
     private
 
-
-    def is_valid?(record, attribute, metadata)
+    def is_valid?(record, attribute, file, metadata)
       flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
+      errors_options = initialize_error_options(options, file)
+
       if metadata[:width].to_i <= 0 || metadata[:height].to_i <= 0
-        add_error(record, attribute, :image_metadata_missing, flat_options[:with])
+        errors_options[:aspect_ratio] = flat_options[:with]
+
+        add_error(record, attribute, :image_metadata_missing, **errors_options)
         return false
       end
 
       case flat_options[:with]
       when :square
         return true if metadata[:width] == metadata[:height]
-        add_error(record, attribute, :aspect_ratio_not_square, flat_options[:with])
+        errors_options[:aspect_ratio] = flat_options[:with]
+        add_error(record, attribute, :aspect_ratio_not_square, **errors_options)
 
       when :portrait
         return true if metadata[:height] > metadata[:width]
-        add_error(record, attribute, :aspect_ratio_not_portrait, flat_options[:with])
+        errors_options[:aspect_ratio] = flat_options[:with]
+        add_error(record, attribute, :aspect_ratio_not_portrait, **errors_options)
 
       when :landscape
         return true if metadata[:width] > metadata[:height]
-        add_error(record, attribute, :aspect_ratio_not_landscape, flat_options[:with])
+        errors_options[:aspect_ratio] = flat_options[:with]
+        add_error(record, attribute, :aspect_ratio_not_landscape, **errors_options)
 
-      else
-        if flat_options[:with] =~ /is_(\d*)_(\d*)/
-          x = $1.to_i
-          y = $2.to_i
+      when ASPECT_RATIO_REGEX
+        flat_options[:with] =~ ASPECT_RATIO_REGEX
+        x = $1.to_i
+        y = $2.to_i
 
-          return true if (x.to_f / y).round(PRECISION) == (metadata[:width].to_f / metadata[:height]).round(PRECISION)
+        return true if x > 0 && y > 0 && (x.to_f / y).round(PRECISION) == (metadata[:width].to_f / metadata[:height]).round(PRECISION)
 
-          add_error(record, attribute, :aspect_ratio_is_not, "#{x}x#{y}")
-        else
-          add_error(record, attribute, :aspect_ratio_unknown, flat_options[:with])
-        end
+        errors_options[:aspect_ratio] = "#{x}:#{y}"
+        add_error(record, attribute, :aspect_ratio_is_not, **errors_options)
+      else
+        errors_options[:aspect_ratio] = flat_options[:with]
+        add_error(record, attribute, :aspect_ratio_unknown, **errors_options)
+        return false
       end
-      false
     end
 
-
-    def add_error(record, attribute, default_message, interpolate)
-      message = options[:message].presence || default_message
-      return if record.errors.added?(attribute, message)
-      record.errors.add(attribute, message, aspect_ratio: interpolate)
+    def ensure_at_least_one_validator_option
+      unless AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
+        raise ArgumentError, 'You must pass :with to the validator'
+      end
     end
 
+    def ensure_aspect_ratio_validity
+      return true if options[:with]&.is_a?(Proc)
+
+      unless NAMED_ASPECT_RATIOS.include?(options[:with]) || options[:with] =~ ASPECT_RATIO_REGEX
+        raise ArgumentError, <<~ERROR_MESSAGE
+          You must pass a valid aspect ratio to the validator
+          It should either be a named aspect ratio (#{NAMED_ASPECT_RATIOS.join(', ')})
+          Or an aspect ratio like 'is_16_9' (matching /#{ASPECT_RATIO_REGEX.source}/)
+        ERROR_MESSAGE
+      end
+    end
   end
 end

data/lib/active_storage_validations/attached_validator.rb

@@ -1,14 +1,29 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
+
 module ActiveStorageValidations
   class AttachedValidator < ActiveModel::EachValidator # :nodoc:
-    def validate_each(record, attribute, _value)
-      return if record.send(attribute).attached?
+    include Errorable
+    include Symbolizable
+
+    ERROR_TYPES = %i[blank].freeze
 
-      errors_options = {}
-      errors_options[:message] = options[:message] if options[:message].present?
+    def check_validity!
+      %i(allow_nil allow_blank).each do |not_authorized_option|
+        if options.include?(not_authorized_option)
+          raise ArgumentError, "You cannot pass the :#{not_authorized_option} option to this validator"
+        end
+      end
+    end
+
+    def validate_each(record, attribute, _value)
+      return if record.send(attribute).attached? &&
+                !Array.wrap(record.send(attribute)).all? { |file| file.marked_for_destruction? }
 
-      record.errors.add(attribute, :blank, **errors_options)
+      errors_options = initialize_error_options(options)
+      add_error(record, attribute, ERROR_TYPES.first, **errors_options)
     end
   end
 end

data/lib/active_storage_validations/concerns/errorable.rb

@@ -0,0 +1,38 @@
+module ActiveStorageValidations
+  module Errorable
+    extend ActiveSupport::Concern
+
+    def initialize_error_options(options, file = nil)
+      not_explicitly_written_options = %i(with in)
+      curated_options = options.except(*not_explicitly_written_options)
+
+      active_storage_validations_options = {
+        validator_type: self.class.to_sym,
+        custom_message: (options[:message] if options[:message].present?),
+        filename: get_filename(file)
+      }.compact
+
+      curated_options.merge(active_storage_validations_options)
+    end
+
+    def add_error(record, attribute, error_type, **errors_options)
+      type = errors_options[:custom_message].presence || error_type
+      return if record.errors.added?(attribute, type)
+
+      # You can read https://api.rubyonrails.org/classes/ActiveModel/Errors.html#method-i-add
+      # to better understand how Rails model errors work
+      record.errors.add(attribute, type, **errors_options)
+    end
+
+    private
+
+    def get_filename(file)
+      return nil unless file
+
+      case file
+      when ActiveStorage::Attached then file.blob.filename.to_s
+      when Hash then file[:filename]
+      end
+    end
+  end
+end

data/lib/active_storage_validations/concerns/symbolizable.rb

@@ -0,0 +1,12 @@
+module ActiveStorageValidations
+  module Symbolizable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def to_sym
+        validator_class = self.name.split("::").last
+        validator_class.sub(/Validator/, '').underscore.to_sym
+      end
+    end
+  end
+end

data/lib/active_storage_validations/content_type_validator.rb

@@ -1,27 +1,37 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
+
 module ActiveStorageValidations
   class ContentTypeValidator < ActiveModel::EachValidator # :nodoc:
     include OptionProcUnfolding
+    include Errorable
+    include Symbolizable
 
     AVAILABLE_CHECKS = %i[with in].freeze
-    
+    ERROR_TYPES = %i[content_type_invalid].freeze
+
+    def check_validity!
+      ensure_exactly_one_validator_option
+      ensure_content_types_validity
+    end
+
     def validate_each(record, attribute, _value)
       return true unless record.send(attribute).attached?
 
       types = authorized_types(record)
       return true if types.empty?
-      
-      files = Array.wrap(record.send(attribute))
 
-      errors_options = { authorized_types: types_to_human_format(types) }
-      errors_options[:message] = options[:message] if options[:message].present?
+      files = Array.wrap(record.send(attribute))
 
       files.each do |file|
         next if is_valid?(file, types)
 
+        errors_options = initialize_error_options(options, file)
+        errors_options[:authorized_types] = types_to_human_format(types)
         errors_options[:content_type] = content_type(file)
-        record.errors.add(attribute, :content_type_invalid, **errors_options)
+        add_error(record, attribute, ERROR_TYPES.first, **errors_options)
         break
       end
     end
@@ -39,7 +49,7 @@ module ActiveStorageValidations
 
     def types_to_human_format(types)
       types
-        .map { |type| type.to_s.split('/').last.upcase }
+        .map { |type| type.is_a?(Regexp) ? type.source : type.to_s.split('/').last.upcase }
         .join(', ')
     end
 
@@ -53,5 +63,35 @@ module ActiveStorageValidations
         type == file_type || (type.is_a?(Regexp) && type.match?(file_type.to_s))
       end
     end
+
+    def ensure_exactly_one_validator_option
+      unless AVAILABLE_CHECKS.one? { |argument| options.key?(argument) }
+        raise ArgumentError, 'You must pass either :with or :in to the validator'
+      end
+    end
+
+    def ensure_content_types_validity
+      return true if options[:with]&.is_a?(Proc) || options[:in]&.is_a?(Proc)
+
+      ([options[:with]] || options[:in]).each do |content_type|
+        raise ArgumentError, invalid_content_type_message(content_type) if invalid_content_type?(content_type)
+      end
+    end
+
+    def invalid_content_type_message(content_type)
+      <<~ERROR_MESSAGE
+        You must pass valid content types to the validator
+        '#{content_type}' is not find in Marcel::EXTENSIONS mimes
+      ERROR_MESSAGE
+    end
+
+    def invalid_content_type?(content_type)
+      case content_type
+      when String, Symbol
+        Marcel::MimeType.for(declared_type: content_type.to_s, extension: content_type.to_s) == 'application/octet-stream'
+      when Regexp
+        false # We always validate regexes
+      end
+    end
   end
 end

data/lib/active_storage_validations/dimension_validator.rb

@@ -1,12 +1,29 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
 require_relative 'metadata.rb'
 
 module ActiveStorageValidations
   class DimensionValidator < ActiveModel::EachValidator # :nodoc
     include OptionProcUnfolding
+    include Errorable
+    include Symbolizable
 
     AVAILABLE_CHECKS = %i[width height min max].freeze
+    ERROR_TYPES = %i[
+      image_metadata_missing
+      dimension_min_inclusion
+      dimension_max_inclusion
+      dimension_width_inclusion
+      dimension_height_inclusion
+      dimension_width_greater_than_or_equal_to
+      dimension_height_greater_than_or_equal_to
+      dimension_width_less_than_or_equal_to
+      dimension_height_less_than_or_equal_to
+      dimension_width_equal_to
+      dimension_height_equal_to
+    ].freeze
 
     def process_options(record)
       flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
@@ -30,10 +47,10 @@ module ActiveStorageValidations
       flat_options
     end
 
-
     def check_validity!
-      return true if AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
-      raise ArgumentError, 'You must pass either :width, :height, :min or :max to the validator'
+      unless AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
+        raise ArgumentError, 'You must pass either :width, :height, :min or :max to the validator'
+      end
     end
 
 
@@ -47,7 +64,7 @@ module ActiveStorageValidations
         files = Array.wrap(changes.is_a?(ActiveStorage::Attached::Changes::CreateMany) ? changes.attachables : changes.attachable)
         files.each do |file|
           metadata = Metadata.new(file).metadata
-          next if is_valid?(record, attribute, metadata)
+          next if is_valid?(record, attribute, file, metadata)
           break
         end
       end
@@ -61,60 +78,81 @@ module ActiveStorageValidations
           # Analyze file first if not analyzed to get all required metadata.
           file.analyze; file.reload unless file.analyzed?
           metadata = file.metadata rescue {}
-          next if is_valid?(record, attribute, metadata)
+          next if is_valid?(record, attribute, file, metadata)
           break
         end
       end
     end
 
 
-    def is_valid?(record, attribute, file_metadata)
+    def is_valid?(record, attribute, file, metadata)
       flat_options = process_options(record)
+      errors_options = initialize_error_options(options, file)
+
       # Validation fails unless file metadata contains valid width and height.
-      if file_metadata[:width].to_i <= 0 || file_metadata[:height].to_i <= 0
-        add_error(record, attribute, :image_metadata_missing)
+      if metadata[:width].to_i <= 0 || metadata[:height].to_i <= 0
+        add_error(record, attribute, :image_metadata_missing, **errors_options)
         return false
       end
 
       # Validation based on checks :min and :max (:min, :max has higher priority to :width, :height).
       if flat_options[:min] || flat_options[:max]
         if flat_options[:min] && (
-          (flat_options[:width][:min] && file_metadata[:width] < flat_options[:width][:min]) ||
-          (flat_options[:height][:min] && file_metadata[:height] < flat_options[:height][:min])
+          (flat_options[:width][:min] && metadata[:width] < flat_options[:width][:min]) ||
+          (flat_options[:height][:min] && metadata[:height] < flat_options[:height][:min])
           )
-          add_error(record, attribute, :dimension_min_inclusion, width: flat_options[:width][:min], height: flat_options[:height][:min])
+          errors_options[:width] = flat_options[:width][:min]
+          errors_options[:height] = flat_options[:height][:min]
+
+          add_error(record, attribute, :dimension_min_inclusion, **errors_options)
           return false
         end
         if flat_options[:max] && (
-          (flat_options[:width][:max] && file_metadata[:width] > flat_options[:width][:max]) ||
-          (flat_options[:height][:max] && file_metadata[:height] > flat_options[:height][:max])
+          (flat_options[:width][:max] && metadata[:width] > flat_options[:width][:max]) ||
+          (flat_options[:height][:max] && metadata[:height] > flat_options[:height][:max])
           )
-          add_error(record, attribute, :dimension_max_inclusion, width: flat_options[:width][:max], height: flat_options[:height][:max])
+          errors_options[:width] = flat_options[:width][:max]
+          errors_options[:height] = flat_options[:height][:max]
+
+          add_error(record, attribute, :dimension_max_inclusion, **errors_options)
           return false
         end
 
       # Validation based on checks :width and :height.
       else
         width_or_height_invalid = false
+
         [:width, :height].each do |length|
           next unless flat_options[length]
           if flat_options[length].is_a?(Hash)
-            if flat_options[length][:in] && (file_metadata[length] < flat_options[length][:min] || file_metadata[length] > flat_options[length][:max])
-              add_error(record, attribute, :"dimension_#{length}_inclusion", min: flat_options[length][:min], max: flat_options[length][:max])
+            if flat_options[length][:in] && (metadata[length] < flat_options[length][:min] || metadata[length] > flat_options[length][:max])
+              error_type = :"dimension_#{length}_inclusion"
+              errors_options[:min] = flat_options[length][:min]
+              errors_options[:max] = flat_options[length][:max]
+
+              add_error(record, attribute, error_type, **errors_options)
               width_or_height_invalid = true
             else
-              if flat_options[length][:min] && file_metadata[length] < flat_options[length][:min]
-                add_error(record, attribute, :"dimension_#{length}_greater_than_or_equal_to", length: flat_options[length][:min])
+              if flat_options[length][:min] && metadata[length] < flat_options[length][:min]
+                error_type = :"dimension_#{length}_greater_than_or_equal_to"
+                errors_options[:length] = flat_options[length][:min]
+
+                add_error(record, attribute, error_type, **errors_options)
                 width_or_height_invalid = true
-              end
-              if flat_options[length][:max] && file_metadata[length] > flat_options[length][:max]
-                add_error(record, attribute, :"dimension_#{length}_less_than_or_equal_to", length: flat_options[length][:max])
+              elsif flat_options[length][:max] && metadata[length] > flat_options[length][:max]
+                error_type = :"dimension_#{length}_less_than_or_equal_to"
+                errors_options[:length] = flat_options[length][:max]
+
+                add_error(record, attribute, error_type, **errors_options)
                 width_or_height_invalid = true
               end
             end
           else
-            if file_metadata[length] != flat_options[length]
-              add_error(record, attribute, :"dimension_#{length}_equal_to", length: flat_options[length])
+            if metadata[length] != flat_options[length]
+              error_type = :"dimension_#{length}_equal_to"
+              errors_options[:length] = flat_options[length]
+
+              add_error(record, attribute, error_type, **errors_options)
               width_or_height_invalid = true
             end
           end
@@ -125,12 +163,5 @@ module ActiveStorageValidations
 
       true # valid file
     end
-
-    def add_error(record, attribute, default_message, **attrs)
-      message = options[:message].presence || default_message
-      return if record.errors.added?(attribute, message)
-      record.errors.add(attribute, message, **attrs)
-    end
-
   end
 end

data/lib/active_storage_validations/limit_validator.rb

@@ -1,25 +1,38 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
+
 module ActiveStorageValidations
   class LimitValidator < ActiveModel::EachValidator # :nodoc:
     include OptionProcUnfolding
+    include Errorable
+    include Symbolizable
 
     AVAILABLE_CHECKS = %i[max min].freeze
+    ERROR_TYPES = %i[
+      limit_out_of_range
+    ].freeze
 
     def check_validity!
-      return true if AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
-      raise ArgumentError, 'You must pass either :max or :min to the validator'
+      ensure_at_least_one_validator_option
+      ensure_arguments_validity
     end
 
     def validate_each(record, attribute, _)
-      files = Array.wrap(record.send(attribute)).compact.uniq
+      files = Array.wrap(record.send(attribute)).reject { |file| file.blank? }.compact.uniq
       flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
-      errors_options = { min: flat_options[:min], max: flat_options[:max] }
 
       return true if files_count_valid?(files.count, flat_options)
-      record.errors.add(attribute, options[:message].presence || :limit_out_of_range, **errors_options)
+
+      errors_options = initialize_error_options(options)
+      errors_options[:min] = flat_options[:min]
+      errors_options[:max] = flat_options[:max]
+      add_error(record, attribute, ERROR_TYPES.first, **errors_options)
     end
 
+    private
+
     def files_count_valid?(count, flat_options)
       if flat_options[:max].present? && flat_options[:min].present?
         count >= flat_options[:min] && count <= flat_options[:max]
@@ -29,5 +42,36 @@ module ActiveStorageValidations
         count >= flat_options[:min]
       end
     end
+
+    def ensure_at_least_one_validator_option
+      unless AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
+        raise ArgumentError, 'You must pass either :max or :min to the validator'
+      end
+    end
+
+    def ensure_arguments_validity
+      return true if min_max_are_proc? || min_or_max_is_proc_and_other_not_present?
+
+      raise ArgumentError, 'You must pass integers to :min and :max' if min_or_max_defined_and_not_integer?
+      raise ArgumentError, 'You must pass a higher value to :max than to :min' if min_higher_than_max?
+    end
+
+    def min_max_are_proc?
+      options[:min]&.is_a?(Proc) && options[:max]&.is_a?(Proc)
+    end
+
+    def min_or_max_is_proc_and_other_not_present?
+      (options[:min]&.is_a?(Proc) && options[:max].nil?) ||
+        (options[:min].nil? && options[:max]&.is_a?(Proc))
+    end
+
+    def min_or_max_defined_and_not_integer?
+      (options.key?(:min) && !options[:min].is_a?(Integer)) ||
+        (options.key?(:max) && !options[:max].is_a?(Integer))
+    end
+
+    def min_higher_than_max?
+      options[:min] > options[:max] if options[:min].is_a?(Integer) && options[:max].is_a?(Integer)
+    end
   end
 end