如何从rake任务中提前返回？

Question

我有一个rake任务，我在开始时做一些检查，如果其中一个检查失败，我想从rake任务提前返回，我不想执行任何剩余的代码。

我认为解决方案是在我希望从代码返回的地方放置一个返回但是我得到以下错误

unexpected return

Answer 1

Rake任务基本上是一个块。除lambdas之外的块不支持返回，但是您可以使用next跳到下一个语句，在rake任务中它与在方法中使用return具有相同的效果。

task :foo do
  puts "printed"
  next
  puts "never printed"
end

或者您可以在方法中移动代码并在方法中使用return。

task :foo do
  do_something
end

def do_something
  puts "startd"
  return
  puts "end"
end

我更喜欢第二种选择。

Answer 2

您可以使用任务内部的abort(message)通过消息中止该任务。

Answer 3

我倾向于使用abort，在这种情况下这是一个更好的选择，例如：

task :foo do
  something = false
  abort 'Failed to proceed' unless something
end

Answer 4

如果您需要突破多个块级别，可以使用fail。

例如

task :something do
  [1,2,3].each do |i|
    ...
    fail "some error" if ...
  end
end

Answer 5

如果你的意思是退出rake任务而不会导致“rake aborted！”要打印的消息，然后您可以使用“中止”或“退出”。但是，当在救援块中使用时，“abort”会终止任务并打印整个错误（即使不使用--trace）。所以“退出”是我使用的。

Answer 6

返回错误❌

如果您返回时出现错误（即退出代码为1），您将需要使用abort，它还会在退出时输出一个可选的字符串参数：

task :check do
  errors = get_errors

  abort( "There are #{errors.count} errors!" ) if errors.any?

  # Do remaining checks...
end

在命令行上：

$ rake check && echo "All good"
#=> There are 2 errors!

如果你没有错误返回（即0的退出代码）你将要使用exit，它不采用字符串参数。

task :check do
  errors = get_errors

  exit if errors.empty?

  # Process errors...
end

在命令行上：

$ rake check && echo "All good"
#=> All good

如果您在cron作业中使用它或者之后需要根据rake任务是否成功执行某些操作，这一点很重要。

Answer 7

我使用了Simone Carletti建议的next方法，因为在测试rake任务时，abort实际上只是exit的包装，并不是理想的行为。

例：

task auto_invoice: :environment do
  if Application.feature_disabled?(:auto_invoice)
    $stderr.puts 'Feature is disabled, aborting.'
  next
end