EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)

2020.07.12に公開

Udemy
8. ユーザーモデル開発
No.4 / 8

今回達成すること

emailカラムにカスタムバリデーションを設定していきます。

RailsではEachValidatorClass（イーチバリデータクラス）が用意されており、このクラスを使うと独自のバリデーションを設定することができます。

最終的なコードは記事下部にあります。

カスタムバリデーション事前準備

まずはカスタムバリデーションを作成するファイルを作成しましょう。

「lib」ディレクトリ配下にバリデータファイルを置く「validator」ディレクトリを作成します。

その「validator」ディレクトリにemail_validator.rbを作成しましょう。

root $ mkdir api/lib/validator && touch $_/email_validator.rb

EachValidatorClassの命名規則

作成されたemail_validator.rbにクラスを宣言します。

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator

end

EmailValidator ... EachValidatorクラスを継承した自作クラス。

このクラス名は<呼び出し名>Validatorという形で宣言します。

EmailValidatorは、emailで呼び出しが可能です。

ユーザーモデルからの呼び出し

クラスを定義したのでemailのバリデーションを追加し、EmailValidatorクラスを呼び出しましょう。

user.rbに移動します。

api/app/models/user.rb

# 追加
require "validator/email_validator"

class User < ApplicationRecord
	...
  # validates
  validates :name, presence: true,
                   length: { maximum: 30, allow_blank: true }
  # 追加
  validates :email, presence: true,
                    email: { allow_blank: true }
	...
end

Rails6からの「lib」ディレクトリ以下のファイル読み込み

Rails6のデフォルトでは「lib」ディレクトリ以下のファイルは読み込まれません。

読み込むには2つの方法があります。

1. requireで呼び出し

今回のように読み込みたい場所でrequireを宣言する方法です。

Railsがデフォルトで読み込むパスには「app/lib」まで設定されていますので、それ以下のファイルパスを渡します。

api/lib/validator/email_validator.rbの場合

=> "validator/email_validator.rb"のパスを渡す。

2. application.rbで呼び出し

Rails6のオートロードシステム「Zeitwerk（ツァイトベルク）」に読み込みパスを追加する方法もあります。

具体的にはapplication.rbに以下の一行を追加します。

api/config/application.rb

module App
  class Application < Rails::Application
    ...
    # Zeitwerk（ツァイトベルク）にvalidator配下のファイルを読み込ます
    config.autoload_paths += %W(#{config.root}/lib/validator)
  end
end

多数のファイルがある場合は、この方法を使うとrequire地獄から抜け出せます。

ただこの方法、完全に非推奨とは書かれていませんがあまりおすすめもされていません。

自動読み込みパスの配列は、config/application.rbのconfig.autoload_pathsを書き換えることで拡張可能ではありますが、やめておきましょう。

引用定数の自動読み込みと再読み込み (Zeitwerk) - Railsガイド

validate_eachメソッドの追加

email_validator.rbに戻ってvalidate_eachメソッドを追加します。

これはカスタムバリデーション用にRailsが用意しているメソッドです。

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    
  end
end

validate_eachメソッドの3つの引数

validate_eachメソッドの引数の中身を確認します。

デバッグbinding.pryを追加しましょう。

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    # 追加
    binding.pry
  end
end

仮ユーザーの保存

それではRailsコンソールに入って仮ユーザーを保存します。

root $ docker-compose run --rm api rails c

> user = User.new(name: "test", email: "test@example.com", password: "password")
> user.save

binding.pryを追加すると実行が止まるので、この状態で引数の中身を確認します。

    2: def validate_each(record, attribute, value)
    3:   # 追加
    4:   binding.pry
 => 5: end

record

ここにはユーザーオブジェクトが入ります。

メソッドの呼び出しなどに使います。

> record
=> #<User:0x0000560ec9db5aa0
 id: nil,
 name: "test",
 email: "test@example.com",
 password_digest: "[FILTERED]",
 activated: false,
 admin: false,
 created_at: nil,
 updated_at: nil>

attribute

これには属性が入ります。

この属性はエラーメッセージにも使われます。

> attribute
=> :email

value

ユーザーが入力した値が入ります。

この引数は文字数検証などに使います。

> value
=> "test@example.com"

ここまで確認取れたらデバッグから抜けましょう。

> exit

カスタムバリデーション設定

それでは実際にメールアドレスのバリデーションを3つ設定していきます。

1. メールアドレスは255文字まで

まずは文字数制限のバリデーション。email_validator.rbに追加してください。

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    # 追加
    # text length
    max = 255
    record.errors.add(attribute, :too_long, count: max) if value.length > max
  end
end

if value.length > max ... もし、入力値の文字数がmax（255）を超えた場合に、
record.errors.add(属性, メッセージ) ... バリデーションエラーを発生させます。
- attribute ... email属性を指定しています。
  
  属性を指定することで、「メールアドレスは...にしてください」という属性が入ったメッセージを表示することができます。
- :too_long, count: max ... エラーメッセージを指定しています。（次回記事にて追加）
  
  引数にcount:を持たせることで「255文字まで」というメッセージを出力することができます。

2. メールアドレスの書式チェック

書式をチェックするバリデーションを追加します。

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    ...
    # 追加
    # format
    format = /\A\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*\z/
    record.errors.add(attribute, :invalid) unless format =~ value
  end
end

=~ ... 文字列と正規表現が一致するかを判定するRubyの演算子。

もし不一致の場合にエラーが発生します。
format ... メールアドレスの書式チェック用正規表現。

この正規表現は、日本語メールなどの特殊なメールアドレスがエラーとなります。

3. アクティブなメールアドレスは1つのみ

一意性を保つバリデーションを追加します。

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
   ...
    # 追加
    # uniqueness
    record.errors.add(attribute, :taken) if record.email_activated?
  end
end

email_activated? ... 登録したメールアドレスと同じメールアドレスの認証済みユーザーが既にいる場合、trueを返すメソッド。

このバリデーションの目的は、メール認証済みのユーザーが何度も会員登録できないようにするためです。（下記で作成）

アクティブユーザーを判定するメソッドの作成

アクティブユーザーとは、メール認証が完了しアクティブフラグ（activated）がtrueとなっているユーザーのことです。

このアクティブユーザーは常に1人だけの状態にしないと、Railsがログインユーザーを正しく認識できません。

登録されたメールアドレスと同じメールアドレスのアクティブユーザーがいた場合にtrueを返すメソッドを作成します。

user.rbにメソッドを追加しましょう。

api/app/models/user.rb

require "validator/email_validator"

class User < ApplicationRecord
	...
	# ここ以下追加

  ## methods
  # class method  ###########################
  class << self
    # emailからアクティブなユーザーを返す
    def find_activated(email)
      find_by(email: email, activated: true)
    end
  end
  # class method end #########################

  # 自分以外の同じemailのアクティブなユーザーがいる場合にtrueを返す
  def email_activated?
    users = User.where.not(id: id)
    users.find_activated(email).present?
  end
end

find_activated(email) ... クラスメソッド。

Userクラスから呼び出します。

こちらは引数のメールアドレスと同じ、かつアクティブなユーザーを一人取り出します。
email_activated? ... インスタンスメソッド。

userオブジェクトから呼び出します。

自分と同じメールアドレスのアクティブなユーザーがいた場合にtrueを返します。

以上でメールアドレスのバリデーション設定が完了しました。

メールアドレスを検証前に小文字化する

ユーザーによってはメールアドレスを大文字で入力したり、意図せず大文字が混ざってしまったりする場合もあります。

Railsは同じメールアドレスでも大文字・小文字で違うものと判定するため一意性が保証できません。

そこでメールアドレスは検証前に全て小文字にするようuser.rbにbefore_validationを追加します。

api/app/models/user.rb

require "validator/email_validator"

class User < ApplicationRecord
  # Userクラスの一番上に追加
  # バリデーション直前
  before_validation :downcase_email


  ...
  
	# Userクラスの一番下に追加
  private

    # email小文字化
    def downcase_email
      self.email.downcase! if email
    end
end

before_validation :<メソッド名> ... バリデーション前に渡されたメソッドを実行する。
downcase! ... 文字列を小文字にして書き換える。（破壊的）

コンソールで確認してみよう

メールアドレスのバリデーションがうまくいっているかRailsコンソールで確認してみましょう。

root $ docker-compose run --rm api rails c

255文字以上だとでエラーを吐いているか

> domain = "@example.com"
> email = "a" * (256 - domain.length) + domain
> email.length
=> 256

> user = User.new(name: "test", email: email, password: "password")
> user.save
> user.errors.full_messages
=> ["メールアドレスは255文字以内で入力してください"]

不正な書式にエラーを吐いているか

> email = "test@example@com"
> user.email = email
> user.save
> user.errors.full_messages
=> ["メールアドレスは不正な値です"]

アクティブなユーザーがいた場合エラーを吐いているか

> email = "active@example.com"
> User.create(name: "active", email: email, password: "password", activated: true)

> user = User.new(name: "test", email: email, password: "password")
> user.save
> user.errors.full_messages
=> ["メールアドレスはすでに存在します"]

メールアドレスは小文字になっているか

> email = "TEST@test.COM"
> user = User.new(name: "test", email: email, password: "password")
> user.save
> user.email
=> "test@test.com"

OK!!ここまでの設定が全て正常に動いていますね。

コンソールから抜けましょう。

> exit

コミットしとこ

以上でカスタムバリデーション設定は終了です。

ここまでの変更をコミットしておききます。

root $ cd api
api  $ git add -A
api  $ git commit -m "add_email_custom_validation"
api  $ cd ..
root $ # 戻っておく

まとめ

今回はユーザーのemailカラムにカスタムバリデーションを設定しました。

バリデーションファイルを「lib」ディレクトリ以下に置いた場合、モデルファイルにrequireを設定してファイルを読み込みます。

user.rb

require "validator/email_validator"

ファイルが多くなってきた場合にはapplication.rbから一括読み込みを行います。

application/rb

config.autoload_paths += %W(#{config.root}/lib/validator)

これよくつまづきますからねー。要メモです。

次回は?

ユーザーのデモデータ、seedデータを投入していきます。

ユーザーデーブルにそれらしいデータが入りますよ。

お楽しみに！

最終的なコード

つまづいた方はこちらのコードをコピペしてください。

api/app/models/user.rb

require "validator/email_validator"

class User < ApplicationRecord
  before_validation :downcase_email

  # gem bcrypt
  has_secure_password

  # validates
  validates :name, presence: true,
                   length: { maximum: 30, allow_blank: true }
  validates :email, presence: true,
                    email: { allow_blank: true }
  VALID_PASSWORD_REGEX = /\A[\w\-]+\z/
  validates :password, presence: true,
                       length: { minimum: 8 },
                       format: {
                         with: VALID_PASSWORD_REGEX,
                         message: :invalid_password # 追加
                       },
                       allow_blank: true

  ## methods
  # class method  ###########################
  class << self
    # emailからアクティブなユーザーを返す
    def find_activated(email)
      find_by(email: email, activated: true)
    end
  end
  # class method end #########################

  # 自分以外の同じemailのアクティブなユーザーがいる場合にtrueを返す
  def email_activated?
    users = User.where.not(id: id)
    users.find_activated(email).present?
  end

  private

    # email小文字化
    def downcase_email
      self.email.downcase! if email
    end
end

api/lib/validator/email_validator.rb

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    # text length
    max = 255
    record.errors.add(attribute, :too_long, count: max) if value.length > max

    # format
    format = /\A\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*\z/
    record.errors.add(attribute, :invalid) unless format =~ value

    # uniqueness
    record.errors.add(attribute, :taken) if record.email_activated?
  end
end

← Prev

8. ユーザーモデル開発

3. Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)

8. ユーザーモデル開発

5. Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方

あなたの力になれること

私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる。そんな方に向けた単発・短期間メンターサービスを行っています。

独学プログラマのサービス

「独学プログラマ」の内容についてSlackで質問できますよ 0円/ALL FREE

【ココナラ】Rails、Nuxt.js周りの短期間・短時間メンターになります 5,500円/1h

Udemyの投稿