active_storage_validations 1.4.0 → 2.0.0

data/README.md

@@ -6,331 +6,724 @@
 [![MiniTest](https://github.com/igorkasyanchuk/active_storage_validations/workflows/MiniTest/badge.svg)](https://github.com/igorkasyanchuk/active_storage_validations/actions)
 [![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
 [![https://www.patreon.com/igorkasyanchuk](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/patron.svg?raw=true)](https://www.patreon.com/igorkasyanchuk)
-[![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/r/igorkasyanchuk/active_storage_validations)
 
-If you are using `active_storage` gem and you want to add simple validations for it, like presence or content_type you need to write a custom validation method.
 
-This gems doing it for you. Just use `attached: true` or `content_type: 'image/png'` validation.
+Active Storage Validations is a gem that allows you to add validations for Active Storage attributes.
 
-## What it can do
+This gems is doing it right for you! Just use `validates :avatar, attached: true, content_type: 'image/png'` and that's it!
 
-* validates if file(s) attached
-* validates content type
-* validates size of files
-* validates total size of files
-* 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
+## Table of Contents
 
-## Usage
+- [Getting started](#getting-started)
+  - [Installation](#installation)
+  - [Error messages (I18n)](#error-messages-i18n)
+  - [Using image metadata validators](#using-image-metadata-validators)
+  - [Using video and audio metadata validators](#using-video-and-audio-metadata-validators)
+- [Validators](#validators)
+  - [Attached](#attached)
+  - [Limit](#limit)
+  - [Content type](#content-type)
+  - [Size](#size)
+  - [Total size](#total-size)
+  - [Dimension](#dimension)
+  - [Duration](#duration)
+  - [Aspect ratio](#aspect-ratio)
+  - [Processable file](#processable-file)
+- [Upgrading from 1.x to 2.x](#upgrading-from-1x-to-2x)
+- [Internationalization (I18n)](#internationalization-i18n)
+- [Test matchers](#test-matchers)
+- [Contributing](#contributing)
+- [Additional information](#additional-information)
 
-For example you have a model like this and you want to add validation.
+## Getting started
+
+### Installation
+
+Active Storage Validations work with Rails 6.1.4 onwards. Add this line to your application's Gemfile:
 
 ```ruby
-class User < ApplicationRecord
-  has_one_attached :avatar
-  has_many_attached :photos
-  has_one_attached :image
-
-  validates :name, presence: true
-
-  validates :avatar, attached: true, content_type: 'image/png',
-                                     dimension: { width: 200, height: 200 }
-  validates :photos, attached: true, content_type: ['image/png', 'image/jpeg'],
-                                     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
+gem 'active_storage_validations'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+### Error messages (I18n)
+
+Once you have installed the gem, you need to add the gem I18n error messages to your app. See [Internationalization (I18n)](#internationalization-i18n) section for more details.
+
+### Using image metadata validators
+
+Optionally, to use the image metadata validators (`dimension`, `aspect_ratio` and `processable_file`), you will have to add one of the corresponding gems:
+
+```ruby
+gem 'mini_magick', '>= 4.9.5'
+# Or
+gem 'ruby-vips', '>= 2.1.0'
 ```
 
-or
+Plus, you have to be sure to have the corresponding command-line tool installed on your system. For example, to use `mini_magick` gem, you need to have `imagemagick` installed on your system (both on your local and in your CI / production environments).
+
+### Using video and audio metadata validators
+
+To use the video and audio metadata validators (`dimension`, `aspect_ratio`, `processable_file` and `duration`), you will not need to add any gems. However you will need to have the `ffmpeg` command-line tool installed on your system (once again, be sure to have it installed both on your local and in your CI / production environments).
+
+### Using content type spoofing protection validator option
+
+To use the `spoofing_protection` option with the `content_type` validator, you only need to have the UNIX `file` command on your system.
+
+## Validators
 
+**List of validators:**
+- [Attached](#attached): validates if file(s) attached
+- [Limit](#limit): validates number of uploaded files
+- [Content type](#content-type): validates file content type
+- [Size](#size): validates file size
+- [Total size](#total-size): validates total file size for several files
+- [Dimension](#dimension): validates image / video dimensions
+- [Duration](#duration): validates video / audio duration
+- [Aspect ratio](#aspect-ratio): validates image / video aspect ratio
+- [Processable file](#processable-file): validates if a file can be processed
+<br>
+<br>
+
+**Proc usage**<br>
+Every validator can use procs instead of values in all the validator examples:
 ```ruby
-class Project < ApplicationRecord
-  has_one_attached :logo
-  has_one_attached :preview
-  has_one_attached :attachment
-  has_many_attached :documents
-
-  validates :title, presence: true
-
-  validates :logo, attached: true, size: { less_than: 100.megabytes , message: 'is too large' }
-  validates :preview, attached: true, size: { between: 1.kilobyte..100.megabytes , message: 'is not given between size' }
-  validates :attachment, attached: true, content_type: { in: 'application/pdf', message: 'is not a PDF' }
-  validates :documents, limit: { min: 1, max: 3 }, total_size: { less_than: 5.megabytes }
+class User < ApplicationRecord
+  has_many_attached :files
+
+  validates :files, limit: { max: -> (record) { record.admin? ? 100 : 10 } }
 end
 ```
 
-### More examples
+**Performance optimization**<br>
+Some validators rely on an expensive operation (metadata analysis and content type analysis). To mitigate the performance cost, the gem leverages the `ActiveStorage::Blob.metadata` method to store retrieved metadata. Therefore, once the file has been analyzed by our gem, the expensive analysis operation will not be triggered again for new validations.
+
+As stated in the Rails documentation: "Blobs are intended to be immutable in so far as their reference to a specific file goes". We based our performance optimization on the same assumption, so if you do not follow it, the gem will not work as expected.
+
+---
+
+### Attached
+
+Validates if the attachment is present.
 
-- Content type validation using symbols or regex.
+#### Options
 
+The `attached` validator has no options.
+
+#### Examples
+
+Use it like this:
 ```ruby
 class User < ApplicationRecord
   has_one_attached :avatar
-  has_many_attached :photos
 
-  validates :avatar, attached: true, content_type: :png
-  # or
-  validates :photos, attached: true, content_type: [:png, :jpg, :jpeg]
-  # or
-  validates :avatar, content_type: /\Aimage\/.*\z/
+  validates :avatar, attached: true # ensures that avatar has an attached file
 end
 ```
-Please note that the symbol types must be registered by [`Marcel::EXTENSIONS`](https://github.com/rails/marcel/blob/main/lib/marcel/tables.rb) that's used by this gem to infer the full content type.
-Example code for adding a new content type to Marcel:
-```ruby
-# config/initializers/mime_types.rb
-Marcel::MimeType.extend "application/ino", extensions: %w(ino), parents: "text/plain" # Registering arduino INO files
+
+#### Error messages (I18n)
+
+```yml
+en:
+  errors:
+    messages:
+      blank: "can't be blank"
 ```
 
-**Content type spoofing protection**
+The error message for this validator relies on Rails own `blank` error message.
 
-File content type spoofing happens when an ill-intentioned user uploads a file which hides its true content type by faking its extension and its declared content type value. For example, a user may try to upload a `.exe` file (application/x-msdownload content type) dissimulated as a `.jpg` file (image/jpeg content type).
+---
 
-By default, the gem does not prevent content type spoofing (prevent it by default is a breaking change that will be implemented in v2). The spoofing protection relies on both the linux `file` command and `Marcel` gem. Be careful, since it needs to load the whole file io to perform the analysis, it will use a lot of RAM for very large files. Therefore it could be a wise decision not to enable it in this case.
+### Limit
 
-Take note that the `file` analyzer will not find the exactly same content type as the ActiveStorage blob (its content type detection relies on a different logic using content+filename+extension). To handle this issue, we consider a close parent content type to be a match. For example, for an ActiveStorage blob which content type is `video/x-ms-wmv`, the `file` analyzer will probably detect a `video/x-ms-asf` content type, this will be considered as a valid match because these 2 content types are closely related. The correlation mapping is based on `Marcel::TYPE_PARENTS`.
+Validates the number of uploaded files.
 
-The difficulty to accurately predict a mime type may generate false positives, if so there are two solutions available:
-- If the ActiveStorage blob content type is closely related to the detected content type using the `file` analyzer, you can enhance `Marcel::TYPE_PARENTS` mapping using `Marcel::MimeType.extend "application/x-rar-compressed", parents: %(application/x-rar)` in the `config/initializers/mime_types.rb` file. (Please drop an issue so we can add it to the gem for everyone!)
-- If the ActiveStorage blob content type is not closely related, you still can disable the content type spoofing protection in the validator, if so, please drop us an issue so we can fix it for everyone!
+#### Options
+
+The `limit` validator has 2 possible options:
+- `min`: defines the minimum allowed number of files
+- `max`: defines the maximum allowed number of files
+
+#### Examples
 
+Use it like this:
 ```ruby
 class User < ApplicationRecord
-  has_one_attached :avatar
+  has_many_attached :certificates
 
-  validates :avatar, attached: true, content_type: :png # spoofing_protection not enabled, at your own risks!
-  validates :avatar, attached: true, content_type: { with: :png, spoofing_protection: true } # spoofing_protection enabled
+  validates :certificates, limit: { min: 1, max: 10 } # restricts the number of files to between 1 and 10
 end
 ```
 
+#### Error messages (I18n)
+
+```yml
+en:
+  errors:
+    messages:
+      limit_out_of_range:
+        zero: "no files attached (must have between %{min} and %{max} files)"
+        one: "only 1 file attached (must have between %{min} and %{max} files)"
+        other: "total number of files must be between %{min} and %{max} files (there are %{count} files attached)"
+      limit_min_not_reached:
+        zero: "no files attached (must have at least %{min} files)"
+        one: "only 1 file attached (must have at least %{min} files)"
+        other: "%{count} files attached (must have at least %{min} files)"
+      limit_max_exceeded:
+        zero: "no files attached (maximum is %{max} files)"
+        one: "too many files attached (maximum is %{max} files, got %{count})"
+        other: "too many files attached (maximum is %{max} files, got %{count})"
+```
+
+The `limit` validator error messages expose 3 values that you can use:
+- `min` containing the minimum allowed number of files (e.g. `1`)
+- `max` containing the maximum allowed number of files (e.g. `10`)
+- `count` containing the current number of files (e.g. `5`)
+
+---
 
-- Dimension validation with `width`, `height` and `in`.
+### Content type
 
+Validates if the attachment has an allowed content type.
+
+#### Options
+
+The `content_type` validator has 3 possible options:
+- `with`: defines the exact allowed content type (string, symbol or regex)
+- `in`: defines the allowed content types (array of strings or symbols)
+- `spoofing_protection`: enables content type spoofing protection (boolean, defaults to `false`)
+
+As mentioned above, this validator can define content types in several ways:
+- String: `image/png` or `png`
+- Symbol: `:png`
+- Regex: `/\Avideo\/.*\z/`
+
+#### Examples
+
+Use it like this:
 ```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 } }
+  validates :avatar, content_type: 'image/png' # only allows PNG images
+  validates :avatar, content_type: :png # only allows PNG images, same as { with: :png }
+  validates :avatar, content_type: /\Avideo\/.*\z/ # only allows video files
+  validates :avatar, content_type: ['image/png', 'image/jpeg'] # only allows PNG and JPEG images
+  validates :avatar, content_type: { in: [:png, :jpeg], spoofing_protection: true } # only allows PNG, JPEG and their variants, with spoofing protection enabled
 end
 ```
 
-- Dimension validation with `min` and `max` range for width and height:
+#### Best practices
+
+When using the `content_type` validator, it is recommended to reflect the allowed content types in the html [`accept` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept) in the corresponding file field in your views. This will prevent users from trying to upload files with not allowed content types (however it is only an UX improvement, a malicious user can still try to upload files with not allowed content types therefore the backend validation).
 
+For example, if you want to allow PNG and JPEG images only, you can do this:
 ```ruby
 class User < ApplicationRecord
+  ACCEPTED_CONTENT_TYPES = ['image/png', 'image/jpeg'].freeze
+
   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  } }
+
+  validates :avatar, content_type: ACCEPTED_CONTENT_TYPES
 end
 ```
 
-- Aspect ratio validation:
+```erb
+<%= form_with model: @user do |f| %>
+  <%= f.file_field :avatar,
+                   accept: ACCEPTED_CONTENT_TYPES.join(',') %>
+<% end %>
+```
+
+#### Content type shorthands
 
+If you choose to use a content_type 'shorthand' (like `png`), note that it will be converted to a full content type using `Marcel::MimeType.for` under the hood. Therefore, you should check if the content_type is registered by [`Marcel::EXTENSIONS`](https://github.com/rails/marcel/blob/main/lib/marcel/tables.rb). If it's not, you can register it by adding the following code to your `config/initializers/mime_types.rb` file:
 ```ruby
-class User < ApplicationRecord
-  has_one_attached :avatar
-  has_one_attached :photo
-  has_many_attached :photos
+Marcel::MimeType.extend "application/ino", extensions: %w(ino), parents: "text/plain" # Registering arduino INO files
+```
 
-  validates :avatar, aspect_ratio: :square
-  validates :photo, aspect_ratio: :landscape
+#### Content type spoofing protection
 
-  # you can also pass dynamic aspect ratio, like :is_4_3, :is_16_9, etc
-  validates :photos, aspect_ratio: :is_4_3
-end
+By default, the gem does not prevent content type spoofing. You can enable it by setting the `spoofing_protection` option to `true` in your validator options.
+
+<details>
+<summary>
+##### What is content type spoofing?
+</summary>
+File content type spoofing happens when an ill-intentioned user uploads a file which hides its true content type by faking its extension and its declared content type value. For example, a user may try to upload a `.exe` file (application/x-msdownload content type) dissimulated as a `.jpg` file (image/jpeg content type).
+</details>
+
+<details>
+<summary>
+##### How do we prevent it?
+</summary>
+The spoofing protection relies on both the UNIX `file` command and `Marcel` gem. Be careful, since it needs to load the whole file io to perform the analysis, it will use a lot of RAM for very large files. Therefore it could be a wise decision not to enable it in this case.
+
+Take note that the `file` analyzer will not find the exactly same content type as the ActiveStorage blob (ActiveStorage content type detection relies on a different logic using first 4kb of content + filename + extension). To handle this issue, we consider a close parent content type to be a match. For example, for an ActiveStorage blob which content type is `video/x-ms-wmv`, the `file` analyzer will probably detect a `video/x-ms-asf` content type, this will be considered as a valid match because these 2 content types are closely related. The correlation mapping is based on `Marcel::TYPE_PARENTS` table.
+</details>
+
+<details>
+<summary>
+##### Edge cases
+</summary>
+The difficulty to accurately predict a mime type may generate false positives, if so there are two solutions available:
+- If the ActiveStorage blob content type is closely related to the detected content type using the `file` analyzer, you can enhance `Marcel::TYPE_PARENTS` mapping using `Marcel::MimeType.extend "application/x-rar-compressed", parents: %(application/x-rar)` in the `config/initializers/mime_types.rb` file. (Please drop an issue so we can add it to the gem for everyone!)
+- If the ActiveStorage blob content type is not closely related, you still can disable the content type spoofing protection in the validator, if so, please drop us an issue so we can fix it for everyone!
+</details>
+
+
+#### Error messages (I18n)
+
+```yml
+en:
+  errors:
+    messages:
+      content_type_invalid:
+        one: "has an invalid content type (authorized content type is %{authorized_human_content_types})"
+        other: "has an invalid content type (authorized content types are %{authorized_human_content_types})"
+      content_type_spoofed:
+        one: "has a content type that is not equivalent to the one that is detected through its content (authorized content type is %{authorized_human_content_types})"
+        other: "has a content type that is not equivalent to the one that is detected through its content (authorized content types are %{authorized_human_content_types})"
 ```
 
-- Proc Usage:
+The `content_type` validator error messages expose 7 values that you can use:
+- `content_type` containing the content type of the sent file (e.g. `image/png`)
+- `human_content_type` containing a more user-friendly version of the sent file content type (e.g. 'TXT' for 'text/plain')
+- `detected_content_type` containing the detected content type of the sent file using `spoofing_protection` option (e.g. `image/png`)
+- `detected_human_content_type` containing a more user-friendly version of the sent file detected content type using `spoofing_protection` option (e.g. 'TXT' for 'text/plain')
+- `authorized_human_content_types` containing the list of authorized content types (e.g. 'PNG, JPEG' for `['image/png', 'image/jpeg']`)
+- `count` containing the number of authorized content types (e.g. `2`)
+- `filename` containing the filename
+
+---
 
-Procs can be used instead of values in all the above examples. They will be called on every validation.
+### Size
+
+Validates each attached file size.
+
+#### Options
+
+The `size` validator has 5 possible options:
+- `less_than`: defines the strict maximum allowed file size
+- `less_than_or_equal_to`: defines the maximum allowed file size
+- `greater_than`: defines the strict minimum allowed file size
+- `greater_than_or_equal_to`: defines the minimum allowed file size
+- `between`: defines the allowed file size range
+
+#### Examples
+
+Use it like this:
 ```ruby
 class User < ApplicationRecord
-  has_many_attached :proc_files
+  has_one_attached :avatar
 
-  validates :proc_files, limit: { max: -> (record) { record.admin? ? 100 : 10 } }
+  validates :avatar, size: { less_than: 2.megabytes } # restricts the file size to < 2MB
+  validates :avatar, size: { less_than_or_equal_to: 2.megabytes } # restricts the file size to <= 2MB
+  validates :avatar, size: { greater_than: 1.kilobyte } # restricts the file size to > 1KB
+  validates :avatar, size: { greater_than_or_equal_to: 1.kilobyte } # restricts the file size to >= 1KB
+  validates :avatar, size: { between: 1.kilobyte..2.megabytes } # restricts the file size to between 1KB and 2MB
 end
-
 ```
 
-## Internationalization (I18n)
+#### Best practices
+
+It is always a good practice to limit the maximum file size to a reasonable value (like 2MB for avatar images). This helps prevent server storage issues, reduces upload/download times, and ensures better performance. Large files can consume excessive bandwidth and storage space, potentially impacting both server resources and user experience.
+Plus, not setting a size limit inside your Rails app might lead into your server throwing a `413 Content Too Large` error, which is not as nice as a Rails validation error.
 
-Active Storage Validations uses I18n for error messages. For this, add these keys in your translation file:
+#### Error messages (I18n)
 
 ```yml
 en:
   errors:
     messages:
-      content_type_invalid: "has an invalid content type"
-      file_size_not_less_than: "file size must be less than %{max_size} (current size is %{file_size})"
-      file_size_not_less_than_or_equal_to: "file size must be less than or equal to %{max_size} (current size is %{file_size})"
-      file_size_not_greater_than: "file size must be greater than %{min_size} (current size is %{file_size})"
-      file_size_not_greater_than_or_equal_to: "file size must be greater than or equal to %{min_size} (current size is %{file_size})"
-      file_size_not_between: "file size must be between %{min_size} and %{max_size} (current size is %{file_size})"
-      total_file_size_not_less_than: "total file size must be less than %{max_size} (current size is %{total_file_size})"
-      total_file_size_not_less_than_or_equal_to: "total file size must be less than or equal to %{max_size} (current size is %{total_file_size})"
-      total_file_size_not_greater_than: "total file size must be greater than %{min_size} (current size is %{total_file_size})"
-      total_file_size_not_greater_than_or_equal_to: "total file size must be greater than or equal to %{min_size} (current size is %{total_file_size})"
-      total_file_size_not_between: "total file size must be between %{min_size} and %{max_size} (current size is %{total_file_size})"
-      limit_out_of_range: "total number is out of range"
-      image_metadata_missing: "is not a valid image"
-      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"
-      aspect_ratio_not_square: "must be a square image"
-      aspect_ratio_not_portrait: "must be a portrait image"
-      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:
+      file_size_not_less_than: "file size must be less than %{max} (current size is %{file_size})"
+      file_size_not_less_than_or_equal_to: "file size must be less than or equal to %{max} (current size is %{file_size})"
+      file_size_not_greater_than: "file size must be greater than %{min} (current size is %{file_size})"
+      file_size_not_greater_than_or_equal_to: "file size must be greater than or equal to %{min} (current size is %{file_size})"
+      file_size_not_between: "file size must be between %{min} and %{max} (current size is %{file_size})"
+```
 
-### Aspect ratio
-The keys starting with `aspect_ratio_` support two variables that you can use:
-- `aspect_ratio` containing the expected aspect ratio, especially useful for custom aspect ratio
+The `size` validator error messages expose 4 values that you can use:
+- `file_size` containing the current file size (e.g. `1.5MB`)
+- `min` containing the minimum allowed file size (e.g. `1KB`)
+- `max` containing the maximum allowed file size (e.g. `2MB`)
 - `filename` containing the current file name
 
-For example :
+---
+
+### Total size
+
+Validates the total file size for several files.
+
+#### Options
+
+The `total_size` validator has 5 possible options:
+- `less_than`: defines the strict maximum allowed total file size
+- `less_than_or_equal_to`: defines the maximum allowed total file size
+- `greater_than`: defines the strict minimum allowed total file size
+- `greater_than_or_equal_to`: defines the minimum allowed total file size
+- `between`: defines the allowed total file size range
+
+#### Examples
+
+Use it like this:
+```ruby
+class User < ApplicationRecord
+  has_many_attached :certificates
+
+  validates :certificates, total_size: { less_than: 10.megabytes } # restricts the total size to < 10MB
+  validates :certificates, total_size: { less_than_or_equal_to: 10.megabytes } # restricts the total size to <= 10MB
+  validates :certificates, total_size: { greater_than: 1.kilobyte } # restricts the total size to > 1KB
+  validates :certificates, total_size: { greater_than_or_equal_to: 1.kilobyte } # restricts the total size to >= 1KB
+  validates :certificates, total_size: { between: 1.kilobyte..10.megabytes } # restricts the total size to between 1KB and 10MB
+end
+```
+
+#### Error messages (I18n)
 
 ```yml
-aspect_ratio_is_not: "must be a %{aspect_ratio} image"
+en:
+  errors:
+    messages:
+      total_file_size_not_less_than: "total file size must be less than %{max} (current size is %{total_file_size})"
+      total_file_size_not_less_than_or_equal_to: "total file size must be less than or equal to %{max} (current size is %{total_file_size})"
+      total_file_size_not_greater_than: "total file size must be greater than %{min} (current size is %{total_file_size})"
+      total_file_size_not_greater_than_or_equal_to: "total file size must be greater than or equal to %{min} (current size is %{total_file_size})"
+      total_file_size_not_between: "total file size must be between %{min} and %{max} (current size is %{total_file_size})"
 ```
 
-### Content type
-The `content_type_invalid` key has three variables that you can use:
-- `content_type` containing the exact content type of the sent file
-- `human_content_type` containing a more user-friendly version of the sent file content type (e.g. 'TXT' for 'text/plain')
-- `authorized_types` containing the list of authorized content types
-- `filename` containing the current file name
+The `total_size` validator error messages expose 4 values that you can use:
+- `total_file_size` containing the current total file size (e.g. `1.5MB`)
+- `min` containing the minimum allowed total file size (e.g. `1KB`)
+- `max` containing the maximum allowed total file size (e.g. `2MB`)
+
+---
+
+### Dimension
+
+Validates the dimension of the attached image / video files.
+
+#### Options
+
+The `dimension` validator has several possible options:
+- `width`: defines the exact allowed width (integer)
+  - `min`: defines the minimum allowed width (integer)
+  - `max`: defines the maximum allowed width (integer)
+  - `in`: defines the allowed width range (range)
+- `height`: defines the exact allowed height (integer)
+  - `min`: defines the minimum allowed height (integer)
+  - `max`: defines the maximum allowed height (integer)
+  - `in`: defines the allowed height range (range)
+- `min`: defines the minimum allowed width and height (range)
+- `max`: defines the maximum allowed width and height (range)
+
+#### Examples
+
+Use it like this:
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+
+  validates :avatar, dimension: { width: 100 } # restricts the width to 100 pixels
+  validates :avatar, dimension: { width: { min: 80, max: 100 } } # restricts the width to between 80 and 100 pixels
+  validates :avatar, dimension: { width: { in: 80..100 } } # restricts the width to between 80 and 100 pixels
+  validates :avatar, dimension: { height: 100 } # restricts the height to 100 pixels
+  validates :avatar, dimension: { height: { min: 600, max: 1800 } } # restricts the height to between 600 and 1800 pixels
+  validates :avatar, dimension: { height: { in: 600..1800 } } # restricts the height to between 600 and 1800 pixels
+  validates :avatar, dimension: { min: 80..600, max: 100..1800 } # restricts the width to between 80 and 100 pixels, and the height to between 600 and 1800 pixels
+end
+```
 
-For example :
+#### Error messages (I18n)
 
 ```yml
-content_type_invalid: "has an invalid content type : %{content_type}, authorized types are %{authorized_types}"
+en:
+  errors:
+    messages:
+      dimension_min_not_included_in: "must be greater than or equal to %{width} x %{height} pixel"
+      dimension_max_not_included_in: "must be less than or equal to %{width} x %{height} pixel"
+      dimension_width_not_included_in: "width is not included between %{min} and %{max} pixel"
+      dimension_height_not_included_in: "height is not included between %{min} and %{max} pixel"
+      dimension_width_not_greater_than_or_equal_to: "width must be greater than or equal to %{length} pixel"
+      dimension_height_not_greater_than_or_equal_to: "height must be greater than or equal to %{length} pixel"
+      dimension_width_not_less_than_or_equal_to: "width must be less than or equal to %{length} pixel"
+      dimension_height_not_less_than_or_equal_to: "height must be less than or equal to %{length} pixel"
+      dimension_width_not_equal_to: "width must be equal to %{length} pixel"
+      dimension_height_not_equal_to: "height must be equal to %{length} pixel"
+      media_metadata_missing: "is not a valid media file"
 ```
 
-### Dimension
-The keys starting with `dimension_` support six variables that you can use:
+The `dimension` validator error messages expose 6 values that you can use:
 - `min` containing the minimum width or height allowed
 - `max` containing the maximum width or height allowed
 - `width` containing the minimum or maximum width allowed
 - `height` containing the minimum or maximum width allowed
 - `length` containing the exact width or height allowed
-- `filename` containing the current file name
+- `filename` containing the current filename in error
 
-For example :
+---
 
-```yml
-dimension_min_inclusion: "must be greater than or equal to %{width} x %{height} pixel."
-```
+### Duration
 
-### File size
-The keys starting with `file_size_not_` support four variables that you can use:
-- `file_size` containing the current file size
-- `min` containing the minimum file size
-- `max` containing the maximum file size
-- `filename` containing the current file name
+Validates the duration of the attached audio / video files.
 
-For example :
+#### Options
 
-```yml
-file_size_not_between: "file size must be between %{min_size} and %{max_size} (current size is %{file_size})"
-```
+The `duration` validator has 5 possible options:
+- `less_than`: defines the strict maximum allowed file duration
+- `less_than_or_equal_to`: defines the maximum allowed file duration
+- `greater_than`: defines the strict minimum allowed file duration
+- `greater_than_or_equal_to`: defines the minimum allowed file duration
+- `between`: defines the allowed file duration range
 
-### Total file size
-The keys starting with `total_file_size_not_` support three variables that you can use:
-- `total_file_size` containing the current total file size
-- `min` containing the minimum file size
-- `max` containing the maximum file size
+#### Examples
 
-For example :
+Use it like this:
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
 
-```yml
-total_file_size_not_between: "total file size must be between %{min_size} and %{max_size} (current size is %{total_file_size})"
+  validates :avatar, duration: { less_than: 2.minutes } # restricts the file duration to < 2 minutes
+  validates :avatar, duration: { less_than_or_equal_to: 2.minutes } # restricts the file duration to <= 2 minutes
+  validates :avatar, duration: { greater_than: 1.second } # restricts the file duration to > 1 second
+  validates :avatar, duration: { greater_than_or_equal_to: 1.second } # restricts the file duration to >= 1 second
+  validates :avatar, duration: { between: 1.second..2.minutes } # restricts the file duration to between 1 second and 2 minutes
+end
 ```
 
-### Number of files
-The `limit_out_of_range` key supports two variables that you can use:
-- `min` containing the minimum number of files
-- `max` containing the maximum number of files
-
-For example :
+#### Error messages (I18n)
 
 ```yml
-limit_out_of_range: "total number is out of range. range: [%{min}, %{max}]"
+en:
+  errors:
+    messages:
+      duration_not_less_than: "duration must be less than %{max} (current duration is %{duration})"
+      duration_not_less_than_or_equal_to: "duration must be less than or equal to %{max} (current duration is %{duration})"
+      duration_not_greater_than: "duration must be greater than %{min} (current duration is %{duration})"
+      duration_not_greater_than_or_equal_to: "duration must be greater than or equal to %{min} (current duration is %{duration})"
+      duration_not_between: "duration must be between %{min} and %{max} (current duration is %{duration})"
 ```
 
-### Processable image
-The `image_not_processable` key supports one variable that you can use:
+The `duration` validator error messages expose 4 values that you can use:
+- `duration` containing the current duration size (e.g. `2 minutes`)
+- `min` containing the minimum allowed duration size (e.g. `1 second`)
+- `max` containing the maximum allowed duration size (e.g. `2 minutes`)
 - `filename` containing the current file name
 
-For example :
+---
+
+### Aspect ratio
+
+Validates the aspect ratio of the attached files.
+
+#### Options
+
+The `aspect_ratio` validator has several options:
+- `with`: defines the exact allowed aspect ratio (e.g. `:is_16/9`)
+- `in`: defines the allowed aspect ratios (e.g. `%i[square landscape]`)
+
+This validator can define aspect ratios in several ways:
+- Symbols:
+  - prebuilt aspect ratios: `:square`, `:portrait`, `:landscape`
+  - custom aspect ratios (it must be of type `is_xx_yy`): `:is_16_9`, `:is_4_3`, etc.
+
+#### Examples
+
+Use it like this:
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+
+  validates :avatar, aspect_ratio: :square # restricts the aspect ratio to 1:1
+  validates :avatar, aspect_ratio: :portrait # restricts the aspect ratio to x:y where y > x
+  validates :avatar, aspect_ratio: :landscape # restricts the aspect ratio to x:y where x > y
+  validates :avatar, aspect_ratio: :is_16_9 # restricts the aspect ratio to 16:9
+  validates :avatar, aspect_ratio: %i[square is_16_9] # restricts the aspect ratio to 1:1 and 16:9
+end
+```
+
+#### Error messages (I18n)
 
 ```yml
-image_not_processable: "is not a valid image (file: %{filename})"
+en:
+  errors:
+    messages:
+      aspect_ratio_not_square: "must be square (current file is %{width}x%{height}px)"
+      aspect_ratio_not_portrait: "must be portrait (current file is %{width}x%{height}px)"
+      aspect_ratio_not_landscape: "must be landscape (current file is %{width}x%{height}px)"
+      aspect_ratio_not_x_y: "must be %{authorized_aspect_ratios} (current file is %{width}x%{height}px)"
+      aspect_ratio_invalid: "has an invalid aspect ratio (valid aspect ratios are %{authorized_aspect_ratios})"
+      media_metadata_missing: "is not a valid media file"
 ```
 
-## Installation
+The `aspect_ratio` validator error messages expose 4 values that you can use:
+- `authorized_aspect_ratios` containing the authorized aspect ratios
+- `width` containing the current width of the image/video
+- `height` containing the current height of the image/video
+- `filename` containing the current filename in error
+
+---
+
+### Processable file
+
+Validates if the attached files can be processed by MiniMagick or Vips (image) or ffmpeg (video/audio).
+
+#### Options
+
+The `processable_file` validator has no options.
 
-Add this line to your application's Gemfile:
+#### Examples
 
+Use it like this:
 ```ruby
-gem 'active_storage_validations'
+class User < ApplicationRecord
+  has_one_attached :avatar
 
-# Optional, to use :dimension validator or :aspect_ratio validator
-gem 'mini_magick', '>= 4.9.5'
-# Or
-gem 'ruby-vips', '>= 2.1.0'
+  validates :avatar, processable_file: true # ensures that the file is processable by MiniMagick or Vips (image) or ffmpeg (video/audio)
+end
 ```
 
-And then execute:
+#### Error messages (I18n)
 
-```bash
-$ bundle
+```yml
+en:
+  errors:
+    messages:
+      file_not_processable: "is not identified as a valid media file"
 ```
 
-## Sample
+The `processable_file` validator error messages expose 1 value that you can use:
+- `filename` containing the current filename in error
+
+---
+
+## Upgrading from 1.x to 2.x
+
+If you are upgrading from 1.x to 2.x, you will be pleased to note that a lot of things have been added and improved!
+
+Added features:
+- `duration` validator has been added for audio / video files
+- `dimension` validator now supports videos
+- `aspect_ratio` validator now supports videos
+- `processable_image` validator is now `processable_file` validator and supports image/video/audio
+- Major performance improvement have been added: we now only perform the expensive io analysis operation on the newly attached files. For previously attached files, we validate them using Rails `ActiveStorage::Blob#metadata` internal mecanism ([more here](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/blob/analyzable.rb)).
+- All error messages have been given an upgrade and new variables that you can use
+
+But this major version bump also comes with some breaking changes. Below are the main breaking changes you need to be aware of:
+- Error messages
+  - We advise you to replace all the v1 translations by the new v2 rather than changing them one by one. A majority of messages have been completely rewritten to be more consistent and easier to understand.
+  - If you wish to change them one by one, here is the list of changes to make:
+    - Some validator errors have been totally changed:
+      - `limit` validator keys have been totally reworked
+      - `dimension` validator keys have been totally reworked
+      - `content_type` validator keys have been totally reworked
+      - `processable_image` validator keys have been totally reworked
+    - Some keys have been changed:
+      - `image_metadata_missing` has been replaced by `media_metadata_missing`
+      - `aspect_ratio_is_not` has been replaced by `aspect_ratio_not_x_y`
+    - Some error messages variables names have been changed to improve readability:
+      - `aspect_ratio` validator:
+        - `aspect_ratio` has been replaced by `authorized_aspect_ratios`
+      - `content_type` validator:
+        - `authorized_types` has been replaced by `authorized_human_content_types`
+      - `size` validator:
+        - `min_size` has been replaced by `min`
+        - `max_size` has been replaced by `max`
+      - `total_size` validator:
+        - `min_size` has been replaced by `min`
+        - `max_size` has been replaced by `max`
+
+- `content_type` validator
+  - The `:in` option now only accepts 'valid' content types (ie content types deemed by Marcel as valid).
+    - The check was mistakenly only performed on the `:with` option previously. Therefore, invalid content types were accepted in the `:in` option, which is not the expected behavior.
+    - This might break some cases when you had for example `content_type: ['image/png', 'image/jpg']`, because `image/jpg` is not a valid content type, it should be replaced by `image/jpeg`.
+  - An `ArgumentError` is now raised if `image/jpg` is used to make it easier to fix. You should now only use `image/jpeg`.
+
+- `processable_image` validator
+  - The validator has been replaced by `processable_file` validator, be sure to replace `processable_image: true` to `processable_file: true`
+  - The associated matcher has also been updated accordingly, be sure to replace `validate_processable_image_of` to `validate_processable_file_of`
 
-Very simple example of validation with file attached, content type check and custom error message.
+## Internationalization (I18n)
 
-[![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)
+Active Storage Validations uses I18n for error messages. Add these keys in your translation files to make them available:
+
+```yml
+en:
+  errors:
+    messages:
+      content_type_invalid:
+        one: "has an invalid content type (authorized content type is %{authorized_human_content_types})"
+        other: "has an invalid content type (authorized content types are %{authorized_human_content_types})"
+      content_type_spoofed:
+        one: "has a content type that is not equivalent to the one that is detected through its content (authorized content type is %{authorized_human_content_types})"
+        other: "has a content type that is not equivalent to the one that is detected through its content (authorized content types are %{authorized_human_content_types})"
+      file_size_not_less_than: "file size must be less than %{max} (current size is %{file_size})"
+      file_size_not_less_than_or_equal_to: "file size must be less than or equal to %{max} (current size is %{file_size})"
+      file_size_not_greater_than: "file size must be greater than %{min} (current size is %{file_size})"
+      file_size_not_greater_than_or_equal_to: "file size must be greater than or equal to %{min} (current size is %{file_size})"
+      file_size_not_between: "file size must be between %{min} and %{max} (current size is %{file_size})"
+      total_file_size_not_less_than: "total file size must be less than %{max} (current size is %{total_file_size})"
+      total_file_size_not_less_than_or_equal_to: "total file size must be less than or equal to %{max} (current size is %{total_file_size})"
+      total_file_size_not_greater_than: "total file size must be greater than %{min} (current size is %{total_file_size})"
+      total_file_size_not_greater_than_or_equal_to: "total file size must be greater than or equal to %{min} (current size is %{total_file_size})"
+      total_file_size_not_between: "total file size must be between %{min} and %{max} (current size is %{total_file_size})"
+      duration_not_less_than: "duration must be less than %{max} (current duration is %{duration})"
+      duration_not_less_than_or_equal_to: "duration must be less than or equal to %{max} (current duration is %{duration})"
+      duration_not_greater_than: "duration must be greater than %{min} (current duration is %{duration})"
+      duration_not_greater_than_or_equal_to: "duration must be greater than or equal to %{min} (current duration is %{duration})"
+      duration_not_between: "duration must be between %{min} and %{max} (current duration is %{duration})"
+      limit_out_of_range:
+        zero: "no files attached (must have between %{min} and %{max} files)"
+        one: "only 1 file attached (must have between %{min} and %{max} files)"
+        other: "total number of files must be between %{min} and %{max} files (there are %{count} files attached)"
+      limit_min_not_reached:
+        zero: "no files attached (must have at least %{min} files)"
+        one: "only 1 file attached (must have at least %{min} files)"
+        other: "%{count} files attached (must have at least %{min} files)"
+      limit_max_exceeded:
+        zero: "no files attached (maximum is %{max} files)"
+        one: "too many files attached (maximum is %{max} files, got %{count})"
+        other: "too many files attached (maximum is %{max} files, got %{count})"
+      media_metadata_missing: "is not a valid media file"
+      dimension_min_not_included_in: "must be greater than or equal to %{width} x %{height} pixel"
+      dimension_max_not_included_in: "must be less than or equal to %{width} x %{height} pixel"
+      dimension_width_not_included_in: "width is not included between %{min} and %{max} pixel"
+      dimension_height_not_included_in: "height is not included between %{min} and %{max} pixel"
+      dimension_width_not_greater_than_or_equal_to: "width must be greater than or equal to %{length} pixel"
+      dimension_height_not_greater_than_or_equal_to: "height must be greater than or equal to %{length} pixel"
+      dimension_width_not_less_than_or_equal_to: "width must be less than or equal to %{length} pixel"
+      dimension_height_not_less_than_or_equal_to: "height must be less than or equal to %{length} pixel"
+      dimension_width_not_equal_to: "width must be equal to %{length} pixel"
+      dimension_height_not_equal_to: "height must be equal to %{length} pixel"
+      aspect_ratio_not_square: "must be square (current file is %{width}x%{height}px)"
+      aspect_ratio_not_portrait: "must be portrait (current file is %{width}x%{height}px)"
+      aspect_ratio_not_landscape: "must be landscape (current file is %{width}x%{height}px)"
+      aspect_ratio_not_x_y: "must be %{authorized_aspect_ratios} (current file is %{width}x%{height}px)"
+      aspect_ratio_invalid: "has an invalid aspect ratio (valid aspect ratios are %{authorized_aspect_ratios})"
+      file_not_processable: "is not identified as a valid media file"
+```
+
+Other translation files are available (here)[https://github.com/igorkasyanchuk/active_storage_validations/tree/master/config/locales].
 
 ## Test matchers
-Provides RSpec-compatible and Minitest-compatible matchers for testing the validators.
+
+The gem also provides RSpec-compatible and Minitest-compatible matchers for testing the validators.
 
 ### RSpec
 
+#### Setup
 In `spec_helper.rb`, you'll need to require the matchers:
 
 ```ruby
 require 'active_storage_validations/matchers'
 ```
 
-And _include_ the module:
+And include the module:
 
 ```ruby
 RSpec.configure do |config|
@@ -338,6 +731,7 @@ RSpec.configure do |config|
 end
 ```
 
+#### Matchers
 Matcher methods available:
 
 ```ruby
@@ -350,8 +744,8 @@ describe User do
   # attached
   it { is_expected.to validate_attached_of(:avatar) }
 
-  # processable_image
-  it { is_expected.to validate_processable_image_of(:avatar) }
+  # processable_file
+  it { is_expected.to validate_processable_file_of(:avatar) }
 
   # limit
   # #min, #max
@@ -389,6 +783,14 @@ describe User do
   it { is_expected.to validate_total_size_of(:avatar).greater_than(1.kilobyte) }
   it { is_expected.to validate_total_size_of(:avatar).greater_than_or_equal_to(1.kilobyte) }
   it { is_expected.to validate_total_size_of(:avatar).between(100..500.kilobytes) }
+
+  # duration:
+  # #less_than, #less_than_or_equal_to, #greater_than, #greater_than_or_equal_to, #between
+  it { is_expected.to validate_duration_of(:introduction).less_than(50.seconds) }
+  it { is_expected.to validate_duration_of(:introduction).less_than_or_equal_to(50.seconds) }
+  it { is_expected.to validate_duration_of(:introduction).greater_than(1.minute) }
+  it { is_expected.to validate_duration_of(:introduction).greater_than_or_equal_to(1.minute) }
+  it { is_expected.to validate_duration_of(:introduction).between(100..500.seconds) }
 end
 ```
 (Note that matcher methods are chainable)
@@ -410,6 +812,8 @@ end
 ```
 
 ### Minitest
+
+#### Setup
 To use the matchers, make sure you have the [shoulda-context](https://github.com/thoughtbot/shoulda-context) gem up and running.
 
 You need to require the matchers:
@@ -418,7 +822,7 @@ You need to require the matchers:
 require 'active_storage_validations/matchers'
 ```
 
-And _extend_ the module:
+And extend the module:
 
 ```ruby
 class ActiveSupport::TestCase
@@ -426,19 +830,19 @@ class ActiveSupport::TestCase
 end
 ```
 
+#### Matchers
 Then you can use the matchers with the syntax specified in the RSpec section, just use `should validate_method` instead of `it { is_expected_to validate_method }` as specified in the [shoulda-context](https://github.com/thoughtbot/shoulda-context) gem.
 
-## Todo
 
-* verify with remote storages (s3, etc)
-* verify how it works with direct upload
-* add more translations
+## Contributing
+
+If you want to contribute to the project, you will have to fork the repository and create a new branch from the `master` branch. Then build your feature, or fix the issue, and create a pull request. Be sure to add tests for your changes.
 
-## Tests & Contributing
+Before submitting your pull request, run the tests to make sure everything works as expected.
 
-To run tests in root folder of gem:
+To run the gem tests, launch the following commands in the root folder of gem repository:
 
-* `BUNDLE_GEMFILE=gemfiles/rails_6_1_4.gemfile bundle exec rake test` to run for Rails 6.1
+* `BUNDLE_GEMFILE=gemfiles/rails_6_1_4.gemfile bundle exec rake test` to run for Rails 6.1.4
 * `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
@@ -461,23 +865,22 @@ BUNDLE_GEMFILE=gemfiles/rails_8_0.gemfile bundle exec rake test
 
 Tips:
 - To focus a specific test, use the `focus` class method provided by [minitest-focus](https://github.com/minitest/minitest-focus)
-- To focus a specific file, use the TEST option provided by minitest, e.g. to only run size_validator_test.rb file you will execute the following command: `bundle exec rake test TEST=test/validators/size_validator_test.rb`
+- To focus a specific file, use the TEST option provided by minitest, e.g. to only run `size_validator_test.rb` file you will launch the following command: `bundle exec rake test TEST=test/validators/size_validator_test.rb`
 
 
-## Contributing
-
-You are welcome to contribute.
+## Additional information
 
-[<img src="https://opensource-heroes.com/svg/embed/igorkasyanchuk/active_storage_validations"
-/>](https://opensource-heroes.com/r/igorkasyanchuk/active_storage_validations)
+### Contributors (BIG THANK YOU!)
 
-## Contributors (BIG THANK YOU)
+We have a long list of valued contributors. Check them all at:
 
 https://github.com/igorkasyanchuk/active_storage_validations/graphs/contributors
 
-## License
+### License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+<br>
+
 [<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
 />](https://www.railsjazz.com/?utm_source=github&utm_medium=bottom&utm_campaign=active_storage_validations)