active_storage_validations 0.9.7 → 2.0.2

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -1,20 +1,50 @@
 # frozen_string_literal: true
 
+require_relative 'shared/asv_active_storageable'
+require_relative 'shared/asv_allow_blankable'
+require_relative 'shared/asv_attachable'
+require_relative 'shared/asv_contextable'
+require_relative 'shared/asv_messageable'
+require_relative 'shared/asv_rspecable'
+require_relative 'shared/asv_validatable'
+
 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 ASVActiveStorageable
+      include ASVAllowBlankable
+      include ASVAttachable
+      include ASVContextable
+      include ASVMessageable
+      include ASVRspecable
+      include ASVValidatable
+
       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 +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
 
@@ -47,42 +77,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_smaller_than_min? && width_larger_than_min? && width_smaller_than_max? && width_larger_than_max? && width_equals? &&
-          height_smaller_than_min? && height_larger_than_min? && height_smaller_than_max? && height_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
@@ -93,59 +121,73 @@ module ActiveStorageValidations
         ((@height_min || 0) + (@height_max || 2000)) / 2
       end
 
-      def width_smaller_than_min?
-        @width_min.nil? || !passes_validation_with_dimensions(@width_min - 1, valid_height, 'width')
+      def width_not_smaller_than_min?
+        @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_larger_than_max?
-        @width_max.nil? || !passes_validation_with_dimensions(@width_max + 1, valid_height, 'width')
+      def width_not_larger_than_max?
+        @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_smaller_than_min?
-        @height_min.nil? || !passes_validation_with_dimensions(valid_width, @height_min - 1, 'height')
+      def height_not_smaller_than_min?
+        @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_larger_than_max?
-        @height_max.nil? || !passes_validation_with_dimensions(valid_width, @height_max + 1, 'height')
+      def height_not_larger_than_max?
+        @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
+          detach_file
+          is_valid? || add_failure_message_artefact(width, height)
+        end
+      end
 
-        attachment = @subject.public_send(@attribute_name)
-        Matchers.mock_metadata(attachment, width, height) do
-          @subject.validate
-          exclude_error_message = @custom_message || "dimension_#{check}"
-          @subject.errors.details[@attribute_name].all? { |error| error[:error].to_s.exclude?(exclude_error_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
 
-      def attachment_for(width, height)
-        { io: Tempfile.new('Hello world!'), filename: 'test.png', content_type: 'image/png' }
+      def mock_dimensions_for(attachment, width, height)
+        Matchers.mock_metadata(attachment, { width: width, height: height }) do
+          yield
+        end
       end
     end
   end

data/lib/active_storage_validations/matchers/duration_validator_matcher.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'base_comparison_validator_matcher'
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_duration_of(attribute_name)
+      DurationValidatorMatcher.new(attribute_name)
+    end
+
+    class DurationValidatorMatcher < BaseComparisonValidatorMatcher
+      def description
+        "validate file duration of :#{@attribute_name}"
+      end
+
+      def failure_message
+        message = ["is expected to validate file duration of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
+      end
+
+      private
+
+      def failure_message_unit
+        "seconds"
+      end
+
+      def smallest_measurement
+        1.second
+      end
+
+      def mock_value_for(io, duration)
+        Matchers.mock_metadata(io, { duration: duration }) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/limit_validator_matcher.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative 'shared/asv_active_storageable'
+require_relative 'shared/asv_allow_blankable'
+require_relative 'shared/asv_attachable'
+require_relative 'shared/asv_contextable'
+require_relative 'shared/asv_messageable'
+require_relative 'shared/asv_rspecable'
+require_relative 'shared/asv_validatable'
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_limits_of(name)
+      LimitValidatorMatcher.new(name)
+    end
+
+    class LimitValidatorMatcher
+      include ASVActiveStorageable
+      include ASVAllowBlankable
+      include ASVAttachable
+      include ASVContextable
+      include ASVMessageable
+      include ASVRspecable
+      include ASVValidatable
+
+      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_file_validator_matcher.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'shared/asv_active_storageable'
+require_relative 'shared/asv_allow_blankable'
+require_relative 'shared/asv_attachable'
+require_relative 'shared/asv_contextable'
+require_relative 'shared/asv_messageable'
+require_relative 'shared/asv_rspecable'
+require_relative 'shared/asv_validatable'
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_processable_file_of(name)
+      ProcessableFileValidatorMatcher.new(name)
+    end
+
+    class ProcessableFileValidatorMatcher
+      include ASVActiveStorageable
+      include ASVAllowBlankable
+      include ASVAttachable
+      include ASVContextable
+      include ASVMessageable
+      include ASVRspecable
+      include ASVValidatable
+
+      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_file_not_processable?
+      end
+
+      private
+
+      def is_valid_when_image_processable?
+        attach_file(processable_image)
+        validate
+        detach_file
+        is_valid?
+      end
+
+      def is_invalid_when_file_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/shared/asv_active_storageable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVActiveStorageable
+      extend ActiveSupport::Concern
+
+      private
+
+      def is_a_valid_active_storage_attribute?
+        @subject.respond_to?(@attribute_name) &&
+          @subject.public_send(@attribute_name).respond_to?(:attach) &&
+          @subject.public_send(@attribute_name).respond_to?(:detach)
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/shared/asv_allow_blankable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVAllowBlankable
+      extend ActiveSupport::Concern
+
+      def initialize_allow_blankable
+        @allow_blank = nil
+      end
+
+      def allow_blank
+        @allow_blank = true
+        self
+      end
+
+      private
+
+      def is_allowing_blank?
+        return true unless @allow_blank
+
+        validate
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/shared/asv_attachable.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVAttachable
+      extend ActiveSupport::Concern
+
+      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/shared/asv_contextable.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVContextable
+      extend ActiveSupport::Concern
+
+      def initialize_contextable
+        @context = nil
+      end
+
+      def on(context)
+        @context = context
+        self
+      end
+
+      private
+
+      def is_context_valid?
+        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 && 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)
+          (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/shared/asv_messageable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveStorageValidations
+  module Matchers
+    module ASVMessageable
+      extend ActiveSupport::Concern
+
+      def initialize_messageable
+        @custom_message = nil
+      end
+
+      def with_message(custom_message)
+        @custom_message = custom_message
+        self
+      end
+
+      private
+
+      def has_an_error_message_which_is_custom_message?
+        validator_errors_for_attribute.one? do |error|
+          error[:custom_message] == @custom_message
+        end
+      end
+    end
+  end
+end