validates_email_format_of 1.7.2 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6220bc1f3cb06d9af63e0bcf8ccfcc6e1dc795a59a5c08cd817ac921a057585b
-  data.tar.gz: 6c0f414549308510ad6434c71b3a1d0cabd88c4fc18cb3a3fb02135b862f3f5b
+  metadata.gz: 11c21b2a28ee1659e6727cc106aaf912487adf9b519eceeebd68f3dbb1750b88
+  data.tar.gz: 8db0acd0c16c49e5042640bf159aa75caad8f75b899a5df91527d66c899012aa
 SHA512:
-  metadata.gz: 91e1f3eb18440c304f144d81b346134d9c6d7bc747e43fe464edeebb9e3a02e972e7fa4b4283d7b9eed6e4556f37a578d11bb4a9bb0328e93f5f2f2658625a30
-  data.tar.gz: 2e3c8cc64f8d860c0fb1e7771197942901a4fae28b166376b613bbef6262275003bbad62b23e244a3a9887ecb99c5f1dad7bc3f3b973150beaa5774782baed2d
+  metadata.gz: c3fcec1122983e8bbcff3e8a388260d040851467dbb89d6a1157e38ab59fbe908c3b8c69793ac2166ee1cedaf1d78d0c6613fc4ac8c450fb523c45fda1821b59
+  data.tar.gz: dbc08e3633edf9d254e80d6614795a36f4c806046aa6dafb1c0aa46e9aa729f19701fbf533be9253138d119b35c8203fdea1a64a87c6c364e0e53ded94e23a7c

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/ci.yml

@@ -1,10 +1,7 @@
 name: CI
 
 on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
+  - pull_request
 
 permissions:
   contents: read
@@ -17,38 +14,78 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
-        gemfile: ["4.2", "5.0", "5.1", "5.2", "6.0", "6.1", "7.0"]
+        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3", "jruby-head"]
+        gemfile: ["4.2", "5.0", "5.1", "5.2", "6.0", "6.1", "7.0", "7.1"]
+
         exclude:
           - gemfile: "4.2"
             ruby: "3.0"
           - gemfile: "4.2"
             ruby: "3.1"
+          - gemfile: "4.2"
+            ruby: "3.2"
+          - gemfile: "4.2"
+            ruby: "3.3"
+          - gemfile: "4.2"
+            ruby: "jruby-head"
           - gemfile: "5.0"
             ruby: "3.0"
           - gemfile: "5.0"
             ruby: "3.1"
+          - gemfile: "5.0"
+            ruby: "3.2"
+          - gemfile: "5.0"
+            ruby: "3.3"
+          - gemfile: "5.0"
+            ruby: "jruby-head"
           - gemfile: "5.1"
             ruby: "3.0"
           - gemfile: "5.1"
             ruby: "3.1"
+          - gemfile: "5.1"
+            ruby: "3.2"
+          - gemfile: "5.1"
+            ruby: "3.3"
+          - gemfile: "5.1"
+            ruby: "jruby-head"
           - gemfile: "5.2"
             ruby: "3.0"
           - gemfile: "5.2"
             ruby: "3.1"
+          - gemfile: "5.2"
+            ruby: "3.2"
+          - gemfile: "5.2"
+            ruby: "3.3"
+          - gemfile: "5.2"
+            ruby: "jruby-head"
+          - gemfile: "6.0"
+            ruby: "3.2"
+          - gemfile: "6.0"
+            ruby: "3.3"
+          - gemfile: "6.1"
+            ruby: "3.2"
+          - gemfile: "6.1"
+            ruby: "3.3"
           - gemfile: "7.0"
             ruby: "2.5"
           - gemfile: "7.0"
             ruby: "2.6"
           - gemfile: "7.0"
             ruby: "2.7"
+          - gemfile: "7.1"
+            ruby: "2.5"
+          - gemfile: "7.1"
+            ruby: "2.6"
+          - gemfile: "7.1"
+            ruby: "2.7"
+
 
     env:
       BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.gemfile }}.gemfile
       RAILS_ENV: test
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: "Install Ruby ${{ matrix.ruby  }}"
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
@@ -65,3 +102,4 @@ jobs:
 
       - name: Run standard.rb
         run: bundle exec rake standard
+        if: ${{ ! startsWith(matrix.ruby, '2.') }}

data/Appraisals

@@ -1,4 +1,8 @@
 # run `bundle exec appraisal install` after making changes here
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1"
+end
+
 appraise "rails-7.0" do
   gem "rails", "~> 7.0"
 end

data/CHANGELOG.md

@@ -2,13 +2,37 @@
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.7.2...master
+[Unreleased]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.8.2...master
+
+## [1.8.2]
+
+* Improve German translations - https://github.com/validates-email-format-of/validates_email_format_of/pull/111
+
+[1.8.2]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.8.1...1.8.2
+
+## [1.8.1]
+
+* Fix IDN->Punycode conversion when domain names start with periods - https://github.com/validates-email-format-of/validates_email_format_of/issues/109
+* Add jruby to test matrix - https://github.com/validates-email-format-of/validates_email_format_of/pull/108
+
+[1.8.1]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.8.0...1.8.1
+
+## [1.8.0]
+
+* Add Internationalized Domain Name support - https://github.com/validates-email-format-of/validates_email_format_of/pull/103 - thanks https://github.com/sbilharz !
+* Add Turkish locale - https://github.com/validates-email-format-of/validates_email_format_of/pull/101 - thanks https://github.com/@krmbzds !
+* Added Indonesian locale - https://github.com/validates-email-format-of/validates_email_format_of/commit/129ebfc3a3b432b4df0334bcbdd74b1d17d765e0 - thanks https://github.com/khoerodin !
+* Fix inconsistent `generate_messages` behaviour - https://github.com/validates-email-format-of/validates_email_format_of/pull/105
+* ⚠️ Deprecate `:with` option - https://github.com/validates-email-format-of/validates_email_format_of/issues/42
+* Require i18n >= 0.8.0 in modern Ruby versions - https://github.com/advisories/GHSA-34hf-g744-jw64
+
+[1.8.0]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.7.2...1.8.0
 
 ## [1.7.2]
 
 * Fix regression that disallowed domains starting with number - https://github.com/validates-email-format-of/validates_email_format_of/issues/88
 
-[Unreleased]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.7.1...v1.7.2
+[1.7.2]: https://github.com/validates-email-format-of/validates_email_format_of/compare/v1.7.1...v1.7.2
 
 ## [1.7.1] (3 Aug 2022)
 

data/README.md

@@ -0,0 +1,120 @@
+# validates_email_format_of
+
+[![Build Status](https://github.com/validates-email-format-of/validates_email_format_of/actions/workflows/ci.yml/badge.svg)]( https://github.com/validates-email-format-of/validates_email_format_of/actions/workflows/ci.yml?query=branch%3Amaster)
+
+A Ruby gem to validate email addresses against RFC 2822 and RFC 5322, with optional domain name lookups.
+
+## Why this email validator?
+
+This gem is the O.G. email validation gem for Rails.  It was started back in 2006.
+
+Why use this validator?  Instead of trying to validate email addresses with one giant regular expression, this library parses addresses character by character.  This lets us handle weird cases like [nested comments](https://www.rfc-editor.org/rfc/rfc5322#appendix-A.5).  Gross, but technically allowed.
+
+In reality, most email validating scripts will get you where you need to go.  This library just aims to go all the way.
+
+## Installation
+
+Add the gem to your Gemfile with:
+
+```sh
+gem 'validates_email_format_of'
+```
+
+### Usage in a Rails app
+
+```ruby
+class Person < ActiveRecord::Base
+  validates :email, :email_format => { :message => "is not looking good" }
+
+  # OR
+
+  validates_email_format_of :email, :message => "is not looking good"
+end
+```
+
+You can use the included `rspec` matcher as well:
+
+```ruby
+require "validates_email_format_of/rspec_matcher"
+
+describe Person do
+  it { should validate_email_format_of(:email).with_message("is not looking good") }
+end
+```
+
+### Usage without Rails
+
+```ruby
+ValidatesEmailFormatOf::validate_email_format("example@mydomain.com") # => nil
+ValidatesEmailFormatOf::validate_email_format("invalid@") # => ["does not appear to be a valid email address"]
+
+# Optional, if you want error messages to be in your language
+ValidatesEmailFormatOf::load_i18n_locales
+I18n.locale = :pl
+
+ValidatesEmailFormatOf::validate_email_format("invalid@") # => ["nieprawidłowy adres email"]
+```
+
+## Internationalized Domain Names (IDN) and Punycode
+
+As of v1.8.0, this gem can validate email addresses using internationalized domain names (like `test@пример.рф`) as well as domains that have already been converted to Punycode code (like `test@xn--test@-3weu6azakd.xn--p1ai`).
+
+If you would like to forbid internationalized domains, you can pass the `idn: false` option.  Punycode is always accepted.
+
+
+## Options
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `:message` | String | A custom error message when the email format is invalid (default is: "does not appear to be a valid email address") |
+| `:check_mx` | Boolean | Check domain for a valid MX record (default is false) |
+| `:check_mx_timeout` | Integer | Timeout in seconds for checking MX records before a `ResolvTimeout` is raised (default is 3). |
+| `:idn` | Boolean | Allowed internationalized domain names like `test@exämple.com` and `test@пример.рф`. Otherwise only domains that have already been converted to [Punycode](https://en.wikipedia.org/wiki/Punycode) are supported. (default is true) |
+| `:mx_message` | String | A custom error message when the domain does not match a valid MX record (default is: "is not routable").  Ignored unless :check_mx option is true. |
+| `:local_length` |Integer | Maximum number of characters allowed in the local part (everything before the '@') (default is 64) |
+| `:domain_length` | Integer | Maximum number of characters allowed in the domain part (everything after the '@') (default is 255) |
+| `:generate_message` | Boolean | Return the I18n key of the error message instead of the error message itself (default is false) |
+
+The standard ActiveModel validation options (`:on`, `:if`, `:unless`, `:allow_nil`, `:allow_blank`, etc...) all work as well when using the gem as part of a Rails application.
+## Testing
+
+The gem is tested against Rails 4.2 and onward across a bunch of Ruby versions including jruby. You can see our [current Ruby and Rails test matrix here](.github/workflows/ci.yml).
+
+To execute the unit tests against [all the Rails versions we support run](gemfiles/) <tt>bundle exec appraisal rspec</tt> or run against an individual version with <tt>bundle exec appraisal rails-6.0 rspec</tt>.
+## Contributing
+
+If you think we're letting some rules about valid email formats slip through the cracks, don't just update the parser. Instead, add a failing test and demonstrate that the described email address should be treated differently.  A link to an appropriate RFC is the best way to do this. Then change the gem code to make the test pass.
+
+```ruby
+describe "i_think_this_is_not_a_v@lid_email_addre.ss" do
+  # According to http://..., this email address IS NOT valid.
+  it { should have_errors_on_email.because("does not appear to be valid") }
+end
+
+describe "i_think_this_is_a_v@lid_email_addre.ss" do
+  # According to http://..., this email address IS valid.
+  it { should_not have_errors_on_email }
+end
+```
+
+Yes, our Rspec syntax is that simple!
+
+## Homepage
+
+* https://github.com/validates-email-format-of/validates_email_format_of
+
+## Credits
+
+Written by [Alex Dunae](https://dunae.ca), 2006-24.
+
+Many thanks to the plugin's recent contributors: https://github.com/alexdunae/validates_email_format_of/contributors
+
+Thanks to [Francis Hwang](http://fhwang.net/) at Diversion Media for creating the 1.1 update.
+
+Thanks to Travis Sinnott for creating the 1.3 update.
+
+Thanks to Denis Ahearn at [Riverock Technologies](http://www.riverocktech.com/) for creating the 1.4 update.
+
+Thanks to [George Anderson](http://github.com/george) and ['history'](http://github.com/history) for creating the 1.4.1 update.
+
+Thanks to [Isaac Betesh](https://github.com/betesh) for converting tests to Rspec and refactoring for version 1.6.0.

data/config/locales/de.yml

@@ -2,7 +2,7 @@ de:
   activemodel: &errors
     errors:
       messages:
-        invalid_email_address: 'ist offensichtlich keine gültige E-Mail-Adresse'
+        invalid_email_address: 'ist anscheinend keine gültige E-Mail-Adresse'
         email_address_not_routable: 'kann nicht erreicht werden'
   activerecord:
     <<: *errors

data/config/locales/en.yml

@@ -2,7 +2,7 @@ en:
   activemodel: &errors
     errors:
       messages:
-        invalid_email_address: 'does not appear to be a valid e-mail address'
+        invalid_email_address: 'does not appear to be a valid email address'
         email_address_not_routable: 'is not routable'
   activerecord:
     <<: *errors

data/config/locales/id.yml

@@ -0,0 +1,8 @@
+id:
+  activemodel: &errors
+    errors:
+      messages:
+        invalid_email_address: 'tampaknya bukan alamat email yang valid'
+        email_address_not_routable: 'tidak dapat dirutekan'
+  activerecord:
+    <<: *errors

data/config/locales/it.yml

@@ -2,7 +2,7 @@ it:
   activemodel: &errors
     errors:
       messages:
-        invalid_email_address: 'non sembra un indirizzo e-mail valido'
+        invalid_email_address: 'non sembra un indirizzo email valido'
         email_address_not_routable: 'dominio non raggiungibile'
   activerecord:
     <<: *errors

data/config/locales/pl.yml

@@ -2,7 +2,7 @@ pl:
   activemodel: &errors
     errors:
       messages:
-        invalid_email_address: 'nieprawidłowy adres e-mail'
+        invalid_email_address: 'nieprawidłowy adres email'
         email_address_not_routable: 'jest nieosiągalny'
   activerecord:
     <<: *errors

data/config/locales/pt-BR.yml

@@ -2,7 +2,7 @@ pt-BR:
   activemodel: &errors
     errors:
       messages:
-        invalid_email_address: 'não parece ser um endereço de e-mail válido'
+        invalid_email_address: 'não parece ser um endereço de email válido'
         email_address_not_routable: 'não é acessível'
   activerecord:
     <<: *errors

data/config/locales/pt.yml

@@ -2,7 +2,7 @@ pt:
   activemodel: &errors
     errors:
       messages:
-        invalid_email_address: 'não parece ser um endereço de e-mail válido'
+        invalid_email_address: 'não parece ser um endereço de email válido'
         email_address_not_routable: 'não é acessível'
   activerecord:
     <<: *errors

data/config/locales/tr.yml

@@ -0,0 +1,8 @@
+tr:
+  activemodel: &errors
+    errors:
+      messages:
+        invalid_email_address: 'geçerli bir eposta adresi değil'
+        email_address_not_routable: 'ulaşılabilir değil'
+  activerecord:
+    <<: *errors

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 7.1"
+
+gemspec path: "../"

data/lib/validates_email_format_of/active_model.rb

@@ -9,7 +9,7 @@ module ActiveModel
   module Validations
     class EmailFormatValidator < EachValidator
       def validate_each(record, attribute, value)
-        (ValidatesEmailFormatOf.validate_email_format(value, options.merge(generate_message: true)) || []).each do |error|
+        (ValidatesEmailFormatOf.validate_email_format(value, options) || []).each do |error|
           record.errors.add(attribute, error)
         end
       end

data/lib/validates_email_format_of/version.rb

@@ -1,3 +1,3 @@
 module ValidatesEmailFormatOf
-  VERSION = "1.7.2"
+  VERSION = "1.8.2"
 end

data/lib/validates_email_format_of.rb

@@ -1,4 +1,5 @@
 require "validates_email_format_of/version"
+require "simpleidn"
 
 module ValidatesEmailFormatOf
   def self.load_i18n_locales
@@ -77,7 +78,7 @@ module ValidatesEmailFormatOf
   # > restriction on the first character is relaxed to allow either a
   # > letter or a digit.  Host software MUST support this more liberal
   # > syntax.
-  DOMAIN_PART_LABEL = /\A[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]?\Z/
+  DOMAIN_PART_LABEL = /\A[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]?\Z/
 
   # From https://tools.ietf.org/id/draft-liman-tld-names-00.html#rfc.section.2
   #
@@ -92,10 +93,12 @@ module ValidatesEmailFormatOf
   # ld       = ALPHA / DIGIT
   # ALPHA    = %x41-5A / %x61-7A   ; A-Z / a-z
   # DIGIT    = %x30-39             ; 0-9
-  DOMAIN_PART_TLD = /\A[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]\Z/
+  DOMAIN_PART_TLD = /\A[A-Za-z][A-Za-z0-9-]*[A-Za-z0-9]\Z/
 
-  def self.validate_email_domain(email, check_mx_timeout: 3)
+  def self.validate_email_domain(email, idn: true, check_mx_timeout: 3)
     domain = email.to_s.downcase.match(/@(.+)/)[1]
+    domain = SimpleIDN.to_ascii(domain) if idn
+
     Resolv::DNS.open do |dns|
       dns.timeouts = check_mx_timeout
       @mx = dns.getresources(domain, Resolv::DNS::Resource::IN::MX) + dns.getresources(domain, Resolv::DNS::Resource::IN::A)
@@ -119,8 +122,8 @@ module ValidatesEmailFormatOf
   # * <tt>message</tt> - A custom error message (default is: "does not appear to be valid")
   # * <tt>check_mx</tt> - Check for MX records (default is false)
   # * <tt>check_mx_timeout</tt> - Timeout in seconds for checking MX records before a `ResolvTimeout` is raised (default is 3)
+  # * <tt>idn</tt> - Enable or disable Internationalized Domain Names (default is true)
   # * <tt>mx_message</tt> - A custom error message when an MX record validation fails (default is: "is not routable.")
-  # * <tt>with</tt> The regex to use for validating the format of the email address (deprecated)
   # * <tt>local_length</tt> Maximum number of characters allowed in the local part (default is 64)
   # * <tt>domain_length</tt> Maximum number of characters allowed in the domain part (default is 255)
   # * <tt>generate_message</tt> Return the I18n key of the error message instead of the error message itself (default is false)
@@ -128,6 +131,7 @@ module ValidatesEmailFormatOf
     default_options = {message: options[:generate_message] ? ERROR_MESSAGE_I18N_KEY : default_message,
                        check_mx: false,
                        check_mx_timeout: 3,
+                       idn: true,
                        mx_message: if options[:generate_message]
                                      ERROR_MX_MESSAGE_I18N_KEY
                                    else
@@ -154,12 +158,13 @@ module ValidatesEmailFormatOf
     domain.reverse!
 
     if opts.has_key?(:with) # holdover from versions <= 1.4.7
+      deprecation_warn(":with option is deprecated and will be removed in the next version")
       return [opts[:message]] unless email&.match?(opts[:with])
     else
-      return [opts[:message]] unless validate_local_part_syntax(local) && validate_domain_part_syntax(domain)
+      return [opts[:message]] unless validate_local_part_syntax(local) && validate_domain_part_syntax(domain, idn: opts[:idn])
     end
 
-    if opts[:check_mx] && !validate_email_domain(email, check_mx_timeout: opts[:check_mx_timeout])
+    if opts[:check_mx] && !validate_email_domain(email, check_mx_timeout: opts[:check_mx_timeout], idn: opts[:idn])
       return [opts[:mx_message]]
     end
 
@@ -171,6 +176,19 @@ module ValidatesEmailFormatOf
     in_quoted_string = false
     comment_depth = 0
 
+    # The local part is made up of dot-atom and quoted-string joined together by "." characters
+    #
+    # https://www.rfc-editor.org/rfc/rfc5322#section-3.4.1
+    # > local-part      =   dot-atom / quoted-string / obs-local-part
+    #
+    # https://www.rfc-editor.org/rfc/rfc5322#section-3.2.3
+    # Both atom and dot-atom are interpreted as a single unit, comprising
+    # > the string of characters that make it up.  Semantically, the optional
+    # > comments and FWS surrounding the rest of the characters are not part
+    # > of the atom; the atom is only the run of atext characters in an atom,
+    # > or the atext and "." characters in a dot-atom.
+    joining_atoms = true
+
     (0..local.length - 1).each do |i|
       ord = local[i].ord
 
@@ -180,6 +198,32 @@ module ValidatesEmailFormatOf
         next
       end
 
+      # double quote delimits quoted strings
+      if ord == 34
+        if in_quoted_string # leaving the quoted string
+          in_quoted_string = false
+          next
+        elsif joining_atoms # are we allowed to enter a quoted string?
+          in_quoted_string = true
+          joining_atoms = false
+          next
+        else
+          return false
+        end
+      end
+
+      # period indicates we want to join atoms, e.g. `aaa.bbb."ccc"@example.com
+      if ord == 46
+        return false if i.zero?
+        return false if joining_atoms
+        joining_atoms = true
+        next
+      end
+
+      joining_atoms = false
+
+      # quoted string logic must come before comment processing since a quoted string
+      # may contain parens, e.g. `"name(a)"@example.com`
       if in_quoted_string
         next if QTEXT.match?(local[i])
       end
@@ -198,41 +242,35 @@ module ValidatesEmailFormatOf
       end
 
       # backslash signifies the start of a quoted pair
-      if ord == 92 && i < local.length - 1
-        return false if !in_quoted_string # must be in quoted string per http://www.rfc-editor.org/errata_search.php?rfc=3696
+      if ord == 92
+        # https://www.rfc-editor.org/rfc/rfc5322#section-3.2.1
+        # > The only places in this specification where quoted-pair currently appears are
+        # > ccontent, qcontent, and in obs-dtext in section 4.
+        return false unless in_quoted_string || comment_depth > 0
         in_quoted_pair = true
         next
       end
 
-      # double quote delimits quoted strings
-      if ord == 34
-        in_quoted_string = !in_quoted_string
-        next
-      end
-
       if comment_depth > 0
         next if CTEXT.match?(local[i])
       elsif ATEXT.match?(local[i, 1])
         next
       end
 
-      # period must be followed by something
-      if ord == 46
-        return false if i == 0 || i == local.length - 1 # can't be first or last char
-        next unless local[i + 1].ord == 46 # can't be followed by a period
-      end
-
       return false
     end
 
+    return false if in_quoted_pair # unbalanced quoted pair
     return false if in_quoted_string # unbalanced quotes
     return false unless comment_depth.zero? # unbalanced comment parens
+    return false if joining_atoms # the last char we encountered was a period
 
     true
   end
 
-  def self.validate_domain_part_syntax(domain)
+  def self.validate_domain_part_syntax(domain, idn: true)
     parts = domain.downcase.split(".", -1)
+    parts.map! { |part| SimpleIDN.to_ascii(part) } if idn
 
     return false if parts.length <= 1 # Only one domain part
 
@@ -256,6 +294,14 @@ module ValidatesEmailFormatOf
     return false unless DOMAIN_PART_TLD.match?(parts[-1])
     true
   end
+
+  def self.deprecation_warn(msg)
+    if defined?(ActiveSupport::Deprecation)
+      ActiveSupport::Deprecation.warn(msg)
+    else
+      warn(msg)
+    end
+  end
 end
 
 require "validates_email_format_of/active_model" if defined?(::ActiveModel) && !(ActiveModel::VERSION::MAJOR < 2 || (ActiveModel::VERSION::MAJOR == 2 && ActiveModel::VERSION::MINOR < 1))

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 require "active_model"
 require "active_support"
-require "pry"
-require "byebug"
 
 RSpec::Matchers.define :have_errors_on_email do
-  match do |actual|
+  match do |user|
+    actual = user.errors.full_messages
+    expect(user.errors.added?(:email, ValidatesEmailFormatOf::ERROR_MESSAGE_I18N_KEY))
     expect(actual).not_to be_nil, "#{actual} should not be nil"
     expect(actual).not_to be_empty, "#{actual} should not be empty"
     expect(actual.size).to eq(@reasons.size), "#{actual} should have #{@reasons.size} elements"
@@ -19,7 +19,7 @@ RSpec::Matchers.define :have_errors_on_email do
   chain :and_because do |reason|
     (@reasons ||= []) << reason
   end
-  match_when_negated do |actual|
-    expect(actual).to(be_empty)
+  match_when_negated do |user|
+    expect(user.errors).to(be_empty)
   end
 end

data/spec/validates_email_format_of_spec.rb

@@ -22,7 +22,7 @@ describe ValidatesEmailFormatOf do
         ActiveModel::Name.new(self, nil, "User")
       end
     end
-    user.new(example.example_group_instance.email).tap(&:valid?).errors.full_messages
+    user.new(example.example_group_instance.email).tap(&:valid?)
   end
   let(:options) { {} }
   let(:email) { |example| example.example_group.description }
@@ -58,13 +58,24 @@ describe ValidatesEmailFormatOf do
       "_somename@example.com",
       # apostrophes
       "test'test@example.com",
-      # international domain names
+      # punycode domain names
       "test@xn--bcher-kva.ch",
       "test@example.xn--0zwm56d",
+
+      # IDN domains,
+      "test@exämple.com",
+      "test@пример.рф",
+      "test@почта.бел",
+
       "test@192.192.192.1",
       # Allow quoted characters.  Valid according to http://www.rfc-editor.org/errata_search.php?rfc=3696
       '"Abc\@def"@example.com',
+      "\"quote\".dotatom.\"otherquote\"@example.com",
       '"Quote(Only".Chars@wier.de',
+      "\"much.more unusual\"@example.com",
+      "\"very.unusual.@.unusual.com\"@example.com",
+      '"very.(),:;<>[]\".VERY.\"very@\\ \"very\".unusual"@strange.example.com',
+      '"()<>[]:,;@\"!#$%&*+-/=?^_`{}| ~  ? ^_`{}|~.a"@example.org',
       '"Fred\ Bloggs"@example.com',
       '"Joe.\\Blow"@example.com',
       # Balanced quoted characters
@@ -98,6 +109,7 @@ describe ValidatesEmailFormatOf do
       "invalid@example.com-",
       "invalid-example.com",
       "invalid@example.b#r.com",
+      "just\"not\"right@example.com",
       "invalid@example.c",
       "invali d@example.com",
       # TLD can not be only numeric
@@ -128,10 +140,11 @@ describe ValidatesEmailFormatOf do
       "\nnewline@example.com",
       " spacesbefore@example.com",
       "spacesafter@example.com ",
-      "(unbalancedcomment@example.com"
+      "(unbalancedcomment@example.com",
+      "help@.example.co.uk" # TLD can not start with a period
     ].each do |address|
       describe address do
-        it { should have_errors_on_email.because("does not appear to be a valid e-mail address") }
+        it { should have_errors_on_email.because("does not appear to be a valid email address") }
       end
     end
 
@@ -141,7 +154,7 @@ describe ValidatesEmailFormatOf do
           it { should_not have_errors_on_email }
         end
         describe "#{"a" * (limit + 1)}@example.com" do
-          it { should have_errors_on_email.because("does not appear to be a valid e-mail address") }
+          it { should have_errors_on_email.because("does not appear to be a valid email address") }
         end
       end
       describe "when using default" do
@@ -158,7 +171,7 @@ describe ValidatesEmailFormatOf do
           it { should_not have_errors_on_email }
         end
         describe "user@#{"a." * (limit / 2 + 1)}com" do
-          it { should have_errors_on_email.because("does not appear to be a valid e-mail address") }
+          it { should have_errors_on_email.because("does not appear to be a valid email address") }
         end
       end
       describe "when using default" do
@@ -179,6 +192,27 @@ describe ValidatesEmailFormatOf do
       end
     end
 
+    describe "when idn support is disabled" do
+      before(:each) do
+        allow(SimpleIDN).to receive(:to_ascii).never
+      end
+      let(:options) { {idn: false} }
+      describe "test@exämple.com" do
+        it { should have_errors_on_email.because("does not appear to be a valid email address") }
+      end
+    end
+
+    describe "when idn support is enabled" do
+      before(:each) do
+        expect(SimpleIDN).to receive(:to_ascii).with("exämple").and_return("xn--exmple-cua")
+        expect(SimpleIDN).to receive(:to_ascii).with("com").and_return("com")
+      end
+      let(:options) { {idn: true} }
+      describe "test@exämple.com" do
+        it { should_not have_errors_on_email }
+      end
+    end
+
     describe "mx record" do
       domain = "example.com"
       email = "valid@#{domain}"
@@ -216,6 +250,9 @@ describe ValidatesEmailFormatOf do
           let(:mx_record) { [] }
           describe email do
             it { should have_errors_on_email.because("is not routable") }
+            it "adds the i18n key" do
+              subject.errors.added?(:email, ValidatesEmailFormatOf::ERROR_MX_MESSAGE_I18N_KEY)
+            end
           end
           describe "with a custom error message" do
             let(:options) { {check_mx: true, mx_message: "There ain't no such domain!"} }
@@ -223,6 +260,7 @@ describe ValidatesEmailFormatOf do
               it { should have_errors_on_email.because("There ain't no such domain!") }
             end
           end
+
           describe "i18n" do
             before(:each) do
               allow(I18n.config).to receive(:locale).and_return(locale)
@@ -236,6 +274,7 @@ describe ValidatesEmailFormatOf do
           end
         end
       end
+
       describe "when not testing" do
         before(:each) { allow(Resolv::DNS).to receive(:open).never }
         describe "by default" do
@@ -258,13 +297,43 @@ describe ValidatesEmailFormatOf do
       end
     end
 
+    describe "mx record for internationalized domain" do
+      domain = "пример.рф"
+      email = "valid@#{domain}"
+
+      describe "when idn support is enabled" do
+        let(:dns) { double(Resolv::DNS) }
+        let(:options) { {check_mx: true, idn: true} }
+
+        before(:each) do
+          allow(Resolv::DNS).to receive(:open).and_yield(dns)
+          allow(dns).to receive(:"timeouts=").with(3).once
+          allow(dns).to receive(:getresources).with(SimpleIDN.to_ascii(domain), Resolv::DNS::Resource::IN::A).once.and_return([double])
+          allow(dns).to receive(:getresources).with(SimpleIDN.to_ascii(domain), Resolv::DNS::Resource::IN::MX).once.and_return([double])
+        end
+
+        describe email do
+          it { should_not have_errors_on_email }
+        end
+      end
+
+      describe "when idn support is disabled" do
+        let(:options) { {check_mx: true, idn: false} }
+
+        describe "test@пример.рф" do
+          let(:domain) { "exämple.com" }
+          it { should have_errors_on_email.because("does not appear to be a valid email address") }
+        end
+      end
+    end
+
     describe "custom regex" do
       let(:options) { {with: /[0-9]+@[0-9]+/} }
       describe "012345@789" do
         it { should_not have_errors_on_email }
       end
       describe "valid@example.com" do
-        it { should have_errors_on_email.because("does not appear to be a valid e-mail address") }
+        it { should have_errors_on_email.because("does not appear to be a valid email address") }
       end
     end
 
@@ -275,7 +344,7 @@ describe ValidatesEmailFormatOf do
       describe "present locale" do
         let(:locale) { :pl }
         describe "invalid@exmaple." do
-          it { should have_errors_on_email.because("nieprawidłowy adres e-mail") }
+          it { should have_errors_on_email.because("nieprawidłowy adres email") }
         end
       end
     end
@@ -320,7 +389,7 @@ describe ValidatesEmailFormatOf do
           ActiveModel::Name.new(self, nil, "User")
         end
       end
-      user.new(example.example_group_instance.email).tap(&:valid?).errors.full_messages
+      user.new(example.example_group_instance.email).tap(&:valid?)
     end
 
     it_should_behave_like :all_specs

data/validates_email_format_of.gemspec

@@ -4,7 +4,7 @@ require "validates_email_format_of/version"
 Gem::Specification.new do |s|
   s.name = "validates_email_format_of"
   s.version = ValidatesEmailFormatOf::VERSION
-  s.summary = "Validate e-mail addresses against RFC 2822 and RFC 3696."
+  s.summary = "Validate email addresses against RFC 2822 and RFC 3696."
   s.description = s.summary
   s.authors = ["Alex Dunae", "Isaac Betesh"]
   s.email = ["code@dunae.ca", "iybetesh@gmail.com"]
@@ -16,13 +16,13 @@ Gem::Specification.new do |s|
   if RUBY_VERSION < "1.9.3"
     s.add_dependency "i18n", "< 0.7.0"
   else
-    s.add_dependency "i18n"
+    s.add_dependency "i18n", ">= 0.8.0"
   end
 
+  s.add_dependency "simpleidn"
   s.add_development_dependency "activemodel"
   s.add_development_dependency "bundler"
   s.add_development_dependency "rspec"
   s.add_development_dependency "standard"
   s.add_development_dependency "appraisal"
-  s.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validates_email_format_of
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.2
 platform: ruby
 authors:
 - Alex Dunae
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -17,22 +17,22 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: simpleidn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Validate e-mail addresses against RFC 2822 and RFC 3696.
+description: Validate email addresses against RFC 2822 and RFC 3696.
 email:
 - code@dunae.ca
 - iybetesh@gmail.com
@@ -117,6 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
@@ -124,15 +125,17 @@ files:
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - config/locales/de.yml
 - config/locales/en.yml
 - config/locales/fr.yml
+- config/locales/id.yml
 - config/locales/it.yml
 - config/locales/ja.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/pt.yml
+- config/locales/tr.yml
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
@@ -140,6 +143,7 @@ files:
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
 - lib/validates_email_format_of.rb
 - lib/validates_email_format_of/active_model.rb
 - lib/validates_email_format_of/railtie.rb
@@ -169,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Validate e-mail addresses against RFC 2822 and RFC 3696.
+summary: Validate email addresses against RFC 2822 and RFC 3696.
 test_files: []

data/README.rdoc

@@ -1,100 +0,0 @@
-= validates_email_format_of Gem and Rails Plugin
-
-Validate e-mail addresses against RFC 2822 and RFC 3696.
-
-== Installation
-
-Installing as a gem:
-
-  gem install validates_email_format_of
-
-Or in your Gemfile:
-
-  gem 'validates_email_format_of'
-
-== Usage
-
-  # Rails
-  # I18n locales are loaded automatically.
-  class Person < ActiveRecord::Base
-    validates_email_format_of :email, :message => 'is not looking good'
-    # OR
-    validates :email, :email_format => { :message => 'is not looking good' }
-  end
-
-  # Now you can test your model using RSpec:
-  require "validates_email_format_of/rspec_matcher"
-  describe Person do
-    it { should validate_email_format_of(:email).with_message('is not looking good') }
-  end
-
-  # If you're not using Rails (which really means, if you're not using ActiveModel::Validations)
-  ValidatesEmailFormatOf::load_i18n_locales # Optional, if you want error messages to be in your language
-  I18n.locale = :pl # If, for example, you want Polish error messages.
-  ValidatesEmailFormatOf::validate_email_format("example@mydomain.com") # => nil
-  ValidatesEmailFormatOf::validate_email_format("invalid_because_there_is_no_at_symbol") # => ["does not appear to be a valid e-mail address"]
-
-=== Options
-
-  :message
-     String. A custom error message when the email format is invalid (default is: "does not appear to be a valid e-mail address")
-  :check_mx
-     Boolean. Check domain for a valid MX record (default is false)
-  :check_mx_timeout
-     Integer. Timeout in seconds for checking MX records before a `ResolvTimeout` is raised (default is 3).
-  :mx_message
-     String. A custom error message when the domain does not match a valid MX record (default is: "is not routable").  Ignored unless :check_mx option is true.
-  :local_length
-    Maximum number of characters allowed in the local part (everything before the '@') (default is 64)
-  :domain_length
-    Maximum number of characters allowed in the domain part (everything after the '@') (default is 255)
-  :generate_message
-    Boolean. Return the I18n key of the error message instead of the error message itself (default is false)
-  :with
-    Specify a custom Regex as the valid email format.
-  :on, :if, :unless, :allow_nil, :allow_blank, :strict
-     Standard ActiveModel validation options.  These work in the ActiveModel/ActiveRecord/Rails syntax only.
-     See http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates for details.
-
-== Testing
-
-To execute the unit tests against [all the Rails versions we support run](gemfiles/) <tt>bundle exec appraisal rspec</tt> or run against an individual version with <tt>bundle exec appraisal rails-6.0 rspec</tt>.
-
-Tested in Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1.2, JRuby and REE 1.8.7.
-
-== Contributing
-
-If you think we're letting some rules about valid email formats slip through the cracks, don't just update the Regex.
-Instead, add a failing test, and demonstrate that the described email address should be treated differently.  A link to an appropriate RFC is the best way to do this.
-Then change the gem code to make the test pass.
-
-  describe "i_think_this_is_not_a_v@lid_email_addre.ss" do
-    # According to http://..., this email address IS NOT valid.
-    it { should have_errors_on_email.because("does not appear to be valid") }
-  end
-  describe "i_think_this_is_a_v@lid_email_addre.ss" do
-    # According to http://..., this email address IS valid.
-    it { should_not have_errors_on_email }
-  end
-
-Yes, our Rspec syntax is that simple!
-
-== Homepage
-
-* https://github.com/validates-email-format-of/validates_email_format_of
-
-== Credits
-
-Written by Alex Dunae (dunae.ca), 2006-22.
-
-Many thanks to the plugin's recent contributors: https://github.com/alexdunae/validates_email_format_of/contributors
-
-Thanks to Francis Hwang (http://fhwang.net/) at Diversion Media for creating the 1.1 update.
-
-Thanks to Travis Sinnott for creating the 1.3 update.
-
-Thanks to Denis Ahearn at Riverock Technologies (http://www.riverocktech.com/) for creating the 1.4 update.
-
-Thanks to George Anderson (http://github.com/george) and 'history' (http://github.com/history) for creating the 1.4.1 update.
-
-Thanks to Isaac Betesh (https://github.com/betesh) for converting tests to Rspec and refactoring for version 1.6.0.