active_storage_validations 1.0.4 → 1.1.4

data/lib/active_storage_validations/matchers/aspect_ratio_validator_matcher.rb

@@ -0,0 +1,128 @@
+# 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
+  module Matchers
+    def validate_aspect_ratio_of(name, expected_aspect_ratio)
+      AspectRatioValidatorMatcher.new(name, expected_aspect_ratio)
+    end
+
+    class AspectRatioValidatorMatcher
+      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
+        @allowed_aspect_ratios = @rejected_aspect_ratios = []
+      end
+
+      def description
+        "validate the aspect ratios allowed on :#{@attribute_name}."
+      end
+
+      def failure_message
+        "is expected to validate aspect ratio of :#{@attribute_name}"
+      end
+
+      def allowing(*aspect_ratios)
+        @allowed_aspect_ratios = aspect_ratios.flatten
+        self
+      end
+
+      def rejecting(*aspect_ratios)
+        @rejected_aspect_ratios = aspect_ratios.flatten
+        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? &&
+          all_allowed_aspect_ratios_allowed? &&
+          all_rejected_aspect_ratios_rejected?
+      end
+
+      protected
+
+      def all_allowed_aspect_ratios_allowed?
+        @allowed_aspect_ratios_not_allowed ||= @allowed_aspect_ratios.reject { |aspect_ratio| aspect_ratio_allowed?(aspect_ratio) }
+        @allowed_aspect_ratios_not_allowed.empty?
+      end
+
+      def all_rejected_aspect_ratios_rejected?
+        @rejected_aspect_ratios_not_rejected ||= @rejected_aspect_ratios.select { |aspect_ratio| aspect_ratio_allowed?(aspect_ratio) }
+        @rejected_aspect_ratios_not_rejected.empty?
+      end
+
+      def aspect_ratio_allowed?(aspect_ratio)
+        width, height = valid_width_and_height_for(aspect_ratio)
+
+        mock_dimensions_for(attach_file, width, height) do
+          validate
+          is_valid?
+        end
+      end
+
+      def is_custom_message_valid?
+        return true unless @custom_message
+
+        mock_dimensions_for(attach_file, -1, -1) do
+          validate
+          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
+        end
+      end
+
+      def valid_width_and_height_for(aspect_ratio)
+        case aspect_ratio
+        when :square then [100, 100]
+        when :portrait then [100, 200]
+        when :landscape then [200, 100]
+        when validator_class::ASPECT_RATIO_REGEX
+          aspect_ratio =~ validator_class::ASPECT_RATIO_REGEX
+          x = Regexp.last_match(1).to_i
+          y = Regexp.last_match(2).to_i
+
+          [100 * x, 100 * y]
+        else
+          [-1, -1]
+        end
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/attached_validator_matcher.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/active_storageable.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_attached_of(name)
@@ -7,52 +13,77 @@ module ActiveStorageValidations
     end
 
     class AttachedValidatorMatcher
+      include ActiveStorageable
+      include Contextable
+      include Messageable
+      include Rspecable
+      include Validatable
+
       def initialize(attribute_name)
+        initialize_contextable
+        initialize_messageable
+        initialize_rspecable
         @attribute_name = attribute_name
       end
 
       def description
-        "validate #{@attribute_name} must be attached"
+        "validate that :#{@attribute_name} must be attached"
+      end
+
+      def failure_message
+        "is expected to validate attachment of :#{@attribute_name}"
       end
 
       def matches?(subject)
         @subject = subject.is_a?(Class) ? subject.new : subject
-        responds_to_methods && valid_when_attached && invalid_when_not_attached
+
+        is_a_valid_active_storage_attribute? &&
+          is_context_valid? &&
+          is_custom_message_valid? &&
+          is_valid_when_file_attached? &&
+          is_invalid_when_file_not_attached?
       end
 
-      def failure_message
-        "is expected to validate attached of #{@attribute_name}"
+      private
+
+      def is_valid_when_file_attached?
+        attach_dummy_file unless file_attached?
+        validate
+        is_valid?
       end
 
-      def failure_message_when_negated
-        "is expected to not validate attached of #{@attribute_name}"
+      def is_invalid_when_file_not_attached?
+        detach_file if file_attached?
+        validate
+        !is_valid?
       end
 
-      private
+      def is_custom_message_valid?
+        return true unless @custom_message
+
+        detach_file if file_attached?
+        validate
+        has_an_error_message_which_is_custom_message?
+      end
 
-      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 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 valid_when_attached
-        @subject.public_send(@attribute_name).attach(attachable) unless @subject.public_send(@attribute_name).attached?
-        @subject.validate
-        @subject.errors.details[@attribute_name].exclude?(error: :blank)
+      def file_attached?
+        @subject.public_send(@attribute_name).attached?
       end
 
-      def invalid_when_not_attached
+      def detach_file
         @subject.public_send(@attribute_name).detach
         # Unset the direct relation since `detach` on an unpersisted record does not set `attached?` to false.
         @subject.public_send("#{@attribute_name}=", nil)
-
-        @subject.validate
-        @subject.errors.details[@attribute_name].include?(error: :blank)
-      end
-
-      def attachable
-        { io: Tempfile.new('.'), filename: 'dummy.txt', content_type: 'text/plain' }
       end
     end
   end

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

@@ -0,0 +1,17 @@
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module ActiveStorageable
+      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/concerns/allow_blankable.rb

@@ -0,0 +1,26 @@
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module AllowBlankable
+      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/concerns/contextable.rb

@@ -0,0 +1,35 @@
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module Contextable
+      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_validator && attribute_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 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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module Messageable
+      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[:error] == @custom_message
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module Rspecable
+      extend ActiveSupport::Concern
+
+      def initialize_rspecable
+        @failure_message_artefacts = []
+      end
+
+      def description
+        raise NotImplementedError, "#{self.class} did not define #{__method__}"
+      end
+
+      def failure_message
+        raise NotImplementedError, "#{self.class} did not define #{__method__}"
+      end
+
+      def failure_message_when_negated
+        failure_message.sub(/is expected to validate/, 'is expected not to validate')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require "active_support/concern"
+
+module ActiveStorageValidations
+  module Matchers
+    module Validatable
+      extend ActiveSupport::Concern
+
+      private
+
+      def validate
+        @subject.validate(@context)
+      end
+
+      def validator_errors_for_attribute
+        @subject.errors.details[@attribute_name].select do |error|
+          error[:validator_type] == validator_class.to_sym
+        end
+      end
+
+      def is_valid?
+        validator_errors_for_attribute.none? do |error|
+          error[:error].in?(available_errors)
+        end
+      end
+
+      def available_errors
+        [
+          *validator_class::ERROR_TYPES,
+          *error_from_custom_message
+        ].compact
+      end
+
+      def validator_class
+        self.class.name.gsub(/::Matchers|Matcher/, '').constantize
+      end
+
+      def attribute_validator
+        @subject.class.validators_on(@attribute_name).find do |validator|
+          validator.class == validator_class
+        end
+      end
+
+      def error_from_custom_message
+        attribute_validator.options[:message]
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -2,6 +2,14 @@
 
 # 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/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)
@@ -9,12 +17,30 @@ module ActiveStorageValidations
     end
 
     class ContentTypeValidatorMatcher
+      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
+        @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)
@@ -29,60 +55,77 @@ module ActiveStorageValidations
 
       def matches?(subject)
         @subject = subject.is_a?(Class) ? subject.new : subject
-        responds_to_methods && allowed_types_allowed? && rejected_types_rejected?
+
+        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 pluralize(types)
+        if types.count == 1
+          ":#{types[0]} was"
+        else
+          ":#{types.join(", :")} were"
+        end
+      end
 
-      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 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_types || []
+      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_types || []
+      def type_allowed?(type)
+        attach_file_of_type(type)
+        validate
+        is_valid?
       end
 
-      def allowed_types_allowed?
-        @missing_allowed_types ||= allowed_types.reject { |type| type_allowed?(type) }
-        @missing_allowed_types.none?
+      def attach_file_of_type(type)
+        @subject.public_send(@attribute_name).attach(attachment_for(type))
       end
 
-      def rejected_types_rejected?
-        @missing_rejected_types ||= rejected_types.select { |type| type_allowed?(type) }
-        @missing_rejected_types.none?
+      def is_custom_message_valid?
+        return true unless @custom_message
+
+        attach_invalid_content_type_file
+        validate
+        has_an_error_message_which_is_custom_message?
       end
 
-      def type_allowed?(type)
-        @subject.public_send(@attribute_name).attach(attachment_for(type))
-        @subject.validate
-        @subject.errors.details[@attribute_name].all? { |error| error[:error] != :content_type_invalid }
+      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