rspec-instafail 技术文档

1. 安装指南

Rspec 2.x 及更高版本

1. 打开终端，输入以下命令安装 rspec-instafail gem：

   gem install rspec-instafail
   

2. 在项目根目录下创建或编辑 .rspec 文件，添加以下内容：

   --require rspec/instafail
   --format RSpec::Instafail
   --format progress
   

Rspec 1.x

对于 Rspec 1.x 版本，需要使用 rspec-instafail 的 0.4.0 版本。请参考 0.4.0 分支 进行安装。

2. 项目的使用说明

rspec-instafail 是一个用于 Rspec 测试框架的插件，旨在即时显示失败的测试用例。它会在测试运行时立即显示失败的测试，而通过的测试则以绿色圆点显示。

输出示例

....................................................*....
1) ApplicationController#sign_out_and_redirect with JSON should return JSON indicating success
   Failure/Error: json_response = JSON.parse response.body
   A JSON text must at least contain two octets!
   # /Users/miwillhite/.rvm/gems/ruby-1.9.2-p0/gems/json_pure-1.4.6/lib/json/common.rb:146:in `initialize'
   # /Users/miwillhite/.rvm/gems/ruby-1.9.2-p0/gems/json_pure-1.4.6/lib/json/common.rb:146:in `new'
   # /Users/miwillhite/.rvm/gems/ruby-1.9.2-p0/gems/json_pure-1.4.6/lib/json/common.rb:146:in `parse'
   # ./spec/controllers/application_controller_spec.rb:17:in `block (4 levels) in <top (required)>'
..................................................................

Finished in 650.095614 seconds

1680 examples, 1 failure, 1 pending

3. 项目API使用文档

rspec-instafail 主要通过 Rspec 的 --format 选项进行配置。以下是主要的 API 使用说明：

• --require rspec/instafail：加载 rspec-instafail 插件。
• --format RSpec::Instafail：设置格式为 RSpec::Instafail，即时显示失败的测试。
• --format progress：保持通过的测试以绿色圆点显示。

4. 项目安装方式

通过 RubyGems 安装

gem install rspec-instafail

通过 Gemfile 安装

在项目的 Gemfile 中添加以下内容：

gem 'rspec-instafail'

然后运行 bundle install 进行安装。

配置 .rspec 文件

在项目根目录下创建或编辑 .rspec 文件，添加以下内容：

--require rspec/instafail
--format RSpec::Instafail
--format progress

通过以上步骤，您可以成功安装并配置 rspec-instafail，以便在 Rspec 测试中即时显示失败的测试用例。