Cucumber.Factory 项目技术文档

本文档旨在帮助用户安装、使用并详细了解 Cucumber.Factory 项目。以下是项目的主要内容：

1. 安装指南

在项目的 Gemfile 文件中添加以下代码：

gem 'cucumber_factory'

然后创建一个名为 features/step_definitions/factory_steps.rb 的文件，并在其中添加以下内容：

require 'cucumber_factory/add_steps'

接着运行以下命令安装依赖项并重启服务器：

bundle install

2. 项目的使用说明

Cucumber.Factory 允许用户直接从 Cucumber 特性文件中创建 ActiveRecord 对象，无需定义步骤。

基本用法

使用 Given there is 开头创建具有默认属性的新记录：

Given there is a movie

创建记录时，cucumber_factory 将根据可用选项调用 FactoryBot.create(:movie)、FactoryGirl.create(:movie)、Movie.make、Movie.create! 或 Movie.new。

使用引号字符串和数字表示属性值：

Given there is a movie with the title "Sunshine" and the year 2007

更新现有记录时，指定记录和更改内容：

Given the movie above has the title "Sunset" and the year 2008
Given the movie "Sunrise" has the year 2009

可以使用 above 关键字指定最近创建的记录，或使用创建时使用的任何字符串。

设置布尔属性

通过在末尾添加 which、that 或 who 来设置布尔属性：

Given there is a movie which is awesome
And there is a movie with the name "Sunshine" that is not a comedy
And there is a director who is popular

可以使用 and、but 或逗号连接句子：

Given there is a movie which is awesome, popular and successful but not science fiction
And there is a director with the income "500000" but with the account balance "-30000"

更新布尔属性时使用 is 关键字：

Given the movie above is awesome but not popular
Given the movie above has the year 1979 but is not science fiction

使用表格设置多个属性

如果有多个属性分配，可以使用文档字符串或数据表：

Given there is a movie with these attributes:
  """
  name: Sunshine
  comedy: false
  """

Given there is a movie with these attributes:
  | name   | Sunshine |
  | comedy | false    |

Given the movie above has these attributes:
  """
  name: Sunshine
  comedy: false
  """

设置关联

可以通过引用最后一个创建的记录作为 above 来设置 belongs_to 和 transient 关联：

Given there is a movie with the title "Before Sunrise"
And there is a movie with the prequel above

示例还展示了如何设置 has_many 关联 - 只需在另一侧设置 belongs_to 关联。

也可以使用创建时使用的任何字符串属性引用以前创建的记录：

Given there is a movie with the title "Before Sunrise"
And there is a movie with the title "Limitless"
And there is a movie with the prequel "Before Sunrise"

还可以显式给记录命名并使用它来在下面设置 belongs_to 关联：

Given "Before Sunrise" is a movie
And there is a movie with the title "Limitless"
And there is a movie with the prequel "Before Sunrise"

注意，在上面的示例中，"Before Sunrise" 仅是用于引用记录的名称。该名称不用于电影标题或其他属性值。

设置数组属性或 has_many 关联

可以通过引用多个命名记录来设置 has_many 关联：

Given there is a movie with the title "Sunshine"
And there is a movie with the title "Limitless"
And there is a movie with the title "Salt"
And there is a user with the favorite movies ["Sunshine", "Limitless" and "Salt"]

使用 PostgreSQL 数组列时，可以将数组属性设置为带方括号的值：

Given there is a movie with the tags ["comedy", "drama" and "action"]

设置文件属性

可以使用以下语法将属性设置为文件对象：

Given there is a movie with the image file:'path/to/image.jpg'

所有路径都是相对于项目根目录的，不支持绝对路径。请注意，文件属性必须遵循 file:"PATH" 语法，单引号和双引号都是允许的。

使用命名工厂和特性

可以使用 FactoryBot 子工厂或 Machinist 命名蓝图，将变体名称放在括号内：

Given there is a movie (comedy) with the title "Groundhog Day"

可以使用 FactoryBot 特性，将特性放在括号中，并用逗号分隔：

Given there is a movie (moody, dark) with the title "Interstellar"

覆盖工厂步骤

如果要覆盖工厂步骤的自定义版本，只需这样做：

Given /^there is a movie with good actors$/ do
  movie = Movie.make
  movie.actors << Actor.make(:name => 'Clive Owen')
  movie.actors << Actor.make(:name => 'Denzel Washington')
end

自定义步骤将始终优先于工厂步骤。如果唯一其他匹配的步骤是工厂步骤，Cucumber 也不会发出关于模糊步骤的警告。感谢 cucumber_priority！

3. 项目 API 使用文档

Cucumber.Factory 的 API 使用主要涉及创建和更新 ActiveRecord 对象。以下是一些基本的使用示例：

• 创建新记录：

Given there is a movie

• 使用属性创建记录：

Given there is a movie with the title "Sunshine" and the year 2007

• 更新现有记录：

Given the movie above has the title "Sunset" and the year 2008

• 设置布尔属性：

Given there is a movie which is awesome

• 使用表格设置多个属性：

Given there is a movie with these attributes:
  | name   | Sunshine |
  | comedy | false    |

• 设置关联：

Given there is a movie with the prequel above

• 使用命名工厂和特性：

Given there is a movie (comedy) with the title "Groundhog Day"

4. 项目安装方式

请参考“安装指南”部分，安装方式如下：

• 在 Gemfile 中添加 gem 'cucumber_factory'
• 创建 features/step_definitions/factory_steps.rb 文件并添加 require 'cucumber_factory/add_steps'
• 运行 bundle install 命令安装依赖项

以上是关于 Cucumber.Factory 项目的详细技术文档，希望对用户有所帮助。