Retrospring/app/validators/typoed_email_validator.rb

# frozen_string_literal: true

require "tldv"

class TypoedEmailValidator < ActiveModel::EachValidator
  # this array contains "forbidden" email address endings
  INVALID_ENDINGS = [
    # with @:
    *%w[
      aoo.com
      fmail.com
      gail.com
      gamil.com
      gemail.com
      gmaik.com
      gmail.cm
      gmail.co
      gmail.co.uk
      gmail.om
      gmaile.com
      gmaill.com
      gmali.com
      gmaul.com
      gnail.com
      hornail.com
      hotamil.com
      hotmai.com
      hotmaill.com
      iclooud.com
      iclould.com
      icluod.com
      maibox.org
      protonail.com
      xn--gmail-xk1c.com
      yahooo.com
      ☺gmail.com
    ].map { "@#{_1}" }
  ].freeze

  def validate_each(record, attribute, value)
    return if valid?(value)

    record.errors.add(attribute, :typo, message: "contains a typo")
  end

  private

  def valid?(value)
    # needs an @
    return false unless value.include?("@")

    # part after the @ needs to have at least one period
    _prefix, domain = value.split("@", 2)
    domain_parts = domain.split(".")
    return false if domain_parts.length == 1

    # check if the TLD is valid
    tld = domain_parts.last
    return false unless TLDv.valid?(tld)

    # finally, common typos
    return false if INVALID_ENDINGS.any? { value.end_with?(_1) }

    true
  end
end
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`# frozen_string_literal: true`

typoed_email_validator: check for valid TLDs i'm sure there are many more typos waiting to happen. one thing we can already catch though is the usage of invalid TLDs. this makes use of my new TLDv gem -- the data it uses can be updated independently from the main gem. 2022-10-13 12:23:12 -07:00			`require "tldv"`

add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`class TypoedEmailValidator < ActiveModel::EachValidator`
			`# this array contains "forbidden" email address endings`
			`INVALID_ENDINGS = [`
			`# with @:`
			`*%w[`
typoed_email_validator: add new endings to the typo list 2023-01-29 21:01:01 -08:00			`aoo.com`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`fmail.com`
typoed_email_validator: add new endings to the typo list 2022-06-21 10:33:51 -07:00			`gail.com`
			`gamil.com`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`gemail.com`
typoed_email_validator: add new endings to the typo list 2022-08-25 11:28:29 -07:00			`gmaik.com`
typoed_email_validator: add new endings to the typo list 2022-06-21 10:33:51 -07:00			`gmail.cm`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`gmail.co`
typoed_email_validator: add new endings to the typo list gmail.co.uk is registered by the big ad company with the 5000 chat apps, but it doesn't have a NX record 2022-10-11 11:43:01 -07:00			`gmail.co.uk`
typoed_email_validator: add new endings to the typo list 2023-01-06 01:26:32 -08:00			`gmail.om`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`gmaile.com`
			`gmaill.com`
typoed_email_validator: add new ending to the typo list 2022-01-17 10:22:34 -08:00			`gmali.com`
typoed_email_validator: add new endings to the typo list 2023-01-29 10:19:35 -08:00			`gmaul.com`
typoed_email_validator: add new endings to the typo list 2022-08-14 11:49:51 -07:00			`gnail.com`
typoed_email_validator: add new endings to the typo list 2023-03-09 11:08:15 -08:00			`hornail.com`
typoed_email_validator: add new endings to the typo list 2022-06-21 10:33:51 -07:00			`hotamil.com`
typoed_email_validator: add new endings to the typo list 2022-07-24 12:43:28 -07:00			`hotmai.com`
typoed_email_validator: add new ending to the typo list also: - consider '.mail' TLD a typo - get rid of a deprecation warning 2022-03-03 21:13:38 -08:00			`hotmaill.com`
typoed_email_validator: add new endings to the typo list 2022-06-21 10:33:51 -07:00			`iclooud.com`
typoed_email_validator: add new ending to the typo list 2022-04-10 00:55:05 -07:00			`iclould.com`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`icluod.com`
typoed_email_validator: add new endings to the typo list 2023-04-22 13:05:15 -07:00			`maibox.org`
typoed_email_validator: add new endings to the typo list 2022-10-02 13:13:34 -07:00			`protonail.com`
typoed_email_validator: add new endings to the typo list 2022-08-14 11:49:51 -07:00			`xn--gmail-xk1c.com`
typoed_email_validator: add new endings to the typo list 2022-07-24 12:43:28 -07:00			`yahooo.com`
typoed_email_validator: add new endings to the typo list 2022-08-14 11:49:51 -07:00			`☺gmail.com`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`].map { "@#{_1}" }`
			`].freeze`

			`def validate_each(record, attribute, value)`
			`return if valid?(value)`

typoed_email_validator: add new ending to the typo list also: - consider '.mail' TLD a typo - get rid of a deprecation warning 2022-03-03 21:13:38 -08:00			`record.errors.add(attribute, :typo, message: "contains a typo")`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00			`end`

			`private`

			`def valid?(value)`
			`# needs an @`
run Rubocop on changed files 2022-01-17 10:23:39 -08:00			`return false unless value.include?("@")`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00
			`# part after the @ needs to have at least one period`
typoed_email_validator: check for valid TLDs i'm sure there are many more typos waiting to happen. one thing we can already catch though is the usage of invalid TLDs. this makes use of my new TLDv gem -- the data it uses can be updated independently from the main gem. 2022-10-13 12:23:12 -07:00			`_prefix, domain = value.split("@", 2)`
			`domain_parts = domain.split(".")`
			`return false if domain_parts.length == 1`

			`# check if the TLD is valid`
			`tld = domain_parts.last`
			`return false unless TLDv.valid?(tld)`
add validator for typoed emails It happens quite often that people typo their email address (I blame phone keyboards for that). Catch common cases in a validator and tell the user that they have a typo in their email. Why yes, I did write the tests for this first, thanks for asking! 2022-01-11 09:37:07 -08:00
			`# finally, common typos`
			`return false if INVALID_ENDINGS.any? { value.end_with?(_1) }`

			`true`
			`end`
			`end`