Merge pull request #3999 from nhsuk/academic-year-model

Add convenience methods for working with academic years

Author: thomasleese

app/jobs/send_vaccination_confirmations_job.rb

@@ -12,7 +12,7 @@ def perform
         .kept
         .where.not(confirmation_sent_at: nil)
         .maximum(:created_at) || 24.hours.ago
-    academic_year = Date.current.academic_year
+    academic_year = AcademicYear.current
 
     VaccinationRecord
       .includes(patient: { consents: :parent })

app/lib/academic_year.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AcademicYear
+  class << self
+    def all = (first..last).to_a
+
+    def current = Date.current.academic_year
+
+    # 2024 is the year we ran Mavis. We support earlier years only in the case
+    # where the service is running in an environment prior to 2024 (only used
+    # when changing the date in tests).
+    def first = [2024, current].min
+
+    def last = current
+  end
+end

app/lib/unscheduled_sessions_factory.rb

@@ -2,7 +2,7 @@
 
 class UnscheduledSessionsFactory
   def initialize(academic_year: nil)
-    @academic_year = academic_year || Date.current.academic_year
+    @academic_year = academic_year || AcademicYear.current
   end
 
   def call

app/models/immunisation_import_row.rb

@@ -573,8 +573,7 @@ def validate_date_of_vaccination
       end
 
       if programme&.flu? &&
-           date_of_vaccination.to_date.academic_year !=
-             Date.current.academic_year
+           date_of_vaccination.to_date.academic_year != AcademicYear.current
         errors.add(
           date_of_vaccination.header,
           "must be in the current academic year"

app/models/organisation.rb

@@ -91,7 +91,7 @@ def generic_clinic
   end
 
   def generic_clinic_session
-    academic_year = Date.current.academic_year
+    academic_year = AcademicYear.current
     location = generic_clinic
 
     sessions

app/models/session.rb

@@ -60,7 +60,7 @@ class Session < ApplicationRecord
   scope :today, -> { has_date(Date.current) }
 
   scope :for_current_academic_year,
-        -> { where(academic_year: Date.current.academic_year) }
+        -> { where(academic_year: AcademicYear.current) }
 
   scope :unscheduled,
         -> do

app/models/vaccination_record.rb

@@ -182,7 +182,7 @@ def academic_year
   end
 
   def performed_this_academic_year?
-    academic_year == Date.current.academic_year
+    academic_year == AcademicYear.current
   end
 
   def show_this_academic_year?

lib/core_ext/integer/academic_year.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Integer
+  def to_academic_year_date_range
+    start_date = Date.new(self, 9, 1)
+    end_date = Date.new(self + 1, 8, 31)
+    start_date..end_date
+  end
+end

lib/generate/cohort_imports.rb

@@ -180,17 +180,13 @@ def build_patient
         end
     end
 
-    def date_of_birth_for_year(
-      year_group,
-      academic_year: Date.current.academic_year
-    )
-      academic_year = academic_year.to_s
-      year_group = year_group.to_i
-
+    def date_of_birth_for_year(year_group, academic_year: AcademicYear.current)
       if year_group < 12
-        start_date = Date.new(academic_year.to_i - (year_group.to_i + 5), 9, 1)
-        end_date = Date.new(academic_year.to_i - (year_group.to_i + 4), 8, 31)
-        rand(start_date..end_date)
+        rand(
+          year_group.to_birth_academic_year(
+            academic_year:
+          ).to_academic_year_date_range
+        )
       else
         raise "Unknown year group: #{year_group}"
       end

spec/factories/patients.rb

@@ -90,7 +90,7 @@
 
     date_of_birth do
       if year_group
-        academic_year_start = Date.new(Date.current.academic_year, 9, 1)
+        academic_year_start = Date.new(AcademicYear.current, 9, 1)
         start_date = academic_year_start - (5 + year_group).years
         end_date = start_date + 1.year - 1.day
         Faker::Date.between(from: end_date, to: start_date)