【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】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
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01
【Rails】IDとパスワードによる認証機能の実装【初学者】
# はじめに 大抵のWebアプリでは、ユーザー登録/解除、ログイン/ログアウトといった認証機能を持っています。Railsには簡単に認証機能を導入できる「device」というGemが用意されています。「devise」は多くのRailsアプリで使われ [...]
2021年11月27日 13:00