active_storage_validations 1.1.3 → 1.1.4

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -1,5 +1,10 @@
 # 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
@@ -9,16 +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)
@@ -31,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
 
@@ -51,25 +75,18 @@ 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 &&
+        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? &&
@@ -79,24 +96,19 @@ module ActiveStorageValidations
           height_larger_than_min? &&
           height_smaller_than_max? &&
           height_not_larger_than_max? &&
-          height_equals? &&
-          validate_custom_message?
-      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
+          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
@@ -108,53 +120,58 @@ 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)
+      def passes_validation_with_dimensions(width, height)
         mock_dimensions_for(attach_file, width, height) do
           validate
-          is_valid?
+          is_valid? || add_failure_message_artefact(width, height)
         end
       end
 
-      def validate_custom_message?
+      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
 
         mock_dimensions_for(attach_file, -1, -1) do

data/lib/active_storage_validations/matchers/size_validator_matcher.rb

@@ -3,6 +3,11 @@
 # 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
@@ -12,16 +17,30 @@ 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
         @min = @max = nil
-        @custom_message = 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)
@@ -49,36 +68,29 @@ module ActiveStorageValidations
         self
       end
 
-      def with_message(message)
-        @custom_message = message
-        self
-      end
-
       def matches?(subject)
         @subject = subject.is_a?(Class) ? subject.new : subject
 
-        responds_to_methods &&
+        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? &&
-          validate_custom_message?
-      end
-
-      def failure_message
-        "is expected to validate file size of #{@attribute_name} to be between #{@min} and #{@max} bytes"
-      end
-
-      def failure_message_when_negated
-        "is expected to not validate file size of #{@attribute_name} to be between #{@min} and #{@max} bytes"
+          not_higher_than_max?
       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[:size]} bytes test file"
+        end
+        message << "  whereas it should have passed"
       end
 
       def not_lower_than_min?
@@ -101,11 +113,16 @@ module ActiveStorageValidations
         mock_size_for(io, size) do
           attach_file
           validate
-          is_valid?
+          is_valid? || add_failure_message_artefact(size)
         end
       end
 
-      def validate_custom_message?
+      def add_failure_message_artefact(size)
+        @failure_message_artefacts << { size: size }
+        false
+      end
+
+      def is_custom_message_valid?
         return true unless @custom_message
 
         mock_size_for(io, -1.kilobytes) do

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,27 +1,33 @@
 # 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 ErrorHandler
+    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)
         return true unless record.send(attribute).attached?
 
-        errors_options = initialize_error_options(options)
-
         changes = record.attachment_changes[attribute.to_s]
         return true if changes.blank?
 
         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, **errors_options) 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
@@ -32,7 +38,10 @@ module ActiveStorageValidations
         files = Array.wrap(record.send(attribute))
 
         files.each do |file|
-          add_error(record, attribute, :image_not_processable, **errors_options) 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

data/lib/active_storage_validations/size_validator.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
 require_relative 'concerns/symbolizable.rb'
 
 module ActiveStorageValidations
   class SizeValidator < ActiveModel::EachValidator # :nodoc:
     include OptionProcUnfolding
-    include ErrorHandler
+    include Errorable
     include Symbolizable
 
     delegate :number_to_human_size, to: ActiveSupport::NumberHelper
@@ -36,14 +37,12 @@ module ActiveStorageValidations
       return true unless record.send(attribute).attached?
 
       files = Array.wrap(record.send(attribute))
-
-      errors_options = initialize_error_options(options)
-
       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))
@@ -55,7 +54,9 @@ module ActiveStorageValidations
       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?

data/lib/active_storage_validations/version.rb

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

data/lib/active_storage_validations.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require 'active_model'
+require 'active_support/concern'
 
 require 'active_storage_validations/railtie'
 require 'active_storage_validations/engine'
 require 'active_storage_validations/option_proc_unfolding'
-require 'active_storage_validations/error_handler'
 require 'active_storage_validations/attached_validator'
 require 'active_storage_validations/content_type_validator'
 require 'active_storage_validations/size_validator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_validations
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -234,14 +234,20 @@ files:
 - lib/active_storage_validations.rb
 - lib/active_storage_validations/aspect_ratio_validator.rb
 - lib/active_storage_validations/attached_validator.rb
+- lib/active_storage_validations/concerns/errorable.rb
 - lib/active_storage_validations/concerns/symbolizable.rb
 - lib/active_storage_validations/content_type_validator.rb
 - lib/active_storage_validations/dimension_validator.rb
 - lib/active_storage_validations/engine.rb
-- lib/active_storage_validations/error_handler.rb
 - lib/active_storage_validations/limit_validator.rb
 - lib/active_storage_validations/matchers.rb
+- lib/active_storage_validations/matchers/aspect_ratio_validator_matcher.rb
 - lib/active_storage_validations/matchers/attached_validator_matcher.rb
+- lib/active_storage_validations/matchers/concerns/active_storageable.rb
+- lib/active_storage_validations/matchers/concerns/allow_blankable.rb
+- lib/active_storage_validations/matchers/concerns/contextable.rb
+- lib/active_storage_validations/matchers/concerns/messageable.rb
+- lib/active_storage_validations/matchers/concerns/rspecable.rb
 - lib/active_storage_validations/matchers/concerns/validatable.rb
 - lib/active_storage_validations/matchers/content_type_validator_matcher.rb
 - lib/active_storage_validations/matchers/dimension_validator_matcher.rb

data/lib/active_storage_validations/error_handler.rb

@@ -1,21 +0,0 @@
-module ActiveStorageValidations
-  module ErrorHandler
-
-    def initialize_error_options(options)
-      {
-        validator_type: self.class.to_sym,
-        custom_message: (options[:message] if options[:message].present?)
-      }.compact
-    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
-
-  end
-end