如何执行已发布的 Ruby Gem CLI 应用程序

Question

几个月前我创建了一个 CLI Ruby Gem 并且刚刚开始发布它。我如何测试执行 gem 以确保它 set-up/published 正确？通常，我运行 bin/run 在终端中从 gem 的根目录，但我不确定如何从 Rails 目录中运行它例如，安装了 gem。基本上只是想确保我做的一切都是正确的，并且它按预期工作。

这里是gem供参考：https://rubygems.org/gems/phl-covid-testing

Answer 1

我发现了一些问题。但首先，让我回答你原来的问题。

在命令行（终端）上进行测试：

$ gem install phl-covid-testing
$ which run
$ run

要在您的 Bundler 项目中对其进行测试，请将 phl-covid-testing 添加到您的 Gemspec/Gemfile。然后这样做：

$ bundle install
$ bundle exec run

现在解决问题。您在上面看到的第一个问题是您将脚本命名为 run。这将放在用户的路径上。最好将 bin/run 脚本重命名为 bin/phl-covid-testing 或其他名称。

接下来，我不知道您是否对 bin/ 中的脚本文件进行了 chmod +x，但我假设您已经进行了。但是查看文件的内容，您会看到：

#!/usr/bin/env ruby

require "bundler/setup"
require "./lib/environment"

PHLCovidTesting::CLI.new.call

您不应该使用 ./lib/environment，而是直接使用 require 'environment'。您也不需要 require "bundler/setup"。如果您在本地测试，只需使用 bundle exec bin/run.

接下来，不要使用名字 environment.rb。我建议将此文件重命名为您的 Gem 的名称，这样它将是 phl-covid-testing.rb.

最后，您的 repo 有很多不需要的文件。删除 .DS_Store 和 phl-covid-testing-0.1.0.gem 并将它们添加到 .gitignore:

# .gitignore
.DS_Store
*.gem

可能还有更多需要忽略的文件或更多问题，但这些是我一眼就能看到的主要文件。

编辑：

我决定添加如何在不上传到 RubyGems.org 的情况下进行测试。

如果您正在使用 bundler 和 rake，并且您的 Rakefile 中有 require 'bundler/gem_tasks'，那么您可以这样做：

$ bundle exec rake install:local

这将在本地构建和安装 Gem。

否则，您也可以使用 gem 命令手动执行此操作：

## Remove old gems (optional).
$ rm -v *.gem

$ gem build phl_covid_testing.gemspec
$ gem install *.gem

有关详细信息，请参阅 official doc。

然后尝试运行我之前提到的脚本：

$ phl_covid_testing
## Or with bundler:
$ bundle exec phl_covid_testing

如何执行已发布的 Ruby Gem CLI 应用程序

How to execute a published Ruby Gem CLI app

ruby

rubygems

编辑：