Merge pull request #4398 from nhsuk/common-delegation-functionality

Add foundational delegation methods

Author: thomasleese

app/models/programme.rb

@@ -35,6 +35,8 @@ class Programme < ApplicationRecord
 
   has_many :teams, through: :team_programmes
 
+  scope :supports_delegation, -> { flu }
+
   enum :type,
        { flu: "flu", hpv: "hpv", menacwy: "menacwy", td_ipv: "td_ipv" },
        validate: true
@@ -51,6 +53,8 @@ def doubles? = menacwy? || td_ipv?
 
   def seasonal? = flu?
 
+  def supports_delegation? = flu?
+
   DEFAULT_YEAR_GROUPS_BY_TYPE = {
     "flu" => (0..11).to_a,
     "hpv" => (8..11).to_a,

app/models/session.rb

@@ -77,6 +77,9 @@ class Session < ApplicationRecord
           )
         end
 
+  scope :supports_delegation,
+        -> { has_programmes(Programme.supports_delegation) }
+
   scope :in_progress, -> { has_date(Date.current) }
   scope :unscheduled, -> { where.not(SessionDate.for_session.arel.exists) }
   scope :scheduled,
@@ -192,6 +195,10 @@ def started?
     Date.current > dates.min
   end
 
+  def supports_delegation? = programmes.any?(&:supports_delegation?)
+
+  def pgd_supply_enabled? = supports_delegation?
+
   def year_groups
     @year_groups ||= location_programme_year_groups.pluck_year_groups
   end

db/seeds.rb

@@ -256,6 +256,11 @@ def create_team_sessions(user, team)
   user = create_user(team:, email: "nurse.joy@example.com")
   create_user(team:, email: "admin.hope@example.com", fallback_role: "admin")
   create_user(team:, email: "superuser@example.com", fallback_role: "superuser")
+  create_user(
+    team:,
+    email: "hca@example.com",
+    fallback_role: "healthcare_assistant"
+  )
 
   attach_sample_of_schools_to(team)
 

spec/models/programme_spec.rb

@@ -17,6 +17,22 @@
 describe Programme do
   subject(:programme) { build(:programme) }
 
+  describe "scopes" do
+    describe "#supports_delegation" do
+      subject(:scope) { described_class.supports_delegation }
+
+      let(:flu_programme) { create(:programme, :flu) }
+      let(:hpv_programme) { create(:programme, :hpv) }
+      let(:menacwy_programme) { create(:programme, :menacwy) }
+      let(:td_ipv_programme) { create(:programme, :td_ipv) }
+
+      it { should include(flu_programme) }
+      it { should_not include(hpv_programme) }
+      it { should_not include(menacwy_programme) }
+      it { should_not include(td_ipv_programme) }
+    end
+  end
+
   describe "validations" do
     it { should validate_presence_of(:type) }
     it { should validate_inclusion_of(:type).in_array(%w[flu hpv]) }
@@ -82,6 +98,34 @@
     end
   end
 
+  describe "#supports_delegation?" do
+    subject { programme.supports_delegation? }
+
+    context "with a flu programme" do
+      let(:programme) { build(:programme, :flu) }
+
+      it { should be(true) }
+    end
+
+    context "with an HPV programme" do
+      let(:programme) { build(:programme, :hpv) }
+
+      it { should be(false) }
+    end
+
+    context "with an MenACWY programme" do
+      let(:programme) { build(:programme, :menacwy) }
+
+      it { should be(false) }
+    end
+
+    context "with an Td/IPV programme" do
+      let(:programme) { build(:programme, :td_ipv) }
+
+      it { should be(false) }
+    end
+  end
+
   describe "#default_year_groups" do
     subject { programme.default_year_groups }
 

spec/models/session_spec.rb

@@ -84,6 +84,26 @@
       end
     end
 
+    describe "#supports_delegation" do
+      subject(:scope) { described_class.supports_delegation }
+
+      let!(:hpv_programme) { create(:programme, :hpv) }
+      let!(:flu_programme) { create(:programme, :flu) }
+      let(:session) { create(:session, programmes:) }
+
+      context "with a session for flu" do
+        let(:programmes) { [flu_programme] }
+
+        it { should include(session) }
+      end
+
+      context "with a session for HPV" do
+        let(:programmes) { [hpv_programme] }
+
+        it { should_not include(session) }
+      end
+    end
+
     describe "#in_progress" do
       subject(:scope) { described_class.in_progress }
 
@@ -149,18 +169,20 @@
     end
   end
 
-  describe "#programmes" do
-    subject(:programmes) { session.reload.programmes }
+  describe "associations" do
+    describe "#programmes" do
+      subject(:programmes) { session.reload.programmes }
 
-    let(:hpv_programme) { create(:programme, :hpv) }
-    let(:menacwy_programme) { create(:programme, :menacwy) }
+      let(:hpv_programme) { create(:programme, :hpv) }
+      let(:menacwy_programme) { create(:programme, :menacwy) }
 
-    let(:session) do
-      create(:session, programmes: [menacwy_programme, hpv_programme])
-    end
+      let(:session) do
+        create(:session, programmes: [menacwy_programme, hpv_programme])
+      end
 
-    it "is ordered by name" do
-      expect(programmes).to eq([hpv_programme, menacwy_programme])
+      it "is ordered by name" do
+        expect(programmes).to eq([hpv_programme, menacwy_programme])
+      end
     end
   end
 
@@ -200,6 +222,54 @@
     end
   end
 
+  describe "#supports_delegation?" do
+    subject { session.supports_delegation? }
+
+    let(:session) { create(:session, programmes:) }
+
+    context "with only a flu programme" do
+      let(:programmes) { [create(:programme, :flu)] }
+
+      it { should be(true) }
+    end
+
+    context "with a flu and HPV programme" do
+      let(:programmes) { [create(:programme, :flu), create(:programme, :hpv)] }
+
+      it { should be(true) }
+    end
+
+    context "with only an HPV programme" do
+      let(:programmes) { [create(:programme, :hpv)] }
+
+      it { should be(false) }
+    end
+  end
+
+  describe "#pgd_supply_enabled?" do
+    subject { session.pgd_supply_enabled? }
+
+    let(:session) { create(:session, programmes:) }
+
+    context "with only a flu programme" do
+      let(:programmes) { [create(:programme, :flu)] }
+
+      it { should be(true) }
+    end
+
+    context "with a flu and HPV programme" do
+      let(:programmes) { [create(:programme, :flu), create(:programme, :hpv)] }
+
+      it { should be(true) }
+    end
+
+    context "with only an HPV programme" do
+      let(:programmes) { [create(:programme, :hpv)] }
+
+      it { should be(false) }
+    end
+  end
+
   describe "#year_groups" do
     subject { session.year_groups }
 

spec/support/cis2_auth_helper.rb

@@ -93,7 +93,7 @@ def cis2_auth_info
     }
   end
 
-  def cis2_sign_in(user, ods_code:, role_code:, workgroups:)
+  def cis2_sign_in(user, ods_code:, role_code:, activity_codes:, workgroups:)
     mock_cis2_auth(
       uid: user.uid,
       given_name: user.given_name,
@@ -102,6 +102,7 @@ def cis2_sign_in(user, ods_code:, role_code:, workgroups:)
       sid: user.session_token,
       org_code: ods_code,
       role_code:,
+      activity_codes:,
       workgroups:
     )
 
@@ -118,15 +119,24 @@ def sign_in(user, organisation: nil, role: :nurse, superuser: false)
 
     ods_code = organisation.ods_code
 
-    role_code ||= {
-      nurse: CIS2Info::NURSE_ROLE,
-      admin: CIS2Info::ADMIN_ROLE
+    role_code = {
+      admin: CIS2Info::ADMIN_ROLE,
+      healthcare_assistant: CIS2Info::ADMIN_ROLE,
+      nurse: CIS2Info::NURSE_ROLE
+    }.fetch(role)
+
+    activity_codes = {
+      admin: [],
+      healthcare_assistant: [
+        CIS2Info::PERSONAL_MEDICATION_ADMINISTRATION_ACTIVITY_CODE
+      ],
+      nurse: []
     }.fetch(role)
 
     workgroups = user.teams.where(organisation:).pluck(:workgroup)
     workgroups << CIS2Info::SUPERUSER_WORKGROUP if superuser
 
-    cis2_sign_in(user, ods_code:, role_code:, workgroups:)
+    cis2_sign_in(user, ods_code:, role_code:, activity_codes:, workgroups:)
   end
 
   def mock_cis2_auth(