valid_email2 5.2.6 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a01a2acf82274bd6e459721211ff637ab27f24ca2ec01ae4423ed4ffac25d9
-  data.tar.gz: cd8506ab6c60327a789e2fb4f1d702a49a2059ff2c9af79c6db10ecb0c7023b0
+  metadata.gz: 0e044955522eceb44fb1def3eb4da317dc58625072d0c41f509ce50cc5634d4b
+  data.tar.gz: bc1af776d07f7a8480441d4bbf3f711d48cc7292947b8e004e1831be71e603bc
 SHA512:
-  metadata.gz: 91af74f0a0c8fecac0ade9e9320186c0e86c76e48665d07ab79fe9ef0fdde75a3ff37d0d39b2cce8e2fd30a04a4815492ab5f24e7094f55b7852e3a6b41aef95
-  data.tar.gz: d19d1e8c83b8aa2833ed2d472e41b8722018d08d5d465416f4cefc8c588dd9a9334d07401787acb9cee89cc9b326892097a6d3ad5d5ff015b0bce774bdbfc4ee
+  metadata.gz: 1974e08b667ae079117faf1415047fccebcb4a870bd1006a240ee15990bcee39ef75999a55ecc33e812c053a0c218afb0a80df7cf8b8379f3e9343583f7de51f
+  data.tar.gz: '085e865491902d39d25a49cf0834743cfc0280dee0a1b6f9358e265e8a473a0381b9da929edf8848b782e4e95715f8d58af66836f65e600bb511d06b651b2675'

data/.github/workflows/ci.yaml

@@ -1,5 +1,5 @@
 name: CI
-on: [push, pull_request]
+on: [push, pull_request_target]
 jobs:
   test:
     strategy:

data/.release-please-manifest.json

@@ -1 +1 @@
-{".":"5.2.6"}
+{".":"5.3.0"}

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [5.3.0](https://github.com/micke/valid_email2/compare/v5.2.6...v5.3.0) (2024-08-31)
+
+
+### Features
+
+* Deprecate blacklist and whitelist naming ([9df0bf8](https://github.com/micke/valid_email2/commit/9df0bf8c9912721b007e5a6acc67f533ca560c9f))
+* Warn when loading deprecated files ([46634df](https://github.com/micke/valid_email2/commit/46634dff409f9a47f10684d629dc022b22daf362))
+
 ## [5.2.6](https://github.com/micke/valid_email2/compare/v5.2.5...v5.2.6) (2024-08-10)
 
 

data/README.md

@@ -73,20 +73,20 @@ To validate that the domain is not a disposable email (checks domain only, does
 validates :email, 'valid_email_2/email': { disposable_domain: true }
 ```
 
-To validate that the domain is not a disposable email or a disposable email (checks domain and MX server) but whitelisted (under config/whitelisted_email_domains.yml):
+To validate that the domain is not a disposable email or a disposable email (checks domain and MX server) but allow-listed (under config/allow_listed_email_domains.yml):
 ```ruby
-validates :email, 'valid_email_2/email': { disposable_with_whitelist: true }
+validates :email, 'valid_email_2/email': { disposable_with_allow_list: true }
 ```
 
-To validate that the domain is not a disposable email or a disposable email (checks domain only, does not check MX server) but whitelisted (under config/whitelisted_email_domains.yml):
+To validate that the domain is not a disposable email or a disposable email (checks domain only, does not check MX server) but allow-listed (under config/allow_listed_email_domains.yml):
 
 ```ruby
-validates :email, 'valid_email_2/email': { disposable_domain_with_whitelist: true }
+validates :email, 'valid_email_2/email': { disposable_domain_with_allow_list: true }
 ```
 
-To validate that the domain is not blacklisted (under config/blacklisted_email_domains.yml):
+To validate that the domain is not on the deny list (under config/deny_list_email_domains.yml):
 ```ruby
-validates :email, 'valid_email_2/email': { blacklist: true }
+validates :email, 'valid_email_2/email': { deny_list: true }
 ```
 
 To validate that email is not subaddressed:
@@ -147,6 +147,15 @@ end
 
 This gem is tested against currently supported Ruby and Rails versions. For an up to date list, check the build matrix in the [workflow](.github/workflows/ci.yaml).
 
+## Upgrading to v5.3.0
+
+In version v5.3.0 the config directory files were renamed as follows:
+
+`config/blacklisted_email_domains.yml` -> `config/deny_listed_email_domains.yml`
+`config/whitelisted_email_domains.yml` -> `config/allow_listed_email_domains.yml`
+
+You won't need to make any changes yourself if you're installing this version for the first time. For individuals updating from earlier versions, make sure to update the file namings as per the above. In future versions this will be a breaking change.
+
 ## Upgrading to v3.0.0
 
 In version v3.0.0 I decided to move __and__ rename the config files from the

data/config/deny_listed_email_domains.yml

@@ -0,0 +1 @@
+- deny-listed-test.com

data/lib/helpers/deprecation_helper.rb

@@ -0,0 +1,14 @@
+module DeprecationHelper
+  def deprecate_method(old_method, new_method)
+    define_method(old_method) do |*args, &block|
+      klass = is_a? Module
+      target = klass ? "#{self}." : "#{self.class}#"
+      warn "Warning: `#{target}#{old_method}` is deprecated and will be removed in version 6 of valid_email2; use `#{new_method}` instead."
+      send(new_method, *args, &block)
+    end
+  end
+
+  def deprecation_message(old_name, new_name)
+    warn "Warning: `#{old_name}` is deprecated and will be removed in version 6 of valid_email2; use `#{new_name}` instead."
+  end
+end

data/lib/valid_email2/address.rb

@@ -3,9 +3,12 @@
 require "valid_email2"
 require "resolv"
 require "mail"
+require_relative "../helpers/deprecation_helper"
 
 module ValidEmail2
   class Address
+    extend DeprecationHelper
+
     attr_accessor :address
 
     PROHIBITED_DOMAIN_CHARACTERS_REGEX = /[+!_\/\s'`]/
@@ -84,13 +87,15 @@ module ValidEmail2
       valid? && mx_server_is_in?(ValidEmail2.disposable_emails)
     end
 
-    def whitelisted?
-      domain_is_in?(ValidEmail2.whitelist)
+    def allow_listed?
+      domain_is_in?(ValidEmail2.allow_list)
     end
+    deprecate_method :whitelisted?, :allow_listed?
 
-    def blacklisted?
-      valid? && domain_is_in?(ValidEmail2.blacklist)
+    def deny_listed?
+      valid? && domain_is_in?(ValidEmail2.deny_list)
     end
+    deprecate_method :blacklisted?, :deny_listed?
 
     def valid_mx?
       return false unless valid?

data/lib/valid_email2/email_validator.rb

@@ -1,9 +1,12 @@
 require "valid_email2/address"
 require "active_model"
 require "active_model/validations"
+require_relative "../helpers/deprecation_helper"
 
 module ValidEmail2
   class EmailValidator < ActiveModel::EachValidator
+    include DeprecationHelper
+
     def default_options
       { disposable: false, mx: false, strict_mx: false, disallow_subaddressing: false, multiple: false, dns_timeout: 5, dns_nameserver: nil }
     end
@@ -33,15 +36,27 @@ module ValidEmail2
       end
 
       if options[:disposable_with_whitelist]
-        error(record, attribute) && return if addresses.any? { |address| address.disposable? && !address.whitelisted? }
+        deprecation_message(:disposable_with_whitelist, :disposable_with_allow_list)
+      end
+
+      if options[:disposable_with_allow_list] || options[:disposable_with_whitelist]
+        error(record, attribute) && return if addresses.any? { |address| address.disposable? && !address.allow_listed? }
       end
 
       if options[:disposable_domain_with_whitelist]
-        error(record, attribute) && return if addresses.any? { |address| address.disposable_domain? && !address.whitelisted? }
+        deprecation_message(:disposable_domain_with_whitelist, :disposable_domain_with_allow_list)
+      end
+
+      if options[:disposable_domain_with_allow_list] || options[:disposable_domain_with_whitelist]
+        error(record, attribute) && return if addresses.any? { |address| address.disposable_domain? && !address.allow_listed? }
       end
 
       if options[:blacklist]
-        error(record, attribute) && return if addresses.any?(&:blacklisted?)
+        deprecation_message(:blacklist, :deny_list)
+      end
+      
+      if options[:deny_list] || options[:blacklist]
+        error(record, attribute) && return if addresses.any?(&:deny_listed?)
       end
 
       if options[:mx]

data/lib/valid_email2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal:true
 
 module ValidEmail2
-  VERSION = "5.2.6"
+  VERSION = "5.3.0"
 end

data/lib/valid_email2.rb

@@ -1,29 +1,51 @@
 # frozen_string_literal: true
 
 require "valid_email2/email_validator"
+require_relative "./helpers/deprecation_helper"
 
 module ValidEmail2
+  
   BLACKLIST_FILE  = "config/blacklisted_email_domains.yml"
+  DENY_LIST_FILE  = "config/deny_listed_email_domains.yml"
   WHITELIST_FILE  = "config/whitelisted_email_domains.yml"
+  ALLOW_LIST_FILE  = "config/allow_listed_email_domains.yml"
   DISPOSABLE_FILE = File.expand_path('../config/disposable_email_domains.txt', __dir__)
 
   class << self
+    extend DeprecationHelper
+
     def disposable_emails
       @disposable_emails ||= load_file(DISPOSABLE_FILE)
     end
 
-    def blacklist
-      @blacklist ||= load_if_exists(BLACKLIST_FILE)
+    def deny_list
+      @deny_list ||= load_if_exists(DENY_LIST_FILE) ||
+        load_deprecated_if_exists(BLACKLIST_FILE) ||
+        Set.new
     end
+    deprecate_method :blacklist, :deny_list
 
-    def whitelist
-      @whitelist ||= load_if_exists(WHITELIST_FILE)
+    def allow_list
+      @allow_list ||= load_if_exists(ALLOW_LIST_FILE) ||
+        load_deprecated_if_exists(WHITELIST_FILE) ||
+        Set.new
     end
+    deprecate_method :whitelist, :allow_list
 
     private
 
     def load_if_exists(path)
-      File.exist?(path) ? load_file(path) : Set.new
+      load_file(path) if File.exist?(path)
+    end
+
+    def load_deprecated_if_exists(path)
+      if File.exist?(path)
+        warn <<~WARN
+          Warning: The file `#{path}` used by valid_email2 is deprecated and won't be read in version 6 of valid_email2;
+          Rename the file to `#{path.gsub("blacklisted", "deny_listed").gsub("whitelisted", "allow_listed")}` instead."
+        WARN
+        load_file(path)
+      end
     end
 
     def load_file(path)

data/release-please-config.json

@@ -1,7 +1,6 @@
 {
   "release-type": "ruby",
   "include-component-in-tag": false,
-  "last-release-sha": "b327e76f71e764f6d76351425e11d1563e04f188",
   "packages": {
     ".": {
       "release-type": "ruby",

data/spec/valid_email2_spec.rb

@@ -47,16 +47,16 @@ class TestUserDisallowDisposableDomain < TestModel
   validates :email, 'valid_email_2/email': { disposable_domain: true }
 end
 
-class TestUserDisallowDisposableWithWhitelist < TestModel
-  validates :email, 'valid_email_2/email': { disposable_with_whitelist: true }
+class TestUserDisallowDisposableWithAllowList < TestModel
+  validates :email, 'valid_email_2/email': { disposable_with_allow_list: true }
 end
 
-class TestUserDisallowDisposableDomainWithWhitelist < TestModel
-  validates :email, 'valid_email_2/email': { disposable_domain_with_whitelist: true }
+class TestUserDisallowDisposableDomainWithAllowList < TestModel
+  validates :email, 'valid_email_2/email': { disposable_domain_with_allow_list: true }
 end
 
-class TestUserDisallowBlacklisted < TestModel
-  validates :email, 'valid_email_2/email': { blacklist: true }
+class TestUserDisallowDenyListed < TestModel
+  validates :email, 'valid_email_2/email': { deny_list: true }
 end
 
 class TestUserMessage < TestModel
@@ -208,58 +208,58 @@ describe ValidEmail2 do
       end
     end
 
-    describe "with whitelisted emails" do
-      let(:whitelist_domain) { disposable_domain }
-      let(:whitelist_file_path) { "config/whitelisted_email_domains.yml" }
+    describe "with allow-listed emails" do
+      let(:allow_list_domain) { disposable_domain }
+      let(:allow_list_file_path) { "config/allow_listed_email_domains.yml" }
 
-      # Some of the specs below need to explictly set the whitelist var or it
+      # Some of the specs below need to explictly set the allow list var or it
       # may be cached to an empty set
-      def set_whitelist
+      def set_allow_list
         ValidEmail2.instance_variable_set(
-          :@whitelist,
-          ValidEmail2.send(:load_if_exists, ValidEmail2::WHITELIST_FILE)
+          :@allow_list,
+          ValidEmail2.send(:load_if_exists, ValidEmail2::ALLOW_LIST_FILE)
         )
       end
 
       after do
-        FileUtils.rm(whitelist_file_path, force: true)
-        set_whitelist
+        FileUtils.rm(allow_list_file_path, force: true)
+        set_allow_list
       end
 
-      it "is invalid if the domain is disposable and not in the whitelist" do
-        user = TestUserDisallowDisposableWithWhitelist.new(email: "foo@#{whitelist_domain}")
+      it "is invalid if the domain is disposable and not in the allow list" do
+        user = TestUserDisallowDisposableWithAllowList.new(email: "foo@#{allow_list_domain}")
         expect(user.valid?).to be_falsey
       end
 
-      it "is valid if the domain is disposable but in the whitelist" do
-        File.open(whitelist_file_path, "w") { |f| f.write [whitelist_domain].to_yaml }
-        set_whitelist
-        user = TestUserDisallowDisposableWithWhitelist.new(email: "foo@#{whitelist_domain}")
+      it "is valid if the domain is disposable but in the allow list" do
+        File.open(allow_list_file_path, "w") { |f| f.write [allow_list_domain].to_yaml }
+        set_allow_list
+        user = TestUserDisallowDisposableWithAllowList.new(email: "foo@#{allow_list_domain}")
         expect(user.valid?).to be_truthy
       end
 
-      it "is invalid if the domain is a disposable_domain and not in the whitelist" do
-        user = TestUserDisallowDisposableDomainWithWhitelist.new(email: "foo@#{whitelist_domain}")
+      it "is invalid if the domain is a disposable_domain and not in the allow list" do
+        user = TestUserDisallowDisposableDomainWithAllowList.new(email: "foo@#{allow_list_domain}")
         expect(user.valid?).to be_falsey
       end
 
-      it "is valid if the domain is a disposable_domain but in the whitelist" do
-        File.open(whitelist_file_path, "w") { |f| f.write [whitelist_domain].to_yaml }
-        set_whitelist
-        user = TestUserDisallowDisposableDomainWithWhitelist.new(email: "foo@#{whitelist_domain}")
+      it "is valid if the domain is a disposable_domain but in the allow list" do
+        File.open(allow_list_file_path, "w") { |f| f.write [allow_list_domain].to_yaml }
+        set_allow_list
+        user = TestUserDisallowDisposableDomainWithAllowList.new(email: "foo@#{allow_list_domain}")
         expect(user.valid?).to be_truthy
       end
     end
   end
 
-  describe "with blacklist validation" do
-    it "is valid if the domain is not blacklisted" do
-      user = TestUserDisallowBlacklisted.new(email: "foo@gmail.com")
+  describe "with deny list validation" do
+    it "is valid if the domain is not deny-listed" do
+      user = TestUserDisallowDenyListed.new(email: "foo@gmail.com")
       expect(user.valid?).to be_truthy
     end
 
-    it "is invalid if the domain is blacklisted" do
-      user = TestUserDisallowBlacklisted.new(email: "foo@blacklisted-test.com")
+    it "is invalid if the domain is deny-listed" do
+      user = TestUserDisallowDenyListed.new(email: "foo@deny-listed-test.com")
       expect(user.valid?).to be_falsey
     end
   end

data/valid_email2.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = ValidEmail2::VERSION
   spec.authors       = ["Micke Lisinge"]
   spec.email         = ["hi@micke.me"]
-  spec.description   = %q{ActiveModel validation for email. Including MX lookup and disposable email blacklist}
-  spec.summary       = %q{ActiveModel validation for email. Including MX lookup and disposable email blacklist}
+  spec.description   = %q{ActiveModel validation for email. Including MX lookup and disposable email deny list}
+  spec.summary       = %q{ActiveModel validation for email. Including MX lookup and disposable email deny list}
   spec.homepage      = "https://github.com/micke/valid_email2"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valid_email2
 version: !ruby/object:Gem::Version
-  version: 5.2.6
+  version: 5.3.0
 platform: ruby
 authors:
 - Micke Lisinge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-10 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 description: ActiveModel validation for email. Including MX lookup and disposable
-  email blacklist
+  email deny list
 email:
 - hi@micke.me
 executables: []
@@ -140,10 +140,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- config/blacklisted_email_domains.yml
+- config/deny_listed_email_domains.yml
 - config/disposable_email_domains.txt
 - gemfiles/activemodel6.gemfile
 - gemfiles/activemodel7.gemfile
+- lib/helpers/deprecation_helper.rb
 - lib/valid_email2.rb
 - lib/valid_email2/address.rb
 - lib/valid_email2/email_validator.rb
@@ -178,7 +179,7 @@ rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: ActiveModel validation for email. Including MX lookup and disposable email
-  blacklist
+  deny list
 test_files:
 - spec/address_spec.rb
 - spec/benchmark_spec.rb

data/config/blacklisted_email_domains.yml

@@ -1 +0,0 @@
-- blacklisted-test.com