valid_email2 1.2.22 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1222657072ab10f3b061ed7b4b64ed98a35007c1
-  data.tar.gz: 7d05b8a724f018fdb5eafaa0adf6f1d6712c6c9e
+  metadata.gz: ea9b203a1d3faf3c116e75dfa87249eef2771056
+  data.tar.gz: e8dd47bc33c9f5d1a7e8e9fa65ceee9f28b53cb5
 SHA512:
-  metadata.gz: ec7d44d7a85cdd3d0bc72534072b017119291bf0fd992be7b92e9a1feeb3dc4d98d00659c2ff7de1bbd1354df7afc8049a91db88460a3c3df82f655087c740a6
-  data.tar.gz: c57522e6e8a3573e7f960a983e0cf31b3460c0ebfb80678faac00b9c6872ab8ddb295685868a530ab8307fdc63c8384187ea3cf1299c6b073d71558fcbbef928
+  metadata.gz: 0ef8ca38e7b4727ab80125cfc5ce2cdf13b2f4de6660ec3c88fcd6bde42fcb2be6ff8545f7fa4cd74e15041c36fcd69ab84f754c03a6e20b63bb4de1c631bf4a
+  data.tar.gz: 044148fdb6e8095d70f2de16e197d21715a975d7142f3c33bba5dc83a1e9d1be93346eb6ed2a40db4e5c871efed0a5d9b6fa8b34d2256f133664dfbc16e59515

data/.travis.yml

@@ -3,11 +3,11 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.3.0
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
+  - 2.4
+  - 2.3
+  - 2.2
 
 gemfile:
   - gemfiles/activemodel3.gemfile
   - gemfiles/activemodel4.gemfile
+  - gemfiles/activemodel5.gemfile

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 2.0.0
+Add validator namespaced under `ValidEmail2` https://github.com/lisinge/valid_email2/pull/79
+Deprecate global `EmailValidator` in favor of the namespaced one.
+
 ## Version 1.2.22
 Added more disposable email domains (https://github.com/lisinge/valid_email2/pull/80)
 

data/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
@@ -89,10 +89,30 @@ end
 ## Requirements
 
 This gem requires Rails 3.2 or 4.0 or higher. It is tested against both versions using:
-* Ruby-2.0
-* Ruby-2.1
 * Ruby-2.2
 * Ruby-2.3
+* Ruby-2.4
+
+## Upgrading to v2.0.0
+
+In version 1.0 of valid_email2 we only defined the `email` validator.  
+But since other gems also define a `email` validator this can cause some unintended
+behaviours and emails that shouldn't be valid are regarded valid because the
+wrong validator is used by rails.
+
+So in version 2.0 we decided to deprecate using the `email` validator directly
+and instead define a `valid_email_2/email` validator to be sure that the correct
+validator gets used.
+
+So this:
+```ruby
+validates :email, email: { mx: true, disposable: true }
+```
+
+Becomes this:
+```ruby
+validates :email, 'valid_email_2/email': { mx: true, disposable: true }
+```
 
 ## Contributing
 

data/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: '../'

data/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: '../'

data/gemfiles/activemodel5.gemfile

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

data/lib/email_validator.rb

@@ -0,0 +1,10 @@
+# This is a shim for keeping backwards compatibility.
+# See the discussion in: https://github.com/lisinge/valid_email2/pull/79
+class EmailValidator < ValidEmail2::EmailValidator
+  def validate_each(record, attribute, value)
+    warn "DEPRECATION WARNING: The email validator from valid_email2 has been " +
+         "deprecated in favour of using the namespaced 'valid_email_2/email' validator. " +
+         "For more information see https://github.com/lisinge/valid_email2#upgrading-to-v200"
+    super
+  end
+end

data/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

data/lib/valid_email2/email_validator.rb

@@ -2,33 +2,35 @@ require "valid_email2/address"
 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

data/lib/valid_email2/version.rb

@@ -1,3 +1,3 @@
 module ValidEmail2
-  VERSION = "1.2.22"
+  VERSION = "2.0.0"
 end

data/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,14 @@ describe ValidEmail2 do
       user = TestUser.new(email: "foo@bar..com")
       expect(user.valid?).to be_falsey
     end
+
+    it "still works with the backwards-compatible syntax" do
+      user = BackwardsCompatibleUser.new(email: "foo@bar.com")
+      expect(user.valid?).to be_truthy
+
+      user = BackwardsCompatibleUser.new(email: "foo@bar")
+      expect(user.valid?).to be_falsey
+    end
   end
 
   describe "disposable emails" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 1.2.22
+  version: 2.0.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,8 @@ files:
 - Rakefile
 - gemfiles/activemodel3.gemfile
 - gemfiles/activemodel4.gemfile
+- gemfiles/activemodel5.gemfile
+- lib/email_validator.rb
 - lib/valid_email2.rb
 - lib/valid_email2/address.rb
 - lib/valid_email2/email_validator.rb