active_storage_validations 1.0.4 → 1.1.4

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/active_storageable.rb'
+require_relative 'concerns/allow_blankable.rb'
+require_relative 'concerns/contextable.rb'
+require_relative 'concerns/messageable.rb'
+require_relative 'concerns/rspecable.rb'
+require_relative 'concerns/validatable.rb'
+
 module ActiveStorageValidations
   module Matchers
     def validate_dimensions_of(name)
@@ -7,14 +14,35 @@ module ActiveStorageValidations
     end
 
     class DimensionValidatorMatcher
+      include ActiveStorageable
+      include AllowBlankable
+      include Contextable
+      include Messageable
+      include Rspecable
+      include Validatable
+
       def initialize(attribute_name)
+        initialize_allow_blankable
+        initialize_contextable
+        initialize_messageable
+        initialize_rspecable
         @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}"
+        "validate the image dimensions of :#{@attribute_name}"
+      end
+
+      def failure_message
+        message = ["is expected to validate dimensions of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
+      end
+
+      def width(width)
+        @width_min = @width_max = width
+        self
       end
 
       def width_min(width)
@@ -27,13 +55,13 @@ module ActiveStorageValidations
         self
       end
 
-      def with_message(message)
-        @custom_message = message
+      def width_between(range)
+        @width_min, @width_max = range.first, range.last
         self
       end
 
-      def width(width)
-        @width_min = @width_max = width
+      def height(height)
+        @height_min = @height_max = height
         self
       end
 
@@ -47,42 +75,40 @@ module ActiveStorageValidations
         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_not_smaller_than_min? && width_larger_than_min? && width_smaller_than_max? && width_not_larger_than_max? && width_equals? &&
-          height_not_smaller_than_min? && height_larger_than_min? && height_smaller_than_max? && height_not_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
+        is_a_valid_active_storage_attribute? &&
+          is_context_valid? &&
+          is_allowing_blank? &&
+          is_custom_message_valid? &&
+          width_not_smaller_than_min? &&
+          width_larger_than_min? &&
+          width_smaller_than_max? &&
+          width_not_larger_than_max? &&
+          width_equals? &&
+          height_not_smaller_than_min? &&
+          height_larger_than_min? &&
+          height_smaller_than_max? &&
+          height_not_larger_than_max? &&
+          height_equals?
       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)
+      def build_failure_message(message)
+        return unless @failure_message_artefacts.present?
+
+        message << "  but there seem to have issues with the matcher methods you used, since:"
+        @failure_message_artefacts.each do |error_case|
+          message << "  validation failed when provided with a #{error_case[:width]}x#{error_case[:height]}px test image"
+        end
+        message << "  whereas it should have passed"
       end
 
       def valid_width
@@ -94,62 +120,83 @@ module ActiveStorageValidations
       end
 
       def width_not_smaller_than_min?
-        @width_min.nil? || !passes_validation_with_dimensions(@width_min - 1, valid_height, 'width')
+        @width_min.nil? || !passes_validation_with_dimensions(@width_min - 1, valid_height)
       end
 
       def width_larger_than_min?
-        @width_min.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_min + 1, valid_height, 'width')
+        @width_min.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_min + 1, valid_height)
       end
 
       def width_smaller_than_max?
-        @width_max.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_max - 1, valid_height, 'width')
+        @width_max.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_max - 1, valid_height)
       end
 
       def width_not_larger_than_max?
-        @width_max.nil? || !passes_validation_with_dimensions(@width_max + 1, valid_height, 'width')
+        @width_max.nil? || !passes_validation_with_dimensions(@width_max + 1, valid_height)
       end
 
       def width_equals?
-        @width_min.nil? || @width_min != @width_max || passes_validation_with_dimensions(@width_min, valid_height, 'width')
+        @width_min.nil? || @width_min != @width_max || passes_validation_with_dimensions(@width_min, valid_height)
       end
 
       def height_not_smaller_than_min?
-        @height_min.nil? || !passes_validation_with_dimensions(valid_width, @height_min - 1, 'height')
+        @height_min.nil? || !passes_validation_with_dimensions(valid_width, @height_min - 1)
       end
 
       def height_larger_than_min?
-        @height_min.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_min + 1, 'height')
+        @height_min.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_min + 1)
       end
 
       def height_smaller_than_max?
-        @height_max.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_max - 1, 'height')
+        @height_max.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_max - 1)
       end
 
       def height_not_larger_than_max?
-        @height_max.nil? || !passes_validation_with_dimensions(valid_width, @height_max + 1, 'height')
+        @height_max.nil? || !passes_validation_with_dimensions(valid_width, @height_max + 1)
       end
 
       def height_equals?
-        @height_min.nil? || @height_min != @height_max || passes_validation_with_dimensions(valid_width, @height_min, 'height')
+        @height_min.nil? || @height_min != @height_max || passes_validation_with_dimensions(valid_width, @height_min)
       end
 
-      def passes_validation_with_dimensions(width, height, check)
-        @subject.public_send(@attribute_name).attach attachment_for(width, height)
+      def passes_validation_with_dimensions(width, height)
+        mock_dimensions_for(attach_file, width, height) do
+          validate
+          is_valid? || add_failure_message_artefact(width, height)
+        end
+      end
+
+      def add_failure_message_artefact(width, height)
+        @failure_message_artefacts << { width: width, height: height }
+        false
+      end
+
+      def is_custom_message_valid?
+        return true unless @custom_message
 
-        attachment = @subject.public_send(@attribute_name)
+        mock_dimensions_for(attach_file, -1, -1) do
+          validate
+          has_an_error_message_which_is_custom_message?
+        end
+      end
+
+      def mock_dimensions_for(attachment, width, height)
         Matchers.mock_metadata(attachment, width, height) do
-          @subject.validate
-          exclude_error_message = @custom_message || "dimension_#{check}"
-          @subject.errors.details[@attribute_name].none? do |error|
-            error[:error].to_s.include?(exclude_error_message) ||
-            error[:error].to_s.include?("dimension_min") ||
-            error[:error].to_s.include?("dimension_max")
-          end
+          yield
         end
       end
 
-      def attachment_for(width, height)
-        { io: Tempfile.new('Hello world!'), filename: 'test.png', content_type: 'image/png' }
+      def attach_file
+        @subject.public_send(@attribute_name).attach(dummy_file)
+        @subject.public_send(@attribute_name)
+      end
+
+      def dummy_file
+        {
+          io: Tempfile.new('Hello world!'),
+          filename: 'test.png',
+          content_type: 'image/png'
+        }
       end
     end
   end

data/lib/active_storage_validations/matchers/size_validator_matcher.rb

@@ -2,6 +2,14 @@
 
 # Big thank you to the paperclip validation matchers:
 # https://github.com/thoughtbot/paperclip/blob/v6.1.0/lib/paperclip/matchers/validate_attachment_size_matcher.rb
+
+require_relative 'concerns/active_storageable.rb'
+require_relative 'concerns/allow_blankable.rb'
+require_relative 'concerns/contextable.rb'
+require_relative 'concerns/messageable.rb'
+require_relative 'concerns/rspecable.rb'
+require_relative 'concerns/validatable.rb'
+
 module ActiveStorageValidations
   module Matchers
     def validate_size_of(name)
@@ -9,85 +17,142 @@ module ActiveStorageValidations
     end
 
     class SizeValidatorMatcher
+      include ActiveStorageable
+      include AllowBlankable
+      include Contextable
+      include Messageable
+      include Rspecable
+      include Validatable
+
       def initialize(attribute_name)
+        initialize_allow_blankable
+        initialize_contextable
+        initialize_messageable
+        initialize_rspecable
         @attribute_name = attribute_name
-        @low = @high = nil
+        @min = @max = nil
       end
 
       def description
-        "validate file size of #{@attribute_name}"
+        "validate file size of :#{@attribute_name}"
+      end
+
+      def failure_message
+        message = ["is expected to validate file size of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
       end
 
       def less_than(size)
-        @high = size - 1.byte
+        @max = size - 1.byte
         self
       end
 
       def less_than_or_equal_to(size)
-        @high = size
+        @max = size
         self
       end
 
       def greater_than(size)
-        @low = size + 1.byte
+        @min = size + 1.byte
         self
       end
 
       def greater_than_or_equal_to(size)
-        @low = size
+        @min = size
         self
       end
 
       def between(range)
-        @low, @high = range.first, range.last
+        @min, @max = range.first, range.last
         self
       end
 
       def matches?(subject)
         @subject = subject.is_a?(Class) ? subject.new : subject
-        responds_to_methods && lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
+
+        is_a_valid_active_storage_attribute? &&
+          is_context_valid? &&
+          is_allowing_blank? &&
+          is_custom_message_valid? &&
+          not_lower_than_min? &&
+          higher_than_min? &&
+          lower_than_max? &&
+          not_higher_than_max?
       end
 
-      def failure_message
-        "is expected to validate file size of #{@attribute_name} to be between #{@low} and #{@high} bytes"
+      protected
+
+      def build_failure_message(message)
+        return unless @failure_message_artefacts.present?
+
+        message << "  but there seem to have issues with the matcher methods you used, since:"
+        @failure_message_artefacts.each do |error_case|
+          message << "  validation failed when provided with a #{error_case[:size]} bytes test file"
+        end
+        message << "  whereas it should have passed"
       end
 
-      def failure_message_when_negated
-        "is expected to not validate file size of #{@attribute_name} to be between #{@low} and #{@high} bytes"
+      def not_lower_than_min?
+        @min.nil? || !passes_validation_with_size(@min - 1)
       end
 
-      protected
+      def higher_than_min?
+        @min.nil? || passes_validation_with_size(@min + 1)
+      end
 
-      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)
+      def lower_than_max?
+        @max.nil? || @max == Float::INFINITY || passes_validation_with_size(@max - 1)
       end
 
-      def lower_than_low?
-        @low.nil? || !passes_validation_with_size(@low - 1)
+      def not_higher_than_max?
+        @max.nil? || @max == Float::INFINITY || !passes_validation_with_size(@max + 1)
       end
 
-      def higher_than_low?
-        @low.nil? || passes_validation_with_size(@low + 1)
+      def passes_validation_with_size(size)
+        mock_size_for(io, size) do
+          attach_file
+          validate
+          is_valid? || add_failure_message_artefact(size)
+        end
       end
 
-      def lower_than_high?
-        @high.nil? || @high == Float::INFINITY || passes_validation_with_size(@high - 1)
+      def add_failure_message_artefact(size)
+        @failure_message_artefacts << { size: size }
+        false
       end
 
-      def higher_than_high?
-        @high.nil? || @high == Float::INFINITY || !passes_validation_with_size(@high + 1)
+      def is_custom_message_valid?
+        return true unless @custom_message
+
+        mock_size_for(io, -1.kilobytes) do
+          attach_file
+          validate
+          has_an_error_message_which_is_custom_message?
+        end
       end
 
-      def passes_validation_with_size(new_size)
-        io = Tempfile.new('Hello world!')
-        Matchers.stub_method(io, :size, new_size) do
-          @subject.public_send(@attribute_name).attach(io: io, filename: 'test.png', content_type: 'image/pg')
-          @subject.validate
-          @subject.errors.details[@attribute_name].all? { |error| error[:error] != :file_size_out_of_range }
+      def mock_size_for(io, size)
+        Matchers.stub_method(io, :size, size) do
+          yield
         end
       end
+
+      def attach_file
+        @subject.public_send(@attribute_name).attach(dummy_file)
+      end
+
+      def dummy_file
+        {
+          io: io,
+          filename: 'test.png',
+          content_type: 'image/png'
+        }
+      end
+
+      def io
+        @io ||= Tempfile.new('Hello world!')
+      end
     end
   end
 end

data/lib/active_storage_validations/matchers.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_storage_validations/matchers/aspect_ratio_validator_matcher'
 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'

data/lib/active_storage_validations/metadata.rb

@@ -4,29 +4,18 @@ module ActiveStorageValidations
 
     attr_reader :file
 
+    DEFAULT_IMAGE_PROCESSOR = :mini_magick.freeze
+
     def initialize(file)
       require_image_processor
       @file = file
     end
 
-    def image_processor
-      Rails.application.config.active_storage.variant_processor
-    end
-
-    def exception_class
-      if image_processor == :vips && defined?(Vips)
-        Vips::Error
-      elsif defined?(MiniMagick)
-        MiniMagick::Error
-      end
-    end
-
-    def require_image_processor
-      if image_processor == :vips
-        require 'vips' unless defined?(Vips)
-      else
-        require 'mini_magick' unless defined?(MiniMagick)
-      end
+    def valid?
+      read_image
+      true
+    rescue InvalidImageError
+      false
     end
 
     def metadata
@@ -42,14 +31,31 @@ module ActiveStorageValidations
       {}
     end
 
-    def valid?
-      read_image
-      true
-    rescue InvalidImageError
-      false
+    private
+
+    def image_processor
+      # Rails returns nil for default image processor, because it is set in an after initiliaze callback
+      # https://github.com/rails/rails/blob/89d8569abe2564c8187debf32dd3b4e33d6ad983/activestorage/lib/active_storage/engine.rb
+      Rails.application.config.active_storage.variant_processor || DEFAULT_IMAGE_PROCESSOR
     end
 
-    private
+    def require_image_processor
+      case image_processor
+      when :vips then require 'vips' unless defined?(Vips)
+      when :mini_magick then require 'mini_magick' unless defined?(MiniMagick)
+      end
+    end
+
+    def exception_class
+      case image_processor
+      when :vips then Vips::Error
+      when :mini_magick then MiniMagick::Error
+      end
+    end
+
+    def vips_image_processor?
+      image_processor == :vips
+    end
 
     def read_image
       is_string = file.is_a?(String)
@@ -95,8 +101,16 @@ module ActiveStorageValidations
     end
 
     def new_image_from_path(path)
-      if image_processor == :vips && defined?(Vips) && (Vips::get_suffixes.include?(File.extname(path).downcase) || !Vips::respond_to?(:vips_foreign_get_suffixes))
-        Vips::Image.new_from_file(path)
+      if vips_image_processor? && (Vips::get_suffixes.include?(File.extname(path).downcase) || !Vips::respond_to?(:vips_foreign_get_suffixes))
+        begin
+          Vips::Image.new_from_file(path)
+        rescue exception_class
+          # We handle cases where an error is raised when reading the file
+          # because Vips can throw errors rather than returning false
+          # We stumble upon this issue while reading 0 byte size file
+          # https://github.com/janko/image_processing/issues/97
+          false
+        end
       elsif defined?(MiniMagick)
         MiniMagick::Image.new(path)
       end
@@ -105,13 +119,13 @@ module ActiveStorageValidations
     def valid_image?(image)
       return false unless image
 
-      image_processor == :vips && image.is_a?(Vips::Image) ? image.avg : image.valid?
+      vips_image_processor? && image.is_a?(Vips::Image) ? image.avg : image.valid?
     rescue exception_class
       false
     end
 
     def rotated_image?(image)
-      if image_processor == :vips && image.is_a?(Vips::Image)
+      if vips_image_processor? && image.is_a?(Vips::Image)
         image.get('exif-ifd0-Orientation').include?('Right-top') ||
           image.get('exif-ifd0-Orientation').include?('Left-bottom')
       else

data/lib/active_storage_validations/processable_image_validator.rb

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
 require_relative 'metadata.rb'
 
 module ActiveStorageValidations
   class ProcessableImageValidator < ActiveModel::EachValidator # :nodoc
     include OptionProcUnfolding
+    include Errorable
+    include Symbolizable
+
+    ERROR_TYPES = %i[
+      image_not_processable
+    ].freeze
 
     if Rails.gem_version >= Gem::Version.new('6.0.0')
       def validate_each(record, attribute, _value)
@@ -16,7 +24,10 @@ module ActiveStorageValidations
         files = Array.wrap(changes.is_a?(ActiveStorage::Attached::Changes::CreateMany) ? changes.attachables : changes.attachable)
 
         files.each do |file|
-          add_error(record, attribute, :image_not_processable) unless Metadata.new(file).valid?
+          if !Metadata.new(file).valid?
+            errors_options = initialize_error_options(options, file)
+            add_error(record, attribute, ERROR_TYPES.first , **errors_options) unless Metadata.new(file).valid?
+          end
         end
       end
     else
@@ -27,17 +38,12 @@ module ActiveStorageValidations
         files = Array.wrap(record.send(attribute))
 
         files.each do |file|
-          add_error(record, attribute, :image_not_processable) unless Metadata.new(file).valid?
+          if !Metadata.new(file).valid?
+            errors_options = initialize_error_options(options, file)
+            add_error(record, attribute, ERROR_TYPES.first , **errors_options) unless Metadata.new(file).valid?
+          end
         end
       end
     end
-
-    private
-
-    def add_error(record, attribute, default_message)
-      message = options[:message].presence || default_message
-      return if record.errors.added?(attribute, message)
-      record.errors.add(attribute, message)
-    end
   end
 end

data/lib/active_storage_validations/size_validator.rb

@@ -1,16 +1,35 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
+
 module ActiveStorageValidations
   class SizeValidator < ActiveModel::EachValidator # :nodoc:
     include OptionProcUnfolding
+    include Errorable
+    include Symbolizable
 
     delegate :number_to_human_size, to: ActiveSupport::NumberHelper
 
-    AVAILABLE_CHECKS = %i[less_than less_than_or_equal_to greater_than greater_than_or_equal_to between].freeze
+    AVAILABLE_CHECKS = %i[
+      less_than
+      less_than_or_equal_to
+      greater_than
+      greater_than_or_equal_to
+      between
+    ].freeze
+    ERROR_TYPES = %i[
+      file_size_not_less_than
+      file_size_not_less_than_or_equal_to
+      file_size_not_greater_than
+      file_size_not_greater_than_or_equal_to
+      file_size_not_between
+    ].freeze
 
     def check_validity!
-      return true if AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
-      raise ArgumentError, 'You must pass either :less_than(_or_equal_to), :greater_than(_or_equal_to), or :between to the validator'
+      unless AVAILABLE_CHECKS.one? { |argument| options.key?(argument) }
+        raise ArgumentError, 'You must pass either :less_than(_or_equal_to), :greater_than(_or_equal_to), or :between to the validator'
+      end
     end
 
     def validate_each(record, attribute, _value)
@@ -18,24 +37,28 @@ module ActiveStorageValidations
       return true unless record.send(attribute).attached?
 
       files = Array.wrap(record.send(attribute))
-
-      errors_options = {}
-      errors_options[:message] = options[:message] if options[:message].present?
       flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
 
       files.each do |file|
-        next if content_size_valid?(file.blob.byte_size, flat_options)
+        next if is_valid?(file.blob.byte_size, flat_options)
 
+        errors_options = initialize_error_options(options, file)
         errors_options[:file_size] = number_to_human_size(file.blob.byte_size)
         errors_options[:min_size] = number_to_human_size(min_size(flat_options))
         errors_options[:max_size] = number_to_human_size(max_size(flat_options))
+        keys = AVAILABLE_CHECKS & flat_options.keys
+        error_type = "file_size_not_#{keys.first}".to_sym
 
-        record.errors.add(attribute, :file_size_out_of_range, **errors_options)
+        add_error(record, attribute, error_type, **errors_options)
         break
       end
     end
 
-    def content_size_valid?(file_size, flat_options)
+    private
+
+    def is_valid?(file_size, flat_options)
+      return false if file_size < 0
+
       if flat_options[:between].present?
         flat_options[:between].include?(file_size)
       elsif flat_options[:less_than].present?

data/lib/active_storage_validations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveStorageValidations
-  VERSION = '1.0.4'
+  VERSION = '1.1.4'
 end