email_format_validator 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in email_format_validator.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/email_format_validator.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "email_format_validator"
+  s.version     = "0.0.1"
+  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency("activemodel", ">= 0")
+end

data/lib/email_format_validator.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require "uri"
+
+class EmailFormatValidator < ActiveModel::EachValidator
+
+  module Patterns
+    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}"
+
+    EMAIL    = /\A#{ADDRESS}\z/
+  end
+
+  def validate_each(record, attribute, value)
+    unless value =~ Patterns::EMAIL
+      record.errors[attribute] << (options[:message] || "is not formatted properly")
+    end
+  end
+
+end

data/test/email_format_validator_test.rb

@@ -0,0 +1,106 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'test_helper'
+
+class TestUser < TestModel
+  validates :email, :email_format => true
+end
+
+class TestUserAllowsNilToTrue < TestModel
+  validates :email, :email_format => {:allow_nil => true}
+end
+
+class TestUserAllowsNilToFalse < TestModel
+  validates :email, :email_format => {:allow_nil => false}
+end
+
+class TestUserWithMessage < TestModel
+  validates :email, :email_format => {:message => 'is not a good looking email'}
+end
+
+class TestEmailFormatValidator < MiniTest::Unit::TestCase
+  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',
+      'local@sub.domains.com'
+    ]
+  end
+
+  def invalid_emails
+    [
+      '@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',
+      'missing-sld@.com',
+      'sld-starts-with-dashsh@-sld.com',
+      'sld-ends-with-dash@sld-.com',
+      'invalid-characters-in-sld@! "#$%(),/;<>_[]`|.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 test_valid_emails
+    valid_emails.each { |email| assert TestUser.new(:email => email).valid? }
+  end
+
+  def test_invalid_emails
+    invalid_emails.each { |email| refute TestUser.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")
+  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")
+  end
+
+  def test_nil_email_when_allow_nil_option_is_not_set
+    refute TestUser.new(:email => nil).valid?
+  end
+
+  def test_nil_email_when_allow_nil_option_is_set_to_true
+    assert TestUserAllowsNilToTrue.new(:email => nil).valid?
+  end
+
+  def test_nil_email_when_allow_nil_option_is_set_to_false
+    refute TestUserAllowsNilToFalse.new(:email => nil).valid?
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'active_model'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'email_format_validator'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: email_format_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Axel Vergult
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70110136755020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70110136755020
+description: A Rails 3 email format validator following the RFC 822
+email:
+- axel.vergult@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- email_format_validator.gemspec
+- lib/email_format_validator.rb
+- test/email_format_validator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/episko/email_format_validator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Rails 3 email format validator following the RFC 822
+test_files:
+- test/email_format_validator_test.rb
+- test/test_helper.rb