FactoryBot コールバックを利用したcreate_listについて(everyday rails - rspecによるrailsテスト入門)

Question

everyday rails - rspecによるrailsテスト入門 150ページ目

FactoryBot.define do

 factory :project do
   sequence(:name) { |n| "Test Project#{n}"}
   description {"Sample project for testing purposes"}
   due_on 1.week.from_now
   association :owner

   trait :with_notes do
     after(:create){ |project| create_list(:note, 5, project: project)}
   end
end
end

上記、traitのwith_notesはコールバックによってオブジェクト作成後、

noteを５個作成するまでは理解したのですが、ブロック内の|project| や　

project: projectの意味が、理解出来ません。

|project|は、factory :projectのオブジェクトが入り、project: projectでは、

渡されたオブジェクトをオーバーライドする感じでよろしいのでしょうか？

Answer 1

「Everyday Rails - RSpecによるRailsテスト入門」翻訳者チームの伊藤です。
Everyday Railsを読んでいただき、どうもありがとうございます。
ご質問の件について、できるだけ詳しく説明してみますね。

なお、以下のサンプルコードはEveryday RailsのGitHubリポジトリから抜粋しています。
https://github.com/everydayrails/everydayrails-rspec-2017

ブロック内の|project|

これはFactoryBotによってcreateされたProjectのインスタンスが渡されます。

もしproject = FactoryBot.create :project, :with_notes, name: 'Foo' というコードがあれば、まずFactoryBot.create :project, name: 'Foo'を呼びだしたのと同じようにProjectのインスタンスが作成され、そのインスタンスがtrait :with_notesの中の|project|に渡ってきます。

project: project

これはcreate_listメソッドで作成されるNoteクラスのインスタンスに関連するProjectクラスのインスタンスの指定です。
Noteクラスの定義は次のようになっているので、何らかのProjectに属する必要があります。

class Note < ApplicationRecord
  belongs_to :project
  belongs_to :user

  # ...

つまり、FactoryBot.create :project, :with_notesをtraitなしで書こうとすると、こんなイメージになります。

project = FactoryBot.create :project
5.times do
  FactoryBot.create :note, project: project
end

なお、ProjectとNoteのファクトリは以下のような定義になっています。

FactoryBot.define do
  factory :project do
    sequence(:name) { |n| "Project #{n}" }
    description "A test project."
    due_on 1.week.from_now
    association :owner

    trait :with_notes do
      after(:create) { |project| create_list(:note, 5, project: project) }
    end

    # ...
  end
end

FactoryBot.define do
  factory :note do
    message "My important note."
    association :project
    user { project.owner }

    trait :with_attachment do
      attachment { File.new("#{Rails.root}/spec/files/attachment.jpg") }
    end
  end
end

FactoryBotをまったく使わずに書くなら、次のようなイメージになります。

owner = User.create!(
  first_name: "Aaron",
  last_name: "Sumner",
  email: "[e-mail]",
  password: "dottle-nouveau-pavilion-tights-furze"
)

project = Project.create!(
  name: "Project 1",
  description: "A test project.",
  due_on: 1.week.from_now,
  owner: owner
)

5.times do
  Note.create!(
    message: "My important note.",
    project: project,
    user: project.owner
  )
end

こんな説明でいかがでしょうか？
何か不明な点があればまたご質問ください。

追記

あ、たしかにFactoryBot.を付け忘れてましたね。すいません。コードの方は修正しておきました。
ちなみにspec/rails_helper.rbにconfig.include FactoryBot::Syntax::Methodsという設定を入れておくとFactoryBot.が省略できます。（参考）
僕はふだんこのスタイルでFactoryBotを使ってます。

コメントに載っていたコードですが、

it "userが作成されたらprojectが５個作成される" do
  project = FactoryBot.create(:user, :with_projects)
  expect(project.projects.length).to eq 5
end

は、

it "userが作成されたらprojectが５個作成される" do
  user = FactoryBot.create(:user, :with_projects)
  expect(user.projects.length).to eq 5
end

というように変数名をuserにした方がわかりやすいと思いました。
それ以外はOKだと思います????

Comments

[Yamken]

伊藤さん有難うございます！ブロック内のprojectの意味わかりました！
自分なりに変えてテストを作成しました。
テスト
it ”userが作成されたらprojectが５個作成される” do
project = FactoryBot.create(:user, :with_projects)
expect(project.projects.length).to eq 5
end

ファクトリー
trait :with_projects do
after(:create) { |user| create_list( :project, 5, owner: user)}
end
にするとテストがgreenになり、|user|は作成されたUserインスタンス
owner: userは、Projectクラスに関連されたownerという認識です。

ちなみにtrait無しで書く、
project = FactoryBot.create :project
5.times do
create :note, project: project
end
ですが、timesメソッドのcreateの部分が　
NoMethodError:
undefined method `create' for #<RSpec::ExampleGroups::Project:0x00007fa24b8f1f70>
と出ますので、createにFactoryBot.createをつけ

project = FactoryBot.create :project
5.times do
FactoryBot.create :note, project: project
end
にすると、エラーが出なくなりました！
また、FactoryBotを使わないテストも教えて頂いて有難うございます、
色々な方法試してみます！

[Yamken]

そういう設定があったんですね、早速入れてみます！
確かに変数名userにしたほうがわかりやすいですね、projectが多くてなんだか違和感があったので、すっきりしました、ありがとうございます！