はじめに
こんにちは。アメリカ在住で独学エンジニアを目指している Taira です。
現在、Rails チュートリアルのアウトプットとしてアプリを製作しています。
Devise の実装が完了し、Mailer のテストコードを書いていたのですが、エラーが出てきて困っていました。
その時に私がとった対策を記事にしておこうと思いました。
問題のコード
class DeviseMailerTest < ActionMailer::TestCase
test 'confirmation_instructions' do
@user = users(:user1)
raw_token, enc_token = Devise.token_generator.generate(User, :confirmation_token)
@user.update(confirmation_token: enc_token)
mail = Devise::Mailer.confirmation_instructions(@user, raw_token) # メールを送信
assert_equal [@user.email], mail.to
assert_equal '（重要）アカウントの有効化について', mail.subject
assert_equal [Devise.mailer_sender], mail.from # from は config/initializers/devise.rb 内の config.mailer_sender を参照
assert_match @user.name, mail.body.encoded
escaped = CGI.escapeHTML(raw_token) # raw_token を HTML エンコード
assert_match escaped, mail.body.encoded
end
end
どこでエラーになるか？
このテストで include Rails.application.routes.url_helpers を書かない場合、
mail = Devise::Mailer.confirmation_instructions(@user, raw_token)
この行でエラーが発生します。
エラー内容の例
undefined method 'confirmation_url' for #<Devise::Mailer:...>NoMethodError: undefined method 'confirmation_url'
これは Devise の Mailer が確認メール本文を生成する際、内部で confirmation_url などのルートヘルパーを呼び出しているためです。
ルートヘルパー(url_helpers)とは？
Rails では routes.rb で定義されたルートごとに user_confirmation_url などのヘルパーメソッドが自動生成されます。
これらのヘルパーをコントローラやビューで使う場合は何も意識する必要はありませんが、
Mailer クラスやテストクラスで使いたい場合は Rails.application.routes.url_helpersを include する必要があります。
例
include Rails.application.routes.url_helpers
これをテストクラスや Mailer クラスに書くことで、
-
user_confirmation_urlなどのメソッドが使えるようになります。
まとめ
- Devise::Mailer がメール本文を生成する際、ルートヘルパー（confirmation_url など）を内部で呼び出す
- そのため、テストやカスタム Mailer では
include Rails.application.routes.url_helpersを忘れると NoMethodError になる - テストや Mailer を実装するときは必ず include することを意識しよう
参考リンク