Cucumber-Rails 项目技术文档

1. 安装指南

1.1 添加 Gem 到项目

首先，将 cucumber-rails 添加到项目的 Gemfile 中。在 Gemfile 的 test 组中添加以下内容：

group :test do
  gem 'cucumber-rails', require: false
  # database_cleaner 不是必须的，但强烈推荐使用
  gem 'database_cleaner'
end

1.2 安装 Gem

运行以下命令来安装 Gem：

bundle install

1.3 生成配置文件

安装完成后，运行以下命令来生成 Cucumber 的配置文件：

rails generate cucumber:install

你可以通过以下命令查看生成器的帮助信息：

rails generate cucumber:install --help

2. 项目的使用说明

2.1 运行 Cucumber

安装完成后，你可以通过以下命令运行 Cucumber 测试：

bundle exec cucumber

2.2 配置选项

2.2.1 禁用数据库清理

默认情况下，cucumber-rails 会在每个场景前后运行 DatabaseCleaner.start 和 DatabaseCleaner.clean。你可以通过以下方式禁用此行为：

# features/support/env.rb
Cucumber::Rails::Database.autorun_database_cleaner = false

2.2.2 禁用 Rack::Test 助手

默认情况下，cucumber-rails 会自动将 Rack::Test 的助手方法混合到默认的 Cucumber World 实例中。你可以通过以下方式禁用此行为：

# features/support/env.rb
ENV['CR_REMOVE_RACK_TEST_HELPERS'] = 'true'

3. 项目 API 使用文档

cucumber-rails 提供了一些配置选项和助手方法，帮助你在 Rails 项目中更好地使用 Cucumber。以下是一些常用的 API 和配置选项：

3.1 数据库清理 API

• Cucumber::Rails::Database.autorun_database_cleaner = false：禁用自动数据库清理。

3.2 Rack::Test 助手 API

• ENV['CR_REMOVE_RACK_TEST_HELPERS'] = 'true'：禁用 Rack::Test 助手方法。

4. 项目安装方式

4.1 升级到新版本

如果你从旧版本升级到新版本，建议重新运行安装命令：

rails generate cucumber:install

4.2 设置开发环境

如果你需要为项目贡献代码，可以按照以下步骤设置开发环境：

1. 确保你安装了支持的 Ruby 版本。
2. 进入 cucumber-rails 仓库目录并运行以下命令：

gem install bundler
bundle install
bin/install_geckodriver.sh
bin/install_webpacker.sh

4.3 运行测试

安装所有依赖后，运行以下命令来执行所有测试：

bundle exec rake

4.4 运行 Appraisal 测试套件

为了测试多个版本的依赖项，cucumber-rails 使用了 Appraisal 来生成多个 Gemfile。你可以通过以下命令运行完整的测试套件：

bundle exec appraisal install
bundle exec appraisal rake test

或者针对特定的 Gemfile 运行测试：

bundle exec appraisal rails_6_0 rake test

4.5 添加依赖项

在添加新的依赖项时，请遵循以下规则：

1. 如果是运行时依赖项，添加到 Gemspec 中。
2. 如果是主要的开发依赖项，添加到 Gemspec 中。
3. 如果是生成 Rails 应用测试的依赖项，添加到修改 Gemfile 的辅助方法中。

例如，rspec 是一个主要的开发依赖项，因此它位于 Gemspec 中。