Add daily batch scope to Submission

This scopes submission based on their created_at, form_id and mode. The
given date is converted to the local time before the comparison to the
created_at value.

Co-authored-by: Stephen Daly <stephen.daly@digital.cabinet-office.gov.uk>

Author: SamJamCul

app/models/submission.rb

@@ -1,9 +1,14 @@
 class Submission < ApplicationRecord
-  include TimeZoneUtils
-
   has_many :submission_deliveries, dependent: :destroy
   has_many :deliveries, through: :submission_deliveries
 
+  scope :for_daily_batch, lambda { |form_id, date, mode|
+    start_time = date.in_time_zone(TimeZoneUtils.submission_time_zone).beginning_of_day
+    end_time = start_time.end_of_day
+
+    where(form_id:, created_at: start_time..end_time, mode: mode).order(created_at: :desc)
+  }
+
   delegate :preview?, to: :mode_object
 
   encrypts :answers
@@ -17,7 +22,7 @@ def form
   end
 
   def submission_time
-    created_at.in_time_zone(submission_time_zone)
+    created_at.in_time_zone(TimeZoneUtils.submission_time_zone)
   end
 
   def payment_url

lib/time_zone_utils.rb

@@ -1,5 +1,5 @@
 module TimeZoneUtils
-  def submission_time_zone
+  def self.submission_time_zone
     Rails.configuration.x.submission.time_zone || "UTC"
   end
 end

spec/models/submission_spec.rb

@@ -1,6 +1,52 @@
 require "rails_helper"
 
 RSpec.describe Submission, type: :model do
+  describe "scopes" do
+    describe ".for_daily_batch" do
+      context "when the date is during BST" do
+        let(:form_id) { 101 }
+        let!(:start_of_day_submission) { create(:submission, form_id:, created_at: Time.utc(2022, 5, 31, 23, 0, 0), mode:) }
+        let!(:end_of_day_submission) { create(:submission, form_id:, created_at: Time.utc(2022, 6, 1, 22, 59, 59), mode:) }
+        let(:mode) { "form" }
+        let(:date) { Date.new(2022, 6, 1) }
+
+        before do
+          create(:submission, form_id: 5, created_at: Time.utc(2022, 6, 1, 12, 0, 0), mode:)
+          create(:submission, form_id:, created_at: Time.utc(2022, 5, 31, 22, 59, 59), mode:)
+          create(:submission, form_id:, created_at: Time.utc(2022, 6, 1, 23, 0, 0), mode:)
+          create(:submission, form_id:, created_at: Time.utc(2022, 6, 2, 12, 0, 0), mode: "preview-live")
+        end
+
+        it "returns only submissions for the given form, date and mode" do
+          submissions = described_class.for_daily_batch(form_id, date, mode)
+          expect(submissions.size).to eq(2)
+          expect(submissions).to contain_exactly(start_of_day_submission, end_of_day_submission)
+        end
+      end
+
+      context "when the date is not during BST" do
+        let(:form_id) { 101 }
+        let!(:start_of_day_submission) { create(:submission, form_id:, created_at: Time.utc(2022, 12, 1, 0, 0, 0), mode:) }
+        let!(:end_of_day_submission) { create(:submission, form_id:, created_at: Time.utc(2022, 12, 1, 23, 59, 59), mode:) }
+        let(:mode) { "form" }
+        let(:date) { Date.new(2022, 12, 1) }
+
+        before do
+          create(:submission, form_id: 5, created_at: Time.utc(2022, 12, 1, 12, 0, 0), mode:)
+          create(:submission, form_id:, created_at: Time.utc(2022, 11, 30, 23, 59, 59), mode:)
+          create(:submission, form_id:, created_at: Time.utc(2022, 12, 2, 0, 0, 0), mode:)
+          create(:submission, form_id:, created_at: Time.utc(2022, 12, 1, 12, 0, 0), mode: "preview-live")
+        end
+
+        it "returns only submissions for the given form, date and mode" do
+          submissions = described_class.for_daily_batch(form_id, date, mode)
+          expect(submissions.size).to eq(2)
+          expect(submissions).to contain_exactly(start_of_day_submission, end_of_day_submission)
+        end
+      end
+    end
+  end
+
   describe "#sent?" do
     context "when the submission is sent" do
       let(:submission) { create :submission, :sent }