Batch docs in README suggest Batch#add is a class method, but it's not

[dmolesUC]

Based on this example from the README, I've written the following:

def schedule_jobs(task)
  batch = GoodJob::Batch.add do
    Holdings::WorldCatJob.perform_later(task) if task.world_cat?
    Holdings::HathiTrustJob.perform_later(task) if task.hathi?
  end
  batch.enqueue(on_finish: Holdings::ResultsJob, task:)
end

However, this fails with NoMethodError: undefined method 'add' for GoodJob::Batch:Class.

Should I instead just write

GoodJob::Batch.enqueue(on_finish: Holdings::ResultsJob, task:) do
  Holdings::WorldCatJob.perform_later(task) if task.world_cat?
  Holdings::HathiTrustJob.perform_later(task) if task.hathi?
end

?

[bensheldon]

Whoops! Sorry about that; the readme is incorrect. I'd recommend you structure it this way, using a Batch instance:

def schedule_jobs(task)
  batch = GoodJob::Batch.new(on_finish: Holdings::ResultsJob, task:)
  batch.add do
    Holdings::WorldCatJob.perform_later(task) if task.world_cat?
    Holdings::HathiTrustJob.perform_later(task) if task.hathi?
  end
  batch.enqueue
end

You could also do this:

GoodJob::Batch.enqueue(on_finish: Holdings::ResultsJob, task:) do
  Holdings::WorldCatJob.perform_later(task) if task.world_cat?
  Holdings::HathiTrustJob.perform_later(task) if task.hathi?
end

Or if you wanted to make sure you didn't end up with an empty batch, you could do something like this to move the conditions outside of the batch actions themselves.

batch = GoodJob::Batch.new(on_finish: Holdings::ResultsJob, task:)
batch.add(Holdings::WorldCatJob.new(task)) if task.world_cat?
batch.add(Holdings::HathiTrustJob.new(task)) if task.hathi?
batch.enqueue if batch.active_jobs.present?

[bensheldon]

Fixed in f8bd028

[dmolesUC]

@bensheldon Thanks!