Merge pull request #79 from fredngo/master

Namespace EmailValidator under the ValidEmail2 namespace.

.travis.yml

@@ -3,11 +3,11 @@ language: ruby
 sudo: false
 
 rvm:
+  - 2.4
   - 2.3
   - 2.2
-  - 2.1
-  - 2.0
 
 gemfile:
   - gemfiles/activemodel3.gemfile
   - gemfiles/activemodel4.gemfile
+  - gemfiles/activemodel5.gemfile

README.md

@@ -39,28 +39,28 @@ Or install it yourself as:
 If you just want to validate that it is a valid email address:
 ```ruby
 class User < ActiveRecord::Base
-  validates :email, presence: true, email: true
+  validates :email, presence: true, 'valid_email_2/email': true
 end
 ```
 
 To validate that the domain has a MX record:
 ```ruby
-validates :email, email: { mx: true }
+validates :email, 'valid_email_2/email': { mx: true }
 ```
 
 To validate that the domain is not a disposable email:
 ```ruby
-validates :email, email: { disposable: true }
+validates :email, 'valid_email_2/email': { disposable: true }
 ```
 
 To validate that the domain is not blacklisted (under vendor/blacklist.yml):
 ```ruby
-validates :email, email: { blacklist: true }
+validates :email, 'valid_email_2/email': { blacklist: true }
 ```
 
 All together:
 ```ruby
-validates :email, email: { mx: true, disposable: true }
+validates :email, 'valid_email_2/email': { mx: true, disposable: true }
 ```
 
 > Note that this gem will let an empty email pass through so you will need to

gemfiles/activemodel3.gemfile

@@ -1,5 +1,5 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activemodel", "~> 3.2.13"
+gem 'activemodel', '~> 3.2.22'
 
-gemspec path: "../"
+gemspec path: '../'

gemfiles/activemodel4.gemfile

@@ -1,5 +1,5 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activemodel", "~> 4.2.0"
+gem 'activemodel', '~> 4.2.9'
 
-gemspec path: "../"
+gemspec path: '../'

gemfiles/activemodel5.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 5.1.2'
+
+gemspec path: '../'

lib/email_validator.rb

@@ -0,0 +1,4 @@
+# This is a shim for keeping backwards compatibility.
+# See the discussion in: https://github.com/lisinge/valid_email2/pull/79
+class EmailValidator < ValidEmail2::EmailValidator
+end

lib/valid_email2.rb

@@ -1,4 +1,5 @@
 require "valid_email2/email_validator"
+require "email_validator" # Backwards-compatibility shim
 
 module ValidEmail2
   def self.disposable_emails

lib/valid_email2/email_validator.rb

@@ -2,33 +2,35 @@
 require "active_model"
 require "active_model/validations"
 
-class EmailValidator < ActiveModel::EachValidator
-  def default_options
-    { regex: true, disposable: false, mx: false }
-  end
+module ValidEmail2
+  class EmailValidator < ActiveModel::EachValidator
+    def default_options
+      { regex: true, disposable: false, mx: false }
+    end
 
-  def validate_each(record, attribute, value)
-    return unless value.present?
-    options = default_options.merge(self.options)
+    def validate_each(record, attribute, value)
+      return unless value.present?
+      options = default_options.merge(self.options)
 
-    address = ValidEmail2::Address.new(value)
+      address = ValidEmail2::Address.new(value)
 
-    error(record, attribute) && return unless address.valid?
+      error(record, attribute) && return unless address.valid?
 
-    if options[:disposable]
-      error(record, attribute) && return if address.disposable?
-    end
+      if options[:disposable]
+        error(record, attribute) && return if address.disposable?
+      end
 
-    if options[:blacklist]
-      error(record, attribute) && return if address.blacklisted?
-    end
+      if options[:blacklist]
+        error(record, attribute) && return if address.blacklisted?
+      end
 
-    if options[:mx]
-      error(record, attribute) && return unless address.valid_mx?
+      if options[:mx]
+        error(record, attribute) && return unless address.valid_mx?
+      end
     end
-  end
 
-  def error(record, attribute)
-    record.errors.add(attribute, options[:message] || :invalid)
+    def error(record, attribute)
+      record.errors.add(attribute, options[:message] || :invalid)
+    end
   end
 end

spec/valid_email2_spec.rb

@@ -1,19 +1,23 @@
 require "spec_helper"
 
 class TestUser < TestModel
-  validates :email, email: true
+  validates :email, 'valid_email_2/email': true
 end
 
 class TestUserMX < TestModel
-  validates :email, email: { mx: true }
+  validates :email, 'valid_email_2/email': { mx: true }
 end
 
 class TestUserDisallowDisposable < TestModel
-  validates :email, email: { disposable: true }
+  validates :email, 'valid_email_2/email': { disposable: true }
 end
 
 class TestUserDisallowBlacklisted < TestModel
-  validates :email, email: { blacklist: true }
+  validates :email, 'valid_email_2/email': { blacklist: true }
+end
+
+class BackwardsCompatibleUser < TestModel
+  validates :email, email: true
 end
 
 describe ValidEmail2 do
@@ -44,6 +48,11 @@ class TestUserDisallowBlacklisted < TestModel
       user = TestUser.new(email: "[email protected]")
       expect(user.valid?).to be_falsey
     end
+
+    it "still works with the backwards-compatible syntax" do
+      user = BackwardsCompatibleUser.new(email: "[email protected]")
+      expect(user.valid?).to be_truthy
+    end
   end
 
   describe "disposable emails" do