active_storage_validations 0.9.4 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ef7bbaa01aafa835921f0ad446b86e5b5c49a73a6f08e42feb97ff9bd3c7fd
-  data.tar.gz: e4f18d0de97ffa2adfe59e2d5d841706a8de3e6e575390aafb5b75dbf82a37a2
+  metadata.gz: 0f77bdb678731cdb6bb3aca1bddf3a3b1d1d4f34355a778c504931d067f6d0e2
+  data.tar.gz: cb723cb17a4cbfcfec2e7a9b8432ac0d2641afbef327a92e38baa376d15ba2fd
 SHA512:
-  metadata.gz: 5b29620eb2a65e73c9f7c1c9d2bf143ba20aed0e460fdd763d415651b80463821f5dea26d2b28834dae7dc90ad035d6bbaa47bc7e89161365bfb154485a12c8b
-  data.tar.gz: ee7ef332175aca338df8d46de13ac0487f1aa4b5a3d7aa220bd14826b0f73f55377a6475c2b2eb9133d06aae456a2d18bdc4fbec07b7caaf9cd9fa3b8f1dcf5b
+  metadata.gz: d44aed46b1f790d3df1913009fc1c84ea5831be3c8809063c94a0c50de3d8b9f40613eab920c49fb8f81dd0808d9c489aebb1705e022defe1e745d1205a48203
+  data.tar.gz: 3d770860efb253f13ea1f18086c5b8a51253caf69875ba1d9d7921c17b9c5ce43f8001f4d8eeb1e095f8f37d1f0924dbddcdb35ca24b721d6fd5cf2a002d9a90

data/README.md

@@ -26,16 +26,17 @@ For example you have a model like this and you want to add validation.
 class User < ApplicationRecord
   has_one_attached :avatar
   has_many_attached :photos
+  has_one_attached :image
 
   validates :name, presence: true
 
   validates :avatar, attached: true, content_type: 'image/png',
                                      dimension: { width: 200, height: 200 }
-  validates :photos, attached: true, content_type: ['image/png', 'image/jpg', 'image/jpeg'],
+  validates :photos, attached: true, content_type: ['image/png', 'image/jpeg'],
                                      dimension: { width: { min: 800, max: 2400 },
                                                   height: { min: 600, max: 1800 }, message: 'is not given between dimension' }
   validates :image, attached: true,
-                    content_type: ['image/png', 'image/jpg'],
+                    content_type: ['image/png', 'image/jpeg'],
                     aspect_ratio: :landscape
 end
 ```
@@ -44,13 +45,15 @@ or
 
 ```ruby
 class Project < ApplicationRecord
+  has_one_attached :logo
   has_one_attached :preview
   has_one_attached :attachment
   has_many_attached :documents
 
   validates :title, presence: true
 
-  validates :preview, attached: true, size: { less_than: 100.megabytes , message: 'is not given between size' }
+  validates :logo, attached: true, size: { less_than: 100.megabytes , message: 'is too large' }
+  validates :preview, attached: true, size: { between: 1.kilobyte..100.megabytes , message: 'is not given between size' }
   validates :attachment, attached: true, content_type: { in: 'application/pdf', message: 'is not a PDF' }
   validates :documents, limit: { min: 1, max: 3 }
 end
@@ -58,14 +61,15 @@ end
 
 ### More examples
 
-- Content type validation using symbols. In order to infer the correct mime type from the symbol, the types must be registered with `Mime::Type`.
+- Content type validation using symbols. In order to infer the correct mime type from the symbol, the types must be registered with `Marcel::EXTENSIONS` (`MimeMagic::EXTENSIONS` for Rails <= 6.1.3).
 
 ```ruby
 class User < ApplicationRecord
   has_one_attached :avatar
   has_many_attached :photos
 
-  validates :avatar, attached: true, content_type: :png # Mime[:png].to_s => 'image/png'
+  validates :avatar, attached: true, content_type: :png # Marcel::Magic.by_extension(:png).to_s => 'image/png'
+                                                        # Rails <= 6.1.3; MimeMagic.by_extension(:png).to_s => 'image/png'
   # or
   validates :photos, attached: true, content_type: [:png, :jpg, :jpeg]
   # or
@@ -176,6 +180,8 @@ gem 'active_storage_validations'
 
 # Optional, to use :dimension validator or :aspect_ratio validator
 gem 'mini_magick', '>= 4.9.5'
+# Or
+gem 'ruby-vips', '>= 2.1.0'
 ```
 
 And then execute:
@@ -292,6 +298,22 @@ To run tests in root folder of gem:
 * `BUNDLE_GEMFILE=gemfiles/rails_5_2.gemfile bundle exec rake test` to run for Rails 5.2
 * `BUNDLE_GEMFILE=gemfiles/rails_6_0.gemfile bundle exec rake test` to run for Rails 6.0
 * `BUNDLE_GEMFILE=gemfiles/rails_6_1.gemfile bundle exec rake test` to run for Rails 6.1
+* `BUNDLE_GEMFILE=gemfiles/rails_next.gemfile bundle exec rake test` to run for Rails main branch
+
+Snippet to run in console:
+
+```
+BUNDLE_GEMFILE=gemfiles/rails_5_2.gemfile bundle
+BUNDLE_GEMFILE=gemfiles/rails_6_0.gemfile bundle
+BUNDLE_GEMFILE=gemfiles/rails_6_1.gemfile bundle
+BUNDLE_GEMFILE=gemfiles/rails_7_0.gemfile bundle
+BUNDLE_GEMFILE=gemfiles/rails_next.gemfile bundle
+BUNDLE_GEMFILE=gemfiles/rails_5_2.gemfile bundle exec rake test
+BUNDLE_GEMFILE=gemfiles/rails_6_0.gemfile bundle exec rake test
+BUNDLE_GEMFILE=gemfiles/rails_6_1.gemfile bundle exec rake test
+BUNDLE_GEMFILE=gemfiles/rails_7_0.gemfile bundle exec rake test
+BUNDLE_GEMFILE=gemfiles/rails_next.gemfile bundle exec rake test
+```
 
 ## Known issues
 
@@ -343,7 +365,16 @@ You are welcome to contribute.
 - https://github.com/dolarsrg
 - https://github.com/jayshepherd
 - https://github.com/ohbarye
-- https://github.com/...
+- https://github.com/randsina
+- https://github.com/vietqhoang
+- https://github.com/kemenaran
+- https://github.com/jrmhaig
+- https://github.com/tagliala
+- https://github.com/evedovelli
+- https://github.com/JuanVqz
+- https://github.com/luiseugenio
+- https://github.com/equivalent
+- https://github.com/NARKOZ
 
 ## License
 

data/config/locales/pt-BR.yml

@@ -2,21 +2,21 @@ pt-BR:
   errors:
     messages:
       content_type_invalid: "tem um tipo de arquivo inválido"
-      file_size_out_of_range: "tamanho %{file_size} está fora da faixa de tamanho válida"
-      limit_out_of_range: "número total está fora do limite"
+      file_size_out_of_range: "tem tamanho %{file_size} e está fora da faixa de tamanho válida"
+      limit_out_of_range: "o número total está fora do limite"
       image_metadata_missing: "não é uma imagem válida"
-      dimension_min_inclusion: "deve ser maior ou igual a %{width} x %{height} pixel"
-      dimension_max_inclusion: "deve ser menor ou igual a %{width} x %{height} pixel"
-      dimension_width_inclusion: "largura não está entre %{min} e %{max} pixel"
-      dimension_height_inclusion: "altura não está entre %{min} e %{max} pixel"
-      dimension_width_greater_than_or_equal_to: "largura deve ser maior ou igual a %{length} pixel"
-      dimension_height_greater_than_or_equal_to: "altura deve ser maior ou igual a %{length} pixel"
-      dimension_width_less_than_or_equal_to: "largura deve ser menor ou igual a %{length} pixel"
-      dimension_height_less_than_or_equal_to: "altura deve ser menor ou igual a %{length} pixel"
-      dimension_width_equal_to: "largura deve ser igual a %{length} pixel"
-      dimension_height_equal_to: "altura deve ser igual a %{length} pixel"
+      dimension_min_inclusion: "deve ser maior ou igual a %{width} x %{height} pixels"
+      dimension_max_inclusion: "deve ser menor ou igual a %{width} x %{height} pixels"
+      dimension_width_inclusion: "deve ter largura entre %{min} e %{max} pixels"
+      dimension_height_inclusion: "deve ter altura entre %{min} e %{max} pixels"
+      dimension_width_greater_than_or_equal_to: "deve ter largura maior ou igual a %{length} pixels"
+      dimension_height_greater_than_or_equal_to: "deve ter altura maior ou igual a %{length} pixels"
+      dimension_width_less_than_or_equal_to: "deve ter largura menor ou igual a %{length} pixels"
+      dimension_height_less_than_or_equal_to: "deve ter altura menor ou igual a %{length} pixels"
+      dimension_width_equal_to: "deve ter largura igual a %{length} pixels"
+      dimension_height_equal_to: "deve ter altura igual a %{length} pixels"
       aspect_ratio_not_square: "não é uma imagem quadrada"
-      aspect_ratio_not_portrait: "não contém uma imagem no formato retrato"
-      aspect_ratio_not_landscape: "não contém uma imagem no formato paisagem"
+      aspect_ratio_not_portrait: "não está no formato retrato"
+      aspect_ratio_not_landscape: "não está no formato paisagem"
       aspect_ratio_is_not: "não contém uma proporção de %{aspect_ratio}"
       aspect_ratio_unknown: "não tem uma proporção definida"

data/lib/active_storage_validations/aspect_ratio_validator.rb

@@ -8,7 +8,6 @@ module ActiveStorageValidations
     PRECISION = 3
 
     def initialize(options)
-      require 'mini_magick' unless defined?(MiniMagick)
       super(options)
     end
 
@@ -18,7 +17,7 @@ module ActiveStorageValidations
       raise ArgumentError, 'You must pass "aspect_ratio: :OPTION" option to the validator'
     end
 
-    if Rails::VERSION::MAJOR >= 6
+    if Rails.gem_version >= Gem::Version.new('6.0.0')
       def validate_each(record, attribute, _value)
         return true unless record.send(attribute).attached?
 
@@ -37,14 +36,14 @@ module ActiveStorageValidations
       # Rails 5
       def validate_each(record, attribute, _value)
         return true unless record.send(attribute).attached?
-  
+
         files = Array.wrap(record.send(attribute))
-  
+
         files.each do |file|
           # Analyze file first if not analyzed to get all required metadata.
           file.analyze; file.reload unless file.analyzed?
           metadata = file.metadata
-  
+
           next if is_valid?(record, attribute, metadata)
           break
         end

data/lib/active_storage_validations/content_type_validator.rb

@@ -20,14 +20,13 @@ module ActiveStorageValidations
     end
 
     def types
-      (Array.wrap(options[:with]) + Array.wrap(options[:in])).compact.map do |type|
+      return @types if defined? @types
+
+      @types = (Array.wrap(options[:with]) + Array.wrap(options[:in])).compact.map do |type|
         if type.is_a?(Regexp)
           type
-        elsif type.is_a?(String) && type =~ %r{\A\w+/[-+.\w]+\z} # mime-type-ish string
-          type
         else
-          Mime[type] || raise(ArgumentError, "content_type must be one of Regxep,"\
-          " supported mime types (e.g. :png, 'jpg'), or mime type String ('image/jpeg')")
+          Marcel::MimeType.for(declared_type: type.to_s, extension: type.to_s)
         end
       end
     end

data/lib/active_storage_validations/dimension_validator.rb

@@ -7,8 +7,6 @@ module ActiveStorageValidations
     AVAILABLE_CHECKS = %i[width height min max].freeze
 
     def initialize(options)
-      require 'mini_magick' unless defined?(MiniMagick)
-
       [:width, :height].each do |length|
         if options[length] and options[length].is_a?(Hash)
           if range = options[length][:in]
@@ -34,7 +32,7 @@ module ActiveStorageValidations
     end
 
 
-    if Rails::VERSION::MAJOR >= 6
+    if Rails.gem_version >= Gem::Version.new('6.0.0')
       def validate_each(record, attribute, _value)
         return true unless record.send(attribute).attached?
 

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -35,7 +35,7 @@ module ActiveStorageValidations
       def failure_message
         <<~MESSAGE
           Expected #{@attribute_name}
-            
+
             Accept content types: #{allowed_types.join(", ")}
               #{accepted_types_and_failures}
 
@@ -57,7 +57,7 @@ module ActiveStorageValidations
       end
 
       def rejected_types
-        @rejected_types || (Mime::LOOKUP.keys - allowed_types)
+        @rejected_types || (content_type_keys - allowed_types)
       end
 
       def allowed_types_allowed?
@@ -96,6 +96,16 @@ module ActiveStorageValidations
         suffix = type.to_s.split('/').last
         { io: Tempfile.new('.'), filename: "test.#{suffix}", content_type: type }
       end
+
+      private
+
+      def content_type_keys
+        if Rails.gem_version < Gem::Version.new('6.1.0')
+          Mime::LOOKUP.keys
+        else
+          Marcel::TYPES.keys
+        end
+      end
     end
   end
 end

data/lib/active_storage_validations/matchers.rb

@@ -22,7 +22,7 @@ module ActiveStorageValidations
     end
 
     def self.mock_metadata(attachment, width, height)
-      if Rails::VERSION::MAJOR >= 6
+      if Rails.gem_version >= Gem::Version.new('6.0.0')
         # Mock the Metadata class for rails 6
         mock = OpenStruct.new(metadata: { width: width, height: height })
         stub_method(ActiveStorageValidations::Metadata, :new, mock) do

data/lib/active_storage_validations/metadata.rb

@@ -3,9 +3,22 @@ module ActiveStorageValidations
     attr_reader :file
 
     def initialize(file)
+      require_image_processor
       @file = file
     end
 
+    def image_processor
+      Rails.application.config.active_storage.variant_processor
+    end
+
+    def require_image_processor
+      if image_processor == :vips
+        require 'vips' unless defined?(Vips)
+      else
+        require 'mini_magick' unless defined?(MiniMagick)
+      end
+    end
+
     def metadata
       read_image do |image|
         if rotated_image?(image)
@@ -21,17 +34,16 @@ module ActiveStorageValidations
     def read_image
       is_string = file.is_a?(String)
       if is_string || file.is_a?(ActiveStorage::Blob)
-        if is_string
-          # If Rails 5.2 or 6.0, use `find_signed`
-          if Rails::VERSION::MAJOR < 6 || (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR == 0)
-            blob = ActiveStorage::Blob.find_signed(file)
-          # If Rails 6.1 or higher, use `find_signed!`
-          elsif Rails::VERSION::MAJOR > 6 || (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR >= 1)
-            blob = ActiveStorage::Blob.find_signed!(file)
+        blob =
+          if is_string
+            if Rails.gem_version < Gem::Version.new('6.1.0')
+              ActiveStorage::Blob.find_signed(file)
+            else
+              ActiveStorage::Blob.find_signed!(file)
+            end
+          else
+            file
           end
-        else
-          blob = file
-        end
 
         tempfile = Tempfile.new(["ActiveStorage-#{blob.id}-", blob.filename.extension_with_delimiter])
         tempfile.binmode
@@ -43,29 +55,53 @@ module ActiveStorageValidations
         tempfile.flush
         tempfile.rewind
 
-        image = MiniMagick::Image.new(tempfile.path)
+        image = if image_processor == :vips && Vips::get_suffixes.include?(File.extname(tempfile.path))
+                  Vips::Image.new_from_file(tempfile.path)
+                else
+                  MiniMagick::Image.new(tempfile.path)
+                end
       else
-        image = MiniMagick::Image.new(read_file_path)
+        image = if image_processor == :vips && Vips::get_suffixes.include?(File.extname(read_file_path))
+                  Vips::Image.new_from_file(read_file_path)
+                else
+                  MiniMagick::Image.new(read_file_path)
+                end
       end
 
-      if image.valid?
+      if image && valid_image?(image)
         yield image
       else
-        logger.info "Skipping image analysis because ImageMagick doesn't support the file"
+        logger.info "Skipping image analysis because ImageMagick or Vips doesn't support the file"
         {}
       end
-    rescue LoadError
-      logger.info "Skipping image analysis because the mini_magick gem isn't installed"
+    rescue LoadError, NameError
+      logger.info "Skipping image analysis because the mini_magick or ruby-vips gem isn't installed"
       {}
     rescue MiniMagick::Error => error
       logger.error "Skipping image analysis due to an ImageMagick error: #{error.message}"
       {}
+    rescue Vips::Error => error
+      logger.error "Skipping image analysis due to a Vips error: #{error.message}"
+      {}
     ensure
       image = nil
     end
 
+    def valid_image?(image)
+      image_processor == :vips ? image.avg : image.valid?
+    rescue Vips::Error
+      false
+    end
+
     def rotated_image?(image)
-      %w[ RightTop LeftBottom ].include?(image["%[orientation]"])
+      if image_processor == :vips
+        image.get('exif-ifd0-Orientation').include?('Right-top') ||
+          image.get('exif-ifd0-Orientation').include?('Left-bottom')
+      else
+        %w[ RightTop LeftBottom ].include?(image["%[orientation]"])
+      end
+    rescue Vips::Error # field "exif-ifd0-Orientation" not found
+      false
     end
 
     def read_file_path

data/lib/active_storage_validations/size_validator.rb

@@ -25,6 +25,9 @@ module ActiveStorageValidations
         next if content_size_valid?(file.blob.byte_size)
 
         errors_options[:file_size] = number_to_human_size(file.blob.byte_size)
+        errors_options[:min_size] = number_to_human_size(min_size)
+        errors_options[:max_size] = number_to_human_size(max_size)
+
         record.errors.add(attribute, :file_size_out_of_range, **errors_options)
         break
       end
@@ -43,5 +46,13 @@ module ActiveStorageValidations
         file_size >= options[:greater_than_or_equal_to]
       end
     end
+
+    def min_size
+      options[:between]&.min || options[:greater_than] || options[:greater_than_or_equal_to]
+    end
+
+    def max_size
+      options[:between]&.max || options[:less_than] || options[:less_than_or_equal_to]
+    end
   end
 end

data/lib/active_storage_validations/version.rb

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

metadata

@@ -1,17 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_validations
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.7
 platform: ruby
 authors:
 - Igor Kasyanchuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.9.5
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Validations for Active Storage (presence)
 email:
 - igorkasyanchuk@gmail.com
@@ -138,7 +208,7 @@ homepage: https://github.com/igorkasyanchuk/active_storage_validations
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Validations for Active Storage
 test_files: []