factory_bot 技术文档

1. 安装指南

使用 Bundler 安装

如果你使用 Bundler 来管理你的 Ruby 项目依赖，可以通过以下命令将 factory_bot 添加到你的 Gemfile 中：

bundle add factory_bot

手动安装

你也可以直接从命令行手动安装 factory_bot ：

gem install factory_bot

支持的 Ruby 版本

factory_bot 支持的 Ruby 版本可以在项目的 .github/workflows/build.yml 文件中查看。

2. 项目的使用说明

factory_bot 是一个用于替代传统 fixtures 的工具，它提供了简洁的定义语法，支持多种构建策略（保存的实例、未保存的实例、属性哈希和存根对象），并且支持为同一类创建多个工厂（例如 user、admin_user 等），包括工厂继承。

基本用法

1. 定义工厂： 你可以通过以下方式定义一个工厂：

   FactoryBot.define do
     factory :user do
       name { "John Doe" }
       email { "[e-mail]" }
     end
   end
   

2. 创建实例： 使用 create 方法创建一个保存到数据库的实例：

   user = FactoryBot.create(:user)
   

3. 构建未保存的实例： 使用 build 方法创建一个未保存的实例：

   user = FactoryBot.build(:user)
   

4. 获取属性哈希： 使用 attributes_for 方法获取一个属性哈希：

   attrs = FactoryBot.attributes_for(:user)
   

5. 存根对象： 使用 build_stubbed 方法创建一个存根对象：

   user = FactoryBot.build_stubbed(:user)
   

工厂继承

你可以通过继承现有工厂来创建新的工厂：

FactoryBot.define do
  factory :admin_user, parent: :user do
    admin { true }
  end
end

3. 项目API使用文档

主要API方法

• FactoryBot.create(name, *traits, &block)：创建并保存一个实例。
• FactoryBot.build(name, *traits, &block)：创建一个未保存的实例。
• FactoryBot.attributes_for(name, *traits, &block)：返回一个属性哈希。
• FactoryBot.build_stubbed(name, *traits, &block)：返回一个存根对象。
• FactoryBot.define(&block)：定义一个新的工厂。

示例

# 创建一个保存的实例
user = FactoryBot.create(:user)

# 创建一个未保存的实例
user = FactoryBot.build(:user)

# 获取属性哈希
attrs = FactoryBot.attributes_for(:user)

# 创建一个存根对象
user = FactoryBot.build_stubbed(:user)

4. 项目安装方式

使用 Bundler

将 factory_bot 添加到你的 Gemfile 中：

gem 'factory_bot'

然后运行：

bundle install

手动安装

直接从命令行安装：

gem install factory_bot

通过以上步骤，你可以成功安装并使用 factory_bot 来简化你的测试数据管理。