如何从 extconf.rb 读取 gem 文件规范？答案

【问题标题】：How to read the gem file specifications from extconf.rb?如何从 extconf.rb 读取 gem 文件规范？
【发布时间】：2015-07-08 10:21:09
【问题描述】：

我正在构建一个 Ruby gem 文件，该文件具有各种 3rd 方可执行要求（gem 将通过系统调用使用的一些非 ruby 工具）。

需求列表是使用 gemspec 提供信息的requirements 列表指定的，我的任务是创建一个设置，在安装期间验证该需求列表 - 基本上将 requirements 列表从提供信息转换为权威。

我最初的方法是使用extensions，就像在extconf.rb 模式中一样，在安装过程中运行一些ruby 代码，这些代码将验证需求列表，如果不满足需求则安装失败。

所以我当前的实现是使用ext/Rakefile，它使用硬编码路径读取 gemspec 文件，使用自定义（但直接且简单）语法解析 requirements 列表，并在所需的可执行文件。

我真的很想排除对知道 gemspec 文件路径的依赖，这样我就可以在其他项目中以模块化方式重用代码。

为了完成（并希望它对某人有用），这是我的代码 - 它使用Gem::Ext::Builder“Rakefile 模式”来运行一些任意代码。

require 'rubygems'
require 'mkmf'

def verify_requirement(reqspec)
  exe, version_spec, version_regex = reqspec.split(/\s*,\s*/,3)

  exe = $1 if exe =~ /\[([^\]]+)\]/ # support human readable alias for executable name

  abort "Missing required executable #{exe}!" unless find_executable(exe)
  return unless version_spec # no version is specified, so executable existing is good enough

  version = %x|#{exe} --version 2>&1|.chomp
  version = %x|#{exe} -version 2>&1|.chomp unless $?.success? 
  abort "Error checking for version of #{exe}: (#{$?.exitstatus}) #{version}" unless $?.success?

  if version_regex
    abort "Version test '#{version_regex}' failed to match '#{version}'!" unless version =~ /#{version_regex}/m
    abort "Version test '#{version_regex}' failed to generate a version number!" unless $1
    version = $1
  end

  abort "Failed to locate a valid version number for #{exe}, found '#{version}'" unless version =~ /^[0-9\.]+/
  abort "Insufficient version '#{version}' for #{exe} - requires #{version_spec}"  unless Gem::Dependency.new(exe, version_spec).match? exe, version
end

task :default do
  gemspec = File.absolute_path('../my.gemspec')
  Gem::Specification::load(gemspec).requirements.each do |req|
    verify_requirement(req)
  end
end

此代码要求requirements 使用以下任一语法：

exe-file[, <semantic-version-spec>[, <version-garabbing-regex>]]
alias '[' exe-file ']'[, <semantic-version-spec>[, <version-garabbing-regex>]]

例如：

spec.requirements << 'sox'
spec.requirements << 'ffmpeg, >= 2.5, ffmpeg version ([\d\.]+)'
spec.requirements << 'ImageMagick [convert], >= 6.7.5, ImageMagick ([\d\.]+)'

【问题讨论】：

标签： ruby gem

【解决方案1】：

Gem::Specification 类可用于加载和解析gemspec。我在ext/Rakefile 中使用以下代码来执行基于gemspec 文件的任务：

task :default do
  gemspec = File.absolute_path('../gemname.gemspec')
  Gem::Specification::load(gemspec).requirements.each do |req|
    verify_requirement(req)
  end
end

【讨论】：