active_storage_validations 1.1.3 → 1.2.0

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -1,24 +1,50 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/active_storageable.rb'
+require_relative 'concerns/allow_blankable.rb'
+require_relative 'concerns/attachable'
+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)
-      DimensionValidatorMatcher.new(name)
+    def validate_dimensions_of(attribute_name)
+      DimensionValidatorMatcher.new(attribute_name)
     end
 
     class DimensionValidatorMatcher
+      include ActiveStorageable
+      include AllowBlankable
+      include Attachable
+      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 +57,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 +77,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 +98,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,57 +122,64 @@ 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?
+          detach_file
+          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
           validate
+          detach_file
           has_an_error_message_which_is_custom_message?
         end
       end
@@ -168,19 +189,6 @@ module ActiveStorageValidations
           yield
         end
       end
-
-      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
 end

data/lib/active_storage_validations/matchers/processable_image_validator_matcher.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/active_storageable.rb'
+require_relative 'concerns/allow_blankable.rb'
+require_relative 'concerns/attachable.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_processable_image_of(name)
+      ProcessableImageValidatorMatcher.new(name)
+    end
+
+    class ProcessableImageValidatorMatcher
+      include ActiveStorageable
+      include AllowBlankable
+      include Attachable
+      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
+      end
+
+      def description
+        "validate that :#{@attribute_name} is a processable image"
+      end
+
+      def failure_message
+        "is expected to validate the processable image of :#{@attribute_name}"
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+
+        is_a_valid_active_storage_attribute? &&
+        is_context_valid? &&
+        is_custom_message_valid? &&
+        is_valid_when_image_processable? &&
+        is_invalid_when_image_not_processable?
+      end
+
+      private
+
+      def is_valid_when_image_processable?
+        attach_file(processable_image)
+        validate
+        detach_file
+        is_valid?
+      end
+
+      def is_invalid_when_image_not_processable?
+        attach_file(not_processable_image)
+        validate
+        detach_file
+        !is_valid?
+      end
+
+      def is_custom_message_valid?
+        return true unless @custom_message
+
+        attach_file(not_processable_image)
+        validate
+        detach_file
+        has_an_error_message_which_is_custom_message?
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/size_validator_matcher.rb

@@ -1,140 +1,22 @@
 # 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_size_matcher.rb
-
-require_relative 'concerns/validatable.rb'
+require_relative 'base_size_validator_matcher'
 
 module ActiveStorageValidations
   module Matchers
-    def validate_size_of(name)
-      SizeValidatorMatcher.new(name)
+    def validate_size_of(attribute_name)
+      SizeValidatorMatcher.new(attribute_name)
     end
 
-    class SizeValidatorMatcher
-      include Validatable
-
-      def initialize(attribute_name)
-        @attribute_name = attribute_name
-        @min = @max = nil
-        @custom_message = nil
-      end
-
+    class SizeValidatorMatcher < BaseSizeValidatorMatcher
       def description
-        "validate file size of #{@attribute_name}"
-      end
-
-      def less_than(size)
-        @max = size - 1.byte
-        self
-      end
-
-      def less_than_or_equal_to(size)
-        @max = size
-        self
-      end
-
-      def greater_than(size)
-        @min = size + 1.byte
-        self
-      end
-
-      def greater_than_or_equal_to(size)
-        @min = size
-        self
-      end
-
-      def between(range)
-        @min, @max = range.first, range.last
-        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 &&
-          not_lower_than_min? &&
-          higher_than_min? &&
-          lower_than_max? &&
-          not_higher_than_max? &&
-          validate_custom_message?
+        "validate file size of :#{@attribute_name}"
       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"
-      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 not_lower_than_min?
-        @min.nil? || !passes_validation_with_size(@min - 1)
-      end
-
-      def higher_than_min?
-        @min.nil? || passes_validation_with_size(@min + 1)
-      end
-
-      def lower_than_max?
-        @max.nil? || @max == Float::INFINITY || passes_validation_with_size(@max - 1)
-      end
-
-      def not_higher_than_max?
-        @max.nil? || @max == Float::INFINITY || !passes_validation_with_size(@max + 1)
-      end
-
-      def passes_validation_with_size(size)
-        mock_size_for(io, size) do
-          attach_file
-          validate
-          is_valid?
-        end
-      end
-
-      def validate_custom_message?
-        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 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!')
+        message = ["is expected to validate file size of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
       end
     end
   end

data/lib/active_storage_validations/matchers/total_size_validator_matcher.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'base_size_validator_matcher'
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_total_size_of(attribute_name)
+      TotalSizeValidatorMatcher.new(attribute_name)
+    end
+
+    class TotalSizeValidatorMatcher < BaseSizeValidatorMatcher
+      def description
+        "validate total file size of :#{@attribute_name}"
+      end
+
+      def failure_message
+        message = ["is expected to validate total file size of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
+      end
+
+      protected
+
+      def attach_file
+        # We attach blobs instead of io for has_many_attached relation
+        @subject.public_send(@attribute_name).attach([dummy_blob])
+        @subject.public_send(@attribute_name)
+      end
+
+      def dummy_blob
+        ActiveStorage::Blob.create_and_upload!(
+          io: io,
+          filename: 'test.png',
+          content_type: 'image/png',
+          service_name: 'test'
+        )
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers.rb

@@ -1,9 +1,12 @@
 # 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/processable_image_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'
+require 'active_storage_validations/matchers/total_size_validator_matcher'
 
 module ActiveStorageValidations
   module Matchers

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 initialize 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,23 +101,49 @@ 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? && (supported_vips_suffix?(path) || vips_version_below_8_8? || open_uri_tempfile?(path))
+        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
     end
 
+    def supported_vips_suffix?(path)
+      Vips::get_suffixes.include?(File.extname(path).downcase)
+    end
+
+    def vips_version_below_8_8?
+      # FYI, Vips 8.8 was released in 2019
+      # https://github.com/libvips/libvips/releases/tag/v8.8.0
+      !Vips::respond_to?(:vips_foreign_get_suffixes)
+    end
+
+    def open_uri_tempfile?(path)
+      # When trying to open urls for 'large' images, OpenURI will return a
+      # tempfile. That tempfile does not have an extension indicating the type
+      # of file. However, Vips will be able to process it anyway.
+      # The 'large' file value is derived from OpenUri::Buffer class (> 10ko)
+      path.split('/').last.starts_with?("open-uri")
+    end
+
     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