Como volto cedo de uma tarefa de rake?

Eu tenho uma tarefa de rake em que faço algumas verificações no início. Se uma das verificações falhar, gostaria de retornar mais cedo da tarefa de rake, não quero executar nenhum código restante.

Eu pensei que a solução seria colocar um retorno onde eu queria retornar do código, mas eu recebo o seguinte erro

unexpected return

Uma tarefa Rake é basicamente um bloco. Um bloco, exceto lambdas, não suporta retorno, mas você pode pular para a próxima instrução usando a nextqual em uma tarefa rake tem o mesmo efeito de usar retorno em um método.

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

Ou você pode mover o código em um método e usar return no método

task :foo do
  do_something
end

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

Eu prefiro a segunda escolha.

Você pode usar abort(message)de dentro da tarefa para interromper a tarefa com uma mensagem.

Costumo usar abortqual é a melhor alternativa em tais situações, por exemplo:

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

Retornar com um erro ❌

Se você estiver retornando com um erro (ou seja, um código de saída de 1), você desejará usar abort, o que também exige um parâmetro de string opcional que será gerado na saída:

task :check do

  # If any of your checks fail, you can exit early like this.
  abort( "One of the checks has failed!" ) if check_failed?

end

Na linha de comando:

$ rake check && echo "All good"
#=> One of the checks has failed!

Retorne com sucesso ✅

Se você estiver retornando sem um erro (ou seja, um código de saída de 0), você desejará usar exit, o que não exige um parâmetro de string.

task :check do

  # If any of your checks fail, you can exit early like this.
  exit if check_failed?

end

Na linha de comando:

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

Isso é importante se você estiver usando isso em um trabalho cron ou algo que precise fazer algo posteriormente com base em se a tarefa rake foi bem-sucedida ou não.

Se você precisar romper vários níveis de bloco, poderá usar falha .

Por exemplo

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

(Consulte https://stackoverflow.com/a/3753955/11543 .)

Se você pretendia sair de uma tarefa de rake sem causar o "rake abortado!" mensagem a ser impressa, você pode usar "abortar" ou "sair". Mas "abortar", quando usado em um bloco de recuperação, finaliza a tarefa e imprime todo o erro (mesmo sem usar --trace). Então "exit" é o que eu uso.

eu usei next abordagem sugerida por Simone Carletti, já que o teste da tarefa de rake abort, que na verdade é apenas um invólucro exit, não é o comportamento desejado.

Exemplo:

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