Commit c8c0ea6c authored by Horatiu Eugen Vlad's avatar Horatiu Eugen Vlad

Align EmailValidator to validate_email gem implementation.

Renamed EmailValidator to DeviseEmailValidator to avoid 'email:' naming collision with ActiveModel::Validations::EmailValidator in 'validates' statement.
Make use of the options attribute of the parent class ActiveModel::EachValidator.
Add more options: regex.
parent 60876192
...@@ -69,7 +69,7 @@ class ApplicationSetting < ActiveRecord::Base ...@@ -69,7 +69,7 @@ class ApplicationSetting < ActiveRecord::Base
url: true url: true
validates :admin_notification_email, validates :admin_notification_email,
email: true, devise_email: true,
allow_blank: true allow_blank: true
validates :two_factor_grace_period, validates :two_factor_grace_period,
......
...@@ -7,7 +7,7 @@ class Email < ActiveRecord::Base ...@@ -7,7 +7,7 @@ class Email < ActiveRecord::Base
belongs_to :user belongs_to :user
validates :user_id, presence: true validates :user_id, presence: true
validates :email, presence: true, uniqueness: true, email: true validates :email, presence: true, uniqueness: true, devise_email: true
validate :unique_email, if: ->(email) { email.email_changed? } validate :unique_email, if: ->(email) { email.email_changed? }
scope :confirmed, -> { where.not(confirmed_at: nil) } scope :confirmed, -> { where.not(confirmed_at: nil) }
......
...@@ -28,7 +28,7 @@ class Member < ActiveRecord::Base ...@@ -28,7 +28,7 @@ class Member < ActiveRecord::Base
presence: { presence: {
if: :invite? if: :invite?
}, },
email: { devise_email: {
allow_nil: true allow_nil: true
}, },
uniqueness: { uniqueness: {
......
...@@ -162,9 +162,9 @@ class User < ApplicationRecord ...@@ -162,9 +162,9 @@ class User < ApplicationRecord
validates :name, presence: true validates :name, presence: true
validates :email, confirmation: true validates :email, confirmation: true
validates :notification_email, presence: true validates :notification_email, presence: true
validates :notification_email, email: true, if: ->(user) { user.notification_email != user.email } validates :notification_email, devise_email: true, if: ->(user) { user.notification_email != user.email }
validates :public_email, presence: true, uniqueness: true, email: true, allow_blank: true validates :public_email, presence: true, uniqueness: true, devise_email: true, allow_blank: true
validates :commit_email, email: true, allow_nil: true, if: ->(user) { user.commit_email != user.email } validates :commit_email, devise_email: true, allow_nil: true, if: ->(user) { user.commit_email != user.email }
validates :bio, length: { maximum: 255 }, allow_blank: true validates :bio, length: { maximum: 255 }, allow_blank: true
validates :projects_limit, validates :projects_limit,
presence: true, presence: true,
......
# frozen_string_literal: true
# DeviseEmailValidator
#
# Custom validator for email formats. It asserts that there are no
# @ symbols or whitespaces in either the localpart or the domain, and that
# there is a single @ symbol separating the localpart and the domain.
#
# The available options are:
# - regexp: Email regular expression used to validate email formats as instance of Regexp class.
# If provided value has different type then a new Rexexp class instance is created using the value.
# Default: +Devise.email_regexp+
#
# Example:
# class User < ActiveRecord::Base
# validates :personal_email, devise_email: true
#
# validates :public_email, devise_email: { regexp: Devise.email_regexp }
# end
class DeviseEmailValidator < ActiveModel::EachValidator
DEFAULT_OPTIONS = {
regexp: Devise.email_regexp
}.freeze
def initialize(options)
options.reverse_merge!(DEFAULT_OPTIONS)
raise ArgumentError, "Expected 'regexp' argument of type class Regexp" unless options[:regexp].is_a?(Regexp)
super(options)
end
def validate_each(record, attribute, value)
record.errors.add(attribute, :invalid) unless value =~ options[:regexp]
end
end
# frozen_string_literal: true
class EmailValidator < ActiveModel::EachValidator
def validate_each(record, attribute, value)
record.errors.add(attribute, :invalid) unless value =~ Devise.email_regexp
end
end
---
title: Align EmailValidator to validate_email gem implementation
merge_request: 24971
author: Horatiu Eugen Vlad
type: fixed
# frozen_string_literal: true
require 'spec_helper'
describe DeviseEmailValidator do
let!(:user) { build(:user, public_email: 'test@example.com') }
subject { validator.validate(user) }
describe 'validations' do
context 'by default' do
let(:validator) { described_class.new(attributes: [:public_email]) }
it 'allows when email is valid' do
subject
expect(user.errors).to be_empty
end
it 'returns error when email is invalid' do
user.public_email = 'invalid'
subject
expect(user.errors).to be_present
expect(user.errors.first[1]).to eq 'is invalid'
end
it 'returns error when email is nil' do
user.public_email = nil
subject
expect(user.errors).to be_present
end
it 'returns error when email is blank' do
user.public_email = ''
subject
expect(user.errors).to be_present
expect(user.errors.first[1]).to eq 'is invalid'
end
end
end
context 'when regexp is set as Regexp' do
let(:validator) { described_class.new(attributes: [:public_email], regexp: /[0-9]/) }
it 'allows when value match' do
user.public_email = '1'
subject
expect(user.errors).to be_empty
end
it 'returns error when value does not match' do
subject
expect(user.errors).to be_present
end
end
context 'when regexp is set as String' do
it 'raise argument error' do
expect { described_class.new( { regexp: 'something' } ) }.to raise_error ArgumentError
end
end
context 'when allow_nil is set to true' do
let(:validator) { described_class.new(attributes: [:public_email], allow_nil: true) }
it 'allows when email is nil' do
user.public_email = nil
subject
expect(user.errors).to be_empty
end
end
context 'when allow_blank is set to true' do
let(:validator) { described_class.new(attributes: [:public_email], allow_blank: true) }
it 'allows when email is blank' do
user.public_email = ''
subject
expect(user.errors).to be_empty
end
end
end
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment