valid_email2 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b11e62f82282c1cc81c9698a17a44af5d2a0baec3dc9a1f147e8b9f6201885cd
-  data.tar.gz: 24b9024326e7f3ad965802c320901f2ecbd42cfcfc7c0b06e757f73767a6ae92
+  metadata.gz: fe834d489ba46cf4a8262cb077bf2f88b0fd866b604bf1ae628d877bbfdbb57b
+  data.tar.gz: af8e27efffae003ed85189ae10d1f9b6e30817e8529deb4064811156a332208e
 SHA512:
-  metadata.gz: cbb94d6b281464231ef30464b775fcbe1d404a8651105b2fe4b488182bc3cdcce9b2140d0a24431db7570c302c85e353f16e4f4444cd4edda009645a64f54ed4
-  data.tar.gz: f5783382e56e570a02dd5abb0e7190d4f4e457a5b47e523bd21ddc4eab51fac7680811e2913e56e1db9ee1593f4c368c7f594558227ce635252c1a1e731a8484
+  metadata.gz: 300c5f449125f0d6bd1abfd224aa88c65caa0377fe2b2a56ec6bc695bb3c0e9bac4ea03f2c091509c19f5cb8614137578ec8fc52a844cfd0765f9da7d5707615
+  data.tar.gz: ce9dfe893b11555a195f4777e3146f0065c3d49c26b289e874d01cb40da0f02f575f5a3efd8430e57bffdd2aaf52a36f05056986b789b3bd982b14d889bea0e2

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Version 3.3.1
+* Fix some performance regressions (https://github.com/micke/valid_email2/pull/150)
+
 ## Version 3.3.0
 * Allow multiple addresses separated by comma (https://github.com/micke/valid_email2/pull/156)
 * Make prohibited_domain_characters_regex changeable (https://github.com/micke/valid_email2/pull/157)

data/lib/valid_email2.rb

@@ -7,23 +7,35 @@ module ValidEmail2
   WHITELIST_FILE  = "config/whitelisted_email_domains.yml"
   DISPOSABLE_FILE = File.expand_path('../config/disposable_email_domains.txt', __dir__)
 
-  def self.disposable_emails
-    @disposable_emails ||= File.open(DISPOSABLE_FILE){ |f| f.read }.split("\n")
-  end
+  class << self
+    def disposable_emails
+      @disposable_emails ||= load_file(DISPOSABLE_FILE)
+    end
 
-  def self.blacklist
-    @blacklist ||= if File.exist?(BLACKLIST_FILE)
-                     YAML.load_file(File.expand_path(BLACKLIST_FILE))
-                   else
-                     []
-                   end
-  end
+    def blacklist
+      @blacklist ||= load_if_exists(BLACKLIST_FILE)
+    end
+
+    def whitelist
+      @whitelist ||= load_if_exists(WHITELIST_FILE)
+    end
+
+    private
+
+    def load_if_exists(path)
+      File.exist?(path) ? load_file(path) : Set.new
+    end
 
-  def self.whitelist
-    @whitelist ||= if File.exist?(WHITELIST_FILE)
-                     YAML.load_file(File.expand_path(WHITELIST_FILE))
-                   else
-                     []
-                   end
+    def load_file(path)
+      # This method MUST return a Set, otherwise the
+      # performance will suffer!
+      if path.end_with?(".yml")
+        Set.new(YAML.load_file(path))
+      else
+        File.open(path, "r").each_line.each_with_object(Set.new) do |domain, set|
+          set << domain.tap(&:chomp!)
+        end
+      end
+    end
   end
 end

data/lib/valid_email2/address.rb

@@ -32,25 +32,20 @@ module ValidEmail2
     end
 
     def valid?
-      @valid ||= begin
-        return false if @parse_error
+      return @valid unless @valid.nil?
+      return false  if @parse_error
 
+      @valid = begin
         if address.domain && address.address == @raw_address
           domain = address.domain
 
           domain !~ self.class.prohibited_domain_characters_regex &&
-            # Domain needs to have at least one dot
-            domain =~ /\./ &&
-            # Domain may not have two consecutive dots
-            domain !~ /\.{2,}/ &&
-            # Domain may not start with a dot
-            domain !~ /^\./ &&
-            # Domain may not start with a dash
-            domain !~ /^-/ &&
-            # Domain name may not end with a dash
-            domain !~ /-\./ &&
-            # Address may not contain a dot directly before @
-            address.address !~ /\.@/
+            domain.include?('.') &&
+            !domain.include?('..') &&
+            !domain.start_with?('.') &&
+            !domain.start_with?('-') &&
+            !domain.include?('-.') &&
+            !address.local.end_with?('.')
         else
           false
         end
@@ -70,7 +65,7 @@ module ValidEmail2
     end
 
     def disposable_domain?
-      valid? && domain_is_in?(ValidEmail2.disposable_emails)
+      domain_is_in?(ValidEmail2.disposable_emails)
     end
 
     def disposable_mx_server?

data/lib/valid_email2/version.rb

@@ -1,3 +1,3 @@
 module ValidEmail2
-  VERSION = "3.3.0"
+  VERSION = "3.3.1"
 end

data/spec/benchmark_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Performance testing" do
+  let(:disposable_domain) { ValidEmail2.disposable_emails.first }
+
+  it "has acceptable lookup performance" do
+    address = ValidEmail2::Address.new("test@example.com")
+
+    # preload list and check size
+    expect(ValidEmail2.disposable_emails).to be_a(Set)
+    expect(ValidEmail2.disposable_emails.count).to be > 30000
+
+    # check lookup timing
+    expect { address.disposable_domain? }.to perform_under(0.0001).sample(10).times
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,15 @@
 $:.unshift File.expand_path("../lib",__FILE__)
 require "valid_email2"
 
+# Include and configure  benchmark
+require 'rspec-benchmark'
+RSpec.configure do |config|
+  config.include RSpec::Benchmark::Matchers
+end
+RSpec::Benchmark.configure do |config|
+  config.disable_gc = true
+end
+
 class TestModel
   include ActiveModel::Validations
 

data/spec/valid_email2_spec.rb

@@ -87,16 +87,11 @@ describe ValidEmail2 do
       expect(user.valid?).to be_falsey
     end
 
-    it "is invalid if the domain contains emoticons" do
+    it "is invalid if the email contains emoticons" do
       user = TestUser.new(email: "foo🙈@gmail.com")
       expect(user.valid?).to be_falsy
     end
 
-    it "is invalid if the domain contains .@ consecutively" do
-      user = TestUser.new(email: "foo.@gmail.com")
-      expect(user.valid?).to be_falsy
-    end
-
     it "is invalid if the domain contains spaces" do
       user = TestUser.new(email: "user@gmail .com")
       expect(user.valid?).to be_falsy

data/valid_email2.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "rspec-benchmark", "~> 0.6"
   spec.add_development_dependency "pry"
   spec.add_runtime_dependency "mail", "~> 2.5"
   spec.add_runtime_dependency "activemodel", ">= 3.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,7 @@ files:
 - lib/valid_email2/email_validator.rb
 - lib/valid_email2/version.rb
 - pull_mailchecker_emails.rb
+- spec/benchmark_spec.rb
 - spec/spec_helper.rb
 - spec/valid_email2_spec.rb
 - valid_email2.gemspec
@@ -148,5 +163,6 @@ specification_version: 4
 summary: ActiveModel validation for email. Including MX lookup and disposable email
   blacklist
 test_files:
+- spec/benchmark_spec.rb
 - spec/spec_helper.rb
 - spec/valid_email2_spec.rb