Factory Bot
A cheatsheet by @rstacruz|Refreshed 7 months ago.Refresh|View source on Github

Introduction

Introduction

Factory Bot is a helper for writing factories for Ruby tests. It was previously known as Factory Girl. For older versions, use FactoryGirl instead of FactoryBot.

Defining factories

Defining factories

FactoryBot.define do
  factory :user do
    first_name { 'John' }
    last_name  { 'Doe' }
    birthdate  { 21.years.ago }
    admin { false }

    sequence(:username) { |n| "user#{n}" }
  end
end

See: Defining factories

Extra options

Extra options

Custom class names

factory :user, class: 'User' do
  ···
end

Aliases

factory :user, aliases: [:author] do
  ···
end

Using

Using

Build a model

FactoryBot.build(:user)

Other ways

build(:user)           # → model (not saved)
create(:user)          # → model (saved)
attributes_for(:user)  # → hash
build_stubbed(:user)   # stubbed out attributes

With options

build(:user, name: 'John')

Lists

create_list(:user, 3)
build_list(:user, 3)

Defining

Defining

factory :post do
  association :author, factory: :user
  association :author, factory: [:user, :admin]
end

or

factory :post do
  author  # assumes there's a factory :author
end

After-create hooks

After-create hooks

factory :post do
  after :create do |post|
    create :theme, post: post             # has_one
    create_list :comment, 3, post: post   # has_many
  end
end

Traits

Traits

factory :user do
  trait :admin do
    admin { true }
  end
end
create :user, :admin

Traits allow you to group attributes together.
See: Traits

Nested factories

Nested factories

factory :user do
  first_name { 'John' }

  factory :sample_user do
    first_name { FFaker::Name.first_name }
  end
end
create :sample_user

See: Inheritance

Sub-factories

Sub-factories

factory :user do
  ···
end
factory :sample_user, parent: :user do
  first_name { FFaker::Name.first_name }
end
create :sample_user

Works the same as nested factories.

Options (transients)

Options (transients)

factory :user do
  transient do
    upcased { true }
  end

  after :create do |user, options|
    user.name.upcase! if options.upcased
  end
end
create(user, upcased: true)

Transient attributes will not get passed to the model, but will be available in after-create hooks.
See: Transient attributes

Paths

Paths

  • test/factories.rb
  • spec/factories.rb
  • test/factories/*.rb
  • spec/factories/*.rb

Place your factories in these locations.

This cheat sheet can be found in the following categories: