[Rails 3] deviseで使うモデルにfind_by_で始まる名前のscopeを定義するとrake db:migrate:resetが通らない

rake db:migrate:resetが通らないという現象に見舞われました。

現象

エラーメッセージは

rake aborted!
Mysql2::Error: Table ‘myproject.users’ doesn’t exist: SHOW FIELDS FROM users

環境は Rails 3.1.0 + Ruby 1.9.2 + devise 1.5.0 です。

原因

原因は、Userモデルに定義した次のスコープでした。

# app/models/user.rb
class User < ActiveRecord::Base
  scope :find_by_hoge, lambda{|val|
   joins(:foo).where("foos.hoge_id" => val
  }
end

# config/routes.rb
devise_for :users

検索を便利に使うためのnamed scopeですが、これがfind_by_*という名前になってしまっていたのが原因です。

stacktraceを追うとわかるのですが、

  • rake db:migrate:resetを起動
  • db初期化される
  • rake起動のためにroutes.rbが読まれる
  • devise_forが実行される
  • 引数を元にroutingを調べるためのUserモデルが読まれる
  • scopeを発見
  • active_record/named_scope.rbのvalid_scope_name?が実行される
  • DynamicFinderMatch.matchが呼ばれる
  • find_by_*に一致するのでattribute一覧とconflictしないかチェックされる
  • attribute一覧を調べるためにMySQLに接続される
  • usersテーブルはまだ無い
  • エラー

といった流れが発生していました。

Railsでfind_by_*find_all_by_*などのメソッドは自動生成されるので、scopeが衝突するとワーニングを出す機能があるのですが、そのチェック箇所で上記現象が発生しています。

解決方法

そもそもscopeでfind_byだと、名前的にActiveRecord::Baseが返ってくると思いきやActiveRecord::Relationが返ってきて混乱するので、scopeの名前はfind_by_*にしてはいけないということですね。

同様に、
* scoped_by_*
* find_all_by_*
* find_last_by_*
* find_or_create_by_*
* find_or_initialize_by_*

でも同じ問題が発生します。

わかりやすくて衝突しない名前に変更しましょう。

デザインも頼めるシステム開発会社をお探しならBPS株式会社までどうぞ 開発エンジニア積極採用中です! Ruby on Rails の開発なら実績豊富なBPS

この記事の著者

baba

ゆとりプログラマー。 高校時代から趣味でプログラミングを初め、そのままコードを書き続けて現在に至る。慶應義塾大学環境情報学部(SFC)卒業。BPS設立初期に在学中から参加している最古参メンバーの一人。Ruby on Rails、PHP、Androidアプリ、Windows/Macアプリ、超縦書の開発などを気まぐれにやる。軽度の資格マニアで、情報処理技術者試験(16区分17回 + 情報処理安全確保支援士試験)、技術士(情報工学部門)、Ruby Programmer Gold、AWSソリューションアーキテクト(アソシエイト)、日商簿記2級、漢検準1級などを保有。

babaの書いた記事

夏のTechRachoフェア2019

週刊Railsウォッチ

インフラ

ActiveSupport探訪シリーズ