active_storage_validations 1.1.1 → 1.2.0

data/lib/active_storage_validations/metadata.rb

@@ -4,29 +4,18 @@ module ActiveStorageValidations
 
     attr_reader :file
 
+    DEFAULT_IMAGE_PROCESSOR = :mini_magick.freeze
+
     def initialize(file)
       require_image_processor
       @file = file
     end
 
-    def image_processor
-      Rails.application.config.active_storage.variant_processor
-    end
-
-    def exception_class
-      if image_processor == :vips && defined?(Vips)
-        Vips::Error
-      elsif defined?(MiniMagick)
-        MiniMagick::Error
-      end
-    end
-
-    def require_image_processor
-      if image_processor == :vips
-        require 'vips' unless defined?(Vips)
-      else
-        require 'mini_magick' unless defined?(MiniMagick)
-      end
+    def valid?
+      read_image
+      true
+    rescue InvalidImageError
+      false
     end
 
     def metadata
@@ -42,14 +31,31 @@ module ActiveStorageValidations
       {}
     end
 
-    def valid?
-      read_image
-      true
-    rescue InvalidImageError
-      false
+    private
+
+    def image_processor
+      # Rails returns nil for default image processor, because it is set in an after initialize callback
+      # https://github.com/rails/rails/blob/89d8569abe2564c8187debf32dd3b4e33d6ad983/activestorage/lib/active_storage/engine.rb
+      Rails.application.config.active_storage.variant_processor || DEFAULT_IMAGE_PROCESSOR
     end
 
-    private
+    def require_image_processor
+      case image_processor
+      when :vips then require 'vips' unless defined?(Vips)
+      when :mini_magick then require 'mini_magick' unless defined?(MiniMagick)
+      end
+    end
+
+    def exception_class
+      case image_processor
+      when :vips then Vips::Error
+      when :mini_magick then MiniMagick::Error
+      end
+    end
+
+    def vips_image_processor?
+      image_processor == :vips
+    end
 
     def read_image
       is_string = file.is_a?(String)
@@ -95,23 +101,49 @@ module ActiveStorageValidations
     end
 
     def new_image_from_path(path)
-      if image_processor == :vips && defined?(Vips) && (Vips::get_suffixes.include?(File.extname(path).downcase) || !Vips::respond_to?(:vips_foreign_get_suffixes))
-        Vips::Image.new_from_file(path)
+      if vips_image_processor? && (supported_vips_suffix?(path) || vips_version_below_8_8? || open_uri_tempfile?(path))
+        begin
+          Vips::Image.new_from_file(path)
+        rescue exception_class
+          # We handle cases where an error is raised when reading the file
+          # because Vips can throw errors rather than returning false
+          # We stumble upon this issue while reading 0 byte size file
+          # https://github.com/janko/image_processing/issues/97
+          false
+        end
       elsif defined?(MiniMagick)
         MiniMagick::Image.new(path)
       end
     end
 
+    def supported_vips_suffix?(path)
+      Vips::get_suffixes.include?(File.extname(path).downcase)
+    end
+
+    def vips_version_below_8_8?
+      # FYI, Vips 8.8 was released in 2019
+      # https://github.com/libvips/libvips/releases/tag/v8.8.0
+      !Vips::respond_to?(:vips_foreign_get_suffixes)
+    end
+
+    def open_uri_tempfile?(path)
+      # When trying to open urls for 'large' images, OpenURI will return a
+      # tempfile. That tempfile does not have an extension indicating the type
+      # of file. However, Vips will be able to process it anyway.
+      # The 'large' file value is derived from OpenUri::Buffer class (> 10ko)
+      path.split('/').last.starts_with?("open-uri")
+    end
+
     def valid_image?(image)
       return false unless image
 
-      image_processor == :vips && image.is_a?(Vips::Image) ? image.avg : image.valid?
+      vips_image_processor? && image.is_a?(Vips::Image) ? image.avg : image.valid?
     rescue exception_class
       false
     end
 
     def rotated_image?(image)
-      if image_processor == :vips && image.is_a?(Vips::Image)
+      if vips_image_processor? && image.is_a?(Vips::Image)
         image.get('exif-ifd0-Orientation').include?('Right-top') ||
           image.get('exif-ifd0-Orientation').include?('Left-bottom')
       else

data/lib/active_storage_validations/processable_image_validator.rb

@@ -1,25 +1,33 @@
 # frozen_string_literal: true
 
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
 require_relative 'metadata.rb'
 
 module ActiveStorageValidations
   class ProcessableImageValidator < ActiveModel::EachValidator # :nodoc
     include OptionProcUnfolding
-    include ErrorHandler
+    include Errorable
+    include Symbolizable
+
+    ERROR_TYPES = %i[
+      image_not_processable
+    ].freeze
 
     if Rails.gem_version >= Gem::Version.new('6.0.0')
       def validate_each(record, attribute, _value)
         return true unless record.send(attribute).attached?
 
-        errors_options = initialize_error_options(options)
-
         changes = record.attachment_changes[attribute.to_s]
         return true if changes.blank?
 
         files = Array.wrap(changes.is_a?(ActiveStorage::Attached::Changes::CreateMany) ? changes.attachables : changes.attachable)
 
         files.each do |file|
-          add_error(record, attribute, :image_not_processable, **errors_options) unless Metadata.new(file).valid?
+          if !Metadata.new(file).valid?
+            errors_options = initialize_error_options(options, file)
+            add_error(record, attribute, ERROR_TYPES.first , **errors_options) unless Metadata.new(file).valid?
+          end
         end
       end
     else
@@ -30,7 +38,10 @@ module ActiveStorageValidations
         files = Array.wrap(record.send(attribute))
 
         files.each do |file|
-          add_error(record, attribute, :image_not_processable, **errors_options) unless Metadata.new(file).valid?
+          if !Metadata.new(file).valid?
+            errors_options = initialize_error_options(options, file)
+            add_error(record, attribute, ERROR_TYPES.first , **errors_options) unless Metadata.new(file).valid?
+          end
         end
       end
     end

data/lib/active_storage_validations/size_validator.rb

@@ -1,63 +1,38 @@
 # frozen_string_literal: true
 
-module ActiveStorageValidations
-  class SizeValidator < ActiveModel::EachValidator # :nodoc:
-    include OptionProcUnfolding
-    include ErrorHandler
-
-    delegate :number_to_human_size, to: ActiveSupport::NumberHelper
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
+require_relative 'base_size_validator.rb'
 
-    AVAILABLE_CHECKS = %i[less_than less_than_or_equal_to greater_than greater_than_or_equal_to between].freeze
-
-    def check_validity!
-      unless AVAILABLE_CHECKS.one? { |argument| options.key?(argument) }
-        raise ArgumentError, 'You must pass either :less_than(_or_equal_to), :greater_than(_or_equal_to), or :between to the validator'
-      end
-    end
+module ActiveStorageValidations
+  class SizeValidator < BaseSizeValidator
+    ERROR_TYPES = %i[
+      file_size_not_less_than
+      file_size_not_less_than_or_equal_to
+      file_size_not_greater_than
+      file_size_not_greater_than_or_equal_to
+      file_size_not_between
+    ].freeze
 
     def validate_each(record, attribute, _value)
-      # only attached
       return true unless record.send(attribute).attached?
 
       files = Array.wrap(record.send(attribute))
-
-      errors_options = initialize_error_options(options)
-
       flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
 
       files.each do |file|
-        next if content_size_valid?(file.blob.byte_size, flat_options)
+        next if is_valid?(file.blob.byte_size, flat_options)
 
+        errors_options = initialize_error_options(options, file)
+        populate_error_options(errors_options, flat_options)
         errors_options[:file_size] = number_to_human_size(file.blob.byte_size)
-        errors_options[:min_size] = number_to_human_size(min_size(flat_options))
-        errors_options[:max_size] = number_to_human_size(max_size(flat_options))
-        error_type = "file_size_not_#{flat_options.keys.first}".to_sym
+
+        keys = AVAILABLE_CHECKS & flat_options.keys
+        error_type = "file_size_not_#{keys.first}".to_sym
 
         add_error(record, attribute, error_type, **errors_options)
         break
       end
     end
-
-    def content_size_valid?(file_size, flat_options)
-      if flat_options[:between].present?
-        flat_options[:between].include?(file_size)
-      elsif flat_options[:less_than].present?
-        file_size < flat_options[:less_than]
-      elsif flat_options[:less_than_or_equal_to].present?
-        file_size <= flat_options[:less_than_or_equal_to]
-      elsif flat_options[:greater_than].present?
-        file_size > flat_options[:greater_than]
-      elsif flat_options[:greater_than_or_equal_to].present?
-        file_size >= flat_options[:greater_than_or_equal_to]
-      end
-    end
-
-    def min_size(flat_options)
-      flat_options[:between]&.min || flat_options[:greater_than] || flat_options[:greater_than_or_equal_to]
-    end
-
-    def max_size(flat_options)
-      flat_options[:between]&.max || flat_options[:less_than] || flat_options[:less_than_or_equal_to]
-    end
   end
 end

data/lib/active_storage_validations/total_size_validator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/errorable.rb'
+require_relative 'concerns/symbolizable.rb'
+require_relative 'base_size_validator.rb'
+
+module ActiveStorageValidations
+  class TotalSizeValidator < BaseSizeValidator
+    ERROR_TYPES = %i[
+      total_file_size_not_less_than
+      total_file_size_not_less_than_or_equal_to
+      total_file_size_not_greater_than
+      total_file_size_not_greater_than_or_equal_to
+      total_file_size_not_between
+    ].freeze
+
+    def validate_each(record, attribute, _value)
+      custom_check_validity!(record, attribute)
+
+      return true unless record.send(attribute).attached?
+
+      files = Array.wrap(record.send(attribute))
+      flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
+
+      total_file_size = files.sum { |file| file.blob.byte_size }
+
+      return true if is_valid?(total_file_size, flat_options)
+
+      errors_options = initialize_error_options(options, nil)
+      populate_error_options(errors_options, flat_options)
+      errors_options[:total_file_size] = number_to_human_size(total_file_size)
+
+      keys = AVAILABLE_CHECKS & flat_options.keys
+      error_type = "total_file_size_not_#{keys.first}".to_sym
+
+      add_error(record, attribute, error_type, **errors_options)
+    end
+
+    private
+
+    def custom_check_validity!(record, attribute)
+      # We can't perform this check in the #check_validity! hook because we do not
+      # have enough data (only options & attributes are accessible)
+      unless record.send(attribute).is_a?(ActiveStorage::Attached::Many)
+        raise ArgumentError, 'This validator is only available for has_many_attached relations'
+      end
+    end
+  end
+end

data/lib/active_storage_validations/version.rb

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

data/lib/active_storage_validations.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 require 'active_model'
+require 'active_support/concern'
 
 require 'active_storage_validations/railtie'
 require 'active_storage_validations/engine'
 require 'active_storage_validations/option_proc_unfolding'
-require 'active_storage_validations/error_handler'
 require 'active_storage_validations/attached_validator'
 require 'active_storage_validations/content_type_validator'
-require 'active_storage_validations/size_validator'
 require 'active_storage_validations/limit_validator'
 require 'active_storage_validations/dimension_validator'
 require 'active_storage_validations/aspect_ratio_validator'
 require 'active_storage_validations/processable_image_validator'
+require 'active_storage_validations/size_validator'
+require 'active_storage_validations/total_size_validator'
 
 ActiveSupport.on_load(:active_record) do
   send :include, ActiveStorageValidations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_validations
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -81,49 +81,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-vips
+  name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 4.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 4.9.5
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,21 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: marcel
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,19 +179,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: globalid
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Validations for Active Storage (presence)
 email:
 - igorkasyanchuk@gmail.com
@@ -202,6 +202,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- config/locales/da.yml
 - config/locales/de.yml
 - config/locales/en.yml
 - config/locales/es.yml
@@ -220,27 +221,42 @@ files:
 - lib/active_storage_validations.rb
 - lib/active_storage_validations/aspect_ratio_validator.rb
 - lib/active_storage_validations/attached_validator.rb
+- lib/active_storage_validations/base_size_validator.rb
+- lib/active_storage_validations/concerns/errorable.rb
+- lib/active_storage_validations/concerns/symbolizable.rb
 - lib/active_storage_validations/content_type_validator.rb
 - lib/active_storage_validations/dimension_validator.rb
 - lib/active_storage_validations/engine.rb
-- lib/active_storage_validations/error_handler.rb
 - lib/active_storage_validations/limit_validator.rb
 - lib/active_storage_validations/matchers.rb
+- lib/active_storage_validations/matchers/aspect_ratio_validator_matcher.rb
 - lib/active_storage_validations/matchers/attached_validator_matcher.rb
+- lib/active_storage_validations/matchers/base_size_validator_matcher.rb
+- lib/active_storage_validations/matchers/concerns/active_storageable.rb
+- lib/active_storage_validations/matchers/concerns/allow_blankable.rb
+- lib/active_storage_validations/matchers/concerns/attachable.rb
+- lib/active_storage_validations/matchers/concerns/contextable.rb
+- lib/active_storage_validations/matchers/concerns/messageable.rb
+- lib/active_storage_validations/matchers/concerns/rspecable.rb
+- lib/active_storage_validations/matchers/concerns/validatable.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/processable_image_validator_matcher.rb
 - lib/active_storage_validations/matchers/size_validator_matcher.rb
+- lib/active_storage_validations/matchers/total_size_validator_matcher.rb
 - lib/active_storage_validations/metadata.rb
 - lib/active_storage_validations/option_proc_unfolding.rb
 - lib/active_storage_validations/processable_image_validator.rb
 - lib/active_storage_validations/railtie.rb
 - lib/active_storage_validations/size_validator.rb
+- lib/active_storage_validations/total_size_validator.rb
 - lib/active_storage_validations/version.rb
 - lib/tasks/active_storage_validations_tasks.rake
 homepage: https://github.com/igorkasyanchuk/active_storage_validations
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -249,14 +265,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Validations for Active Storage

data/lib/active_storage_validations/error_handler.rb

@@ -1,18 +0,0 @@
-module ActiveStorageValidations
-  module ErrorHandler
-
-    def initialize_error_options(options)
-      {
-        message: (options[:message] if options[:message].present?)
-      }
-    end
-
-    def add_error(record, attribute, default_message, **errors_options)
-      message = errors_options[:message].presence || default_message
-      return if record.errors.added?(attribute, message)
-
-      record.errors.add(attribute, message, **errors_options)
-    end
-
-  end
-end