Rubydeps 项目技术文档

1. 安装指南

1.1 安装 Rubydeps

要安装 Rubydeps，您可以使用以下命令：

gem install rubydeps

1.2 支持的 Ruby 版本

Rubydeps 目前仅支持 Ruby 1.9.2 及以上版本。如果您需要支持 Ruby 1.8.x 版本，请安装 0.2.0 版本：

gem install rubydeps -v0.2.0

1.3 依赖项

Rubydeps 依赖以下软件包：

• graphviz
• ruby-graphviz gem
• rcov gem（仅适用于 0.2.0 版本）

2. 项目的使用说明

2.1 基本使用

Rubydeps 是一个用于从测试套件中创建类依赖关系图的工具。它通过运行测试套件来记录项目的调用图，并使用这些信息生成 Graphviz 的 dot 图。

2.2 使用步骤

1. 添加 Rubydeps 到 Gemfile：

   在您的 Gemfile 中添加以下内容，并运行 bundle install：

   gem 'rubydeps', :group => :test
   

2. 启动 Rubydeps：

   在您的 test/test_helper.rb（或 spec_helper.rb、cucumber 的 env.rb 等）中插入以下代码：

   Rubydeps.start
   

   请注意，这会减慢您的测试速度，因此建议在完成测试后删除该行，或使用环境变量进行条件控制。

3. 运行测试：

   运行您的测试套件，将在项目根目录下生成一个名为 rubydeps.dump 的文件。

4. 生成 Graphviz dot 图：

   使用生成的 rubydeps.dump 文件生成 Graphviz dot 图 rubydeps.dot，并指定过滤器：

   rubydeps --path_filter='app/models'
   

5. 转换为图像格式：

   使用 Graphviz 的 dot 工具将 rubydeps.dot 文件转换为所需的图像格式，例如：

   dot -Tsvg rubydeps.dot > rubydeps.svg
   

   请注意，有时可能会缺少依赖项，因为图表仅显示通过测试执行的依赖项，因此可以用作项目测试覆盖率的快速概览。

3. 项目 API 使用文档

3.1 命令行选项

• --path_filter：指定一个正则表达式，匹配您感兴趣分析的文件路径。例如，您可以使用 'project_name/app|project_name/lib' 来分析仅位于 app 和 lib 目录中的代码，或者使用负正则表达式 'project_name(?!.*test)' 排除某些目录。

• --class_name_filter：类似于 --path_filter，但正则表达式匹配类名（即图节点名称）。

• --from_file：指定测试（或块）运行后生成的 dump 文件，以便在不重新运行测试的情况下尝试不同的过滤器。例如：

  rubydeps --from_file='rubydeps.dump' --path_filter='app/models'
  rubydeps --from_file='rubydeps.dump' --path_filter='app/models|app/controllers'
  

  如果未重命名文件，可以跳过此选项，因为它将使用默认的 rubydeps.dump。

3.2 库使用

只需在代码中引入 rubydeps，并将要分析的代码块传递给 analyze 方法：

require 'rubydeps'

Rubydeps.analyze(:path_filter => path_filter_regexp, :class_name_filter => class_name_filter_regexp, :to_file => "rubydeps.dump") do
    # 您的代码在这里
end

4. 项目安装方式

4.1 通过 Gem 安装

gem install rubydeps

4.2 通过 Gemfile 安装

在 Gemfile 中添加以下内容：

gem 'rubydeps', :group => :test

然后运行 bundle install。

4.3 支持旧版本 Ruby

如果您需要支持 Ruby 1.8.x 版本，请安装 0.2.0 版本：

gem install rubydeps -v0.2.0

请注意，在 0.2.0 版本中，应使用 dot_for 而不是 analyze，并且缺少 dump 功能。