email_validator 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a61b5f5394d7e3995cb72b8020ed8877539658f
-  data.tar.gz: e1781250b91b5b62faf766b6120c0e91ae2cbd0e
+SHA256:
+  metadata.gz: da5f6cc330adef4786045236ce8a34a49ad638a5b42c7447e7585711e0dccca4
+  data.tar.gz: 04eff8f220eaafdb748f8ba0bc1f8890f450b0620731b5c3a10c9125954b6e7b
 SHA512:
-  metadata.gz: 7c0d25c20be026d62ef9bda3a775efe42e21f87be95323f3fbd5be16df2ed761d31066c0d54a3578ef1b7f22562e09df80152de910dd6a6517de936efce70279
-  data.tar.gz: 2c6bd876e48aa9f27ac6d2ce53942961b52207cfe508d80dad93cd9df2ed0b0d1bc346ca3fc1ff8c218463b499b7d2fa5630af5374c3df013aec9cce183d93b7
+  metadata.gz: 9b39cbd7c9d87a3274f6d4b570a7a774ef0a232e5171f561a384e2c287d3242d832e91fb0240437484b5a500da98ee9715a20a5a15247075fbfd4100d596b0b2
+  data.tar.gz: 8907894a088e8a2c53c53eb346331abc561643b2316bd4f5132f8961bc9cb98e08dc3ea4cb930d3a038ad8199922c429047b314e75ff96f034f506936ae1621b

data/.travis.yml

@@ -1,7 +1,16 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.3
+  - 2.1.10
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
   - ruby-head
   - jruby-19mode
-  - rbx-2
+  - jruby-head
+  - rbx-3
+matrix:
+  allow_failures:
+    - rvm: rbx-3

data/Changes.md

@@ -1,5 +1,9 @@
 # HEAD
 
+# 2.0.0
+
+* Looser validation [#49]
+
 # 1.6.0
 
 * Unicode characters support [i7an #24]

data/README.md

@@ -17,47 +17,40 @@ bundle install
 Then add the following to your model:
 
 ```ruby
-validates :my_email_attribute, :email => true
+validates :my_email_attribute, email: true
 ```
 
-## Strict mode
-
-In order to have stricter validation (according to http://www.remote.org/jochen/mail/info/chars.html) enable strict mode. You can do this globally by adding the following to your Gemfile:
-
-```ruby
-gem 'email_validator', :require => 'email_validator/strict'
-```
+## Validation outside a model
 
-Or you can do this in a specific `validates` call:
+If you'd like to validate an email outside of a model then here are some class methods that you can use:
 
 ```ruby
-validates :my_email_attribute, :email => {:strict_mode => true}
+EmailValidator.regexp # returns the regex
+EmailValidator.valid?('narf@example.com') # => true
+EmailValidator.invalid?('narf@example.com') # => false
 ```
 
-## Validation outside a model
-
-If you need to validate an email outside a model, you can get the regexp :
+## Validation philosophy
 
-### Normal mode
+The validation provided by this gem is loose. It just checks that there's an `@` with something before and after it. See [this article by David Gilbertson](https://hackernoon.com/the-100-correct-way-to-validate-email-addresses-7c4818f24643) for an explanation of why.
 
-```ruby
-EmailValidator.regexp # returns the regex
-EmailValidator.valid?('narf@example.com') # boolean
-```
+## Trimming whitespace
 
-### Strict mode
+Your users may accidentally submit leading or trailing whitespace when submitting a form. You may want to automatically trim this. This is not the job of a validator gem but it's trivial to implement yourself by adding a setter in your model:
 
 ```ruby
-EmailValidator.regexp(:strict_mode => true)
+def email=(e)
+  e = e.strip if e
+  super
+end
 ```
 
-## Thread safety
-
-This gem is thread safe, with one caveat: `EmailValidator.default_options` must be configured before use in a multi-threaded environment. If you configure `default_options` in a Rails initializer file, then you're good to go since initializers are run before worker threads are spawned.
+You may also want to convert emails to lowercase in the same way.
 
-## Credit
+## Alternative gems
 
-Based on http://thelucid.com/2010/01/08/sexy-validation-in-edge-rails-rails-3
+Do you prefer a different email validation gem? If so, open an issue with a brief explanation of how it differs from this gem. I'll add a link to it in this README.
 
-Regular Expression based on http://fightingforalostcause.net/misc/2006/compare-email-regex.php tests.
+## Thread safety
 
+This gem is thread safe.

data/email_validator.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = %q{email_validator}
-  s.version = "1.6.0"
+  s.version = "2.0.0"
   s.authors = ["Brian Alexander"]
-  s.description = %q{An email validator for Rails 3+. See homepage for details: http://github.com/balexand/email_validator}
+  s.description = %q{Email validator for Rails and ActiveModel.}
   s.email = %q{balexand@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.homepage = %q{https://github.com/balexand/email_validator}
   s.require_paths = %w(lib)
-  s.summary = %q{An email validator for Rails 3+.}
+  s.summary = %q{An email validator for Rails and ActiveModel.}
 
   s.add_dependency("activemodel", ">= 0")
 

data/lib/email_validator.rb

@@ -1,28 +1,28 @@
-# encoding: UTF-8
-# Based on work from http://thelucid.com/2010/01/08/sexy-validation-in-edge-rails-rails-3/
-class EmailValidator < ActiveModel::EachValidator
-  @@default_options = {}
+# frozen_string_literal: true
+require 'active_model'
 
+class EmailValidator < ActiveModel::EachValidator
   def self.regexp(options = {})
-    options = default_options.merge(options)
-
-    name_validation = options[:strict_mode] ? "-\\p{L}\\d+._" : "^@\\s"
+    if options[:strict_mode]
+      ActiveSupport::Deprecation.warn(
+        'Strict mode has been deprecated in email_validator 2.0. To fix this warning, '\
+        'remove `strict_mode: true` from your validation call.'
+      )
+    end
 
-    /\A\s*([#{name_validation}]{1,64})@((?:[-\p{L}\d]+\.)+\p{L}{2,})\s*\z/i
+    /[^\s]@[^\s]/
   end
 
-  def self.valid?(value, options = {})
-    !!(value =~ regexp(options))
+  def self.valid?(value, options = nil)
+    !invalid?(value)
   end
 
-  def self.default_options
-    @@default_options
+  def self.invalid?(value, options = nil)
+    !(value =~ regexp)
   end
 
   def validate_each(record, attribute, value)
-    options = @@default_options.merge(self.options)
-
-    unless self.class.valid?(value, self.options)
+    if self.class.invalid?(value)
       record.errors.add(attribute, options[:message] || :invalid)
     end
   end

data/lib/email_validator/strict.rb

@@ -1,5 +1,9 @@
-# require this file to enable :strict_mode by default
+# frozen_string_literal: true
 
-require 'email_validator'
+ActiveSupport::Deprecation.warn(
+  'Strict mode has been deprecated in email_validator 2.0. You are receiving '\
+  'this warning because your project is requiring "email_validator/strict", '\
+  'most likely in your Gemfile.'
+)
 
-EmailValidator::default_options[:strict_mode] = true
+require 'email_validator'

data/spec/email_validator_spec.rb

@@ -5,10 +5,6 @@ class TestUser < TestModel
   validates :email, :email => true
 end
 
-class StrictUser < TestModel
-  validates :email, :email => {:strict_mode => true}
-end
-
 class TestUserAllowsNil < TestModel
   validates :email, :email => {:allow_nil => true}
 end
@@ -49,25 +45,30 @@ describe EmailValidator do
         "nigel.worthington@big.co.uk",
         "f@c.com",
         "areallylongnameaasdfasdfasdfasdf@asdfasdfasdfasdfasdf.ab.cd.ef.gh.co.ca",
-        "ящик@яндекс.рф"
+        "ящик@яндекс.рф",
+        "test@test.testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttes",
+        "hans,peter@example.com",
+        "hans(peter@example.com",
+        "hans)peter@example.com",
+        "partially.\"quoted\"@sld.com",
+        "&'*+-./=?^_{}~@other-valid-characters-in-local.net",
+        "mixed-1234-in-{+^}-local@sld.net",
+        "user@domain.рф",
+        "寿司@example.com"
       ].each do |email|
 
         it "#{email.inspect} should be valid" do
           expect(TestUser.new(:email => email)).to be_valid
         end
 
-        it "#{email.inspect} should be valid in strict_mode" do
-          expect(StrictUser.new(:email => email)).to be_valid
+        it "#{email.inspect} should not be invalid" do
+          expect(TestUser.new(:email => email)).not_to be_invalid
         end
 
         it "#{email.inspect} should match the regexp" do
           expect(email =~ EmailValidator.regexp).to be_truthy
         end
 
-        it "#{email.inspect} should match the strict regexp" do
-          expect(email =~ EmailValidator.regexp(:strict_mode => true)).to be_truthy
-        end
-
         it "#{email.inspect} should pass the class tester" do
           expect(EmailValidator.valid?(email)).to be_truthy
         end
@@ -79,80 +80,32 @@ describe EmailValidator do
     context "given the invalid emails" do
       [
         "",
-        "f@s",
-        "f@s.c",
         "@bar.com",
-        "test@example.com@example.com",
+        " @bar.com",
         "test@",
-        "@missing-local.org",
-        "a b@space-in-local.com",
-        "! \#$%\`|@invalid-characters-in-local.org",
-        "<>@[]\`|@even-more-invalid-characters-in-local.org",
-        "missing-sld@.com",
-        "invalid-characters-in-sld@! \"\#$%(),/;<>_[]\`|.org",
-        "missing-dot-before-tld@com",
-        "missing-tld@sld.",
+        "test@ ",
         " ",
         "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",
-        "the-local-part-is-invalid-if-it-is-longer-than-sixty-four-characters@sld.net",
-        "user@example.com\n<script>alert('hello')</script>"
       ].each do |email|
 
         it "#{email.inspect} should not be valid" do
           expect(TestUser.new(:email => email)).not_to be_valid
         end
 
-        it "#{email.inspect} should not be valid in strict_mode" do
-          expect(StrictUser.new(:email => email)).not_to be_valid
+        it "#{email.inspect} should be invalid" do
+          expect(TestUser.new(:email => email)).to be_invalid
         end
 
         it "#{email.inspect} should not match the regexp" do
           expect(email =~ EmailValidator.regexp).to be_falsy
         end
 
-        it "#{email.inspect} should not match the strict regexp" do
-          expect(email =~ EmailValidator.regexp(:strict_mode => true)).to be_falsy
-        end
-
         it "#{email.inspect} should fail the class tester" do
           expect(EmailValidator.valid?(email)).to be_falsy
         end
 
       end
     end
-
-    context "given the emails that should be invalid in strict_mode but valid in normal mode" do
-      [
-        "hans,peter@example.com",
-        "hans(peter@example.com",
-        "hans)peter@example.com",
-        "partially.\"quoted\"@sld.com",
-        "&'*+-./=?^_{}~@other-valid-characters-in-local.net",
-        "mixed-1234-in-{+^}-local@sld.net"
-      ].each do |email|
-
-        it "#{email.inspect} should be valid" do
-          expect(TestUser.new(:email => email)).to be_valid
-        end
-
-        it "#{email.inspect} should not be valid in strict_mode" do
-          expect(StrictUser.new(:email => email)).not_to be_valid
-        end
-
-        it "#{email.inspect} should match the regexp" do
-          expect(email =~ EmailValidator.regexp).to be_truthy
-        end
-
-        it "#{email.inspect} should not match the strict regexp" do
-          expect(email =~ EmailValidator.regexp(:strict_mode => true)).to be_falsy
-        end
-
-      end
-    end
   end
 
   describe "error messages" do
@@ -188,14 +141,4 @@ describe EmailValidator do
       expect(TestUserAllowsNilFalse.new(:email => nil)).not_to be_valid
     end
   end
-
-  describe "default_options" do
-    context "when 'email_validator/strict' has been required" do
-      before { require 'email_validator/strict' }
-
-      it "should validate using strict mode" do
-        expect(TestUser.new(:email => "&'*+-./=?^_{}~@other-valid-characters-in-local.net")).not_to be_valid
-      end
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_validator
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Alexander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2019-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'An email validator for Rails 3+. See homepage for details: http://github.com/balexand/email_validator'
+description: Email validator for Rails and ActiveModel.
 email: balexand@gmail.com
 executables: []
 extensions: []
@@ -90,9 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: An email validator for Rails 3+.
+summary: An email validator for Rails and ActiveModel.
 test_files: []