active_storage_validations 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3fa76d4dc0cf3d5bffc62dcc604d6f38edf165931c94d9314288606b6205a56
-  data.tar.gz: 9adb8defb7d44c65a4ea67cf632087d423a1c2c44b918822653638132f8beef4
+  metadata.gz: b3a3eccb847537354b9018f239171e4b3bdf363991d68c57844d87ecd0c14fcd
+  data.tar.gz: 432cfb9b3162db1d57446536de58d3b511c5a641d3da8c22123da56c877fd804
 SHA512:
-  metadata.gz: 9a2d4ce5113ed8a018d71b4d40b01c11946892eea438d2b7481b7007511022695998271d06215e6ddf07929d4e057fc8411a2b0babcb508f70af6140fb4d65c8
-  data.tar.gz: 3d31b7848f3174a8df330e5410b5c1aec018a243bfdefa2abdfc8eee9d9f652e34645853da38dee2b1627ef42efa679fabdac11e896a6a37ce9cd0ed1c5569f7
+  metadata.gz: '0697168d7d38d2974772a89e203861099bf5ac476e147dbc14826d1cee98271e3ded9789fd0ada073853d835658165141a596eeeb92af1cf52850d8c8f76c110'
+  data.tar.gz: d9ad210e053d90e69df85a6ce21644ace0eb096376db6ff5c5b1e4fb31a6eff2d23db6000f1ef566fba33337d242b23b52dbdc9af481b10e9870248a88c15fac

data/README.md

@@ -19,6 +19,7 @@ This gems doing it for you. Just use `attached: true` or `content_type: 'image/p
 * validates dimension of images/videos
 * validates number of uploaded files (min/max required)
 * validates aspect ratio (if square, portrait, landscape, is_16_9, ...)
+* validates if file can be processed by MiniMagick or Vips
 * custom error messages
 * allow procs for dynamic determination of values
 
@@ -40,6 +41,7 @@ class User < ApplicationRecord
                                      dimension: { width: { min: 800, max: 2400 },
                                                   height: { min: 600, max: 1800 }, message: 'is not given between dimension' }
   validates :image, attached: true,
+                    processable_image: true,
                     content_type: ['image/png', 'image/jpeg'],
                     aspect_ratio: :landscape
 end
@@ -164,6 +166,7 @@ en:
       aspect_ratio_not_landscape: "must be a landscape image"
       aspect_ratio_is_not: "must have an aspect ratio of %{aspect_ratio}"
       aspect_ratio_unknown: "has an unknown aspect ratio"
+      image_not_processable: "is not a valid image"
 ```
 
 In some cases, Active Storage Validations provides variables to help you customize messages:
@@ -395,6 +398,8 @@ You are welcome to contribute.
 = https://github.com/gr8bit
 = https://github.com/codegeek319
 = https://github.com/clwy-cn
+= https://github.com/kukicola
+= https://github.com/sobrinho
 
 ## License
 

data/config/locales/en.yml

@@ -20,3 +20,4 @@ en:
       aspect_ratio_not_landscape: "must be a landscape image"
       aspect_ratio_is_not: "must have an aspect ratio of %{aspect_ratio}"
       aspect_ratio_unknown: "has an unknown aspect ratio"
+      image_not_processable: "is not a valid image"

data/lib/active_storage_validations/matchers/content_type_validator_matcher.rb

@@ -19,11 +19,13 @@ module ActiveStorageValidations
 
       def allowing(*types)
         @allowed_types = types.flatten
+        either_allowing_or_rejecting
         self
       end
 
       def rejecting(*types)
         @rejected_types = types.flatten
+        either_allowing_or_rejecting
         self
       end
 
@@ -33,19 +35,29 @@ module ActiveStorageValidations
       end
 
       def failure_message
-        <<~MESSAGE
-          Expected #{@attribute_name}
+        message = ["Expected #{@attribute_name}"]
 
-            Accept content types: #{allowed_types.join(", ")}
-              #{accepted_types_and_failures}
+        if @allowed_types
+          message << "Accept content types: #{allowed_types.join(", ")}"
+          message << "#{@missing_allowed_types.join(", ")} were rejected"
+        end
+
+        if @rejected_types
+          message << "Reject content types: #{rejected_types.join(", ")}"
+          message << "#{@missing_rejected_types.join(", ")} were accepted"
+        end
 
-            Reject content types: #{rejected_types.join(", ")}
-              #{rejected_types_and_failures}
-        MESSAGE
+        message.join("\n")
       end
 
       protected
 
+      def either_allowing_or_rejecting
+        if @allowed_types && @rejected_types
+          raise ArgumentError, "You must specify either allowing or rejecting"
+        end
+      end
+
       def responds_to_methods
         @subject.respond_to?(@attribute_name) &&
           @subject.public_send(@attribute_name).respond_to?(:attach) &&
@@ -57,7 +69,7 @@ module ActiveStorageValidations
       end
 
       def rejected_types
-        @rejected_types || (content_type_keys - allowed_types)
+        @rejected_types || []
       end
 
       def allowed_types_allowed?
@@ -70,22 +82,6 @@ module ActiveStorageValidations
         @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
@@ -96,16 +92,6 @@ 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/metadata.rb

@@ -1,5 +1,7 @@
 module ActiveStorageValidations
   class Metadata
+    class InvalidImageError < StandardError; end
+
     attr_reader :file
 
     def initialize(file)
@@ -10,7 +12,7 @@ module ActiveStorageValidations
     def image_processor
       Rails.application.config.active_storage.variant_processor
     end
-    
+
     def exception_class
       if image_processor == :vips && defined?(Vips)
         Vips::Error
@@ -35,6 +37,16 @@ module ActiveStorageValidations
           { width: image.width, height: image.height }
         end
       end
+    rescue InvalidImageError
+      logger.info "Skipping image analysis because ImageMagick or Vips doesn't support the file"
+      {}
+    end
+
+    def valid?
+      read_image
+      true
+    rescue InvalidImageError
+      false
     end
 
     private
@@ -76,12 +88,9 @@ module ActiveStorageValidations
                 end
       end
 
-      if image && valid_image?(image)
-        yield image
-      else
-        logger.info "Skipping image analysis because ImageMagick or Vips doesn't support the file"
-        {}
-      end
+
+      raise InvalidImageError unless valid_image?(image)
+      yield image
     rescue LoadError, NameError
       logger.info "Skipping image analysis because the mini_magick or ruby-vips gem isn't installed"
       {}
@@ -93,6 +102,8 @@ module ActiveStorageValidations
     end
 
     def valid_image?(image)
+      return false unless image
+
       image_processor == :vips && image.is_a?(Vips::Image) ? image.avg : image.valid?
     rescue exception_class
       false

data/lib/active_storage_validations/option_proc_unfolding.rb

@@ -1,10 +1,10 @@
 module ActiveStorageValidations
   module OptionProcUnfolding
 
-    def unfold_procs(record, object, only_keys = nil)
+    def unfold_procs(record, object, only_keys)
       case object
       when Hash
-        object.merge(object) { |key, value| only_keys&.exclude?(key) ? unfold_procs(record, value, []) : unfold_procs(record, value) }
+        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

data/lib/active_storage_validations/processable_image_validator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'metadata.rb'
+
+module ActiveStorageValidations
+  class ProcessableImageValidator < ActiveModel::EachValidator # :nodoc
+    include OptionProcUnfolding
+
+    if Rails.gem_version >= Gem::Version.new('6.0.0')
+      def validate_each(record, attribute, _value)
+        return true unless record.send(attribute).attached?
+
+        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) unless Metadata.new(file).valid?
+        end
+      end
+    else
+      # 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|
+          add_error(record, attribute, :image_not_processable) unless Metadata.new(file).valid?
+        end
+      end
+    end
+
+    private
+
+    def add_error(record, attribute, default_message)
+      message = options[:message].presence || default_message
+      return if record.errors.added?(attribute, message)
+      record.errors.add(attribute, message)
+    end
+  end
+end

data/lib/active_storage_validations/version.rb

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

data/lib/active_storage_validations.rb

@@ -9,6 +9,7 @@ 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'
 
 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.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -216,6 +216,7 @@ files:
 - lib/active_storage_validations/matchers/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/version.rb
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Validations for Active Storage