ruby - 如果 gem 安装不支持， native 扩展回退到纯 Ruby

Question

我正在开发一个 gem，它目前是纯 Ruby，但我也一直在为其中一个特性开发一个更快的 C 变体。该功能在纯 Ruby 中可用，但有时速度较慢。缓慢只会影响一些潜在用户(取决于他们需要哪些功能，以及他们如何使用它们)，因此如果 gem 无法在目标系统上编译，那么让 gem 可以优雅地回退到 Ruby-only 功能是有意义的。

我想在单个 gem 中维护该功能的 Ruby 和 C 变体，并在安装时提供 gem 的最佳(即最快)体验。这将使我能够从我的单个项目中支持最广泛的潜在用户。它还将允许其他人的依赖 gem 和项目使用目标系统上的最佳可用依赖项，而不是为了兼容性而使用最低公分母版本。

我希望 require 在运行时回退到主 lib/foo.rb 文件中，就像这样:

begin
  require 'foo/foo_extended'
rescue LoadError
  require 'foo/ext_bits_as_pure_ruby'
end

但是，我不知道如何让 gem 安装检查(或尝试并失败)本地扩展支持，以便 gem 正确安装它是否可以构建“foo_extended”。当我研究如何做到这一点时，我主要发现了几年前的讨论，例如http://permalink.gmane.org/gmane.comp.lang.ruby.gems.devel/1479和 http://rubyforge.org/pipermail/rubygems-developers/2007-November/003220.html这意味着 Ruby gems 并不真正支持此功能。虽然最近没有什么，所以我希望 SO 上的人有一些最新的知识？

我理想的解决方案是在尝试构建扩展之前检测目标 Ruby 不支持(或者可能只是在项目级别不想要)C 原生扩展。而且，如果不太脏的话，try/catch 机制也可以。

这可能吗，如果可能的话怎么办？或者我在搜索时发现的发布两个 gem 变体(例如 foo 和 foo_ruby)的建议是否仍然是当前的最佳实践？

Answer 1

这是我迄今为止尝试回答我自己的问题的最佳结果。它似乎适用于 JRuby(在 Travis 和我在 RVM 下的本地安装上测试)，这是我的主要目标。但是，我对它在其他环境中工作的确认以及关于如何使其更通用和/或更健壮的任何输入非常感兴趣:

---

gem 安装代码需要一个 Makefile 作为 extconf.rb 的输出，但对它应该包含什么没有意见。因此 extconf.rb 可以决定创建一个什么都不做 Makefile，而不是从 mkmf 调用 create_makefile 。在实践中可能看起来像这样:

ext/foo/extconf.rb

can_compile_extensions = false
want_extensions = true

begin
  require 'mkmf'
  can_compile_extensions = true
rescue Exception
  # This will appear only in verbose mode.
  $stderr.puts "Could not require 'mkmf'. Not fatal, the extensions are optional."
end


if can_compile_extensions && want_extensions
  create_makefile( 'foo/foo' )

else
  # Create a dummy Makefile, to satisfy Gem::Installer#install
  mfile = open("Makefile", "wb")
  mfile.puts '.PHONY: install'
  mfile.puts 'install:'
  mfile.puts "\t" + '@echo "Extensions not installed, falling back to pure Ruby version."'
  mfile.close

end

正如问题中所建议的，这个答案还需要以下逻辑来加载主库中的 Ruby 回退代码:

lib/foo.rb(摘录)

begin
  # Extension target, might not exist on some installations
  require 'foo/foo'
rescue LoadError
  # Pure Ruby fallback, should cover all methods that are otherwise in extension
  require 'foo/foo_pure_ruby'
end

遵循这条路线还需要一些 rake 任务，这样默认的 rake 任务就不会尝试在我们正在测试的 Rubies 上编译，而这些 Rubies 没有编译扩展的能力:

Rakefile(节选)

def can_compile_extensions
  return false if RUBY_DESCRIPTION =~ /jruby/
  return true
end 

if can_compile_extensions
  task :default => [:compile, :test]
else
  task :default => [:test]
end

请注意 Rakefile 部分不必完全通用，它只需要涵盖我们想要在本地构建和测试 gem 的已知环境(例如所有 Travis 目标)。

我注意到一个烦恼。也就是说，默认情况下您会看到 Ruby Gems 的消息 Building native extensions。这可能需要一段时间...，并且没有迹象表明扩展编译已被跳过。但是，如果您使用 gem install foo --verbose 调用安装程序，您确实会看到添加到 extconf.rb 的消息，所以还不错。