如何在 Ruby 脚本中运行 Rake 任务？

Posted 2023-03-16

【中文标题】如何在 Ruby 脚本中运行 Rake 任务？

【英文标题】：How do I run Rake tasks within a Ruby script?

【发布时间】：2010-09-05 10:26:51

【问题描述】：

我有一个 Rakefile 和一个我通常会从命令行调用的 Rake 任务：

rake blog:post Title

我想编写一个多次调用该 Rake 任务的 Ruby 脚本，但我看到的唯一解决方案是使用 ``（反引号）或 system 进行炮击。

这样做的正确方法是什么？

【参考方案1】：

来自timocracy.com：

require 'rake'

def capture_stdout
  s = StringIO.new
  oldstdout = $stdout
  $stdout = s
  yield
  s.string
ensure
  $stdout = oldstdout
end

Rake.application.rake_require 'metric_fetcher', ['../../lib/tasks']
results = capture_stdout Rake.application['metric_fetcher'].invoke

【讨论】：

在 Rails 3.1 中，rake/rdoctask 已被弃用，并且缺少 tasks/rails。上面的代码只适用于第一个 require 语句。

为了更改标准输出，我建议通过#dup 保存原始流，然后将#reopen 保存到Tempfile，在重新打开原始流后读取。如果任务使用STDOUT 常量或运行外部程序，则仅分配$stdout 将不起作用。

请注意rake_require 始终将给定路径与$LOAD_PATH 数组中的每个路径连接起来，并检查文件是否存在。所以第一个参数应该是一个相对路径。即使它包含前导斜杠（或非 Unix 系统上的反斜杠），它也会被视为相对。

【参考方案2】：

您可以使用invoke 和reenable 再次执行任务。

您的示例调用rake blog:post Title 似乎有一个参数。这个参数可以作为invoke中的参数：

例子：

require 'rake'
task 'mytask', :title do |tsk, args|
  p "called #tsk (#args[:title])"
end



Rake.application['mytask'].invoke('one')
Rake.application['mytask'].reenable
Rake.application['mytask'].invoke('two')

请将mytask 替换为blog:post，而不是您可以require rakefile 的任务定义。

此解决方案会将结果写入标准输出 - 但您没有提到要抑制输出。

---

有趣的实验：

您也可以在任务定义中调用reenable。这允许任务重新启用自己。

例子：

require 'rake'
task 'mytask', :title do |tsk, args|
  p "called #tsk (#args[:title])"
  tsk.reenable  #<-- HERE
end

Rake.application['mytask'].invoke('one')
Rake.application['mytask'].invoke('two')

结果（用 rake 10.4.2 测试）：

"called mytask (one)"
"called mytask (two)"

【讨论】：

@JasonFB 你有例子吗？

@JasonFB 另请参阅我编辑的答案。也许这是您的问题的替代方案..

【参考方案3】：

这适用于 Rake 版本 10.0.3：

require 'rake'
app = Rake.application
app.init
# do this as many times as needed
app.add_import 'some/other/file.rake'
# this loads the Rakefile and other imports
app.load_rakefile

app['sometask'].invoke

正如 knut 所说，如果您想多次调用，请使用 reenable。

【讨论】：

嗨@JasonFB，您可以使用app.add_import "#Gem::Specification.find_by_name('statesman').gem_dir/lib/tasks/statesman.rake" 之类的方式访问gem

【参考方案4】：

在加载了 Rails 的脚本中（例如 rails runner script.rb）

def rake(*tasks)
  tasks.each do |task|
    Rake.application[task].tap(&:invoke).tap(&:reenable)
  end
end

rake('db:migrate', 'cache:clear', 'cache:warmup')