草庐IT

ruby - 我应该如何在开发过程中试用我的 gem？

coder 2025-06-12 原文

假设我有一个名为 foo 的 gem，其文件结构如下:

foo.gemspec
test_foo.rb
lib/foo.rb
lib/foo/file1.rb
lib/foo/file2.rb

test_foo.rb 文件包含一些我用来试用我的 gem 的代码。它使用以下行访问 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。

但是，如果我想构建 gem，则必须将调用更改为 require，如下所示:

require 'foo/file1'
require 'foo/file2'

代替

require './lib/foo/file1'
require './lib/foo/file2'

每次我想构建 gem 时，这样做有点乏味。

因此，我想到了另一种尝试方法，即使用 rake 来自动构建和安装 gem，如下所示:

task :build do
    `gem build foo.gemspec`
    `gem uninstall foo`
    `gem install ./foo-0.0.0.gem`
end

然后，当我更改我的代码并想尝试一下时，只需运行 rake build，然后在 test_foo 中调用 require 'foo' .rb.

但这是一个相当缓慢的过程，感觉有点违背了 ruby​​ 作为一种语言的意义，在这种语言中，您无需在尝试之前构建代码。

那么，我的问题是，在积极开发 gem 并对其进行测试时使用什么是最好的工作流程？

最佳答案

为了使代码在不同情况下运行(本地测试、“生产”作为 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) 要将 require_path 设置为您的 gem 的 lib，添加一个 gemspec 文件被认为是一种很好的做法。

要测试您的代码(例如使用您的 test_foo.rb)，您有多种选择:

4) 您可以使用 ruby​​ 的 -I 选项运行 test_foo.rb 以将 lib/目录包含在其加载路径中:

ruby -I lib test_foo.rb

这比直接在您的代码中添加额外的 include 更不突兀。

5) Bundler是一种更好的管理代码/gem 的方法，以便在“现实生活”条件下对其进行测试，尤其是当您同时开发两个或多个相互依赖的 gem 时。 Bundler 为您提供了在本地引用这些 gem 的选项，因此无需正式部署它们以在开发过程中测试它们的功能。要使用 Bundler，您需要将 Gemfile 添加到您的 gem 代码的根目录。

6) 最后，为了方便起见，将开发过程中的常见步骤集成到 Rakefile 中是有意义的，使用 rake 来驱动过程。

我在自己的项目中经常使用这些技术，这里有一些链接供您引用，为您提供一些具体示例:

1) Test files just contain a "require 'foo'"

2) Use "require_relative" from your "main" file to pull in subsequent parts

3) Example gemspec with require_path set to "lib"

5) Example Gemfile

6) Example Rakefile

当然，您不需要使用所有这些技术，使用步骤 1-4 可能没问题，但随着您的项目变得越来越大，额外的努力肯定会得到返回。

关于ruby - 我应该如何在开发过程中试用我的 gem？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/10959904/

中试何在coderequirefoorubygemrake

有关ruby - 我应该如何在开发过程中试用我的 gem？的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. Ruby 解析字符串 - 2

    我有一个字符串input="maybe(thisis|thatwas)some((nice|ugly)(day|night)|(strange(weather|time)))"Ruby中解析该字符串的最佳方法是什么？我的意思是脚本应该能够像这样构建句子:maybethisissomeuglynightmaybethatwassomenicenightmaybethiswassomestrangetime等等，你明白了......我应该一个字符一个字符地读取字符串并构建一个带有堆栈的状态机来存储括号值以供以后计算，还是有更好的方法？也许为此目的准备了一个开箱即用的库？

  4. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  5. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  6. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  7. ruby-on-rails - rails : keeping DRY with ActiveRecord models that share similar complex attributes - 2

    这似乎应该有一个直截了当的答案，但在Google上花了很多时间，所以我找不到它。这可能是缺少正确关键字的情况。在我的RoR应用程序中，我有几个模型共享一种特定类型的字符串属性，该属性具有特殊验证和其他功能。我能想到的最接近的类似示例是表示URL的字符串。这会导致模型中出现大量重复(甚至单元测试中会出现更多重复)，但我不确定如何让它更DRY。我能想到几个可能的方向...按照“validates_url_format_of”插件，但这只会让验证干给这个特殊的字符串它自己的模型，但这看起来很像重溶液为这个特殊的字符串创建一个ruby​​类，但是我如何得到ActiveRecord关联这个类模型

  8. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  9. ruby - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  10. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣，我很好奇如何按顺序创建PI，而不是在过程结果之后生成数字，而是让数字在过程本身生成时显示。如果是这种情况，那么数字可以自行产生，我可以对以前看到的数字实现垃圾收集，从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法，类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

随机推荐