active_storage_validations 1.3.0 → 1.3.2

data/lib/active_storage_validations/shared/attachable.rb

@@ -0,0 +1,134 @@
+require_relative "../metadata"
+
+module ActiveStorageValidations
+  # ActiveStorageValidations::Attachable
+  #
+  # Validator methods for analyzing attachable.
+  #
+  # An attachable is a file representation such as ActiveStorage::Blob,
+  # ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile, Hash, String,
+  # File or Pathname
+  module Attachable
+    extend ActiveSupport::Concern
+
+    private
+
+    # Loop through the newly submitted attachables to validate them. Using
+    # attachables is the only way to get the attached file io that is necessary
+    # to perform file analyses.
+    def validate_changed_files_from_metadata(record, attribute)
+      attachables_from_changes(record, attribute).each do |attachable|
+        is_valid?(record, attribute, attachable, Metadata.new(attachable).metadata)
+      end
+    end
+
+    # Retrieve an array of newly submitted attachables. Some file could be passed
+    # several times, we just need to perform the analysis once on the file,
+    # therefore the use of #uniq.
+    def attachables_from_changes(record, attribute)
+      changes = record.attachment_changes[attribute.to_s]
+      return [] if changes.blank?
+
+      Array.wrap(
+        changes.is_a?(ActiveStorage::Attached::Changes::CreateMany) ? changes.attachables : changes.attachable
+      ).uniq
+    end
+
+    # Retrieve the full declared content_type from attachable.
+    def full_attachable_content_type(attachable)
+      case attachable
+      when ActiveStorage::Blob
+        attachable.content_type
+      when ActionDispatch::Http::UploadedFile
+        attachable.content_type
+      when Rack::Test::UploadedFile
+        attachable.content_type
+      when String
+        blob = ActiveStorage::Blob.find_signed!(attachable)
+        blob.content_type
+      when Hash
+        attachable[:content_type]
+      when File
+        supports_file_attachment? ? marcel_content_type_from_filename(attachable) : raise_rails_like_error(attachable)
+      when Pathname
+        supports_pathname_attachment? ? marcel_content_type_from_filename(attachable) : raise_rails_like_error(attachable)
+      else
+        raise_rails_like_error(attachable)
+      end
+    end
+
+    # Retrieve the declared content_type from attachable without potential mime
+    # type parameters (e.g. 'application/x-rar-compressed;version=5')
+    def attachable_content_type(attachable)
+      full_attachable_content_type(attachable) && full_attachable_content_type(attachable).downcase.split(/[;,\s]/, 2).first
+    end
+
+    # Retrieve the io from attachable.
+    def attachable_io(attachable)
+      case attachable
+      when ActiveStorage::Blob
+        attachable.download
+      when ActionDispatch::Http::UploadedFile
+        attachable.read
+      when Rack::Test::UploadedFile
+        attachable.read
+      when String
+        blob = ActiveStorage::Blob.find_signed!(attachable)
+        blob.download
+      when Hash
+        attachable[:io].read
+      when File
+        supports_file_attachment? ? attachable : raise_rails_like_error(attachable)
+      when Pathname
+        supports_pathname_attachment? ? attachable.read : raise_rails_like_error(attachable)
+      else
+        raise_rails_like_error(attachable)
+      end
+    end
+
+    # Retrieve the declared filename from attachable.
+    def attachable_filename(attachable)
+      case attachable
+      when ActiveStorage::Blob
+        attachable.filename
+      when ActionDispatch::Http::UploadedFile
+        attachable.original_filename
+      when Rack::Test::UploadedFile
+        attachable.original_filename
+      when String
+        blob = ActiveStorage::Blob.find_signed!(attachable)
+        blob.filename
+      when Hash
+        attachable[:filename]
+      when File
+        supports_file_attachment? ? File.basename(attachable) : raise_rails_like_error(attachable)
+      when Pathname
+        supports_pathname_attachment? ? File.basename(attachable) : raise_rails_like_error(attachable)
+      else
+        raise_rails_like_error(attachable)
+      end
+    end
+
+    # Raise the same Rails error for not-implemented file representations.
+    def raise_rails_like_error(attachable)
+      raise(
+        ArgumentError,
+        "Could not find or build blob: expected attachable, " \
+          "got #{attachable.inspect}"
+      )
+    end
+
+    # Check if the current Rails version supports File or Pathname attachment
+    #
+    # https://github.com/rails/rails/blob/7-1-stable/activestorage/CHANGELOG.md#rails-710rc1-september-27-2023
+    def supports_file_attachment?
+      Rails.gem_version >= Gem::Version.new('7.1.0.rc1')
+    end
+    alias :supports_pathname_attachment? :supports_file_attachment?
+
+    # Retrieve the content_type from the file name only
+    def marcel_content_type_from_filename(attachable)
+      Marcel::MimeType.for(name: attachable_filename(attachable).to_s)
+    end
+  end
+end

data/lib/active_storage_validations/{concerns → shared}/errorable.rb

@@ -30,8 +30,9 @@ module ActiveStorageValidations
 
       case file
       when ActiveStorage::Attached, ActiveStorage::Attachment then file.blob&.filename&.to_s
+      when ActiveStorage::Blob then file.filename
       when Hash then file[:filename]
-      end
+      end.to_s
     end
   end
 end

data/lib/active_storage_validations/shared/optionable.rb

@@ -0,0 +1,27 @@
+module ActiveStorageValidations
+  # ActiveStorageValidations::Optionable
+  #
+  # Helper method to flatten the validator options.
+  module Optionable
+    extend ActiveSupport::Concern
+
+    private
+
+    def set_flat_options(record)
+      flatten_options(record, self.options)
+    end
+
+    def flatten_options(record, options, available_checks = self.class::AVAILABLE_CHECKS)
+      case options
+      when Hash
+        options.merge(options) do |key, value|
+          available_checks&.exclude?(key) ? {} : flatten_options(record, value, nil)
+        end
+      when Array
+        options.map { |option| flatten_options(record, option, available_checks) }
+      else
+        options.is_a?(Proc) ? options.call(record) : options
+      end
+    end
+  end
+end

data/lib/active_storage_validations/size_validator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'base_size_validator.rb'
+require_relative 'base_size_validator'
 
 module ActiveStorageValidations
   class SizeValidator < BaseSizeValidator
@@ -15,7 +15,7 @@ module ActiveStorageValidations
     def validate_each(record, attribute, _value)
       return if no_attachments?(record, attribute)
 
-      flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
+      flat_options = set_flat_options(record)
 
       attached_files(record, attribute).each do |file|
         next if is_valid?(file.blob.byte_size, flat_options)

data/lib/active_storage_validations/total_size_validator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'base_size_validator.rb'
+require_relative 'base_size_validator'
 
 module ActiveStorageValidations
   class TotalSizeValidator < BaseSizeValidator
@@ -18,7 +18,7 @@ module ActiveStorageValidations
       return if no_attachments?(record, attribute)
 
       total_file_size = attached_files(record, attribute).sum { |file| file.blob.byte_size }
-      flat_options = unfold_procs(record, self.options, AVAILABLE_CHECKS)
+      flat_options = set_flat_options(record)
 
       return if is_valid?(total_file_size, flat_options)
 

data/lib/active_storage_validations/version.rb

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

data/lib/active_storage_validations.rb

@@ -5,7 +5,6 @@ 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/attached_validator'
 require 'active_storage_validations/content_type_validator'
 require 'active_storage_validations/limit_validator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_validations
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-20 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -81,47 +95,73 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: marcel
+  name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 4.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 4.9.5
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.5
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.5
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest-stub_any_instance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -222,11 +262,6 @@ files:
 - 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/active_storageable.rb
-- lib/active_storage_validations/concerns/errorable.rb
-- lib/active_storage_validations/concerns/loggable.rb
-- lib/active_storage_validations/concerns/metadatable.rb
-- lib/active_storage_validations/concerns/symbolizable.rb
 - lib/active_storage_validations/content_type_spoof_detector.rb
 - lib/active_storage_validations/content_type_validator.rb
 - lib/active_storage_validations/dimension_validator.rb
@@ -237,23 +272,28 @@ files:
 - 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/limit_validator_matcher.rb
 - lib/active_storage_validations/matchers/processable_image_validator_matcher.rb
+- lib/active_storage_validations/matchers/shared/active_storageable.rb
+- lib/active_storage_validations/matchers/shared/allow_blankable.rb
+- lib/active_storage_validations/matchers/shared/attachable.rb
+- lib/active_storage_validations/matchers/shared/contextable.rb
+- lib/active_storage_validations/matchers/shared/messageable.rb
+- lib/active_storage_validations/matchers/shared/rspecable.rb
+- lib/active_storage_validations/matchers/shared/validatable.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/shared/active_storageable.rb
+- lib/active_storage_validations/shared/attachable.rb
+- lib/active_storage_validations/shared/errorable.rb
+- lib/active_storage_validations/shared/loggable.rb
+- lib/active_storage_validations/shared/optionable.rb
+- lib/active_storage_validations/shared/symbolizable.rb
 - lib/active_storage_validations/size_validator.rb
 - lib/active_storage_validations/total_size_validator.rb
 - lib/active_storage_validations/version.rb
@@ -278,7 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Validations for Active Storage

data/lib/active_storage_validations/concerns/metadatable.rb

@@ -1,31 +0,0 @@
-require_relative '../metadata'
-
-module ActiveStorageValidations
-  # ActiveStorageValidations::Metadatable
-  #
-  # Validator methods for analyzing the attachment metadata.
-  module Metadatable
-    extend ActiveSupport::Concern
-
-    private
-
-    # Loop through the newly submitted attachables to validate them
-    def validate_changed_files_from_metadata(record, attribute)
-      attachables_from_changes(record, attribute).each do |attachable|
-        is_valid?(record, attribute, attachable, Metadata.new(attachable).metadata)
-      end
-    end
-
-    # Retrieve an array of newly submitted attachables which are file
-    # representations such as ActiveStorage::Blob, ActionDispatch::Http::UploadedFile,
-    # Rack::Test::UploadedFile, Hash, String, File or Pathname
-    def attachables_from_changes(record, attribute)
-      changes = record.attachment_changes[attribute.to_s]
-      return [] if changes.blank?
-
-      Array.wrap(
-        changes.is_a?(ActiveStorage::Attached::Changes::CreateMany) ? changes.attachables : changes.attachable
-      )
-    end
-  end
-end

data/lib/active_storage_validations/option_proc_unfolding.rb

@@ -1,16 +0,0 @@
-module ActiveStorageValidations
-  module OptionProcUnfolding
-
-    def unfold_procs(record, object, only_keys)
-      case object
-      when Hash
-        object.merge(object) { |key, value| only_keys&.exclude?(key) ? {} : unfold_procs(record, value, nil) }
-      when Array
-        object.map { |o| unfold_procs(record, o, only_keys) }
-      else
-        object.is_a?(Proc) ? object.call(record) : object
-      end
-    end
-
-  end
-end