如何解析 Gemfile 以找到不在源块内的内部 gem？

问题描述

为了安全起见，Gemfile 中的内部 Ruby gem 应始终在 source 块内引用，因此它永远不会尝试从 ruby​​gems.org 获取它们。我想自动查找人们无法执行此操作的地方，因此想解析 Gemfile，找到与我们的内部名称匹配的任何 gem，并检查 ruby​​gems.org 是否不在其可能的来源列表中。

source 'https://rubygems.org'

gem 'rails'

gem 'my-private-gem1' # this should be in the source block below

source PRIVATE_GEM_REPO do
  gem 'my-private-gem2'
end

我已经看到您可以解析 Gemfile

Bundler::Definition.build('Gemfile','',{})

但在返回的数据结构中找不到任何显示每个 gem 可用/允许来源的内容

如果我包含 Gemfile.lock，我会看到更多的源信息，但这似乎不对，因为每个 gem 都会列出我的所有源，而不管它们是否在源块中

Bundler::Definition.build('Gemfile','Gemfile.lock',{}).
  locked_gems.
  specs.
  map {|g| [g.full_name,g.source.remotes.map(&:hostname).join(',')]}
=> ["rails-6.0.3.4","my.private.gemserver,rubygems.org"],["my-private-gem1-1.0.0",["my-private-gem2-1.0.0",rubygems.org"]]

关于如何解析 Gemfile 以发现 my-private-gem1 位于源块之外的任何想法？

解决方法

终于想通了，只是花了一些时间来研究 Bundler 方法 - 以及同事的帮助。

Bundler::Definition.
  build('Gemfile','',nil).
  dependencies.
  map {|dep| [dep.name,dep.source&.remotes&.map(&:hostname)&.join(',')]}
=>
[["rails",nil],["my-private-gem1",["my-private-gem2","my.private.gemserver"]]

现在，我可以轻松地在结果数据结构中搜索未锁定到我的私有 gem 服务器的任何私有 gem。

,

前言

在我写这个答案时，OP 找到了一个特定于 Bundler 的答案。但是，我在下面提供了一个更通用的解决方案。此解决方案还提供用户反馈，可以更轻松地修复文件。

通过列对齐查找候选 Gems，使用白名单

如果您可以安全地假设您的 Gemfile 始终正确缩进，那么 KISS 解决方案可能是简单地识别组定义中未缩进的 gem。例如：

# example Gemfile to test against
GEMFILE = <<~'EOF'
  source 'https://rubygems.org'
  gem 'rails'
  gem 'my-private-gem1' # this should be in the source block below
  source PRIVATE_GEM_REPO do
    gem 'my-private-gem2'
  end
EOF

# gems that are acceptable in a non-group context
whitelist = Regexp.new %w[rails sass-rails webpacker].join(?|)

UngroupedGem   = Struct.new :line_no,:line_txt,:gem_name
ungrouped_gems = []

GEMFILE.lines.each_with_index do |line_txt,line_no|
  next if line_txt =~ whitelist or line_txt !~ /^\s*gem/
  gem_name = line_txt.match(/(?<=(['"]))(.*?)(?=\1)/)[0]
  ungrouped_gems.append(
    UngroupedGem.new line_no.succ,line_txt,gem_name
  ).compact!
end

# tell the user what actions to take
if ungrouped_gems.any?
  puts "Line No.\tGem Name"
  ungrouped_gems.each { printf "%d\t\t%s\n",_1.line_no,_1.gem_name }
else
  puts "No gems need to be moved."
end

在这个例子中，它将打印：

Line No.  Gem Name
3         my-private-gem1
5         my-private-gem2

这将使您清楚地了解 Gemfile 中的哪些行需要移动，以及涉及哪些特定的 gem。