【Rails】マイグレーションの書き方《Seed篇》

はじめに

Railsには、マイグレーションで作成したデータベーススキーマにテストデータを登録する機能が用意されています。それがSeedと呼ばれるものです。Seedはテストデータを登録する処理をRubyで記述し、コマンドを実行することでデータベースにテストデータを登録することができます。

Seedを使うと、大量のデータを少しの記述とコマンド実行だけで登録することができますし、一度処理を書いてしまえば何度でも使えるので、データベースをリセットしてデータを再登録する必要がある場合に便利です。

なお、マイグレーションファイルの作成・編集については以下の記事をご覧ください。

また、マイグレーションの実行については以下の記事をご覧ください。

Seedでテストデータを登録

Seedの処理はdb/seeds.rbに記述していきます。テストデータを登録する処理を記述したら、以下のコマンドを実行することでテストデータを登録できます。

$ rails db:seed

基本の書き方

最もベーシックな書き方は以下の通りです。

Article.create!(
  title: 'タイトル',
  content: '本文',
  image: File.open('app/assets/images/test.jpg')
)

もしデータ登録時にバリデーションエラーが発生した場合、createだとfalseが返却されます。create!だとActiveRecord::RecordInvalidという例外を発生させてくれます。こちらのほうがバリデーションエラーが発生してデータ登録ができなかったということがわかりやすいので、特別な事情がない限りcreate!を使ったほうがベターでしょう。

imageのようにファイルを登録することもできます。なお、ファイルの登録にActiveStorageを使っている場合のデータ登録方法は後述します。

複数データ

繰り返し処理を使って大量のデータを一気に登録することができます。

100.times do |i|
  Article.create!(
    title: "タイトル#{i + 1}",
    content: '本文',
    image: File.open('app/assets/images/test.jpg')
  )
end

一意制約を設定しているカラムには#{i + 1}を付け足す必要があります。

関連付けデータ

モデル同士で関連付け設定をしているデータは、以下のように記述します。

Article.all.each do |article|
  article.comments.create!(
    name: '名前',
    content: 'コメント本文'
  )
end

関連付けモデルの子データを登録する処理の前に、親データを登録する処理を記述しておく必要があります(逆に記述していてもエラーにはなりませんが子データは登録されません)。

ActiveStorageのデータ

ファイルの登録にActiveStorageを使っている場合、以下のように記述します。

article = Article.create!(
  title: 'タイトル',
  content: '本文'
)

article.image.attach(io: File.open(Rails.root.join('app/assets/images/test.jpg')), filename: 'test.jpg')

一度データを登録した後、attachメソッドを使ってファイルを登録します。

deviseのユーザーデータ

deviseとは、ユーザー登録や認証といった認証系の処理をひとまとめに提供してくれる便利なGemです。deviseで使用するユーザーテーブルにテストデータを登録するには、以下のように記述します。

User.create!(
  email: 'test@example.com',
  password: 'password'
)

実際にはdeviseで使用するユーザーテーブルにpasswordカラムはありませんが、passwordにパスワードを登録することによってパスワードは暗号化され、password_digestというカラムに登録されます。

まとめ

Seedは大量のテストデータを登録する必要がある場合や、データベースをリセットしたときに再度テストデータを登録する必要があるときに便利です。しかし、モデルを変更したときにはそれにあわせてSeedも変更する必要があるのでご注意ください。

本記事を参考にして、Seedの使い方について覚えていただければと思います。

関連記事

【Rails】ダウンロードしたフリーフォントをWebpackerを使って導入する方法
# はじめに Webサイトのデザインを彩るひとつの要素にフォントの種類があります。Google Fontsの登場により、様々なフォントが手軽に導入できるようになりました。しかし、世の中にはGoogle Fontsが提供するフォント以外にもたくさん [...]
2021年10月16日 13:26
【Rails】mimemagicに依存しているRailsアプリでbundle installコマンドが失敗する事象の対処法
# はじめに Railsアプリで`bundle install`コマンドを実行しようとしたところ、以下のエラーメッセージが出力されコマンドに失敗しました。 ``` Your bundle is locked to mimemagic (0 [...]
2021年10月14日 14:44
【Rails】macOSのアップデート後にrailsコマンドが失敗する事象の対処法
# はじめに 久しぶりにRailsアプリに手を入れようと思い、`rails server`コマンドを実行してRailsサーバーを立ち上げようとしたところ、エラーが出て起動に失敗してしまいました。 前回までの間にしたことの中で思い当たることと [...]
2021年10月14日 12:11
【Rails】Railsアプリのデバッグ《マルチデバイス篇》
# はじめに 近年のWebアプリはレスポンシブ対応が当たり前になっています。最低でもPCとスマートフォンに対応したデザイン、ときにはその中間のタブレットに対応したデザインなんかも作成する必要があります。 Webアプリの開発はPCを使って行う [...]
2021年5月23日 13:02
【Rails】Railsアプリのデバッグ《Better Errors篇》
# はじめに Railsアプリの開発中になんらかのエラーが発生すると、デフォルトでは以下のような画面が表示されます(画像をクリックすると拡大します)。 <a class="gallery" data-group="gallery" href [...]
2021年5月22日 19:42