假设我有一个名为foo的gem,其文件结构如下:
foo.gemspec
test_foo.rb
lib/foo.rb
lib/foo/file1.rb
lib/foo/file2.rb
该文件test_foo.rb包含一些我用来试用我的宝石的代码.它使用以下行访问gem的代码:
require './lib/foo'
然后,lib/foo.rb加入gem所需的其他文件,如下所示:
require './lib/foo/file1'
require './lib/foo/file2'
由于test_foo.rb位于gem目录的根目录中,因此需要lib/foo使用根目录中的完整路径来输入文件.
这一切都很好,并允许我通过更改使用的代码立即玩我的宝石test_foo.rb.
但是,如果我想构建gem,那么我必须更改我的调用require,如下所示:
require 'foo/file1'
require 'foo/file2'
代替
require './lib/foo/file1'
require './lib/foo/file2'
每次我想要构建宝石时,这都是一种乏味的做法.
所以,我想到了另一种尝试它的方法,即rake用于自动构建和安装gem,如下所示:
task :build do
`gem build foo.gemspec`
`gem uninstall foo`
`gem install ./foo-0.0.0.gem`
end
然后当我更改了我的代码,并想尝试一下,只需运行rake build,并调用require 'foo'在test_foo.rb.
但这是一个相当缓慢的过程,感觉有点像它击败了红宝石作为一种语言,你不必在尝试之前构建代码.
所以,我的问题是,在积极开发gem并测试它时,最好的工作流程是什么？
它容易出错并且容易混淆require源文件中的路径,以使代码在不同的情况下运行(本地测试,"生产"作为宝石等).
你可以使用一些技巧来"编写一次,随处运行"(抱歉Java,偷窃).这也是您应该瞄准的目标,使用这些标准实践可以让其他人更容易理解您的代码,或者在某些内容无法正常工作时帮助您.
您的代码已经遵循常见的gem目录布局,不需要在那里进行任何更改.但是,作为一般经验法则,您应该使用require加载"库"和require_relative(如果您使用的是Ruby> 1.9)来加载相对于您正在处理的源文件.
1)您的文件test_foo.rb应该只包含一行:
require 'foo'
那就是省略require路径中的'./lib'部分.gem的入口点("require_path")通常选择为"lib".稍后再详述(3).
2)接下来,在foo.rb中,使用require_relative(再次假设Ruby 1.9)来提取相关的源文件:
require_relative 'foo/file1'
require_relative 'foo/file2'
3)要将gem的require_path设置为lib,添加gemspec文件被认为是一种好习惯.
要测试代码(例如使用test_foo.rb),您有以下几种选择:
4)您可以使用ruby的-I选项运行test_foo.rb,以在其加载路径中包含lib /目录:
ruby -I lib test_foo.rb
这比直接在代码中添加其他包含更不突兀.
5)Bundler是一种更好的管理代码/ gem的方法,以便在"真实"条件下对其进行测试,特别是如果您一次开发两个或多个相互依赖的宝石.Bundler为您提供了在本地引用这些gem的选项,因此无需正式部署它们以便在开发期间测试它们的功能.要使用Bundler,您需要将Gemfile添加到gem代码的根目录中.
6)最后,为方便起见,将开发过程中的常用步骤集成到Rakefile中是有意义的,使用rake来驱动进程.
我在自己的项目中使用了这些技术,这里有一些链接供你参考,给你一些具体的例子:
2)使用"main"文件中的"require_relative"来引入后续部分
3)示例gemspec,require_path设置为"lib"
当然,您不需要使用所有这些技术,使用步骤1-4可能会很好,但随着您的项目变得越来越大,额外的努力肯定会得到回报.