Guard::Spork 项目技术文档

1. 安装指南

在开始使用 Guard::Spork 之前，请确保已经安装了 Guard。Guard::Spork 是一个用于自动启动和重载 RSpec/Cucumber/Test::Unit 的 Spork 服务器的工具。

安装步骤

1. 安装 Guard： 如果你还没有安装 Guard，请先安装：

   $ gem install guard
   

2. 安装 Guard::Spork： 使用以下命令安装 Guard::Spork：

   $ gem install guard-spork
   

3. 添加到 Gemfile： 将 guard-spork 添加到你的 Gemfile 的 development 组中：

   group :development do
     gem 'guard-spork'
   end
   

4. 生成 Guardfile： 使用以下命令将 guard-spork 的配置添加到你的 Guardfile 中：

   $ guard init spork
   

2. 项目的使用说明

基本用法

Guard::Spork 的主要功能是自动启动和重载 Spork 服务器。你可以通过 Guard 的命令行工具来启动 Guard::Spork：

$ guard

Guardfile 配置

在 Guardfile 中，你需要确保 Spork 的 guard 定义在 RSpec/Cucumber/Test::Unit 的 guard 之前。以下是一个典型的 Rails 应用的 Guardfile 配置示例：

guard 'spork' do
  watch('config/application.rb')
  watch('config/environment.rb')
  watch(%r{^config/environments/.*\.rb$})
  watch(%r{^config/initializers/.*\.rb$})
  watch('Gemfile.lock')
  watch('spec/spec_helper.rb') { :rspec }
  watch('test/test_helper.rb') { :test_unit }
  watch(%r{features/support/}) { :cucumber }
end

通过 Spork 运行测试

为了通过 Spork 的 DRb 服务器运行测试，你需要在 Guard::RSpec 和 Guard::Cucumber 的配置中添加 :cmd => "rspec --drb" 选项：

guard 'rspec', :cmd => "rspec --drb" do
  # ...
end

guard 'cucumber', :cmd => "rspec --drb" do
  # ...
end

对于 MiniTest，你需要添加 :drb => true 选项：

guard 'minitest', :drb => true do
  # ...
end

3. 项目API使用文档

选项配置

Guard::Spork 提供了多种选项来定制其行为。以下是一些常用的选项：

• :rspec => false：禁用 RSpec 支持。
• :cucumber => false：禁用 Cucumber 支持。
• :test_unit => false：禁用 Test::Unit 支持。
• :bundler => false：不使用 bundle exec。
• :rspec_env、:cucumber_env、:test_unit_env：为 RSpec、Cucumber 和 Test::Unit 提供额外的环境变量。
• :foreman => true：使用 Foreman 启动 Spork，并传递 .env 文件中的环境变量。

示例：

guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'cucumber' }, :rspec_env => { 'RAILS_ENV' => 'test' }, :test_unit_env => { 'RAILS_ENV' => 'test' } do
  # ...
end

常见问题排查

如果你手动启动 Spork 成功，但通过 Guard::Spork 启动时出现错误，可以尝试增加 :wait 选项的值，例如：

guard 'spork', :wait => 60 do
  # ...
end

4. 项目安装方式

Guard::Spork 的安装方式非常简单，只需按照以下步骤操作：

1. 确保已安装 Guard。
2. 使用 gem install guard-spork 命令安装 Guard::Spork。
3. 将 guard-spork 添加到 Gemfile 的 development 组中。
4. 使用 guard init spork 命令生成 Guardfile 配置。

通过以上步骤，你就可以成功安装并配置 Guard::Spork，开始使用它来自动化你的测试环境。