active_storage_validations 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5c26b96ccb72cbb6ca57cf20df590f334703e2e30e51e4f2ccc1ff5891a74f5
-  data.tar.gz: 401043685c41419a8ab9018de42f844a15d2d1219b74f0f1c37473840129bdea
+  metadata.gz: 455224d1bb911fd68b4d89e76bcbac8d262db1119bfe30d20a46e5483c48f428
+  data.tar.gz: 3c3189898c56806b8efe8601f4f7b530af365cc0ae34b88f5d738ebd5a27a43b
 SHA512:
-  metadata.gz: c0cda1fa4d225a0bf381fb08a2db575d1f3a2baef5b85bd954473455a26c454af2efc0de4b40ecc9156a9b553f38cd8653cb78f7c70a05c87291d0a0a01df94e
-  data.tar.gz: c98ff98594d610a57cc649f66bc7a5bd3ac135723dae52f68d807e6ccf0131e76fc5e9e577708a36badf20583ce08f61b7a0c9f3286e53f119e4e39f04714407
+  metadata.gz: f13f49e78f5b04d96e36c46de7deb7c4d18abbb95f6a0f1fcb60a4e68e6c58b0280a9038fac22c085b55c778854775bfc3f9d690beb3cd11bf4a5ae2b9a81d4d
+  data.tar.gz: 2a6062552f5e05701f8efde71dbfccbebd64a43a9adc637d1b74c70676b9e289e7089cd2d79eb25042c22cdebf3723991c73dc86a34d1852cf985186cc3eeae3

data/README.md

@@ -11,6 +11,7 @@ This gems doing it for you. Just use `attached: true` or `content_type: 'image/p
 * validates if file(s) attached
 * validates content type
 * validates size of files
+* validates dimension of images/videos
 * validates number of uploaded files (min/max required)
 * custom error messages
 
@@ -25,8 +26,11 @@ class User < ApplicationRecord
 
   validates :name, presence: true
 
-  validates :avatar, attached: true, content_type: 'image/png'
-  validates :photos, attached: true, content_type: ['image/png', 'image/jpg', 'image/jpeg']
+  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'],
+                                     dimension: { width: { min: 800, max: 2400 },
+                                                  height: { min: 600, max: 1800 }, message: 'is not given between dimension' }
 end
 ```
 
@@ -46,19 +50,60 @@ class Project < ApplicationRecord
 end
 ```
 
+### More examples
+
+- Dimension validation with `width`, `height` and `in`.
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+  has_many_attached :photos
+
+  validates :avatar, dimension: { width: { in: 80..100 }, message: 'is not given between dimension' }
+  validates :photos, dimension: { height: { in: 600..1800 } }
+end
+```
+
+- Dimension validation with `min` and `max` range for width and height.
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+  has_many_attached :photos
+
+  validates :avatar, dimension: { min: 200..100 }
+  # Equivalent to:
+  # validates :avatar, dimension: { width: { min: 200 }, height: { min: 100  } }
+  validates :photos, dimension: { min: 200..100, max: 400..200 }
+  # Equivalent to:
+  # validates :avatar, dimension: { width: { min: 200, max: 400 }, height: { min: 100, max: 200  } }
+end
+```
+
 ## Internationalization (I18n)
 
-Active Storage Validations use I18n for errors messages. For this add there keys in your translation file :
+Active Storage Validations use I18n for errors messages. For this add there keys in your translation file:
 
 ```yml
 en:
   errors:
     messages:
       content_type_invalid: "has an invalid content type"
+      file_size_out_of_range: "size %{file_size} is not between required range"
       limit_out_of_range: "total number is out of range"
+      dimension_min_inclusion: "must be greater than or equal to %{width} x %{height} pixel."
+      dimension_max_inclusion: "must be less than or equal to %{width} x %{height} pixel."
+      dimension_width_inclusion: "width is not included between %{min} and %{max} pixel."
+      dimension_height_inclusion: "height is not included between %{min} and %{max} pixel."
+      dimension_width_greater_than_or_equal_to: "width must be greater than or equal to %{length} pixel."
+      dimension_height_greater_than_or_equal_to: "height must be greater than or equal to %{length} pixel."
+      dimension_width_less_than_or_equal_to: "width must be less than or equal to %{length} pixel."
+      dimension_height_less_than_or_equal_to: "height must be less than or equal to %{length} pixel."
+      dimension_width_equal_to: "width must be equal to %{length} pixel."
+      dimension_height_equal_to: "height must be equal to %{length} pixel."
 ```
 
-In some cases Active Storage Validations provides variables to help you customize messages :
+In some cases Active Storage Validations provides variables to help you customize messages:
 
 The "content_type_invalid" key has two variables that you can use, a variable named "content_type" containing the content type of the send file and a variable named "authorized_type" containing the list of authorized content types.
 
@@ -87,6 +132,7 @@ gem 'active_storage_validations'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
@@ -98,9 +144,12 @@ Very simple example of validation with file attached, content type check and cus
 [![Sample](https://raw.githubusercontent.com/igorkasyanchuk/active_storage_validations/master/docs/preview.png)](https://raw.githubusercontent.com/igorkasyanchuk/active_storage_validations/master/docs/preview.png)
 
 ## Todo
+
 * verify with remote storages (s3, etc)
-* verify how it works with direct upload 
-* better error message when  content_size is invalid
+* verify how it works with direct upload
+* better error message when content_size is invalid
+* add more translations
+* add aspect ratio validation
 
 ## Tests & Contributing
 
@@ -110,7 +159,7 @@ To play with app `cd test/dummy` and `rails s -b 0.0.0.0` (before `rails db:migr
 
 ## Known issues
 
-- there is an issue in Rails which it possible to get if you have aadded a validation and generating for example an image preview of atachments. It can be fixed with this:
+- There is an issue in Rails which it possible to get if you have added a validation and generating for example an image preview of attachments. It can be fixed with this:
 
 ```
   <% if @user.avatar.attached? && @user.avatar.attachment.blob.present? && @user.avatar.attachment.blob.persisted? %>
@@ -129,6 +178,8 @@ You are welcome to contribute.
 - https://github.com/Uysim
 - https://github.com/D-system
 - https://github.com/ivanelrey
+- https://github.com/phlegx
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/locales/de.yml

@@ -0,0 +1,16 @@
+de:
+  errors:
+    messages:
+      content_type_invalid: "hat einen ungültigen Dateityp"
+      file_size_out_of_range: "Dateigröße von %{file_size} ist außerhalb des erlaubten Bereichs"
+      limit_out_of_range: "Anzahl ist außerhalb des gültigen Bereichs"
+      dimension_min_inclusion: "muss größer oder gleich %{width} x %{height} Pixel sein"
+      dimension_max_inclusion: "muss kleiner oder gleich %{width} x %{height} Pixel sein"
+      dimension_width_inclusion: "Breite ist nicht zwischen %{min} und %{max} Pixel enthalten"
+      dimension_height_inclusion: "Höhe ist nicht zwischen %{min} und %{max} Pixel enthalten"
+      dimension_width_greater_than_or_equal_to: "Breite muss größer oder gleich %{length} Pixel sein"
+      dimension_height_greater_than_or_equal_to: "Höhe muss größer oder gleich %{length} Pixel sein"
+      dimension_width_less_than_or_equal_to: "Breite muss kleiner oder gleich %{length} Pixel sein"
+      dimension_height_less_than_or_equal_to: "Höhe muss kleiner oder gleich %{length} Pixel sein"
+      dimension_width_equal_to: "Breite muss genau %{length} Pixel sein"
+      dimension_height_equal_to: "Höhe muss genau %{length} Pixel sein"

data/config/locales/en.yml

@@ -2,4 +2,15 @@ en:
   errors:
     messages:
       content_type_invalid: "has an invalid content type"
+      file_size_out_of_range: "size %{file_size} is not between required range"
       limit_out_of_range: "total number is out of range"
+      dimension_min_inclusion: "must be greater than or equal to %{width} x %{height} pixel"
+      dimension_max_inclusion: "must be less than or equal to %{width} x %{height} pixel"
+      dimension_width_inclusion: "width is not included between %{min} and %{max} pixel"
+      dimension_height_inclusion: "height is not included between %{min} and %{max} pixel"
+      dimension_width_greater_than_or_equal_to: "width must be greater than or equal to %{length} pixel"
+      dimension_height_greater_than_or_equal_to: "height must be greater than or equal to %{length} pixel"
+      dimension_width_less_than_or_equal_to: "width must be less than or equal to %{length} pixel"
+      dimension_height_less_than_or_equal_to: "height must be less than or equal to %{length} pixel"
+      dimension_width_equal_to: "width must be equal to %{length} pixel"
+      dimension_height_equal_to: "height must be equal to %{length} pixel"

data/lib/active_storage_validations.rb

@@ -6,6 +6,7 @@ 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'
 
 ActiveSupport.on_load(:active_record) do
   send :include, ActiveStorageValidations

data/lib/active_storage_validations/content_type_validator.rb

@@ -3,11 +3,9 @@
 module ActiveStorageValidations
   class ContentTypeValidator < ActiveModel::EachValidator # :nodoc:
     def validate_each(record, attribute, _value)
-      files = record.send(attribute)
+      return true if !record.send(attribute).attached? || types.empty?
 
-      return true if !files.attached? || types.empty?
-
-      files = Array.wrap(files)
+      files = Array.wrap(record.send(attribute))
 
       errors_options = { authorized_types: types_to_human_format }
       errors_options[:message] = options[:message] if options[:message].present?

data/lib/active_storage_validations/dimension_validator.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ActiveStorageValidations
+  class DimensionValidator < ActiveModel::EachValidator # :nodoc
+    AVAILABLE_CHECKS = %i[width height min max].freeze
+
+    def initialize(options)
+      [:width, :height].each do |length|
+        if options[length] and options[length].is_a?(Hash)
+          if range = options[length][:in]
+            raise ArgumentError, ":in must be a Range" unless range.is_a?(Range)
+            options[length][:min], options[length][:max] = range.min, range.max
+          end
+        end
+      end
+      [:min, :max].each do |dim|
+        if range = options[dim]
+          raise ArgumentError, ":#{dim} must be a Range (width..height)" unless range.is_a?(Range)
+          options[:width] = { dim => range.first }
+          options[:height] = { dim => range.last }
+        end
+      end
+      super
+    end
+
+
+    def check_validity!
+      return true if AVAILABLE_CHECKS.any? { |argument| options.key?(argument) }
+      raise ArgumentError, 'You must pass either :width, :height, :min or :max to the validator'
+    end
+
+
+    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?
+
+        # File has no dimension and no width and height in metadata.
+        raise StandardError, 'File has no dimension and no width and height in metadata' unless (['width', 'height'] - file.metadata.keys).empty?
+
+        next if dimension_valid?(record, attribute, file.metadata)
+        break
+      end
+    end
+
+
+    def dimension_valid?(record, attribute, file_metadata)
+      valid = true
+
+      # Validation based on checks :min and :max (:min, :max has higher priority to :width, :height).
+      if options[:min] || options[:max]
+        if options[:min] && (
+           (options[:width][:min] && file_metadata[:width] < options[:width][:min]) ||
+           (options[:height][:min] && file_metadata[:height] < options[:height][:min])
+          )
+          valid = record.errors.add(attribute, options[:message].presence || :"dimension_min_inclusion", width: options[:width][:min], height: options[:height][:min]).empty?
+        end
+        if options[:max] && (
+           (options[:width][:max] && file_metadata[:width] > options[:width][:max]) ||
+           (options[:height][:max] && file_metadata[:height] > options[:height][:max])
+          )
+          valid = record.errors.add(attribute, options[:message].presence || :"dimension_max_inclusion", width: options[:width][:max], height: options[:height][:max]).empty?
+        end
+
+      # Validation based on checks :width and :height.
+      else
+        [:width, :height].each do |length|
+          next unless options[length]
+          if options[length].is_a?(Hash)
+            if options[length][:in] && (file_metadata[length] < options[length][:min] || file_metadata[length] > options[length][:max])
+              valid = record.errors.add(attribute, options[:message].presence || :"dimension_#{length}_inclusion", min: options[length][:min], max: options[length][:max]).empty?
+            else
+              if options[length][:min] && file_metadata[length] < options[length][:min]
+                valid = record.errors.add(attribute, options[:message].presence || :"dimension_#{length}_greater_than_or_equal_to", length: options[length][:min]).empty?
+              end
+              if options[length][:max] && file_metadata[length] > options[length][:max]
+                valid = record.errors.add(attribute, options[:message].presence || :"dimension_#{length}_less_than_or_equal_to", length: options[length][:max]).empty?
+              end
+            end
+          else
+            if file_metadata[length] != options[length]
+              valid = record.errors.add(attribute, options[:message].presence || :"dimension_#{length}_equal_to", length: options[length]).empty?
+            end
+          end
+        end
+      end
+
+      valid
+    end
+
+  end
+end

data/lib/active_storage_validations/limit_validator.rb

@@ -11,11 +11,9 @@ module ActiveStorageValidations
     end
 
     def validate_each(record, attribute, _value)
-      files = record.send(attribute)
+      return true unless record.send(attribute).attached?
 
-      return true unless files.attached?
-
-      files = Array.wrap(files)
+      files = Array.wrap(record.send(attribute))
 
       errors_options = {}
       errors_options[:min] = options[:min]

data/lib/active_storage_validations/size_validator.rb

@@ -18,10 +18,14 @@ module ActiveStorageValidations
 
       files = Array.wrap(record.send(attribute))
 
+      errors_options = {}
+      errors_options[:message] = options[:message] if options[:message].present?
+
       files.each do |file|
         next if content_size_valid?(file.blob.byte_size)
 
-        record.errors.add(attribute, options[:message].presence || "size #{number_to_human_size(file.blob.byte_size)} is not between required range")
+        errors_options[:file_size] = number_to_human_size(file.blob.byte_size)
+        record.errors.add(attribute, :file_size_out_of_range, errors_options)
         break
       end
     end

data/lib/active_storage_validations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_validations
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -76,10 +90,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- config/locales/de.yml
 - config/locales/en.yml
 - lib/active_storage_validations.rb
 - lib/active_storage_validations/attached_validator.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/limit_validator.rb
 - lib/active_storage_validations/railtie.rb
@@ -105,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Validations for Active Storage