Randexp 项目技术文档

1. 安装指南

Randexp 是一个用于从正则表达式生成随机字符串的工具。它非常易于安装，并且不需要任何额外的依赖。

安装步骤

1. 打开终端或命令行工具。

2. 输入以下命令进行安装：

   sudo gem install randexp
   

3. 安装完成后，您可以在终端中使用 randexp 命令来验证安装是否成功。

2. 项目使用说明

Randexp 的主要功能是为给定的正则表达式生成随机字符串。它通过扩展 Ruby 的 Regexp 类，添加了 #generate 方法（或简写为 #gen），使得您可以直接从正则表达式生成随机字符串。

基本用法

以下是一些基本的使用示例：

# 生成一个匹配 "abc" 或 "def" 的随机字符串
/abc|def/.gen
# => "def"

# 生成一个匹配 "Aaaahhhhh!" 的随机字符串
/Aa{3}h{3,15}!/.gen
# => "Aaaahhhhh!"

# 生成一个随机单词
/\w+/.gen
# => "groveling"

复杂匹配

Randexp 支持复杂的正则表达式匹配，包括单词字符（\w）、空白字符（\s）和数字（\d）。您可以使用 [:...:] 语法来定义复杂的匹配模式。

# 生成一个包含随机句子的字符串
/[:sentence:]/.gen
# => "Nonhearer demetricize toppiece filicic possessedness rhodizite zoomagnetism earwigginess steady"

自定义匹配

您可以通过扩展 Randgen 类来添加自定义的复杂匹配模式。例如：

class Randgen
  def self.serial_number(options = {})
    /XX\d{4}-\w-\d{5}/.gen
  end
end

# 生成一个自定义的序列号
/[:serial_number:]/.gen
# => "XX3770-M-33114"

3. 项目 API 使用文档

Randexp 提供了简单且强大的 API，主要通过 Regexp 类的 #generate 方法（或 #gen）来生成随机字符串。

API 方法

• Regexp#generate 或 Regexp#gen

  该方法用于从正则表达式生成随机字符串。

  参数: 无

  返回值: 生成的随机字符串

  示例:

  /abc|def/.gen
  # => "def"
  

支持的正则表达式

Randexp 支持大多数简单的正则表达式，但对于一些过于模糊的正则表达式（如 *），可能会抛出 RuntimeError。建议在使用时为模糊的正则表达式设置范围。

# 错误的正则表达式
/Aa{3}h*!/.gen
# => RuntimeError: Sorry, "h*" is too vague, try setting a range: "h{0,3}"

# 正确的正则表达式
/Aa{3}h{3,15}!/.gen
# => "Aaaahhhhh!"

4. 项目安装方式

Randexp 的安装非常简单，只需使用 RubyGems 进行安装即可。

安装命令

sudo gem install randexp

验证安装

安装完成后，您可以通过在终端中输入 randexp 命令来验证安装是否成功。

---

通过以上文档，您应该能够顺利安装和使用 Randexp 项目，并了解其 API 的使用方法。