Verbs 项目技术文档

1. 安装指南

安装步骤

要安装 Verbs 项目，您可以使用 RubyGems 进行安装。请在终端中运行以下命令：

gem install verbs

安装完成后，您可以在 Ruby 项目中引入 Verbs 库并开始使用。

2. 项目的使用说明

基本用法

Verbs 项目的主要功能是 conjugates（动词变位），即根据不同的时态、人称、单复数等规则，生成英语动词的正确形式。以下是一些基本用法的示例：

require 'verbs'

# 变位动词 "be" 为过去时，第二人称，单数形式
result = Verbs::Conjugator.conjugate :be, :tense => :past, :person => :second, :plurality => :singular, :aspect => :perfective
puts result  # 输出: :were

# 变位动词 "be nice" 为现在时，主语为 "Matz"
result = 'be nice'.verb.conjugate :subject => 'Matz'
puts result  # 输出: "Matz is nice"

# 变位动词 "sleep" 为将来时，第一人称，单数形式，进行时态
result = :sleep.verb.conjugate :tense => :future, :person => :first, :plurality => :singular, :aspect => :progressive, :subject => true
puts result  # 输出: :"I will be sleeping"

参数说明

• :tense：时态，可选值为 :past（过去时）、:present（现在时）、:future（将来时），默认值为 :present。
• :person：人称，可选值为 :first（第一人称）、:second（第二人称）、:third（第三人称），默认值为 :third。
• :plurality：单复数，可选值为 :singular（单数）、:plural（复数），默认值为 :singular。
• :aspect：动词体，可选值为 :habitual（习惯体）、:perfect（完成体）、:perfective（完成体）、:progressive（进行体）、:prospective（展望体），默认值为 :habitual。
• :mood：语气，可选值为 :indicative（陈述语气）、:imperative（祈使语气）、:subjunctive（虚拟语气），默认值为 :indicative。
• :subject：主语，可以设置为字符串或 true，如果设置为 true，则使用标准的人称代词。
• :diathesis：语态，可选值为 :active（主动语态）、:passive（被动语态），默认值为 :active。

3. 项目API使用文档

Verbs::Conjugator.conjugate

该方法用于对动词进行变位，接受以下参数：

• verb：要变位的动词，可以是符号或字符串。
• options：一个哈希，包含变位的选项，如 :tense、:person、:plurality、:aspect、:mood、:subject、:diathesis。

示例

result = Verbs::Conjugator.conjugate :be, :tense => :past, :person => :second, :plurality => :singular, :aspect => :perfective
puts result  # 输出: :were

4. 项目安装方式

使用 RubyGems 安装

gem install verbs

安装完成后，您可以在 Ruby 项目中引入 Verbs 库并开始使用。

手动安装

如果您不想使用 RubyGems，也可以手动下载项目源码并将其添加到您的项目中。

---

通过以上文档，您应该能够顺利安装和使用 Verbs 项目，并了解如何通过 API 进行动词变位。