Udemy 8. ユーザーモデル開発 #05
2020年07月14日に公開

Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方

今回達成すること

ユーザーテーブルにSeedデータを投入します。

また、「開発」「テスト」「本番」の3つの環境でSeedデータを切り替える方法もご紹介します。

Seedデータとは?

Seedデータとは、テーブルに保存するデモデータのことです。

このデータはアプリケーションの動作確認用データとして扱われます。

Seedデータは、Railsのseeds.rbにデータ生成用コードを書くことによって、一度に大量のデモデータを生成できます。

環境ごとにSeedデータを切り替える

「開発環境にデモデータを投入したいけど、本番環境にはデータは投入したくない」

「テスト環境だけ大量にデモデータを投入したい」

など、環境ごとにデータを切り替えたい場面があります。


ただその都度データ生成用のコードを書き換えるのは大変。。。

そこで「開発」「テスト」「本番」の3つのディレクトリを用意し、環境ごとに読み込むファイルを切り替える設定を行います。

環境ごとのディレクトリを作成する

まずは「db」ディレクトリに「seeds」ディレクトリを作成し、その中に環境ごとのディレクトリを作成します。

root $ mkdir api/db/seeds && mkdir $_/{test,development,production}

ディレクトリ構造は以下のようになりました。

api/db
├── migrate
│   └── 20200708014630_create_users.rb
├── schema.rb
├── seeds
│   ├── development
│   ├── production
│   └── test
└── seeds.rb

seeds.rbの編集

続いてseeds.rbに、環境ごとに読み込みファイルを切り替える実装を行います。

api/db/seeds.rb
table_names = %w(
  users
)

table_names.each do |table_name|
  path = Rails.root.join("db/seeds/#{Rails.env}/#{table_name}.rb")

  # ファイルが存在しない場合はdevelopmentディレクトリを読み込む
  path = path.sub(Rails.env, "development") unless File.exist?(path)

  puts "#{table_name}..."
  require path
end

table_names = %w(users)

まず読み込みたいファイル名の配列を作成します。

> table_names
=> ["users"]

path = Rails.root.join(“db/seeds/#{Rails.env}/#{table_name}.rb”)

配列をループしてファイルパスを作成します。

> path
=> #<Pathname:/app/db/seeds/development/users.rb>

Rails.env

今現在の環境を文字列で返します。

> Rails.env
=> "development"

unless File.exist?(path)

パスにファイルが存在しない場合

> File.exist?(path)
=> false

path = path.sub(Rails.env, “development”)

「development」ディレクトリを参照するようpathを書き換えます。

> path
=> #<Pathname:/app/db/seeds/development/users.rb>

puts “#{table_name}…”

現在の読み込みファイルをターミナルに出力します。

> puts "#{table_name}..."
users...

require path

Rubyのrequireメソッドでファイルを読み込みます。

require path

以上で環境ごとに読み込むファイルを切り替えることができます。

(コラム)文字列書き換えメソッド「sub」と「gsub」の違い

  • sub最初に一致した文字列を書き換えます。
  • gsub … gはグローバルの略で一致する全ての文字列を書き換えます。
"abcabc".sub(/abc/, "")
=> "abc"

> "abcabc".gsub(/abc/, "")
=> ""

参考 Ruby文字列のgsubメソッドとsubメソッドの違いは何ですか - Stack Overflow

(コラム終わり)

Seedデータ生成ファイルを作成する

ユーザーSeedデータを生成するusers.rbを作成しましょう。

今回は「developmentディレクトリ直下だけに作成します。

root $ touch api/db/seeds/development/users.rb

10人のユーザーを生成します。

api/db/seeds/development/users.rb
10.times do |n|
  name = "user#{n}"
  email = "#{name}@example.com"
  user = User.find_or_initialize_by(name: name, email: email, activated: true)

   if user.new_record?
     user.password = "password"
     user.save!
   end
end

puts "users = #{User.count}"
  • find_or_initialize_by

    ユーザーテーブルをfind_by(email: email, activated: true)で検索する。

    • ユーザーが存在する場合 … ユーザーオブジェクトを返す。
    • 存在しない場合 … 新しいユーザーオブジェクトを作成する。
  • if user.new_record? … もしuserが新規作成オブジェクトだった場合、
  • user.password = "password" ... … パスワードをセットして保存。

これでSeedデータの準備が整いました。

ユーザーSeedデータを投入する

Railsは、seeds.rbをコマンドで操作することができます。

Seedデータを追加で投入したい時
$ rails db:seed
今あるSeedデータを全て削除して、新たに投入したい時
$ rails db:reset

今回はバリデーションでデモユーザーを作成したので、全てリセットして新たにユーザーを投入します。

resetコマンドを実行しましょう。

root $ docker-compose run --rm api rails db:reset

...
users...
users = 10

Railsコンソールに入って確認してみましょう。

root $ docker-compose run --rm api rails c

> User.all

+----+-------+-------------------+-------------------------+-----------+-------+-------------------------+-------------------------+
| id | name  | email             | password_digest         | activated | admin | created_at              | updated_at              |
+----+-------+-------------------+-------------------------+-----------+-------+-------------------------+-------------------------+
| 1  | user0 | user0@example.com | $2a$12$kljilHAWmLjYD... | true      | false | 2020-07-14 11:09:03 ... | 2020-07-14 11:09:03 ... |
| 2  | user1 | user1@example.com | $2a$12$QMSnQWBXBuSUs... | true      | false | 2020-07-14 11:09:04 ... | 2020-07-14 11:09:04 ... |
| 3  | user2 | user2@example.com | $2a$12$i1KuI4xNFCvks... | true      | false | 2020-07-14 11:09:04 ... | 2020-07-14 11:09:04 ... |
...

10人のユーザーデータの確認が取れたら成功です。

コンソールから抜けましょう。

コミットしとく

これでユーザーSeedデータが用意できました。

ここまでの変更をコミットしておきましょう。

root $ cd api
api  $ git add -A
api  $ git commit -m "add_seed_data_users"
api  $ cd ..
root $

まとめ

今回は環境ごとにSeedデータを切り替えるセッティングを行いました。

編集したseeds.rbは、環境ごとの新たなファイルを作成すれば自動で読み込まれ、ファイルがない場合は開発環境と同じファイルを読み込みます。

この回では、「test」「production」ディレクトリにseedファイルを作成しませんが、興味がある方は是非ファイルを作成しSeedデータを切り替えてみてください。

次回は?

ここまでにユーザーテーブル、Seedデータが整いましたが、まだバリデーションが正しく動いているかテストをしていませんね。

そこで次回はテスト環境を整えていきます。

どうぞ👇下へ。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】このカテゴリーで作るアプリケーションの仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. 認証アプリのレイアウト設計 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. 認証アプリのレイアウト設計 #02
ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
新着
10. 認証アプリのレイアウト設計 #03
ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
新着
10. 認証アプリのレイアウト設計 #04
addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
新着
10. 認証アプリのレイアウト設計 #05
ウェルカムページをレスポンシブデザインに対応させよう(4/4)
新着
SPA開発
ブログ構築
小ネタ集