active_storage_validations 1.1.1 → 1.2.0

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -2,20 +2,47 @@
 
 # Big thank you to the paperclip validation matchers:
 # https://github.com/thoughtbot/paperclip/blob/v6.1.0/lib/paperclip/matchers/validate_attachment_content_type_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
-    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
+      include Validatable
+
       def initialize(attribute_name)
+        initialize_allow_blankable
+        initialize_contextable
+        initialize_messageable
+        initialize_rspecable
         @attribute_name = attribute_name
-        @custom_message = nil
+        @allowed_types = @rejected_types = []
       end
 
       def description
-        "validate the content types allowed on attachment #{@attribute_name}"
+        "validate the content types allowed on :#{@attribute_name}"
+      end
+
+      def failure_message
+        message = ["is expected to validate the content types of :#{@attribute_name}"]
+        build_failure_message(message)
+        message.join("\n")
       end
 
       def allowing(*types)
@@ -28,83 +55,80 @@ 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 && allowed_types_allowed? && rejected_types_rejected? && validate_custom_message?
+
+        is_a_valid_active_storage_attribute? &&
+          is_context_valid? &&
+          is_allowing_blank? &&
+          is_custom_message_valid? &&
+          all_allowed_types_allowed? &&
+          all_rejected_types_rejected?
       end
 
-      def failure_message
-        message = ["Expected #{@attribute_name}"]
+      protected
 
-        if @allowed_types
-          message << "Accept content types: #{allowed_types.join(", ")}"
-          message << "#{@missing_allowed_types.join(", ")} were rejected"
+      def build_failure_message(message)
+        if @allowed_types_not_allowed.present?
+          message << "  the following content type#{'s' if @allowed_types.count > 1} should be allowed: :#{@allowed_types.join(", :")}"
+          message << "  but #{pluralize(@allowed_types_not_allowed)} rejected"
         end
 
-        if @rejected_types
-          message << "Reject content types: #{rejected_types.join(", ")}"
-          message << "#{@missing_rejected_types.join(", ")} were accepted"
+        if @rejected_types_not_rejected.present?
+          message << "  the following content type#{'s' if @rejected_types.count > 1} should be rejected: :#{@rejected_types.join(", :")}"
+          message << "  but #{pluralize(@rejected_types_not_rejected)} accepted"
         end
-
-        message.join("\n")
       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 allowed_types
-        @allowed_types || []
+      def pluralize(types)
+        if types.count == 1
+          ":#{types[0]} was"
+        else
+          ":#{types.join(", :")} were"
+        end
       end
 
-      def rejected_types
-        @rejected_types || []
+      def all_allowed_types_allowed?
+        @allowed_types_not_allowed ||= @allowed_types.reject { |type| type_allowed?(type) }
+        @allowed_types_not_allowed.empty?
       end
 
-      def allowed_types_allowed?
-        @missing_allowed_types ||= allowed_types.reject { |type| type_allowed?(type) }
-        @missing_allowed_types.none?
+      def all_rejected_types_rejected?
+        @rejected_types_not_rejected ||= @rejected_types.select { |type| type_allowed?(type) }
+        @rejected_types_not_rejected.empty?
       end
 
-      def rejected_types_rejected?
-        @missing_rejected_types ||= rejected_types.select { |type| type_allowed?(type) }
-        @missing_rejected_types.none?
+      def type_allowed?(type)
+        attach_file_of_type(type)
+        validate
+        detach_file
+        is_valid?
       end
 
-      def type_allowed?(type)
+      def attach_file_of_type(type)
         @subject.public_send(@attribute_name).attach(attachment_for(type))
-        @subject.validate
-        @subject.errors.details[@attribute_name].none? do |error|
-          error[:error].to_s.include?(error_message)
-        end
       end
 
-      def validate_custom_message?
+      def is_custom_message_valid?
         return true unless @custom_message
 
-        @subject.public_send(@attribute_name).attach(attachment_for('fake/fake'))
-        @subject.validate
-        @subject.errors.details[@attribute_name].select{|error| error[:content_type]}.all? do |error|
-          error[:error].to_s.include?(error_message)
-        end
+        attach_invalid_content_type_file
+        validate
+        has_an_error_message_which_is_custom_message?
       end
 
-      def error_message
-        @custom_message || :content_type_invalid.to_s
+      def attach_invalid_content_type_file
+        @subject.public_send(@attribute_name).attach(attachment_for('fake/fake'))
       end
 
       def attachment_for(type)
         suffix = type.to_s.split('/').last
-        { io: Tempfile.new('.'), filename: "test.#{suffix}", content_type: type }
+
+        {
+          io: Tempfile.new('.'),
+          filename: "test.#{suffix}",
+          content_type: type
+        }
       end
     end
   end

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -1,20 +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)
@@ -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_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 +122,72 @@ 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
+          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].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
+      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, height) do
+          yield
+        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,101 +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 '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
-      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 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(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
-          exclude_error_message = @custom_message || "file_size_not_"
-          @subject.errors.details[@attribute_name].none? do |error|
-            error[:error].to_s.include?(exclude_error_message)
-          end
-        end
+        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