【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の使い方について覚えていただければと思います。

関連記事

【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58