Make URN mandatory for UK schools and NCES ID mandatory for US schools

Author: Mohamed-RPF

app/models/school.rb

@@ -16,8 +16,14 @@ class School < ApplicationRecord
   validates :address_line_1, presence: true
   validates :municipality, presence: true
   validates :country_code, presence: true, inclusion: { in: ISO3166::Country.codes }
-  validates :reference, uniqueness: { case_sensitive: false, allow_nil: true }, presence: false
-  validates :district_nces_id, uniqueness: { case_sensitive: false, allow_nil: true }, presence: false
+  validates :reference,
+            uniqueness: { conditions: -> { where(rejected_at: nil) }, case_sensitive: false, allow_nil: true },
+            presence: { if: :united_kingdom? },
+            format: { with: /\A\d{5,6}\z/, allow_nil: true, message: I18n.t('validations.school.reference') }
+  validates :district_nces_id,
+            uniqueness: { conditions: -> { where(rejected_at: nil) }, case_sensitive: false, allow_nil: true },
+            presence: { if: :united_states? },
+            format: { with: /\A\d{12}\z/, allow_nil: true, message: I18n.t('validations.school.district_nces_id') }
   validates :creator_id, presence: true, uniqueness: true
   validates :creator_agree_authority, presence: true, acceptance: true
   validates :creator_agree_terms_and_conditions, presence: true, acceptance: true
@@ -118,6 +124,14 @@ def should_format_uk_postal_code?
     country_code == 'GB' && postal_code.to_s.length >= 5
   end
 
+  def united_kingdom?
+    country_code == 'GB'
+  end
+
+  def united_states?
+    country_code == 'US'
+  end
+
   def format_uk_postal_code
     cleaned_postal_code = postal_code.delete(' ')
     # insert a space as the third-from-last character in the postcode, eg. SW1A1AA -> SW1A 1AA

config/locales/en.yml

@@ -14,6 +14,8 @@ en:
   validations:
     school:
       website: "must be a valid URL"
+      reference: "must be 5-6 digits (e.g., 100000)"
+      district_nces_id: "must be 12 digits (e.g., 010000000001)"
     invitation:
       email_address: "'%<value>s' is invalid"
   activerecord:

db/migrate/20251208134354_change_reference_and_nces_id_indexes_to_partial.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class ChangeReferenceAndNcesIdIndexesToPartial < ActiveRecord::Migration[7.2]
+  def change
+    # Convert reference (UK URN) index to partial index
+    # This allows rejected schools to release their URN for reuse
+    remove_index :schools, :reference
+    add_index :schools, :reference, unique: true, where: 'rejected_at IS NULL'
+
+    # Convert district_nces_id (US NCES ID) index to partial index
+    # This allows rejected schools to release their NCES ID for reuse
+    remove_index :schools, :district_nces_id
+    add_index :schools, :district_nces_id, unique: true, where: 'rejected_at IS NULL'
+  end
+end
+

db/schema.rb

@@ -7,6 +7,7 @@
     address_line_1 { 'Address Line 1' }
     municipality { 'Greater London' }
     country_code { 'GB' }
+    sequence(:reference) { |n| format('%06d', 100000 + n) }
     creator_id { SecureRandom.uuid }
     creator_agree_authority { true }
     creator_agree_terms_and_conditions { true }

spec/factories/school.rb

@@ -132,21 +132,113 @@
       expect(school).to be_valid
     end
 
-    it 'does not require a reference' do
-      create(:school, id: SecureRandom.uuid, reference: nil)
-
+    it 'does not require a reference for non-UK schools' do
+      school.country_code = 'IE'
       school.reference = nil
       expect(school).to be_valid
     end
 
+    it 'requires reference for UK schools' do
+      school.country_code = 'GB'
+      school.reference = nil
+      expect(school).not_to be_valid
+      expect(school.errors[:reference]).to include("can't be blank")
+    end
+
     it 'requires references to be unique if provided' do
+      school.reference = '100000'
+      school.save!
+
+      duplicate_school = build(:school, reference: '100000')
+      expect(duplicate_school).not_to be_valid
+    end
+
+    it 'accepts a valid reference format (5-6 digits)' do
+      school.reference = '100000'
+      expect(school).to be_valid
+    end
+
+    it 'accepts a 5-digit reference' do
+      school.reference = '20000'
+      expect(school).to be_valid
+    end
+
+    it 'rejects a reference with non-digit characters' do
       school.reference = 'URN-123'
+      expect(school).not_to be_valid
+      expect(school.errors[:reference]).to include('must be 5-6 digits (e.g., 100000)')
+    end
+
+    it 'rejects a reference with too few digits' do
+      school.reference = '1234'
+      expect(school).not_to be_valid
+      expect(school.errors[:reference]).to include('must be 5-6 digits (e.g., 100000)')
+    end
+
+    it 'rejects a reference with too many digits' do
+      school.reference = '1234567'
+      expect(school).not_to be_valid
+      expect(school.errors[:reference]).to include('must be 5-6 digits (e.g., 100000)')
+    end
+
+    it 'allows reference reuse when original school is rejected' do
+      school.reference = '100000'
       school.save!
+      school.reject
+
+      new_school = build(:school, reference: '100000')
+      expect(new_school).to be_valid
+      expect { new_school.save! }.not_to raise_error
+    end
+
+    it 'does not require a district_nces_id for non-US schools' do
+      school.country_code = 'GB'
+      school.district_nces_id = nil
+      expect(school).to be_valid
+    end
 
-      duplicate_school = build(:school, reference: 'urn-123')
+    it 'requires district_nces_id for US schools' do
+      school.country_code = 'US'
+      school.district_nces_id = nil
+      expect(school).not_to be_valid
+      expect(school.errors[:district_nces_id]).to include("can't be blank")
+    end
+
+    it 'requires district_nces_id to be unique if provided' do
+      school.district_nces_id = '010000000001'
+      school.save!
+
+      duplicate_school = build(:school, district_nces_id: '010000000001')
       expect(duplicate_school).not_to be_valid
     end
 
+    it 'accepts a valid district_nces_id format (12 digits)' do
+      school.district_nces_id = '010000000001'
+      expect(school).to be_valid
+    end
+
+    it 'rejects a district_nces_id with non-digit characters' do
+      school.district_nces_id = '01000000000A'
+      expect(school).not_to be_valid
+      expect(school.errors[:district_nces_id]).to include('must be 12 digits (e.g., 010000000001)')
+    end
+
+    it 'rejects a district_nces_id with wrong length' do
+      school.district_nces_id = '12345678901'
+      expect(school).not_to be_valid
+      expect(school.errors[:district_nces_id]).to include('must be 12 digits (e.g., 010000000001)')
+    end
+
+    it 'allows district_nces_id reuse when original school is rejected' do
+      school.district_nces_id = '010000000001'
+      school.save!
+      school.reject
+
+      new_school = build(:school, district_nces_id: '010000000001')
+      expect(new_school).to be_valid
+      expect { new_school.save! }.not_to raise_error
+    end
+
     it 'requires an address_line_1' do
       school.address_line_1 = ' '
       expect(school).not_to be_valid