Version Sorter 技术文档

1. 安装指南

要安装 VersionSorter，您可以使用 Ruby 的包管理工具 gem。在终端中运行以下命令即可完成安装：

gem install version_sorter

安装完成后，您可以在 Ruby 项目中通过 require 'version_sorter' 来引入该库。

2. 项目的使用说明

VersionSorter 是一个用于快速排序表示版本号的字符串的库。它支持对字符串数组进行排序，并且可以通过提供一个块来对任意对象数组进行排序。

基本用法

以下是一个基本的排序示例：

require 'version_sorter'

versions = ["1.0.9", "2.0", "1.0.10", "1.0.3", "2.0.pre"]

sorted_versions = VersionSorter.sort(versions)
puts sorted_versions
#=> 1.0.3
#=> 1.0.9
#=> 1.0.10
#=> 2.0.pre
#=> 2.0

对任意对象数组进行排序

如果您有一个包含任意对象的数组，并且希望根据对象的某个属性进行排序，可以通过提供一个块来实现：

tags = [
  { name: "1.0.9" },
  { name: "2.0" },
  { name: "1.0.10" },
  { name: "1.0.3" },
  { name: "2.0.pre" }
]

sorted_tags = VersionSorter.sort(tags) { |tag| tag[:name] }
puts sorted_tags.map { |tag| tag[:name] }
#=> 1.0.3
#=> 1.0.9
#=> 1.0.10
#=> 2.0.pre
#=> 2.0

3. 项目API使用文档

VersionSorter 提供了以下几个主要的 API 方法：

VersionSorter.sort(versions)

对传入的版本号数组进行升序排序，并返回排序后的数组。

sorted_versions = VersionSorter.sort(versions)

VersionSorter.rsort(versions)

对传入的版本号数组进行降序排序，并返回排序后的数组。

reverse_sorted_versions = VersionSorter.rsort(versions)

VersionSorter.sort!(versions)

对传入的版本号数组进行升序排序，并直接修改原数组。

VersionSorter.sort!(versions)

VersionSorter.rsort!(versions)

对传入的版本号数组进行降序排序，并直接修改原数组。

VersionSorter.rsort!(versions)

VersionSorter.compare(version_a, version_b)

比较两个版本号，返回一个正数或负数，表示 version_a 和 version_b 的排序顺序。

result = VersionSorter.compare("1.0.9", "1.0.10")
# result 为负数，表示 "1.0.9" 在 "1.0.10" 之前

4. 项目安装方式

VersionSorter 的安装方式非常简单，只需使用 Ruby 的包管理工具 gem 即可完成安装：

gem install version_sorter

安装完成后，您可以在 Ruby 项目中通过 require 'version_sorter' 来引入该库，并开始使用其提供的排序功能。

---

通过以上文档，您应该能够顺利安装并使用 VersionSorter 来对版本号进行排序。如果您有任何问题或需要进一步的帮助，请参考项目的 GitHub Wiki 或联系项目维护者。