active_storage_validations 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354dd29a7d41df8c36694ecb4424869a5a6c0c7add98a32186995199c036ae23
-  data.tar.gz: db75c2027d7e9fe55150223007b414957c67bdf1d3ccd5a58fcbb38daf836e1a
+  metadata.gz: 8ee7d6623af014086158c960b7ef7408f4cf7527536f57539765351357160189
+  data.tar.gz: 6819ee596bd09560ca801fade1006bfbe4bf03b820b7ca1b0f84eafe0bb47ac1
 SHA512:
-  metadata.gz: c919243c4a4791c4615d5b3112c896462ab34125ed3b4974a0ad1d29bf53b8521a95dc5c34636ad11025f607247794f2c29772217f2fc130771493330b569bd1
-  data.tar.gz: 9ecc389a981df18f6663e0ae112df499e9bf56e5f0f99a7a086c3cf59368625bc530e4f0c5add8d25f1e783ab8727aaa34bdf0ec3ca197be7035e3931a93fd44
+  metadata.gz: c1a79fa7e8825320b308f8a689b3b09763072ec8093c5fc1f43e4686dad3dd05b4d345ce8d62149b23865b5c215b90dcdd68b292ea4ccef26456e752a35aad5a
+  data.tar.gz: 69517cf6f0d5a5c64c39416945f06bb31ccb6c5b1c0288d883005184c96e353d44a3f9479767783bd9aae856ee2157a6ffdde48ebdb6abbf23a5f4972fd8f3b0

data/README.md

@@ -189,6 +189,92 @@ Very simple example of validation with file attached, content type check and cus
 
 [![Sample](https://raw.githubusercontent.com/igorkasyanchuk/active_storage_validations/master/docs/preview.png)](https://raw.githubusercontent.com/igorkasyanchuk/active_storage_validations/master/docs/preview.png)
 
+## Test matchers
+Provides RSpec-compatible and Minitest-compatible matchers for testing the validators.
+
+### RSpec
+
+In spec_helper.rb, you'll need to require the matchers:
+
+```ruby
+require 'active_storage_validations/matchers'
+```
+
+And _include_ the module:
+
+```ruby
+RSpec.configure do |config|
+  config.include ActiveStorageValidations::Matchers
+end
+```
+
+Example (Note that the options are chainable):
+    
+```ruby
+describe User do
+  it { is_expected.to validate_attached_of(:avatar) }
+
+  it { is_expected.to validate_content_type_of(:avatar).allowing('image/png', 'image/gif') }
+  it { is_expected.to validate_content_type_of(:avatar).rejecting('text/plain', 'text/xml') }
+
+  it { is_expected.to validate_dimensions_of(:avatar).width(250) }
+  it { is_expected.to validate_dimensions_of(:avatar).height(200) }
+  it { is_expected.to validate_dimensions_of(:avatar).width_min(200) }
+  it { is_expected.to validate_dimensions_of(:avatar).width_max(500) }
+  it { is_expected.to validate_dimensions_of(:avatar).height_min(100) }
+  it { is_expected.to validate_dimensions_of(:avatar).height_max(300) }
+  it { is_expected.to validate_dimensions_of(:avatar).width_between(200..500) }
+  it { is_expected.to validate_dimensions_of(:avatar).height_between(100..300) }
+
+  it { is_expected.to validate_size_of(:avatar).less_than(50.kilobytes) }
+  it { is_expected.to validate_size_of(:avatar).less_than_or_equal_to(50.kilobytes) }
+  it { is_expected.to validate_size_of(:avatar).greater_than(1.kilobyte) }
+  it { is_expected.to validate_size_of(:avatar).greater_than_or_equal_to(1.kilobyte) }
+  it { is_expected.to validate_size_of(:avatar).between(100..500.kilobytes) }
+end
+```
+
+### Minitest
+To use the following syntax, make sure you have the [shoulda-context](https://github.com/thoughtbot/shoulda-context) gem up and running. To make use of the matchers you need to require the matchers:
+
+```ruby
+require 'active_storage_validations/matchers'
+```
+
+And _extend_ the module:
+
+```bash
+class ActiveSupport::TestCase
+  extend ActiveStorageValidations::Matchers
+end
+```
+
+Example (Note that the options are chainable):
+
+```ruby
+class UserTest < ActiveSupport::TestCase
+  should validate_attached_of(:avatar)
+
+  should validate_content_type_of(:avatar).allowing('image/png', 'image/gif')
+  should validate_content_type_of(:avatar).rejecting('text/plain', 'text/xml')
+
+  should validate_dimensions_of(:avatar).width(250)
+  should validate_dimensions_of(:avatar).height(200)
+  should validate_dimensions_of(:avatar).width_min(200)
+  should validate_dimensions_of(:avatar).width_max(500)
+  should validate_dimensions_of(:avatar).height_min(100)
+  should validate_dimensions_of(:avatar).height_max(300)
+  should validate_dimensions_of(:avatar).width_between(200..500)
+  should validate_dimensions_of(:avatar).height_between(100..300)
+
+  should validate_size_of(:avatar).less_than(50.kilobytes)
+  should validate_size_of(:avatar).less_than_or_equal_to(50.kilobytes)
+  should validate_size_of(:avatar).greater_than(1.kilobyte)
+  should validate_size_of(:avatar).greater_than_or_equal_to(1.kilobyte)
+  should validate_size_of(:avatar).between(100..500.kilobytes)
+end
+```
+
 ## Todo
 
 * verify with remote storages (s3, etc)
@@ -240,6 +326,7 @@ You are welcome to contribute.
 - https://github.com/UICJohn
 - https://github.com/giovannibonetti
 - https://github.com/dlepage
+- https://github.com/StefSchenkelaars
 
 ## License
 

data/lib/active_storage_validations/matchers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'active_storage_validations/matchers/attached_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'
+
+module ActiveStorageValidations
+  module Matchers
+    # Helper to stub a method with either RSpec or Minitest (whatever is available)
+    def self.stub_method(object, method, result)
+      if defined?(Minitest::Mock)
+        object.stub(method, result) do
+          yield
+        end
+      elsif defined?(RSpec::Mocks)
+        RSpec::Mocks.allow_message(object, method) { result }
+        yield
+      else
+        raise 'Need either Minitest::Mock or RSpec::Mocks to run this validator matcher'
+      end
+    end
+
+    def self.mock_metadata(attachment, width, height)
+      if Rails::VERSION::MAJOR >= 6
+        # Mock the Metadata class for rails 6
+        mock = OpenStruct.new(metadata: { width: width, height: height })
+        stub_method(ActiveStorageValidations::Metadata, :new, mock) do
+          yield
+        end
+      else
+        # Stub the metadata analysis for rails 5
+        stub_method(attachment, :analyze, true) do
+          stub_method(attachment, :analyzed?, true) do
+            stub_method(attachment, :metadata, { width: width, height: height }) do
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/attached_validator_matcher.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_attached_of(name)
+      AttachedValidatorMatcher.new(name)
+    end
+
+    class AttachedValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+      end
+
+      def description
+        "validate #{@attribute_name} must be attached"
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject : subject.class
+
+        invalid_when_not_attached && valid_when_attached
+      end
+
+      def failure_message
+        "is expected to validate attached of #{@attribute_name}"
+      end
+
+      def failure_message_when_negated
+        "is expected to not validate attached of #{@attribute_name}"
+      end
+
+      private
+
+      def valid_when_attached
+        instance = @subject.new
+        instance.public_send(@attribute_name).attach(attachable)
+        instance.validate
+        instance.errors.details[@attribute_name].exclude?(error: :blank)
+      end
+
+      def invalid_when_not_attached
+        instance = @subject.new
+        instance.validate
+        instance.errors.details[@attribute_name].include?(error: :blank)
+      end
+
+      def attachable
+        { io: Tempfile.new('.'), filename: 'dummy.txt', content_type: 'text/plain' }
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -0,0 +1,95 @@
+# 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_content_type_matcher.rb
+module ActiveStorageValidations
+  module Matchers
+    def validate_content_type_of(name)
+      ContentTypeValidatorMatcher.new(name)
+    end
+
+    class ContentTypeValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+      end
+
+      def description
+        "validate the content types allowed on attachment #{@attribute_name}"
+      end
+
+      def allowing(*types)
+        @allowed_types = types.flatten
+        self
+      end
+
+      def rejecting(*types)
+        @rejected_types = types.flatten
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+        allowed_types_allowed? && rejected_types_rejected?
+      end
+
+      def failure_message
+        <<~MESSAGE
+          Expected #{@attribute_name}
+            
+            Accept content types: #{allowed_types.join(", ")}
+              #{accepted_types_and_failures}
+
+            Reject content types: #{rejected_types.join(", ")}
+              #{rejected_types_and_failures}
+        MESSAGE
+      end
+
+      protected
+
+      def allowed_types
+        @allowed_types || []
+      end
+
+      def rejected_types
+        @rejected_types || (Mime::LOOKUP.keys - allowed_types)
+      end
+
+      def allowed_types_allowed?
+        @missing_allowed_types ||= allowed_types.reject { |type| type_allowed?(type) }
+        @missing_allowed_types.none?
+      end
+
+      def rejected_types_rejected?
+        @missing_rejected_types ||= rejected_types.select { |type| type_allowed?(type) }
+        @missing_rejected_types.none?
+      end
+
+      def accepted_types_and_failures
+        if @missing_allowed_types.present?
+          "#{@missing_allowed_types.join(", ")} were rejected."
+        else
+          "All were accepted successfully."
+        end
+      end
+
+      def rejected_types_and_failures
+        if @missing_rejected_types.present?
+          "#{@missing_rejected_types.join(", ")} were accepted."
+        else
+          "All were rejected successfully."
+        end
+      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 }
+      end
+
+      def attachment_for(type)
+        suffix = type.to_s.split('/').last
+        { io: Tempfile.new('.'), filename: "test.#{suffix}", content_type: type }
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/dimension_validator_matcher.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  module Matchers
+    def validate_dimensions_of(name)
+      DimensionValidatorMatcher.new(name)
+    end
+
+    class DimensionValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+        @width_min = @width_max = @height_min = @height_max = nil
+      end
+
+      def description
+        "validate image dimensions of #{@attribute_name}"
+      end
+
+      def width_min(width)
+        @width_min = width
+        self
+      end
+
+      def width_max(width)
+        @width_max = width
+        self
+      end
+
+      def width(width)
+        @width_min = @width_max = width
+        self
+      end
+
+      def height_min(height)
+        @height_min = height
+        self
+      end
+
+      def height_max(height)
+        @height_max = height
+        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
+        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
+      end
+
+      protected
+
+      def valid_width
+        ((@width_min || 0) + (@width_max || 2000)) / 2
+      end
+
+      def valid_height
+        ((@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')
+      end
+
+      def width_larger_than_min?
+        @width_min.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_min + 1, valid_height, 'width')
+      end
+
+      def width_smaller_than_max?
+        @width_max.nil? || @width_min == @width_max || passes_validation_with_dimensions(@width_max - 1, valid_height, 'width')
+      end
+
+      def width_larger_than_max?
+        @width_max.nil? || !passes_validation_with_dimensions(@width_max + 1, valid_height, 'width')
+      end
+
+      def width_equals?
+        @width_min.nil? || @width_min != @width_max || passes_validation_with_dimensions(@width_min, valid_height, 'width')
+      end
+
+      def height_smaller_than_min?
+        @height_min.nil? || !passes_validation_with_dimensions(valid_width, @height_min - 1, 'height')
+      end
+
+      def height_larger_than_min?
+        @height_min.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_min + 1, 'height')
+      end
+
+      def height_smaller_than_max?
+        @height_max.nil? || @height_min == @height_max || passes_validation_with_dimensions(valid_width, @height_max - 1, 'height')
+      end
+
+      def height_larger_than_max?
+        @height_max.nil? || !passes_validation_with_dimensions(valid_width, @height_max + 1, 'height')
+      end
+
+      def height_equals?
+        @height_min.nil? || @height_min != @height_max || passes_validation_with_dimensions(valid_width, @height_min, 'height')
+      end
+
+      def passes_validation_with_dimensions(width, height, check)
+        @subject.public_send(@attribute_name).attach attachment_for(width, height)
+
+        attachment = @subject.public_send(@attribute_name)
+        Matchers.mock_metadata(attachment, width, height) do
+          @subject.validate
+          @subject.errors.details[@attribute_name].all? { |error| error[:error].to_s.exclude?("dimension_#{check}") }
+        end
+      end
+
+      def attachment_for(width, height)
+        { io: Tempfile.new('Hello world!'), filename: 'test.png', content_type: 'image/png' }
+      end
+    end
+  end
+end

data/lib/active_storage_validations/matchers/size_validator_matcher.rb

@@ -0,0 +1,87 @@
+# 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
+module ActiveStorageValidations
+  module Matchers
+    def validate_size_of(name)
+      SizeValidatorMatcher.new(name)
+    end
+
+    class SizeValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+        @low = @high = nil
+      end
+
+      def description
+        "validate file size of #{@attribute_name}"
+      end
+
+      def less_than(size)
+        @high = size - 1.byte
+        self
+      end
+
+      def less_than_or_equal_to(size)
+        @high = size
+        self
+      end
+
+      def greater_than(size)
+        @low = size + 1.byte
+        self
+      end
+
+      def greater_than_or_equal_to(size)
+        @low = size
+        self
+      end
+
+      def between(range)
+        @low, @high = range.first, range.last
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+        lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
+      end
+
+      def failure_message
+        "is expected to validate file size of #{@attribute_name} to be between #{@low} and #{@high} bytes"
+      end
+
+      def failure_message_when_negated
+        "is expected to not validate file size of #{@attribute_name} to be between #{@low} and #{@high} bytes"
+      end
+
+      protected
+
+      def lower_than_low?
+        @low.nil? || !passes_validation_with_size(@low - 1)
+      end
+
+      def higher_than_low?
+        @low.nil? || passes_validation_with_size(@low + 1)
+      end
+
+      def lower_than_high?
+        @high.nil? || @high == Float::INFINITY || passes_validation_with_size(@high - 1)
+      end
+
+      def higher_than_high?
+        @high.nil? || @high == Float::INFINITY || !passes_validation_with_size(@high + 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
+          @subject.errors.details[@attribute_name].all? { |error| error[:error] != :file_size_out_of_range }
+        end
+      end
+    end
+  end
+end

data/lib/active_storage_validations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveStorageValidations
-  VERSION = '0.8.6'
+  VERSION = '0.8.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_validations
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,11 @@ files:
 - lib/active_storage_validations/dimension_validator.rb
 - lib/active_storage_validations/engine.rb
 - lib/active_storage_validations/limit_validator.rb
+- lib/active_storage_validations/matchers.rb
+- lib/active_storage_validations/matchers/attached_validator_matcher.rb
+- lib/active_storage_validations/matchers/content_type_validator_matcher.rb
+- lib/active_storage_validations/matchers/dimension_validator_matcher.rb
+- lib/active_storage_validations/matchers/size_validator_matcher.rb
 - lib/active_storage_validations/metadata.rb
 - lib/active_storage_validations/railtie.rb
 - lib/active_storage_validations/size_validator.rb