Yardstick 项目技术文档

1. 安装指南

Yardstick 是一个用于验证 Ruby 代码文档覆盖率的工具。在安装 Yardstick 前，请确保您的系统中已经安装了 Ruby。

通过 Ruby 的包管理器 gem 来安装 Yardstick：

gem install yardstick

确保安装成功，可以在命令行中运行以下命令查看版本：

yardstick -v

2. 项目的使用说明

Yardstick 提供了三种使用方式：命令行工具、Rake 任务和库。

命令行工具

命令行工具是最简单的使用方式。为其提供文件列表，它将测量所有文件并输出改进建议：

yardstick 'lib/**/*.rb' 'app/**/*.rb' ...etc...

Rake 任务

Yardstick 可以与现有的 Rake 文件和构建过程集成，特别是在持续集成系统中非常有用。可以设置阈值，并检查阈值是否与实际覆盖率匹配，如果实际覆盖率增加，则必须提高阈值。

在 Rake 文件中配置示例：

# 测量覆盖率

require 'yardstick/rake/measurement'

Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
  measurement.output = 'measurement/report.txt'
end

# 验证覆盖率

require 'yardstick/rake/verify'

Yardstick::Rake::Verify.new do |verify|
  verify.threshold = 100
end

库

Yardstick 提供了几个库，允许您处理文件列表或字符串代码片段：

require 'yardstick'

# 测量文件路径列表
measurements = Yardstick.measure(paths)

# 测量代码片段
measurements = Yardstick.measure_string <<-RUBY
  # 显示传递给 stdout 的消息
  #
  # @param [#to_str] message
  #   要显示的消息
  #
  # @return [undefined]
  #
  # @api public
  def display(message)
    puts message.to_str
  end
RUBY

3. 项目 API 使用文档

Yardstick API 允许您在代码中直接使用其功能。以下是一些使用示例：

• 使用 Yardstick.measure 来测量文件路径列表的文档覆盖率。
• 使用 Yardstick.measure_string 来测量字符串代码片段的文档覆盖率。

4. 项目安装方式

如前所述，Yardstick 通过 Ruby 的 gem 包管理器进行安装：

gem install yardstick

在安装完成后，您可以使用命令行工具，或在您的 Ruby 项目中作为库来引用 Yardstick。