Contents

# 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 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 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)
      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)
      # 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
valid_email2-5.3.0	lib/valid_email2.rb