email_format_validator 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Axel Vergult
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+Installation
+------------
+
+Add this line to your Gemfile:
+
+    gem 'email_format_validator'
+    
+Then run:
+
+    bundle install
+    
+Usage
+-----
+
+Add the following to one of your models:
+
+    validates :email, :email_format => true
+    
+You can turn on RFC 822 compliant email verification by passing on:
+
+    validates :email, :email_format => { :rfc => true }
+
+Be aware that this is disabled by default as websites will often need a less permissive email check than the RFC one (check out tests for more details).
+
+You can also modify the default message if validation fails:
+
+    validates :email, :email_format => { :message => "is not formatted properly" }
+
+Tests
+-----
+
+    cd test
+    ruby email_format_validator_test.rb
+    
+Credits
+-------
+
+Regular Expression tests based on [Comparing E-mail Address Validating Regular Expressions](http://fightingforalostcause.net/misc/2006/compare-email-regex.php)

data/email_format_validator.gemspec

@@ -3,12 +3,12 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "email_format_validator"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.authors     = ["Axel Vergult"]
   s.email       = ["axel.vergult@gmail.com"]
   s.homepage    = "https://github.com/episko/email_format_validator"
-  s.summary     = %q{A Rails 3 email format validator following the RFC 822}
-  s.description = %q{A Rails 3 email format validator following the RFC 822}
+  s.summary     = %q{A Rails 3 email format validator with RFC 822 compliant option}
+  s.description = %q{A Rails 3 email format validator with RFC 822 compliant option}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/email_format_validator.rb

@@ -8,20 +8,22 @@ class EmailFormatValidator < ActiveModel::EachValidator
     def self.create_regexp(string)
       Regexp.new string, nil, 'n'
     end
-    ATOM      = create_regexp "[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+"
-    QTEXT     = create_regexp "[^\\x0d\\x22\\x5c\\x80-\\xff]"
-    QPAIR     = create_regexp "\\x5c[\\x00-\\x7f]"
-    QSTRING   = create_regexp "\\x22(?:#{QTEXT}|#{QPAIR})*\\x22"
-    WORD      = create_regexp "(?:#{ATOM}|#{QSTRING})"
-    LOCAL_PT  = create_regexp "#{WORD}(?:\\x2e#{WORD})*"
-    ADDRESS   = create_regexp "#{LOCAL_PT}\\x40#{URI::REGEXP::PATTERN::HOSTNAME}"
+    ATOM                      = create_regexp "[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+"
+    QTEXT                     = create_regexp "[^\\x0d\\x22\\x5c\\x80-\\xff]"
+    QPAIR                     = create_regexp "\\x5c[\\x00-\\x7f]"
+    QSTRING                   = create_regexp "\\x22(?:#{QTEXT}|#{QPAIR})*\\x22"
+    WORD                      = create_regexp "(?:#{ATOM}|#{QSTRING})"
+    LOCAL_PT                  = create_regexp "#{WORD}(?:\\x2e#{WORD})*"
+    ADDRESS                   = create_regexp "#{LOCAL_PT}\\x40#{URI::REGEXP::PATTERN::HOSTNAME}"
 
-    EMAIL    = /\A#{ADDRESS}\z/
+    EMAIL                     = /\A#{ADDRESS}\z/
+    LESS_RFC_COMPLIANT_EMAIL  = /\A[\w\-_\.]+@((?:[\w\-\.]+\.)+[a-z]{2,})\Z/i
   end
 
   def validate_each(record, attribute, value)
-    unless value =~ Patterns::EMAIL
-      record.errors[attribute] << (options[:message] || "is not formatted properly")
+    pattern_choosed = options[:rfc] ? Patterns::EMAIL : Patterns::LESS_RFC_COMPLIANT_EMAIL
+    unless value =~ pattern_choosed
+      record.errors.add(attribute, options[:message] || :invalid)
     end
   end
 

data/test/email_format_validator_test.rb

@@ -6,20 +6,24 @@ class TestUser < TestModel
   validates :email, :email_format => true
 end
 
+class TestUserWithRfcCompliantEmail < TestModel
+  validates :email, :email_format => { :rfc => true }
+end
+
 class TestUserAllowsNilToTrue < TestModel
-  validates :email, :email_format => {:allow_nil => true}
+  validates :email, :email_format => { :allow_nil => true }
 end
 
 class TestUserAllowsNilToFalse < TestModel
-  validates :email, :email_format => {:allow_nil => false}
+  validates :email, :email_format => { :allow_nil => false }
 end
 
 class TestUserWithMessage < TestModel
-  validates :email, :email_format => {:message => 'is not a good looking email'}
+  validates :email, :email_format => { :message => 'is not formatted properly' }
 end
 
 class TestEmailFormatValidator < MiniTest::Unit::TestCase
-  def valid_emails
+  def rfc_valid_emails
     [
       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ@letters-in-local.org',
       '01234567890@numbers-in-local.net',
@@ -46,12 +50,18 @@ class TestEmailFormatValidator < MiniTest::Unit::TestCase
       'the-total-length@of-an-entire-address-cannot-be-longer-than-two-hundred-and-fifty-four-characters' +
         '-and-this-address-is-254-characters-exactly-so-it-should-be-valid-and-im-going-to-add-some-more' +
         '-words-here-to-increase-the-lenght-blah-blah-blah-blah-bla.org',
+      # 'bracketed-IP-instead-of-domain@[127.0.0.1]',
       'local@sub.domains.com'
     ]
   end
 
-  def invalid_emails
+  def rfc_invalid_emails
     [
+      '',
+      # 'foo@bar',
+      # 'foo@bar.c',
+      'foo@bar.com@bar.com',
+      'foo@',
       '@missing-local.org',
       '! #$%`|@invalid-characters-in-local.org',
       '(),:;`|@more-invalid-characters-in-local.org',
@@ -59,10 +69,82 @@ class TestEmailFormatValidator < MiniTest::Unit::TestCase
       '.local-starts-with-dot@sld.com',
       'local-ends-with-dot.@sld.com',
       'two..consecutive-dots@sld.com',
+      # 'partially."quoted"@sld.com',
+      # 'the-local-part-is-invalid-if-it-is-longer-than-sixty-four-characters@sld.net',
       'missing-sld@.com',
       'sld-starts-with-dashsh@-sld.com',
       'sld-ends-with-dash@sld-.com',
       'invalid-characters-in-sld@! "#$%(),/;<>_[]`|.org',
+      # 'missing-dot-before-tld@com',
+      # 'missing-tld@sld.',
+      # 'the-total-length@of-an-entire-address-cannot-be-longer-than-two-hundred-and-fifty-four-characters-and' +
+      #   '-this-address-is-255-characters-exactly-so-it-should-be-invalid-and-im-going-to-add-some-more-words' +
+      #   '-here-to-increase-the-lenght-blah-blah-blah-blah-bl.org',
+      'missing-at-sign.net',
+      'unbracketed-IP@127.0.0.1',
+      'invalid-ip@127.0.0.1.26',
+      'another-invalid-ip@127.0.0.256',
+      'IP-and-port@127.0.0.1:25'
+    ]
+  end
+
+  def valid_emails
+    [
+      'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ@letters-in-local.org',
+      '01234567890@numbers-in-local.net',
+      # '&\'*+-./=?^_{}~@other-valid-characters-in-local.net',
+      # 'mixed-1234-in-{+^}-local@sld.net',
+      'a@single-character-in-local.org',
+      # '"quoted"@sld.com',
+      # '"\e\s\c\a\p\e\d"@sld.com',
+      # '"quoted-at-sign@sld.org"@sld.com',
+      # '"escaped\"quote"@sld.com',
+      # '"back\slash"@sld.com',
+      'one-character-third-level@a.example.com',
+      'single-character-in-sld@x.org',
+      'local@dash-in-sld.com',
+      'letters-in-sld@123.com',
+      'one-letter-sld@x.org',
+      'uncommon-tld@sld.museum',
+      'uncommon-tld@sld.travel',
+      'uncommon-tld@sld.mobi',
+      'country-code-tld@sld.uk',
+      'country-code-tld@sld.rw',
+      'local@sld.newTLD',
+      # 'punycode-numbers-in-tld@sld.xn--3e0b707e',
+      'the-total-length@of-an-entire-address-cannot-be-longer-than-two-hundred-and-fifty-four-characters' +
+        '-and-this-address-is-254-characters-exactly-so-it-should-be-valid-and-im-going-to-add-some-more' +
+        '-words-here-to-increase-the-lenght-blah-blah-blah-blah-bla.org',
+      # 'bracketed-IP-instead-of-domain@[127.0.0.1]',
+      'local@sub.domains.com'
+    ]
+  end
+
+  def invalid_emails
+    [
+      '',
+      'foo@bar',
+      'foo@bar.c',
+      'foo@bar.com@bar.com',
+      'foo@',
+      '@missing-local.org',
+      '! #$%`|@invalid-characters-in-local.org',
+      '(),:;`|@more-invalid-characters-in-local.org',
+      '<>@[]\`|@even-more-invalid-characters-in-local.org',
+      # '.local-starts-with-dot@sld.com',
+      # 'local-ends-with-dot.@sld.com',
+      # 'two..consecutive-dots@sld.com',
+      'partially."quoted"@sld.com',
+      # 'the-local-part-is-invalid-if-it-is-longer-than-sixty-four-characters@sld.net',
+      'missing-sld@.com',
+      # 'sld-starts-with-dashsh@-sld.com',
+      # 'sld-ends-with-dash@sld-.com',
+      'invalid-characters-in-sld@! "#$%(),/;<>_[]`|.org',
+      'missing-dot-before-tld@com',
+      'missing-tld@sld.',
+      # 'the-total-length@of-an-entire-address-cannot-be-longer-than-two-hundred-and-fifty-four-characters-and' +
+      #   '-this-address-is-255-characters-exactly-so-it-should-be-invalid-and-im-going-to-add-some-more-words' +
+      #   '-here-to-increase-the-lenght-blah-blah-blah-blah-bl.org',
       'missing-at-sign.net',
       'unbracketed-IP@127.0.0.1',
       'invalid-ip@127.0.0.1.26',
@@ -79,16 +161,24 @@ class TestEmailFormatValidator < MiniTest::Unit::TestCase
     invalid_emails.each { |email| refute TestUser.new(:email => email).valid? }
   end
 
+  def test_valid_emails_with_rfc_compliant
+    rfc_valid_emails.each { |email| assert TestUserWithRfcCompliantEmail.new(:email => email).valid? }
+  end
+
+  def test_invalid_emails_with_rfc_compliant
+    rfc_invalid_emails.each { |email| refute TestUserWithRfcCompliantEmail.new(:email => email).valid? }
+  end
+
   def test_default_message_on_error
     test_user = TestUser.new(:email => "invalid_email@")
     refute test_user.valid?
-    assert test_user.errors[:email].include?("is not formatted properly")
+    assert test_user.errors[:email].include?("is invalid")
   end
 
   def test_custom_message_on_error
     test_user = TestUserWithMessage.new(:email => "invalid_email@")
     refute test_user.valid?
-    assert test_user.errors[:email].include?("is not a good looking email")
+    assert test_user.errors[:email].include?("is not formatted properly")
   end
 
   def test_nil_email_when_allow_nil_option_is_not_set

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_format_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-09 00:00:00.000000000Z
+date: 2011-11-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70110136755020 !ruby/object:Gem::Requirement
+  requirement: &70169645444580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +21,8 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70110136755020
-description: A Rails 3 email format validator following the RFC 822
+  version_requirements: *70169645444580
+description: A Rails 3 email format validator with RFC 822 compliant option
 email:
 - axel.vergult@gmail.com
 executables: []
@@ -31,6 +31,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - email_format_validator.gemspec
 - lib/email_format_validator.rb
@@ -59,7 +61,7 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A Rails 3 email format validator following the RFC 822
+summary: A Rails 3 email format validator with RFC 822 compliant option
 test_files:
 - test/email_format_validator_test.rb
 - test/test_helper.rb