RubyMine 2025.2 Help

创建并发布您的第一个 Ruby gem

本分步教程将向您展示如何创建一个简单的 Ruby gem 并将其发布到 RubyGems.org

在开始本教程之前,请执行以下操作:

创建一个 Gem 应用程序

要创建一个新的 Gem 应用程序,请按照以下步骤操作:

  1. 运行 RubyMine 并点击 新建项目欢迎界面

    欢迎屏幕
  2. 新建项目 对话框中,选择左侧窗格中的 Gem 并指定以下设置:

    新建项目对话框 / Gem
    • Location :指定项目的位置和名称(在我们的示例中为 hello_rubymine)。

    • 解释器 :选择所需的 Ruby 解释器。

    在指定所有选项后,单击 创建 以完成 新建项目 对话框。 RubyMine 将创建一个新的 Gem 应用程序。

添加代码

gem 的代码位于 lib 目录中。 我们的 新创建的项目在此文件夹中包含 hello_rubymine.rb 文件。 让我们为我们的 gem 添加工作代码:

  1. 要打开 hello_rubymine.rb ,请按 Ctrl+Shift+N ,开始输入 hello_rubymine.rb ,选择此文件并按 Enter

  2. 在打开的 lib/hello_rubymine.rb 文件中,添加以下代码:

    require "hello_rubymine/version" module HelloRubymine def self.greet(name) puts "Hello, #{name}! I'm Ruby!" end end

提供 gem 规范

每个 gem 项目都有一个 *.gemspec 文件,其中包含 gem 的信息。 在我们的项目中,这些信息存储在 hello_rubymine.gemspec 文件中。 执行以下步骤以提供所需数据:

  1. Ctrl+Shift+N ,开始输入 hello_rubymine.gemspec ,选择 hello_rubymine.gemspec 文件并按 Enter

  2. 在打开的 hello_rubymine.gemspec 文件中,指定所需的 gemspec 属性

    Gemspec 文件

    对于我们的示例 gem,我们已指定以下字段:

    • authors :gem 的作者。

    • email :电子邮件地址。

    • 摘要 :简短的 gem 描述。

    • homepage :gem 的主页 URL。 我们将在 将 gem 的代码发布到 GitHub后指定此地址。

    • metadata["source_code_uri"] :gem 的源代码 URI。 我们将使用与 homepage 相同的值。

    • metadata["allowed_push_host"] :我们从 *.gemspec 中删除了此字符串以 发布到 RubyGems。

在 GitHub 上分享 gem

在本部分中,我们将把 gem 的源代码发布到 GitHub:

  1. 转到 Git | 在 GitHub 上共享项目

  2. 在调用的对话框中,指定要在 GitHub 上创建的存储库名称。 然后,在 通过以下方式共享 字段中选择所需的账户并单击 共享 按钮。

    在 GitHub 对话框上共享项目
  3. 在下一个对话框中,系统会提示您选择用于初始提交的文件。 保留默认文件集,指定提交消息,然后单击 Add。 然后,等待项目推送到 GitHub。

  4. 在项目创建到 GitHub 后, 提供项目的 homepagemetadata["source_code_uri"] 属性到 *.gemspec 文件中(在我们的示例中为 https://github.com/rubyminedoc/hello_rubymine )。 然后, 提交并推送 *.gemspec 中所做的更改。

构建 gem

在我们完成了 *.gemspec 中的所有更改后,我们可以构建一个 gem:

  1. 在主菜单中,进入 工具 | Gem | 构建 Gem .

  2. 在调用的对话框中,单击 Build 按钮以构建 gem。 RubyMine 将在 运行 工具窗口中显示已创建 gem 的信息。

    构建 gem

    您可以在项目视图(Alt+1 )中看到已创建的 gem。

安装 gem

构建 gem 后,我们可以将其安装到 本地解释器中进行测试:

  • 按两次 Ctrl 并输入以下命令:

    gem install hello_rubymine

    Enter 安装 gem。

使用 IRB 测试 gem

在本章中,我们将通过调用其 greet 方法,使用 IRB 控制台测试我们的 gem:

  1. 在主菜单中,进入 工具 | 运行 IRB 控制台.

  2. 输入 require 'hello_rubymine' 并按 Enter 将我们的 gem 加载到 IRB。

  3. 然后,在控制台中输入 HelloRubymine.greet("JetBrains") 并再次按 Enter 以确保我们的 gem 按预期工作。

    在 IRB 控制台中测试 gem

发布 gem

最后,我们将把我们的 gem 发布到 RubyGems.org。 请注意,您需要在 RubyGems.org 上拥有一个账户才能执行此操作。

  1. 转到 工具 | Gem | 推送 Gem

  2. 运行 工具窗口中,指定您的 RubyGems 凭据。

    将 gem 推送到 RubyGems

    您的 gem 将被发布到 RubyGems.org

最后修改日期: 2025年 9月 26日