构建一个 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 的用户。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容