Appraisal 项目技术文档

1. 安装指南

在项目依赖中添加 Appraisal：

s.add_development_dependency "appraisal"

确保在全局命名空间中捆绑宝石。不支持将宝石捆绑到本地位置或引入插件。

2. 项目的使用说明

Appraisal 与 bundler 和 rake 集成，用于在可重复的情景（称为“评估”）中对不同版本的依赖项进行测试。Appraisal 设计用于轻松检查库的回归，同时不会干扰日常开发。

设置

在项目根目录创建一个 Appraisals 文件，并对 Rakefile 进行一些修改。

Appraisals 文件包含几个评估定义。每个评估定义是一系列宝石依赖项。例如，要测试几个版本的 Rails：

appraise "rails-3" do
  gem "rails", "3.2.14"
end

appraise "rails-4" do
  gem "rails", "4.0.0"
end

Appraisals 文件中的依赖项会与 Gemfile 中的依赖项结合，因此无需重复每个评估中都相同的项。

使用

配置好要使用的评估后，需要为每个评估安装依赖项：

$ bundle exec appraisal install

然后可以运行单个评估的任何命令：

$ bundle exec appraisal rails-3 rake test

也可以依次运行每个评估：

$ bundle exec appraisal rake test

如果想使用 Gemfile 中的依赖项，只需正常运行 rake test。

若要默认运行所有评估，可以在 Rakefile 中添加以下内容：

if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
  task :default => :appraisal
end

3. 项目API使用文档

Appraisal 提供以下命令：

appraisal clean                  # 删除 gemfiles 文件夹中生成的所有 gemfile 和 lockfile
appraisal generate               # 为每个评估生成 gemfile
appraisal help [COMMAND]         # 描述可用的命令或特定命令
appraisal install                # 为每个评估解析和安装依赖项
appraisal list                   # 列出定义的评估名称
appraisal update [LIST_OF_GEMS]  # 删除所有生成的 gemfile 和 lockfile，重新解析并安装依赖项
appraisal version                # 显示版本并退出

4. 项目安装方式

请参考上述安装指南。

以上就是 Appraisal 项目的详细技术文档，希望对您使用该库有所帮助。