active_storage_validations 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0539919d5597eda332d4c989c432986009f1944e0ab62251882cc250fa6f021a'
-  data.tar.gz: 8d7566007ede3adf24a60297c20d7a39b28e211bc00f5158148f3c2cdf0a82e5
+  metadata.gz: 12a58907c84f972cb00aab13b6a60d26afda0383cbe88e13ec12b1c9d178ba36
+  data.tar.gz: 4df97d0b9e88054403ff7a39c89b00c4b3f9a0c3de7a38997f4f3a6193d803af
 SHA512:
-  metadata.gz: 364050c102e1fa3feac404972479edf30eb25d7df969e7593afae838ffe556bb0cb69693c94ad8ced10b056b0d8b5c232800bc3885bdc37984c9cf51a836bff1
-  data.tar.gz: 7350e9ffb7d0c93bc233561ab3457aec477f988c447708498d791f559440a08207cfddf245b2b835716f978d2d8171f4c71252697183df5284ee8f33ce136540
+  metadata.gz: 80210f9dd1636fac2f2dd9ab15c0090990312fdcd1c34f2c0aa6157c9c4e27b1aed9a03c064e91b148014388eaec3ed4171dd57d4c059e4f2e9ee919610d098a
+  data.tar.gz: f23b85dbb613af03faa0637fd5e9dd626e8e975b87590a0b87aedeba296bcd24c0f79c16dc20059ddb8f41b892887098d0f7dc58d1b951eaae0094b5dd15ea2a

data/README.md

@@ -204,6 +204,7 @@ en:
       aspect_ratio_not_landscape: "must be a landscape image"
       aspect_ratio_is_not: "must have an aspect ratio of %{aspect_ratio}"
       image_not_processable: "is not a valid image"
+      aspect_ratio_invalid: "has invalid aspect ratio"
 ```
 
 In several cases, Active Storage Validations provides variables to help you customize messages:
@@ -354,8 +355,8 @@ describe User do
 
   # limit
   # #min, #max
-  it { is_expected.to validate_limit_of(:avatar).min(1) }
-  it { is_expected.to validate_limit_of(:avatar).max(5) }
+  it { is_expected.to validate_limits_of(:avatar).min(1) }
+  it { is_expected.to validate_limits_of(:avatar).max(5) }
 
   # content_type:
   # #allowing, #rejecting
@@ -437,7 +438,7 @@ Then you can use the matchers with the syntax specified in the RSpec section, ju
 
 To run tests in root folder of gem:
 
-* `BUNDLE_GEMFILE=gemfiles/rails_6_1_4.gemfile bundle exec rake test` to run for Rails 7.0
+* `BUNDLE_GEMFILE=gemfiles/rails_6_1_4.gemfile bundle exec rake test` to run for Rails 6.1
 * `BUNDLE_GEMFILE=gemfiles/rails_7_0.gemfile bundle exec rake test` to run for Rails 7.0
 * `BUNDLE_GEMFILE=gemfiles/rails_7_1.gemfile bundle exec rake test` to run for Rails 7.1
 * `BUNDLE_GEMFILE=gemfiles/rails_7_2.gemfile bundle exec rake test` to run for Rails 7.2
@@ -471,71 +472,8 @@ You are welcome to contribute.
 />](https://opensource-heroes.com/r/igorkasyanchuk/active_storage_validations)
 
 ## Contributors (BIG THANK YOU)
-- https://github.com/schweigert
-- https://github.com/tleneveu
-- https://github.com/reckerswartz
-- https://github.com/Uysim
-- https://github.com/D-system
-- https://github.com/ivanelrey
-- https://github.com/phlegx
-- https://github.com/rr-dev
-- https://github.com/dsmalko
-- https://github.com/danderozier
-- https://github.com/cseelus
-- https://github.com/vkinelev
-- https://github.com/reed
-- https://github.com/connorshea
-- https://github.com/Atul9
-- https://github.com/victorbueno
-- https://github.com/UICJohn
-- https://github.com/giovannibonetti
-- https://github.com/dlepage
-- https://github.com/StefSchenkelaars
-- https://github.com/willnet
-- https://github.com/mohanklein
-- https://github.com/High5Apps
-- https://github.com/mschnitzer
-- https://github.com/sinankeskin
-- https://github.com/alejandrodevs
-- https://github.com/molfar
-- https://github.com/connorshea
-- https://github.com/yshmarov
-- https://github.com/fongfan999
-- https://github.com/cooperka
-- https://github.com/dolarsrg
-- https://github.com/jayshepherd
-- https://github.com/ohbarye
-- https://github.com/randsina
-- https://github.com/vietqhoang
-- https://github.com/kemenaran
-- https://github.com/jrmhaig
-- https://github.com/evedovelli
-- https://github.com/JuanVqz
-- https://github.com/luiseugenio
-- https://github.com/equivalent
-- https://github.com/NARKOZ
-- https://github.com/stephensolis
-- https://github.com/kwent
-- https://github.com/Animesh-Ghosh
-- https://github.com/gr8bit
-- https://github.com/codegeek319
-- https://github.com/clwy-cn
-- https://github.com/kukicola
-- https://github.com/sobrinho
-- https://github.com/iainbeeston
-- https://github.com/marckohlbrugge
-- https://github.com/Mth0158
-- https://github.com/technicalpickles
-- https://github.com/ricsdeol
-- https://github.com/Fonsan
-- https://github.com/tagliala
-- https://github.com/ocarreterom
-- https://github.com/aditya-cherukuri
-- https://github.com/searls
-- https://github.com/yenshirak
-- https://github.com/wataori
-- https://github.com/Scorpahr
 
+https://github.com/igorkasyanchuk/active_storage_validations/graphs/contributors
 
 ## License
 

data/config/locales/da.yml

@@ -30,3 +30,4 @@ da:
       aspect_ratio_not_landscape: "skal være et landskabsbillede"
       aspect_ratio_is_not: "skal have et størrelsesforhold på %{aspect_ratio}"
       image_not_processable: "er ikke et gyldigt billede"
+      aspect_ratio_invalid: "har et ugyldigt billedformat"

data/config/locales/de.yml

@@ -30,3 +30,4 @@ de:
       aspect_ratio_not_landscape: "muss Querformat sein"
       aspect_ratio_is_not: "muss ein Bildseitenverhältnis von %{aspect_ratio} haben"
       image_not_processable: "ist kein gültiges Bild"
+      aspect_ratio_invalid: "hat ein ungültiges Seitenverhältnis"

data/config/locales/en.yml

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

data/config/locales/es.yml

@@ -30,3 +30,4 @@ es:
       aspect_ratio_not_landscape: "debe ser una imagen apaisada"
       aspect_ratio_is_not: "debe tener una relación de aspecto de %{aspect_ratio}"
       image_not_processable: "no es una imagen válida"
+      aspect_ratio_invalid: "tiene una relación de aspecto no válida"

data/config/locales/fr.yml

@@ -30,3 +30,4 @@ fr:
       aspect_ratio_not_landscape: "doit être une image en format paysage"
       aspect_ratio_is_not: "doit avoir un rapport hauteur / largeur de %{aspect_ratio}"
       image_not_processable: "n'est pas une image valide"
+      aspect_ratio_invalid: "a un rapport hauteur / largeur invalide"

data/config/locales/it.yml

@@ -30,3 +30,4 @@ it:
       aspect_ratio_not_landscape: "l’orientamento dell’immagine deve essere orizzontale"
       aspect_ratio_is_not: "deve avere un rapporto altezza / larghezza di %{aspect_ratio}"
       image_not_processable: "non è un'immagine valida"
+      aspect_ratio_invalid: "ha proporzioni non valide"

data/config/locales/ja.yml

@@ -30,3 +30,4 @@ ja:
       aspect_ratio_not_landscape: "は横長にしてください"
       aspect_ratio_is_not: "のアスペクト比は %{aspect_ratio} にしてください"
       image_not_processable: "は不正な画像です"
+      aspect_ratio_invalid: "アスペクト比が無効です"

data/config/locales/nl.yml

@@ -30,3 +30,4 @@ nl:
       aspect_ratio_not_landscape: "moet een liggende afbeelding zijn"
       aspect_ratio_is_not: "moet een beeldverhouding hebben van %{aspect_ratio}"
       image_not_processable: "is geen geldige afbeelding"
+      aspect_ratio_invalid: "heeft een ongeldige beeldverhouding"

data/config/locales/pl.yml

@@ -30,3 +30,4 @@ pl:
       aspect_ratio_not_landscape: "musi mieć proporcje pejzażu"
       aspect_ratio_is_not: "musi mieć proporcje %{aspect_ratio}"
       image_not_processable: "nie jest prawidłowym obrazem"
+      aspect_ratio_invalid: "ma nieprawidłowy współczynnik proporcji"

data/config/locales/pt-BR.yml

@@ -30,3 +30,4 @@ pt-BR:
       aspect_ratio_not_landscape: "não está no formato paisagem"
       aspect_ratio_is_not: "não contém uma proporção de %{aspect_ratio}"
       image_not_processable: "não é uma imagem válida"
+      aspect_ratio_invalid: "tem uma proporção de aspecto inválida"

data/config/locales/ru.yml

@@ -30,3 +30,4 @@ ru:
       aspect_ratio_not_landscape: "должно быть пейзажное изображение"
       aspect_ratio_is_not: "должен иметь соотношение сторон %{aspect_ratio}"
       image_not_processable: "не является допустимым изображением"
+      aspect_ratio_invalid: "имеет недопустимое соотношение сторон"

data/config/locales/sv.yml

@@ -30,3 +30,4 @@ sv:
       aspect_ratio_not_landscape: "måste vara en landskapsorienterad bild"
       aspect_ratio_is_not: "måste ha en följande aspect ratio  %{aspect_ratio}"
       image_not_processable: "är inte en giltig bild"
+      aspect_ratio_invalid: "har ett ogiltigt bildförhållande"

data/config/locales/tr.yml

@@ -30,3 +30,4 @@ tr:
       aspect_ratio_not_landscape: "yatay bir imaj olmalı"
       aspect_ratio_is_not: "%{aspect_ratio} en boy oranına sahip olmalı"
       image_not_processable: "geçerli bir imaj değil"
+      aspect_ratio_invalid: "geçersiz bir en boy oranına sahip"

data/config/locales/uk.yml

@@ -30,3 +30,4 @@ uk:
       aspect_ratio_not_landscape: "мусить бути пейзажне зображення"
       aspect_ratio_is_not: "мусить мати співвідношення сторін %{aspect_ratio}"
       image_not_processable: "не є допустимим зображенням"
+      aspect_ratio_invalid: "має недійсне співвідношення сторін"

data/config/locales/vi.yml

@@ -30,3 +30,4 @@ vi:
       aspect_ratio_not_landscape: "phải là ảnh ngang"
       aspect_ratio_is_not: "phải có tỉ lệ ảnh %{aspect_ratio}"
       image_not_processable: "không phải là ảnh"
+      aspect_ratio_invalid: "có tỷ lệ khung hình không hợp lệ"

data/config/locales/zh-CN.yml

@@ -30,3 +30,4 @@ zh-CN:
       aspect_ratio_not_landscape: "必须是横屏图片"
       aspect_ratio_is_not: "纵横比必须是 %{aspect_ratio}"
       image_not_processable: "不是有效的图像"
+      aspect_ratio_invalid: "宽高比无效"

data/lib/active_storage_validations/analyzer/image_analyzer/image_magick.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  # This analyzer relies on the third-party {MiniMagick}[https://github.com/minimagick/minimagick] gem.
+  # MiniMagick requires the {ImageMagick}[http://www.imagemagick.org] system library.
+  # This is the default Rails image analyzer.
+  class Analyzer::ImageAnalyzer::ImageMagick < Analyzer::ImageAnalyzer
+
+    private
+
+    def read_image
+      Tempfile.create(binmode: true) do |tempfile|
+        begin
+          if image(tempfile).valid?
+            yield image(tempfile)
+          else
+            logger.info "Skipping image analysis because ImageMagick doesn't support the file"
+            {}
+          end
+        ensure
+          tempfile.close
+        end
+      end
+    rescue MiniMagick::Error => error
+      logger.error "Skipping image analysis due to an ImageMagick error: #{error.message}"
+      {}
+    end
+
+    def image_from_path(path)
+      instrument("mini_magick") do
+        MiniMagick::Image.new(path)
+      end
+    end
+
+    def rotated_image?(image)
+      %w[ RightTop LeftBottom TopRight BottomLeft ].include?(image["%[orientation]"])
+    end
+
+    def supported?
+      require "mini_magick"
+      true
+    rescue LoadError
+      logger.info "Skipping image analysis because the mini_magick gem isn't installed"
+      false
+    end
+  end
+end

data/lib/active_storage_validations/analyzer/image_analyzer/vips.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  # This analyzer relies on the third-party {ruby-vips}[https://github.com/libvips/ruby-vips] gem.
+  # Ruby-vips requires the {libvips}[https://libvips.github.io/libvips/] system library.
+  class Analyzer::ImageAnalyzer::Vips < Analyzer::ImageAnalyzer
+
+    private
+
+    def read_image
+      Tempfile.create(binmode: true) do |tempfile|
+        begin
+          if image(tempfile)
+            yield image(tempfile)
+          else
+            logger.info "Skipping image analysis because Vips doesn't support the file"
+            {}
+          end
+        ensure
+          tempfile.close
+        end
+      end
+    rescue ::Vips::Error => error
+      logger.error "Skipping image analysis due to a Vips error: #{error.message}"
+      {}
+    end
+
+    def image_from_path(path)
+      instrument("vips") do
+        begin
+          ::Vips::Image.new_from_file(path, access: :sequential)
+        rescue ::Vips::Error
+          # Vips throw errors rather than returning false when reading a not
+          # supported attachable.
+          # We stumbled upon this issue while reading 0 byte size attachable
+          # https://github.com/janko/image_processing/issues/97
+          logger.info "Skipping image analysis because Vips doesn't support the file"
+          nil
+        end
+      end
+    end
+
+    def supported?
+      require "vips"
+      true
+    rescue LoadError
+      logger.info "Skipping image analysis because the ruby-vips gem isn't installed"
+      false
+    end
+
+    ROTATIONS = /Right-top|Left-bottom|Top-right|Bottom-left/
+    def rotated_image?(image)
+      ROTATIONS === image.get("exif-ifd0-Orientation")
+    rescue ::Vips::Error
+      false
+    end
+  end
+end

data/lib/active_storage_validations/analyzer/image_analyzer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  # = Active Storage Image \Analyzer
+  #
+  # This is an abstract base class for image analyzers, which extract width and height from an image attachable.
+  #
+  # If the image contains EXIF data indicating its angle is 90 or 270 degrees, its width and height are swapped for convenience.
+  #
+  # Example:
+  #
+  #   ActiveStorage::Analyzer::ImageAnalyzer::ImageMagick.new(attachable).metadata
+  #   # => { width: 4104, height: 2736 }
+  class Analyzer::ImageAnalyzer < Analyzer
+    @@supported_analyzers = {}
+
+    def metadata
+      return {} unless analyzer_supported?
+
+      read_image do |image|
+        if rotated_image?(image)
+          { width: image.height, height: image.width }
+        else
+          { width: image.width, height: image.height }
+        end
+      end
+    end
+
+    private
+
+    def image(tempfile)
+      case @attachable
+      when ActiveStorage::Blob, String
+        blob = @attachable.is_a?(String) ? ActiveStorage::Blob.find_signed!(@attachable) : @attachable
+        image_from_tempfile_path(tempfile, blob)
+      when Hash
+        io = @attachable[:io]
+        if io.is_a?(StringIO)
+          image_from_tempfile_path(tempfile, io)
+        else
+          File.open(io) do |file|
+            image_from_path(file.path)
+          end
+        end
+      when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile
+        image_from_path(@attachable.path)
+      when File
+        supports_file_attachment? ? image_from_path(@attachable.path) : raise_rails_like_error(@attachable)
+      when Pathname
+        supports_pathname_attachment? ? image_from_path(@attachable.to_s) : raise_rails_like_error(@attachable)
+      else
+        raise_rails_like_error(@attachable)
+      end
+    end
+
+    def image_from_tempfile_path(tempfile, file_representation)
+      if file_representation.is_a?(ActiveStorage::Blob)
+        file_representation.download { |chunk| tempfile.write(chunk) }
+      else
+        IO.copy_stream(file_representation, tempfile)
+        file_representation.rewind
+      end
+
+      tempfile.flush
+      tempfile.rewind
+      image_from_path(tempfile.path)
+    end
+
+    def analyzer_supported?
+      if @@supported_analyzers.key?(self)
+        @@supported_analyzers.fetch(self)
+      else
+        @@supported_analyzers[self] = supported?
+      end
+    end
+
+    def read_image
+      raise NotImplementedError
+    end
+
+    def image_from_path(path)
+      raise NotImplementedError
+    end
+
+    def rotated_image?(image)
+      raise NotImplementedError
+    end
+
+    def supported?
+      raise NotImplementedError
+    end
+  end
+end

data/lib/active_storage_validations/analyzer/null_analyzer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  # = Active Storage Null Analyzer
+  #
+  # This is a fallback analyzer when the attachable media type is not supported
+  # by our gem.
+  #
+  # Example:
+  #
+  #   ActiveStorage::Analyzer::NullAnalyzer.new(attachable).metadata
+  #   # => {}
+  class Analyzer::NullAnalyzer < Analyzer
+    def metadata
+      {}
+    end
+  end
+end

data/lib/active_storage_validations/analyzer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'shared/asv_attachable'
+require_relative 'shared/asv_loggable'
+
+module ActiveStorageValidations
+  # = Active Storage Validations \Analyzer
+  #
+  # This is an abstract base class for analyzers, which extract metadata from attachables.
+  # See ActiveStorageValidations::Analyzer::ImageAnalyzer for an example of a concrete subclass.
+  #
+  # Heavily (not to say 100%) inspired by Rails own ActiveStorage::Analyzer
+  class Analyzer
+    include ASVAttachable
+    include ASVLoggable
+
+    attr_reader :attachable
+
+    def initialize(attachable)
+      @attachable = attachable
+    end
+
+    # Override this method in a concrete subclass. Have it return a Hash of metadata.
+    def metadata
+      raise NotImplementedError
+    end
+
+    private
+
+    def instrument(analyzer, &block)
+      ActiveSupport::Notifications.instrument("analyze.active_storage_validations", analyzer: analyzer, &block)
+    end
+  end
+end