构建一个 Ruby Gem 第十章 命令行可执行文件

很多 Ruby gems 提供了可执行的命令行作为它们的功能的一部分。想象一下离开了命令行你能使用 bunlder 或者 rake 吗? ... 那就不是一个 gem 了!

这些可执行文件和我们在前几章看到的 web 和测试的支持库没有什么大的区别。通常来说,它们是独立在一个单独的类库中并且不被入口文件包含用于加载。在本章中,我们将会集成一个可执行命令行到我们的 mega_lotoo gem 来代理我们已经写好的 drawing 方法。

用例

我们想要创建一个命令行工具为 mega_lotto 来代理 #draw 方法在 MegaLotto::Drawing 并且返回这样的东西:

$ mega_lotto
1
6
47
57 
15 
26

由于 #draw 方法已经被实现了, 创建一个可执行命令不会很难。

实现

bin/ 目录是一个配套的可执行文件的标准位置。再一次看看我们的 mega_lotto.gemspec 注意下面行:

spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

gemspec 定义了一个可执行文件的列表,通过被提交到 git 并且位于 bin/ 目录下。 所以让我们加入文件 bin/mega_lotto

由于它是一个脚本会被命令行执行,我们有两个重要的改变要做:

  1. 在文件的顶部加入 #!/usr/bin/env 并且使用命令 chomd +x bin/mega_lotto 允许其被执行(假设你在 linux 或者 macOS 平台上)

  2. 因为这个文件是独立于 gem 的其他部分的,我们不得不加载必要的依赖

#!/usr/bin/env ruby
require_relative "../lib/mega_lotto/drawing"

现在让我们代理 #draw 方法:

#!/usr/bin/env ruby
require_relative "../lib/mega_lotto/drawing"
drawing = MegaLotto::Drawing.new.draw 
puts drawing

让我们提交我们的改变,并运行 rake install

$ mega_lotto
8
11
9
38
43

注意: 如果你使用 Rbenv 来管理 Ruby 版本,你可能需要运行 rbenv rehash 在可执行文件可被得到前。

选项解析

很少有命令行不支持选项解析。如果你依赖于命令行,-h 是一个你可能经常使用的选项。因为只有很少一部分人可以记住我们日常使用的可执行文件的选项。

允许选项和参数被传入命令行可以呈几何级数地增强它的功能。幸运的是, Ruby 已经有了标准库内置的 OptonParser 类。我把实现的细节留给了其他资源, 但是这是值得一提的,因为你的可执行文件可不会像上面提到的那么简单。

抽取 CLI 类

可执行命令行需要加载更多的代码而不是仅仅从主命名空间的一两个方法。在这种情况下,通常需要分隔到一个单独的文件,就像 lib/mega_lotto/cli.rb。所以不是加载
require_relative "../lib/mega_lotto/drawing"
在可执行文件中,而是包含 require_relative "../lib/mega_lotto/cli"
在可执行命令中, 我们可以
添加 lib/mega_lotto/cli.rb 文件来负责加载依赖并且 lib/mega_lotto/cli.rb 文件可以解析选项(如果有的话)。

现实中的例子

Bundler 采取了后一种策略(和大多数 gem 做法一样)并且实现了一个 cli.rb 类 来管理依赖和可执行文件。在那里,功能被包裹来一个单独的类中这样就容易测试。测试 shell 脚本是大多数 Ruby 程序员不擅长的,所以我们要尽量把责任转让给 Ruby 本身。

Resque 是另一例子, 有一个单独的 CLI 类的例子. 事实上, 看看可执行文件的代码.
非常简单, 不是吗? 这就是我们希望我们的可执行文件看上去的样子 - 简单, 直接并且把所有的功能和错误处理都放到独立的 Ruby 类中。

总结

�写一个可执行命令行的结构和最佳实践超出了本书的范围。有很多更好的资源关于这个主题,并且更加深入细节,特别是 David Bryant Copeland 的书 <Building Awesome Command-Line Applications in Ruby>。然而,希望你现在能明白包含一个可执行的命令到你的 gem 中是多么简单的一件事情。

在下一章,我们将会实现一个配置模式来提供额外的灵活的价值给我们的 gem 的用户。

推荐阅读更多精彩内容