active_storage_validations 1.1.4 → 1.3.0

data/lib/active_storage_validations/matchers/aspect_ratio_validator_matcher.rb

@@ -2,6 +2,7 @@
 
 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'
@@ -9,13 +10,14 @@ require_relative 'concerns/validatable.rb'
 
 module ActiveStorageValidations
   module Matchers
-    def validate_aspect_ratio_of(name, expected_aspect_ratio)
-      AspectRatioValidatorMatcher.new(name, expected_aspect_ratio)
+    def validate_aspect_ratio_of(attribute_name)
+      AspectRatioValidatorMatcher.new(attribute_name)
     end
 
     class AspectRatioValidatorMatcher
       include ActiveStorageable
       include AllowBlankable
+      include Attachable
       include Contextable
       include Messageable
       include Rspecable
@@ -76,6 +78,7 @@ module ActiveStorageValidations
 
         mock_dimensions_for(attach_file, width, height) do
           validate
+          detach_file
           is_valid?
         end
       end
@@ -85,23 +88,11 @@ module ActiveStorageValidations
 
         mock_dimensions_for(attach_file, -1, -1) do
           validate
+          detach_file
           has_an_error_message_which_is_custom_message?
         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
-
       def mock_dimensions_for(attachment, width, height)
         Matchers.mock_metadata(attachment, width, height) do
           yield

data/lib/active_storage_validations/matchers/attached_validator_matcher.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'concerns/active_storageable.rb'
+require_relative 'concerns/attachable.rb'
 require_relative 'concerns/contextable.rb'
 require_relative 'concerns/messageable.rb'
 require_relative 'concerns/rspecable.rb'
@@ -8,12 +9,13 @@ require_relative 'concerns/validatable.rb'
 
 module ActiveStorageValidations
   module Matchers
-    def validate_attached_of(name)
-      AttachedValidatorMatcher.new(name)
+    def validate_attached_of(attribute_name)
+      AttachedValidatorMatcher.new(attribute_name)
     end
 
     class AttachedValidatorMatcher
       include ActiveStorageable
+      include Attachable
       include Contextable
       include Messageable
       include Rspecable
@@ -47,7 +49,7 @@ module ActiveStorageValidations
       private
 
       def is_valid_when_file_attached?
-        attach_dummy_file unless file_attached?
+        attach_file unless file_attached?
         validate
         is_valid?
       end
@@ -66,16 +68,6 @@ module ActiveStorageValidations
         has_an_error_message_which_is_custom_message?
       end
 
-      def attach_dummy_file
-        dummy_file = {
-          io: Tempfile.new('.'),
-          filename: 'dummy.txt',
-          content_type: 'text/plain'
-        }
-
-        @subject.public_send(@attribute_name).attach(dummy_file)
-      end
-
       def file_attached?
         @subject.public_send(@attribute_name).attached?
       end

data/lib/active_storage_validations/matchers/base_size_validator_matcher.rb

@@ -0,0 +1,134 @@
+# 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/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
+    class BaseSizeValidatorMatcher
+      # BaseSizeValidatorMatcher is an abstract class and shouldn't be instantiated directly.
+
+      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
+        @min = @max = nil
+      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 matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+
+        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
+
+      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 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
+          detach_file
+          is_valid? || add_failure_message_artefact(size)
+        end
+      end
+
+      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
+          attach_file
+          validate
+          detach_file
+          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
+    end
+  end
+end

data/lib/active_storage_validations/matchers/concerns/attachable.rb

@@ -0,0 +1,66 @@
+module ActiveStorageValidations
+  module Matchers
+    module Attachable
+      private
+
+      def attach_file(file = dummy_file)
+        @subject.public_send(@attribute_name).attach(file)
+        @subject.public_send(@attribute_name)
+      end
+
+      def attach_files(count)
+        return unless count.positive?
+
+        file_array = Array.new(count, dummy_file)
+
+        @subject.public_send(@attribute_name).attach(file_array)
+      end
+
+      def detach_file
+        @subject.attachment_changes.delete(@attribute_name.to_s)
+      end
+      alias :detach_files :detach_file
+
+      def file_attached?
+        @subject.public_send(@attribute_name).attached?
+      end
+
+      def dummy_blob
+        ActiveStorage::Blob.create_and_upload!(**dummy_file)
+      end
+
+      def dummy_file
+        {
+          io: io,
+          filename: 'test.png',
+          content_type: 'image/png'
+        }
+      end
+
+      def processable_image
+        {
+          io: StringIO.new(image_data),
+          filename: 'processable_image.png',
+          content_type: 'image/png'
+        }
+      end
+
+      def not_processable_image
+        {
+          io: Tempfile.new('.'),
+          filename: 'not_processable_image.txt',
+          content_type: 'text/plain'
+        }
+      end
+
+      def io
+        @io ||= Tempfile.new('Hello world!')
+      end
+
+      def image_data
+        # Binary data for a 1x1 transparent PNG image
+        "\x89PNG\r\n\x1A\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x06\x00\x00\x00\x1F\x15\xC4\x89\x00\x00\x00\nIDATx\x9Cc\x00\x01\x00\x00\x05\x00\x01\r\n\x2D\xB4\x00\x00\x00\x00IEND\xAE\x42\x60\x82"
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/concerns/contextable.rb

@@ -17,19 +17,31 @@ module ActiveStorageValidations
       private
 
       def is_context_valid?
-        return true if !@context && !(attribute_validator && attribute_validator.options[:on])
+        return true if !@context && attribute_validators.none? { |validator| validator.options[:on] }
 
-        raise ArgumentError, "This validator matcher needs the #on option to work since its validator has one" if !@context
+        raise ArgumentError, "This validator matcher needs the #on option to work since its validator has one" if !@context && attribute_validators.all? { |validator| validator.options[:on] }
         raise ArgumentError, "This validator matcher option only allows a symbol or an array" if !(@context.is_a?(Symbol) || @context.is_a?(Array))
 
-        if @context.is_a?(Array) && attribute_validator.options[:on].is_a?(Array)
-          @context.to_set == attribute_validator.options[:on].to_set
-        elsif @context.is_a?(Symbol) && attribute_validator.options[:on].is_a?(Symbol)
-          @context == attribute_validator.options[:on]
-        else
-          false
+        if @context.is_a?(Array)
+          (validator_contexts & @context.map(&:to_s)) == validator_contexts || raise_context_not_listed_error
+        elsif @context.is_a?(Symbol)
+          validator_contexts.include?(@context.to_s) || raise_context_not_listed_error
         end
       end
+
+      def validator_contexts
+        attribute_validators.map do |validator|
+          case validator.options[:on]
+          when Array then validator.options[:on].map { |context| context.to_s }
+          when NilClass then nil
+          else validator.options[:on].to_s
+          end
+        end.flatten.compact
+      end
+
+      def raise_context_not_listed_error
+        raise ArgumentError, "One of the provided contexts to the #on method is not found in any of the listed contexts for this attribute"
+      end
     end
   end
 end

data/lib/active_storage_validations/matchers/concerns/messageable.rb

@@ -18,7 +18,7 @@ module ActiveStorageValidations
 
       def has_an_error_message_which_is_custom_message?
         validator_errors_for_attribute.one? do |error|
-          error[:error] == @custom_message
+          error[:custom_message] == @custom_message
         end
       end
     end

data/lib/active_storage_validations/matchers/concerns/validatable.rb

@@ -26,7 +26,7 @@ module ActiveStorageValidations
       def available_errors
         [
           *validator_class::ERROR_TYPES,
-          *error_from_custom_message
+          *errors_from_custom_messages
         ].compact
       end
 
@@ -40,8 +40,14 @@ module ActiveStorageValidations
         end
       end
 
-      def error_from_custom_message
-        attribute_validator.options[:message]
+      def attribute_validators
+        @subject.class.validators_on(@attribute_name).select do |validator|
+          validator.class == validator_class
+        end
+      end
+
+      def errors_from_custom_messages
+        attribute_validators.map { |validator| validator.options[:message] }
       end
     end
   end

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -5,6 +5,7 @@
 
 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'
@@ -12,13 +13,14 @@ require_relative 'concerns/validatable.rb'
 
 module ActiveStorageValidations
   module Matchers
-    def validate_content_type_of(name)
-      ContentTypeValidatorMatcher.new(name)
+    def validate_content_type_of(attribute_name)
+      ContentTypeValidatorMatcher.new(attribute_name)
     end
 
     class ContentTypeValidatorMatcher
       include ActiveStorageable
       include AllowBlankable
+      include Attachable
       include Contextable
       include Messageable
       include Rspecable
@@ -99,6 +101,7 @@ module ActiveStorageValidations
       def type_allowed?(type)
         attach_file_of_type(type)
         validate
+        detach_file
         is_valid?
       end
 
@@ -127,6 +130,13 @@ module ActiveStorageValidations
           content_type: type
         }
       end
+
+      # Due to the way we build test attachments in #attachment_for
+      # (ie spoofed file basically), we need to ignore the error related to
+      # content type spoofing in our matcher to pass the tests
+      def validator_errors_for_attribute
+        super.reject { |hash| hash[:error] == :spoofed_content_type }
+      end
     end
   end
 end

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -2,6 +2,7 @@
 
 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'
@@ -9,13 +10,14 @@ 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
@@ -162,6 +164,7 @@ module ActiveStorageValidations
       def passes_validation_with_dimensions(width, height)
         mock_dimensions_for(attach_file, width, height) do
           validate
+          detach_file
           is_valid? || add_failure_message_artefact(width, height)
         end
       end
@@ -176,6 +179,7 @@ module ActiveStorageValidations
 
         mock_dimensions_for(attach_file, -1, -1) do
           validate
+          detach_file
           has_an_error_message_which_is_custom_message?
         end
       end
@@ -185,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/limit_validator_matcher.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/active_storageable'
+require_relative 'concerns/allow_blankable'
+require_relative 'concerns/attachable'
+require_relative 'concerns/contextable'
+require_relative 'concerns/messageable'
+require_relative 'concerns/rspecable'
+require_relative 'concerns/validatable'
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_limits_of(name)
+      LimitValidatorMatcher.new(name)
+    end
+
+    class LimitValidatorMatcher
+      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
+        @min = @max = nil
+      end
+
+      def description
+        "validate the limit files of :#{@attribute_name}"
+      end
+
+      def failure_message
+        message = ["is expected to validate limit file of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
+      end
+
+      def min(count)
+        @min = count
+        self
+      end
+
+      def max(count)
+        @max = count
+        self
+      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? &&
+          file_count_not_smaller_than_min? &&
+          file_count_equal_min? &&
+          file_count_larger_than_min? &&
+          file_count_smaller_than_max? &&
+          file_count_equal_max? &&
+          file_count_not_larger_than_max?
+      end
+
+        private
+
+      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 #{error_case[:count]} file(s)"
+        end
+        message << "  whereas it should have passed"
+      end
+
+      def file_count_not_smaller_than_min?
+        @min.nil? || @min.zero? || !passes_validation_with_limits(@min - 1)
+      end
+
+      def file_count_equal_min?
+        @min.nil? || @min.zero? || passes_validation_with_limits(@min)
+      end
+
+      def file_count_larger_than_min?
+        @min.nil? || @min.zero? || @min == @max || passes_validation_with_limits(@min + 1)
+      end
+
+      def file_count_smaller_than_max?
+        @max.nil? || @min == @max || passes_validation_with_limits(@max - 1)
+      end
+
+      def file_count_equal_max?
+        @max.nil? || passes_validation_with_limits(@max)
+      end
+
+      def file_count_not_larger_than_max?
+        @max.nil? || !passes_validation_with_limits(@max + 1)
+      end
+
+      def passes_validation_with_limits(count)
+        attach_files(count)
+        validate
+        detach_files
+        is_valid? || add_failure_message_artefact(count)
+      end
+
+      def is_custom_message_valid?
+        return true if !@custom_message || (@min&.zero? && @max.nil?)
+
+        @min.nil? ? attach_files(@max + 1) : attach_files(@min - 1)
+        validate
+        detach_files
+        has_an_error_message_which_is_custom_message?
+      end
+
+      def add_failure_message_artefact(count)
+        @failure_message_artefacts << { count: count }
+        false
+      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