RSpec FactoryBot【応用編】：関連付け・Trait・コールバック活用術

2025年4月21日

【入門編】では、FactoryBotの基本的な使い方とファクトリ定義を学びました。テストデータ作成が少し楽になったのではないでしょうか？

Trait (トレイト) ：ファクトリの状態を部品化する

Traitは、ファクトリの特定の「状態」や「属性のバリエーション」を再利用可能な部品として定義する機能です。これを活用すると、ファクトリ定義が非常に柔軟かつDRYになります。

Traitとは？

属性の変更やコールバック処理などを trait :名前 do ... end で定義します。
ファクトリ呼び出し時に create(:user, :admin, :inactive) のように複数のTrait名を指定することで、それらの特徴をオブジェクトに「ミックスイン」できます。

Traitのメリット:

DRY: 共通の設定（例: 管理者フラグを立てる）をTraitにまとめ、重複コードを削減。
可読性: オブジェクトがどのような状態か（管理者か、非アクティブかなど）が明確になる。
柔軟性: 必要なTraitを組み合わせることで、多様なテストデータパターンを簡単に生成。

定義方法:

# spec/factories/users.rb
factory :user do
  name { Faker::Name.name }
  sequence(:email) { |n| "user_#{n}@example.com" }
  admin { false }      # デフォルト値
  activated { true }   # デフォルト値

  # 管理者状態を表すTrait
  trait :admin do
    admin { true }
  end

  # 非アクティブ状態を表すTrait
  trait :inactive do
    activated { false }
  end

  # プロフィールを持つ状態を表すTrait (関連付けを含む)
  trait :with_profile do
    after(:create) do |user, evaluator|
      create(:profile, user: user) # Profileを作成して紐付け
    end
  end
end

使い方: ファクトリ名の後にシンボルで指定します。

# 通常ユーザー
user = create(:user)

# 管理者ユーザー
admin_user = create(:user, :admin)

# プロフィールを持つ非アクティブな管理者ユーザー
complex_user = create(:user, :admin, :inactive, :with_profile)

TraitはFactoryBotの応用において中心的な機能です。状態の表現には積極的にTraitを活用しましょう。

Transient Attribute：一時的な値でファクトリを制御する

Transient Attribute（一時的な属性）は、ファクトリ呼び出し時に値を渡せるものの、最終的なモデルオブジェクトの属性にはならない一時的な変数です。主にコールバック処理の挙動を外部からコントロールするために使います。

Transient Attributeとは？

transient do ... end ブロックで定義します。
モデルの属性ではない情報（例: 生成する関連データの数）をファクトリに渡したい場合に便利です。

定義方法と使い方:

# spec/factories/posts.rb
factory :post do
  title { Faker::Lorem.sentence }
  user

  # 一時的な属性を定義 (コメント数と、タグ付けするかどうかのフラグ)
  transient do
    comments_count { 0 }  # デフォルトは0件
    add_tags { false } # デフォルトはタグ付けしない
  end

  # コールバック内で一時的な属性を参照
  after(:create) do |post, evaluator|
    # evaluator.属性名 で値にアクセスできる
    if evaluator.comments_count > 0
      create_list(:comment, evaluator.comments_count, post: post) # 仮: Commentを作成
    end

    if evaluator.add_tags
      # create_list(:tag, 2, posts: [post]) # 仮: Tagを作成して紐付け
      puts "Tags added to post #{post.id}"
    end
  end
end

# 呼び出し時に一時的な属性の値を指定

# 5つのコメントを持つ投稿を作成
create(:post, comments_count: 5)

# タグ付きの投稿を作成
create(:post, add_tags: true)

# 3つのコメントを持ち、タグも付ける投稿を作成
create(:post, comments_count: 3, add_tags: true)

Transient Attributeを使うことで、ファクトリの汎用性を高め、呼び出し側で柔軟に挙動を調整できます。

コールバック (Callback) ：特定のタイミングで処理を実行

コールバックは、FactoryBotがオブジェクトを生成する特定のタイミング（DB保存前後など）で、追加の処理を実行するための仕組みです。

主なコールバック:

after(:build): オブジェクトが build された直後 (DB保存前) に実行。
before(:create): オブジェクトが create される直前 (DB保存前) に実行。
after(:create): オブジェクトが create された直後 (DB保存後) に実行。最もよく使われる。

使い方: コールバック名 do |オブジェクト, evaluator| ... end で定義します。

# spec/factories/orders.rb (Orderモデルを仮定)
factory :order do
  user
  ordered_at { Time.current }

  transient do
    mark_as_shipped { false }
  end

  # Order作成後に実行
  after(:create) do |order, evaluator|
    # デフォルトで関連するOrderItemを1つ作成 (仮)
    create(:order_item, order: order)

    # もし mark_as_shipped が true なら、ステータスを更新
    if evaluator.mark_as_shipped
      order.update!(status: 'shipped', shipped_at: Time.current)
      puts "Order #{order.id} marked as shipped."
    end
  end
end

# 呼び出し例

# 通常の注文を作成 (OrderItemも1つ作成される)
create(:order)

# 作成と同時に発送済みにする注文
create(:order, mark_as_shipped: true)

注意点:
コールバック、特に after(:create) は非常に便利ですが、多用するとファクトリの挙動が複雑になり、テストの実行速度が低下する可能性があります。
処理が複雑になる場合は、TraitやTransient Attribute、あるいはテストコード側での明示的なデータ作成を検討しましょう。シンプルさを保つことが重要です。

ファクトリの継承：共通定義を引き継ぐ

継承は、既存のファクトリ（親）の定義を引き継ぎ、一部を変更・追加して新しいファクトリ（子）を作る機能です。共通の基盤を持つファクトリ群（例: User, AdminUser）をDRYに定義するのに役立ちます。

定義方法: 子ファクトリで parent: :親ファクトリ名 オプションを指定します。子は親の属性やTraitを引き継ぎ、同名属性は上書きされます。

# spec/factories/users.rb
# 親ファクトリ
factory :user do
  name { Faker::Name.name }
  sequence(:email) { |n| "user_#{n}@example.com" }
  role { "general" }
end

# :user を継承した子ファクトリ (:admin)
factory :admin, parent: :user do
  # role 属性を上書き
  role { "admin" }

  # 子ファクトリ独自の属性を追加
  admin_privilege { true }
end

# 呼び出し例
user = create(:user)     # role: "general"
admin = create(:admin)   # role: "admin", admin_privilege: true

Traitとの使い分け:
以前はよく使われましたが、現在ではTraitの方が柔軟性が高く、推奨されることが多いです。明確な「is-a」関係があり、構造をシンプルにしたい場合に継承を検討する、という使い分けが良いでしょう。多くの場合、Traitの組み合わせで同様のことが実現できます。

まとめ：応用テクニックでFactoryBotを使いこなそう！

この【応用編】では、FactoryBotをさらに深く活用するための以下のテクニックを解説しました。

関連付け: モデル間のリレーションを簡単に扱う。
Trait: 状態やバリエーションを部品化し、柔軟に組み合わせる。
Transient Attribute: ファクトリの挙動を外部から制御する。
コールバック: 特定のタイミングで追加処理を行う（ただし慎重に）。
継承: 共通定義を引き継ぐ（Traitの方が推奨されることが多い）。

これらの機能を理解し、適切に使い分けることで、テストデータ作成はさらに効率的になり、テストコード全体の可読性や保守性も向上します。

次のステップ:
FactoryBotを使いこなせるようになったら、次はRSpecテスト全体の中でどのように活用し、テストコードをさらに改善していくかを見ていきましょう。

【実践編】では、RSpecでの効果的な使い方、テストのパフォーマンス改善、デバッグ方法、そしてFactoryBotのベストプラクティスについて解説します。

未経験からエンジニアへ転職！おすすめの転職サービスはこちら

「未経験だけどエンジニアになりたい…」「IT業界に興味があるけど、どこから始めるべきかわからない…」
そんな方におすすめなのが、プログラミングスクールを活用した転職活動です。
実績豊富なスクールを利用すれば、未経験からでもエンジニアとしての転職がぐっと近づきます！

Harmonia

初心者向けプログラミングスクールおすすめを徹底比較！初心者が安心して学べるおすすめのプログラミングスクールを厳選紹介！料金や口コミ、転職支援などを徹底比較しました。失敗しないスクール選びのポイントも解説。

この記事が気に入ったら
フォローしてね！

Follow @blue3orz Follow Me

よかったらシェアしてね！

URLをコピーしました！

URLをコピーしました！