Diffy 使用与技术文档

1. 安装指南

在 Unix 系统

使用以下命令安装：

gem install diffy

在 Windows 系统

1. 确保您的计算机上安装了可用的 diff 命令，并且它在您的搜索路径中。
2. 有多种选择：
   • 安装 Diff::LCS，它包含 ldiff。
   • 如果您使用 RubyInstaller，安装 devkit。
   • 安装 unxutils http://sourceforge.net/projects/unxutils。
   • 从 gnuwin32 项目单独安装两个工具 http://gnuwin32.sourceforge.net/。

请注意，这些工具包含的 diff 版本可能影响 Diffy 的测试结果。

3. 使用以下命令安装宝石：

gem install diffy

2. 项目的使用说明

Diffy 是一个 Ruby 库，用于方便地生成两个字符串或文件之间的差异。它使用久经考验的 Unix diff 命令来生成差异，并专注于提供方便的接口。

以下是使用 Diffy 对两个字符串进行差异比较的示例：

string1 = "Hello how are you\nI'm fine\nThat's great\n"
string2 = "Hello how are you?\nI'm fine\nThat's swell\n"
puts Diffy::Diff.new(string1, string2)

输出：

-Hello how are you
+Hello how are you?
 I'm fine
-That's great
+That's swell

3. 项目API使用文档

Diffy::Diff 类提供了以下方法：

• Diffy::Diff.new(string1, string2, [options])：创建一个新的差异对象。
• #to_s([format])：将差异转换为字符串。格式可以是 :text、:color、:html 或 :html_simple。

还有 Diffy::SplitDiff 类用于生成并排差异：

• Diffy::SplitDiff.new(string1, string2, [options])：创建一个新的并排差异对象。
• #left 和 #right：分别获取左侧和右侧的差异。

更多选项和配置，请参考项目 GitHub Wiki。

4. 项目安装方式

请参考上文“安装指南”部分的说明进行安装。