Ingreedy 技术文档

1. 安装指南

Ingreedy 是一个用于解析食谱中成分和数量的 Ruby 库。要安装 Ingreedy，请按照以下步骤操作：

首先，确保您的系统中已经安装了 Ruby 环境。然后，在您的项目中，通过 Gem 文件或直接在命令行中运行以下命令来添加 Ingreedy 依赖：

gem install ingreedy

确保安装成功后，您可以在 Ruby 脚本中导入并使用 Ingreedy。

2. 项目的使用说明

Ingreedy 提供了简单的接口来解析食谱中的数量、单位和食材名称。以下是一个基本的使用示例：

result = Ingreedy.parse('1 lb. potatoes')
print result.amount  # 输出：1.0
print result.unit    # 输出：:pound
print result.ingredient  # 输出："potatoes"

Ingreedy 还支持国际化和自定义词典。以下是如何设置和使用自定义词典的示例：

Ingreedy.dictionaries[:fr] = { 
  units: { dash: ['pincée'] }, 
  numbers: { 'une' => 1 }, 
  prepositions: ['de'] 
}

Ingreedy.locale = :fr

result = Ingreedy.parse('une pincée de sucre')
print result.amount  # 输出：1.0
print result.unit    # 输出：:dash
print result.ingredient  # 输出："sucre"

3. 项目API使用文档

Ingreedy 提供以下主要方法：

• Ingreedy.parse(text)：解析文本中的成分信息。
• Ingreedy.dictionaries[locale]：自定义字典，支持国际化和本地化。
• Ingreedy.locale：设置当前的语言环境。
• Ingreedy.preserve_amounts：设置是否保留原始数量表示。

以下是一些详细说明：

• parse(text) 方法接受一个字符串作为输入，并返回一个包含数量（amount）、单位（unit）和食材（ingredient）的对象。
• dictionaries[locale] 允许您为不同的语言环境设置自定义的单位和数量解析规则。
• locale 方法用于设置默认的语言环境，如果您的应用使用 I18n 库，Ingreedy 会自动遵循 I18n 的设置。
• preserve_amounts 设置为 true 时，Ingreedy 会保留输入中的数量格式，而不是将其转换为分数。

4. 项目安装方式

Ingreedy 的安装方式已在“安装指南”部分介绍。以下是一个简短的总结：

• 确保您的系统中安装了 Ruby。
• 使用 gem install ingreedy 命令安装 Ingreedy Gem。
• 在您的 Ruby 项目中引入 ingreedy 并开始使用。

以上是关于 Ingreedy 技术文档的详细说明。希望这对您使用该库有所帮助。