ApprovalTests.Ruby 项目技术文档

本文档将详细介绍 ApprovalTests.Ruby 项目的安装、使用和 API 调用方法。

1. 安装指南

ApprovalTests.Ruby 可以通过 Ruby 的包管理工具 gem 进行安装。在终端中运行以下命令：

gem install approvals

确保已经安装了最新版本的 Ruby。

2. 项目使用说明

ApprovalTests.Ruby 基于黄金文件（golden master）的概念。您首先对对象进行快照，然后将所有未来的对象版本与快照进行比较。

2.1 配置

您可以通过以下代码块配置 ApprovalTests.Ruby 的输出目录：

Approvals.configure do |config|
  config.approvals_path = 'output/dir/'
end

默认的输出文件位置是：

approvals/

2.2 使用

使用以下代码对对象进行验证：

Approvals.verify(your_subject, :format => :json)

如果验证失败，将抛出 ApprovalError 异常。

第一次运行验证时，将创建一个包含对象内容的文件：

the_name_of_the_approval.received.txt # 或 .json, .html, .xml

由于尚未批准任何内容，*.approved 文件不存在，比较将失败。

2.3 自定义格式化输出

对于复杂对象，您需要提供自定义的写入器来获取有用的输出：

class MyCustomWriter < Approvals::Writers::TextWriter
  def format(data)
    # 自定义数据格式化
  end

  def filter(data)
    # 自定义数据过滤
  end
end

在测试中，使用字符串引用自定义类：

it "验证复杂对象" do
  Approvals.verify hello, :format => "MyCustomWriter"
end

根据需要定义和使用不同的自定义写入器！

3. 项目API使用文档

ApprovalTests.Ruby 提供了以下主要API：

• Approvals.verify(subject, options): 对象验证方法，其中 subject 是要验证的对象，options 是可选参数，包括格式、名称等。
• Approvals.configure: 配置方法，用于设置项目路径等配置项。

4. 项目安装方式

ApprovalTests.Ruby 的安装方式如下：

4.1 使用 RubyGems 安装

在终端中运行以下命令：

gem install approvals

4.2 使用 Bundler 安装

如果您使用 Bundler 管理项目依赖，可以在项目的 Gemfile 文件中添加以下代码：

gem 'approvals'

然后运行 bundle install 命令安装依赖项。

以上是 ApprovalTests.Ruby 项目的技术文档，希望对您使用该项目有所帮助。