abstracted user email validations into EmailValidations concern

Author: Oaphi

app/models/concerns/email_validations.rb

@@ -0,0 +1,57 @@
+module EmailValidations
+  extend ActiveSupport::Concern
+
+  included do
+    validate :email_domain_not_blocklisted
+    validate :email_not_blocklisted
+    validate :email_not_bad_pattern
+  end
+
+  def email_domain_not_blocklisted
+    return unless File.exist?(Rails.root.join('../.qpixel-domain-blocklist.txt'))
+    return unless saved_changes.include? 'email'
+
+    blocklist = File.read(Rails.root.join('../.qpixel-domain-blocklist.txt')).split("\n")
+    email_domain = email.split('@')[-1]
+    matched = blocklist.select { |x| email_domain == x }
+    if matched.any?
+      errors.add(:base, ApplicationRecord.useful_err_msg.sample)
+      matched_domains = matched.map { |d| "equals: #{d}" }
+      AuditLog.block_log(event_type: 'user_email_domain_blocked',
+                         comment: "email: #{email}\n#{matched_domains.join("\n")}\nsource: file")
+    end
+  end
+
+  def email_not_blocklisted
+    return true unless saved_changes.include? 'email'
+
+    email_domain = email.split('@')[-1]
+    is_mail_blocked = BlockedItem.emails.where(value: email)
+    is_mail_host_blocked = BlockedItem.email_hosts.where(value: email_domain)
+    if is_mail_blocked.any? || is_mail_host_blocked.any?
+      errors.add(:base, ApplicationRecord.useful_err_msg.sample)
+      if is_mail_blocked.any?
+        AuditLog.block_log(event_type: 'user_email_blocked', related: is_mail_blocked.first,
+                           comment: "email: #{email}\nfull match to: #{is_mail_blocked.first.value}")
+      end
+      if is_mail_host_blocked.any?
+        AuditLog.block_log(event_type: 'user_email_domain_blocked', related: is_mail_host_blocked.first,
+                           comment: "email: #{email}\ndomain match to: #{is_mail_host_blocked.first.value}")
+      end
+    end
+  end
+
+  def email_not_bad_pattern
+    return unless File.exist?(Rails.root.join('../.qpixel-email-patterns.txt'))
+    return unless changes.include? 'email'
+
+    patterns = File.read(Rails.root.join('../.qpixel-email-patterns.txt')).split("\n")
+    matched = patterns.select { |p| email.match? Regexp.new(p) }
+    if matched.any?
+      errors.add(:base, ApplicationRecord.useful_err_msg.sample)
+      matched_patterns = matched.map { |p| "matched: #{p}" }
+      AuditLog.block_log(event_type: 'user_email_pattern_match',
+                         comment: "email: #{email}\n#{matched_patterns.join("\n")}")
+    end
+  end
+end

app/models/user.rb

@@ -1,4 +1,5 @@
 class User < ApplicationRecord
+  include ::EmailValidations
   include ::UsernameValidations
   include ::UserRateLimits
   include ::UserMerge
@@ -36,9 +37,6 @@ class User < ApplicationRecord
   accepts_nested_attributes_for :user_websites
 
   validates :login_token, uniqueness: { allow_blank: true, case_sensitive: false }
-  validate :email_domain_not_blocklisted
-  validate :not_blocklisted?
-  validate :email_not_bad_pattern
 
   delegate :reputation, :reputation=, :privilege?, :privilege, to: :community_user
 
@@ -375,54 +373,6 @@ def rtl_safe_username
     "#{username}\u202D"
   end
 
-  def email_domain_not_blocklisted
-    return unless File.exist?(Rails.root.join('../.qpixel-domain-blocklist.txt'))
-    return unless saved_changes.include? 'email'
-
-    blocklist = File.read(Rails.root.join('../.qpixel-domain-blocklist.txt')).split("\n")
-    email_domain = email.split('@')[-1]
-    matched = blocklist.select { |x| email_domain == x }
-    if matched.any?
-      errors.add(:base, ApplicationRecord.useful_err_msg.sample)
-      matched_domains = matched.map { |d| "equals: #{d}" }
-      AuditLog.block_log(event_type: 'user_email_domain_blocked',
-                         comment: "email: #{email}\n#{matched_domains.join("\n")}\nsource: file")
-    end
-  end
-
-  def not_blocklisted?
-    return true unless saved_changes.include? 'email'
-
-    email_domain = email.split('@')[-1]
-    is_mail_blocked = BlockedItem.emails.where(value: email)
-    is_mail_host_blocked = BlockedItem.email_hosts.where(value: email_domain)
-    if is_mail_blocked.any? || is_mail_host_blocked.any?
-      errors.add(:base, ApplicationRecord.useful_err_msg.sample)
-      if is_mail_blocked.any?
-        AuditLog.block_log(event_type: 'user_email_blocked', related: is_mail_blocked.first,
-                           comment: "email: #{email}\nfull match to: #{is_mail_blocked.first.value}")
-      end
-      if is_mail_host_blocked.any?
-        AuditLog.block_log(event_type: 'user_email_domain_blocked', related: is_mail_host_blocked.first,
-                           comment: "email: #{email}\ndomain match to: #{is_mail_host_blocked.first.value}")
-      end
-    end
-  end
-
-  def email_not_bad_pattern
-    return unless File.exist?(Rails.root.join('../.qpixel-email-patterns.txt'))
-    return unless changes.include? 'email'
-
-    patterns = File.read(Rails.root.join('../.qpixel-email-patterns.txt')).split("\n")
-    matched = patterns.select { |p| email.match? Regexp.new(p) }
-    if matched.any?
-      errors.add(:base, ApplicationRecord.useful_err_msg.sample)
-      matched_patterns = matched.map { |p| "matched: #{p}" }
-      AuditLog.block_log(event_type: 'user_email_pattern_match',
-                         comment: "email: #{email}\n#{matched_patterns.join("\n")}")
-    end
-  end
-
   def ensure_community_user!
     community_user || create_community_user(reputation: SiteSetting['NewUserInitialRep'])
   end

test/models/user_test.rb

@@ -309,7 +309,7 @@ class UserTest < ActiveSupport::TestCase
     assert_equal 1, local_result.size
   end
 
-  test 'not_blocklisted? should correctly determine if the user is blocklisted' do
+  test 'email_not_blocklisted should correctly determine if the user is blocklisted' do
     std = users(:standard_user)
 
     std.skip_reconfirmation!