Skip to content

docs: add factory usage quickstart #1831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomatotomata wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add factory usage quickstart #1831

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,26 @@ To install the gem manually from your shell, run:
gem install factory_bot
```

## Quick Start

Define a factory for a model in `spec/factories/users.rb`:

```ruby
FactoryBot.define do
factory :user do
name { "Jane Doe" }
email { "jane@example.com" }
end
end
```

Use the factory in a test or other Ruby code:

```ruby
user = FactoryBot.build(:user) # Build an in-memory user.
saved_user = FactoryBot.create(:user) # Persist a user through the model layer.
```

## Supported Ruby versions

Supported Ruby versions are listed in `.github/workflows/build.yml` ([source](https://github.com/thoughtbot/factory_bot/blob/main/.github/workflows/build.yml))
Expand Down