如何创建支持 Ruby 的 shell 命令？

我正在创建一个 gem，我希望能够在其中使用 shell 命令来执行 gem 中的功能。在更简单的上下文中，我需要创建一个 shell 脚本，该脚本在触发 shell 命令时执行带有选项的 Ruby 函数。做到这一点最简单的方法是什么？

例如：

$ cow moo

会采用一个带有ow命令脚本的cow gem，并在Ruby gem中执行“moo”函数。

如果可以的话，我还希望在 shell 中支持常见的“选项”格式：

$ cow -t moo

上面的示例将采用一个选项并应用 Ruby 中的脚本来处理它（在此示例中-t会打印“moo”两次）。

如果有人能帮助我们解决这个问题，那将是一个很大的帮助。谢谢！

您可以创建一个名为的常规可执行 Ruby 文件cow包含：

#!/usr/bin/env ruby
require 'cow'

Cow.say ARGV.first

注意第一行，这是舍邦线 http://en.wikipedia.org/wiki/Shebang_%28Unix%29。它告诉您的 shell 使用哪个程序来解释脚本。这允许用户简单地调用cow代替ruby $(which cow).

将您的脚本放入bin目录：

cow/
  bin/
    cow  <- your executable file
  lib/
    cow.rb
    cow/
      say.rb
  cow.gemspec

现在，您需要做的就是将其放入您的 gem 规范中：

Gem::Specification.new 'cow' do |gem|
  gem.executables = %w(bin/cow)
end

在安装过程中，Rubygems 会将 gem 的二进制文件安装在用户路径中的某个位置，确保可以找到它们。

至于选项解析，标准库包括optparse http://www.ruby-doc.org/stdlib-1.9.3/libdoc/optparse/rdoc/OptionParser.html，但也有许多宝石 https://www.ruby-toolbox.com/categories/CLI_Option_Parsers可用的。

我创建我自己的选项解析器，称为 Acclaim https://www.ruby-toolbox.com/projects/acclaim，我在自己的实用程序中使用它。这是一个示例：

class Cow::Command < Acclaim::Command
  option :all_caps, '-A', '--all-caps'

  when_called do |options, args|
    text = args.first.to_s
    text.upcase! if options.all_caps?
    Cow.say text
  end
end

为了测试您的应用程序，您只需执行脚本即可：

$ pwd
~/projects/cow
$ ./bin/cow moo
# output here...

但是，这要求您根据规范构建 gem，并在每次想要测试更改时在本地安装它：

ruby -I ./lib -r cow -e 'puts Cow.version'
0.0.1
gem build cow.gemspec && gem install cow-0.0.1.gem

Bundler http://gembundler.com/通过自动将代码插入到加载路径中，使生活变得更轻松。您只需通过 Bundler 运行可执行文件即可：

$ bundle exec ./bin/cow moo
# output here...