Jeweler 使用与技术文档

1. 安装指南

首先，您需要使用 RubyGems 安装 Jeweler。在命令行中执行以下命令：

gem install jeweler

2. 项目使用说明

安装完 Jeweler 后，您可以使用它来生成新的 RubyGem 项目。基本的用法是为项目提供一个名称：

jeweler 项目名称

这将创建一个包含以下文件和目录的新目录：

• Rakefile：为 Jeweler 配置的 Rake 任务
• README.rdoc：包含贡献指南和版权信息的自述文件
• LICENSE：以 MIT 许可证授权的许可证文件
• Gemfile：包含开发依赖项的 Gemfile
• lib/项目名称.rb：等待您编写代码的库文件
• test/：包含一个（失败的）shoulda 测试套件

3. 项目API使用文档

Jeweler 的 API 主要涉及使用 Gem::Specification 对象来自定义您的宝石。以下是一些常用的 API 方法：

• gem.name：设置宝石的名称。
• gem.summary：设置宝石的简短摘要。
• gem.description：设置宝石的详细描述。
• gem.email：设置您的联系电子邮件。
• gem.homepage：设置宝石的主页地址。
• gem.authors：设置宝石的作者列表。

更多可用的选项和配置，请参考 RubyGems 规范参考。

4. 项目安装方式

要开始使用您的新宝石，首先需要定义一个版本号：

rake version:write MAJOR=0 MINOR=1 PATCH=0

接着，您可以构建并安装宝石：

rake install

如果您使用的是系统安装的 Ruby，可能需要使用 sudo 运行此命令：

sudo rake install

当您准备好将宝石发布到 rubygems.org 时，执行以下命令：

rake release

这将自动执行以下操作：

• 生成 项目名称.gemspec 并提交它
• 使用 git 标记并推送 v0.1.0 标签
• 构建 项目名称-0.1.0.gem 并将其推送到 rubygems.org

以上就是 Jeweler 的基本使用和配置方法。开始创建您的 RubyGem 吧！