Add suitability record models

app/models/suitability_record.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: suitability_records
+#
+#  id            :bigint           not null, primary key
+#  archive_note  :text             default(""), not null
+#  archived_at   :datetime
+#  country_code  :text             default(""), not null
+#  date_of_birth :date
+#  note          :text             not null
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+class SuitabilityRecord < ApplicationRecord
+  has_and_belongs_to_many :application_forms
+  has_many :emails, class_name: "SuitabilityRecord::Email"
+  has_many :names, class_name: "SuitabilityRecord::Name"
+
+  scope :active, -> { where(archived_at: nil) }
+
+  validates :note, presence: true
+  validates :archive_note, presence: true, if: :archived?
+
+  def archived?
+    archived_at.present?
+  end
+
+  class Email < ApplicationRecord
+    self.table_name = "suitability_record_emails"
+
+    validates :value, presence: true
+    validates :canonical, presence: true
+
+    def value=(value)
+      self.value = value
+      self.canonical = EmailAddress.canonical(value)
+    end
+  end
+
+  class Name < ApplicationRecord
+    self.table_name = "suitability_record_names"
+
+    validates :value, presence: true
+  end
+end

config/analytics.yml

@@ -55,6 +55,9 @@
     - written_statement_confirmation
     - written_statement_optional
     - written_statement_status
+  :application_forms_suitability_records:
+    - application_form_id
+    - suitability_record_id
   :assessment_sections:
     - assessed_at
     - assessment_id
@@ -314,6 +317,26 @@
     - updated_at
     - verify_permission
     - withdraw_permission
+  :suitability_record_emails:
+    - canonical
+    - created_at
+    - id
+    - suitability_record_id
+    - updated_at
+    - value
+  :suitability_record_names:
+    - created_at
+    - id
+    - suitability_record_id
+    - updated_at
+    - value
+  :suitability_records:
+    - archived_at
+    - country_code
+    - created_at
+    - date_of_birth
+    - id
+    - updated_at
   :teachers:
     - canonical_email
     - created_at

config/analytics_blocklist.yml

@@ -86,6 +86,9 @@
     - invitation_token
     - reset_password_token
     - unlock_token
+  :suitability_records:
+    - archive_note
+    - note
   :teachers:
     - access_your_teaching_qualifications_url
   :timeline_events:

config/analytics_hidden_pii.yml

@@ -17,6 +17,13 @@
     - last_sign_in_ip
     - name
     - unconfirmed_email
+  :suitability_record_emails:
+    - canonical
+    - value
+  :suitability_record_names:
+    - value
+  :suitability_records:
+    - date_of_birth
   :teachers:
     - canonical_email
     - current_sign_in_ip

db/migrate/20240711100342_add_suitability_records.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class AddSuitabilityRecords < ActiveRecord::Migration[7.1]
+  def change
+    create_table :suitability_records do |t|
+      t.text :country_code, limit: 7, null: false, default: ""
+      t.date :date_of_birth
+
+      t.text :note, null: false
+
+      t.datetime :archived_at
+      t.text :archive_note, null: false, default: ""
+
+      t.timestamps
+    end
+
+    create_table :suitability_record_emails do |t|
+      t.text :value, null: false
+      t.text :canonical, null: false
+      t.references :suitability_record, null: false, foreign_key: true
+      t.timestamps
+    end
+
+    create_table :suitability_record_names do |t|
+      t.text :value, null: false
+      t.references :suitability_record, null: false, foreign_key: true
+      t.timestamps
+    end
+
+    create_join_table :suitability_records, :application_forms
+  end
+end

spec/factories/suitability_records.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :suitability_record do
+    note { Faker::Lorem.sentence }
+
+    trait :archived do
+      archived_at { Time.zone.now }
+      archive_note { Faker::Lorem.sentence }
+    end
+  end
+
+  factory :suitability_record_email do
+    association :suitability_record
+
+    value { Faker::Name.name }
+  end
+
+  factory :suitability_record_name do
+    association :suitability_record
+
+    value { Faker::Internet.email }
+    canonical { EmailAddress.canonical(value) }
+  end
+end

spec/models/suitability_record_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe SuitabilityRecord, type: :model do
+  subject(:suitability_record) { build(:suitability_record) }
+
+  describe "validations" do
+    it { is_expected.to be_valid }
+
+    it { is_expected.to validate_presence_of(:note) }
+    it { is_expected.not_to validate_presence_of(:archive_note) }
+
+    context "when archived" do
+      before { suitability_record.archived_at = Time.zone.now }
+
+      it { is_expected.to validate_presence_of(:archive_note) }
+    end
+  end
+end