Implement job batches

Author: matteeyah

README.md

@@ -324,6 +324,24 @@ class MyJob < ActiveJob::Base
 end
 ```
 
+### Grouping jobs into batches
+
+```ruby
+job       = MyJob.perform_later
+other_job = OtherJob.perform_later 
+
+batch = ActiveJob::Status::Batch.new(job, other_job)
+batch.status
+# "queued"
+```
+
+The batch status can be `queued`, `failed`, `completed` or `working`.
+
+1. The batch is considered `queued` if **all** of the jobs are `queued`
+2. The batch is considered `failed` if **one** of the jobs is `failed`
+3. The batch is considered `completed` if **all** of the jobs are `completed`
+4. The batch is considered `working` in all other circumstances
+
 ## ActiveJob::Status and exceptions
 
 Internally, ActiveJob::Status uses `ActiveSupport#rescue_from` to catch every `Exception` to apply the `failed` status

lib/activejob-status.rb

@@ -8,6 +8,7 @@
 require "activejob-status/status"
 require "activejob-status/progress"
 require "activejob-status/throttle"
+require "activejob-status/batch"
 
 module ActiveJob
   module Status

lib/activejob-status/batch.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module Status
+    class Batch
+      def initialize(*jobs)
+        @statuses = jobs.map { |job| ActiveJob::Status.get(job) }
+      end
+
+      def status
+        if @statuses.all? { |status| status[:status] == :queued }
+          :queued
+        elsif @statuses.any? { |status| status[:status] == :failed }
+          :failed
+        elsif @statuses.all? { |status| status[:status] == :completed }
+          :completed
+        else
+          :working
+        end
+      end
+    end
+  end
+end

spec/specs/active_job/status/batch_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "../../../spec_helper"
+require_relative "../../../jobs/test_jobs"
+
+RSpec.describe ActiveJob::Status::Batch do
+  describe "#status" do
+    it "returns queued when all jobs are queued" do
+      first_job = BaseJob.perform_later
+      second_job = BaseJob.perform_later
+      batch = described_class.new(first_job, second_job)
+
+      ActiveJob::Status.get(first_job).update(status: :queued)
+      ActiveJob::Status.get(second_job).update(status: :queued)
+
+      expect(batch.status).to eq(:queued)
+    end
+
+    it "returns failed when one job is failed" do
+      first_job = BaseJob.perform_later
+      second_job = BaseJob.perform_later
+      batch = described_class.new(first_job, second_job)
+
+      ActiveJob::Status.get(first_job).update(status: :failed)
+      ActiveJob::Status.get(second_job).update(status: :completed)
+
+      expect(batch.status).to eq(:failed)
+    end
+
+    it "returns completed when all jobs are completed" do
+      first_job = BaseJob.perform_later
+      second_job = BaseJob.perform_later
+      batch = described_class.new(first_job, second_job)
+
+      ActiveJob::Status.get(first_job).update(status: :completed)
+      ActiveJob::Status.get(second_job).update(status: :completed)
+
+      expect(batch.status).to eq(:completed)
+    end
+
+    it "returns working in other cases" do
+      first_job = BaseJob.perform_later
+      second_job = BaseJob.perform_later
+      batch = described_class.new(first_job, second_job)
+
+      ActiveJob::Status.get(first_job).update(status: :queued)
+      ActiveJob::Status.get(second_job).update(status: :working)
+
+      expect(batch.status).to eq(:working)
+    end
+  end
+end