Create ImportantNotice model and policy

This supports the dismiss notice feature. The policy restricts notices to superusers in the select team only.

Author: murugapl

app/models/important_notice.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: important_notices
+#
+#  id                    :bigint           not null, primary key
+#  dismissed_at          :datetime
+#  recorded_at           :datetime         not null
+#  type                  :integer          not null
+#  created_at            :datetime         not null
+#  updated_at            :datetime         not null
+#  dismissed_by_user_id  :bigint
+#  patient_id            :bigint           not null
+#  team_id               :bigint           not null
+#  vaccination_record_id :bigint
+#
+# Indexes
+#
+#  index_important_notices_on_dismissed_by_user_id             (dismissed_by_user_id)
+#  index_important_notices_on_patient_id                       (patient_id)
+#  index_important_notices_on_team_id                          (team_id)
+#  index_important_notices_on_vaccination_record_id            (vaccination_record_id)
+#  index_notices_on_patient_and_type_and_recorded_at_and_team  (patient_id,type,recorded_at,team_id) UNIQUE
+#
+# Foreign Keys
+#
+#  fk_rails_...  (dismissed_by_user_id => users.id)
+#  fk_rails_...  (patient_id => patients.id)
+#  fk_rails_...  (team_id => teams.id)
+#  fk_rails_...  (vaccination_record_id => vaccination_records.id)
+#
+class ImportantNotice < ApplicationRecord
+  self.inheritance_column = nil
+
+  belongs_to :patient
+
+  belongs_to :vaccination_record, optional: true
+
+  enum :type,
+       { deceased: 0, invalidated: 1, restricted: 2, gillick_no_notify: 3 }
+
+  scope :active, ->(team:) { where(dismissed_at: nil, team_id: team.id) }
+  scope :dismissed,
+        ->(team:) { where.not(dismissed_at: nil).where(team_id: team.id) }
+
+  validates :type, presence: true
+  validates :recorded_at, presence: true
+  validates :message, presence: true
+
+  def dismiss!(user: nil)
+    update!(dismissed_at: Time.current, dismissed_by_user_id: user&.id)
+  end
+
+  def message
+    case type
+    when "deceased"
+      "Record updated with child’s date of death"
+    when "invalidated"
+      "Record flagged as invalid"
+    when "restricted"
+      "Record flagged as sensitive"
+    when "gillick_no_notify"
+      "Child gave consent for #{vaccination_record.programme.name} under Gillick competence and " \
+        "does not want their parents to be notified. " \
+        "These records will not be automatically synced with GP records. " \
+        "Your team must let the child's GP know they were vaccinated."
+    else
+      "Important notice"
+    end
+  end
+
+  def can_dismiss?
+    type.in?(%w[deceased restricted gillick_no_notify])
+  end
+end

app/policies/important_notice_policy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class ImportantNoticePolicy < ApplicationPolicy
+  class Scope < ApplicationPolicy::Scope
+    def resolve
+      scope
+        .joins(:patient)
+        .active(team: user.selected_team)
+        .where(team_id: user.selected_team.id)
+    end
+  end
+
+  def index?
+    user.can_access_sensitive_flagged_records?
+  end
+end

spec/factories/important_notices.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: important_notices
+#
+#  id                    :bigint           not null, primary key
+#  dismissed_at          :datetime
+#  recorded_at           :datetime         not null
+#  type                  :integer          not null
+#  created_at            :datetime         not null
+#  updated_at            :datetime         not null
+#  dismissed_by_user_id  :bigint
+#  patient_id            :bigint           not null
+#  team_id               :bigint           not null
+#  vaccination_record_id :bigint
+#
+# Indexes
+#
+#  index_important_notices_on_dismissed_by_user_id             (dismissed_by_user_id)
+#  index_important_notices_on_patient_id                       (patient_id)
+#  index_important_notices_on_team_id                          (team_id)
+#  index_important_notices_on_vaccination_record_id            (vaccination_record_id)
+#  index_notices_on_patient_and_type_and_recorded_at_and_team  (patient_id,type,recorded_at,team_id) UNIQUE
+#
+# Foreign Keys
+#
+#  fk_rails_...  (dismissed_by_user_id => users.id)
+#  fk_rails_...  (patient_id => patients.id)
+#  fk_rails_...  (team_id => teams.id)
+#  fk_rails_...  (vaccination_record_id => vaccination_records.id)
+#
+FactoryBot.define do
+  factory :important_notice do
+    patient
+    team_id { create(:team).id }
+
+    type { ImportantNotice.types.keys.sample }
+    recorded_at { Time.current }
+
+    after(:build) do |notice|
+      if notice.type == "gillick_no_notify" && notice.vaccination_record.nil?
+        notice.vaccination_record = build(:vaccination_record)
+      end
+    end
+
+    trait :deceased do
+      type { :deceased }
+    end
+
+    trait :restricted do
+      type { :restricted }
+    end
+
+    trait :invalidated do
+      type { :invalidated }
+    end
+
+    trait :gillick_no_notify do
+      type { :gillick_no_notify }
+      vaccination_record
+    end
+
+    trait :dismissed do
+      dismissed_at { 1.day.ago }
+      dismissed_by_user { association :user }
+    end
+  end
+end

spec/models/important_notice_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: important_notices
+#
+#  id                    :bigint           not null, primary key
+#  dismissed_at          :datetime
+#  recorded_at           :datetime         not null
+#  type                  :integer          not null
+#  created_at            :datetime         not null
+#  updated_at            :datetime         not null
+#  dismissed_by_user_id  :bigint
+#  patient_id            :bigint           not null
+#  team_id               :bigint           not null
+#  vaccination_record_id :bigint
+#
+# Indexes
+#
+#  index_important_notices_on_dismissed_by_user_id             (dismissed_by_user_id)
+#  index_important_notices_on_patient_id                       (patient_id)
+#  index_important_notices_on_team_id                          (team_id)
+#  index_important_notices_on_vaccination_record_id            (vaccination_record_id)
+#  index_notices_on_patient_and_type_and_recorded_at_and_team  (patient_id,type,recorded_at,team_id) UNIQUE
+#
+# Foreign Keys
+#
+#  fk_rails_...  (dismissed_by_user_id => users.id)
+#  fk_rails_...  (patient_id => patients.id)
+#  fk_rails_...  (team_id => teams.id)
+#  fk_rails_...  (vaccination_record_id => vaccination_records.id)
+#
+describe ImportantNotice do
+  subject(:notice) { build(:important_notice) }
+
+  let(:team) { create(:team) }
+  let(:patient) { create(:patient) }
+  let(:user) { create(:user) }
+
+  describe "validations" do
+    it { should validate_presence_of(:type) }
+    it { should validate_presence_of(:recorded_at) }
+  end
+
+  describe "associations" do
+    it { should belong_to(:patient) }
+  end
+
+  describe "enums" do
+    it do
+      expect(notice).to define_enum_for(:type).with_values(
+        deceased: 0,
+        invalidated: 1,
+        restricted: 2,
+        gillick_no_notify: 3
+      )
+    end
+  end
+
+  describe "#dismiss!" do
+    let(:notice) { create(:important_notice, team_id: team.id) }
+
+    context "when dismissing without a user" do
+      it "sets dismissed_at" do
+        freeze_time do
+          notice.dismiss!
+          expect(notice.dismissed_at).to eq(Time.current)
+        end
+      end
+
+      it "does not set dismissed_by_user_id" do
+        notice.dismiss!
+        expect(notice.dismissed_by_user_id).to be_nil
+      end
+    end
+
+    context "when dismissing with a user" do
+      it "sets dismissed_at and dismissed_by_user_id" do
+        freeze_time do
+          notice.dismiss!(user: user)
+          expect(notice.dismissed_at).to eq(Time.current)
+          expect(notice.dismissed_by_user_id).to eq(user.id)
+        end
+      end
+    end
+  end
+end

spec/policies/important_notice_policy_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+describe ImportantNoticePolicy do
+  let(:team) { create(:team) }
+  let(:notice) { create(:important_notice, team_id: team.id) }
+  let(:policy) { described_class.new(user, notice) }
+
+  describe "Scope#resolve" do
+    subject { ImportantNoticePolicy::Scope.new(user, ImportantNotice).resolve }
+
+    let(:team) { create(:team) }
+    let(:another_team) { create(:team) }
+    let(:user) { create(:user, team:) }
+
+    context "when notices are in different teams" do
+      let(:notice_in_team) { create(:important_notice, team_id: team.id) }
+      let(:notice_in_another_team) do
+        create(:important_notice, team_id: another_team.id)
+      end
+      let(:notice_in_another_team_2) do
+        create(:important_notice, team_id: another_team.id)
+      end
+
+      before do
+        notice_in_team
+        notice_in_another_team
+        notice_in_another_team_2
+      end
+
+      it { should contain_exactly(notice_in_team) }
+    end
+
+    context "when multiple notices exist in the team" do
+      let(:notice_one) { create(:important_notice, team_id: team.id) }
+      let(:notice_two) { create(:important_notice, team_id: team.id) }
+      let(:notice_in_another_team) do
+        create(:important_notice, team_id: another_team.id)
+      end
+
+      before do
+        notice_one
+        notice_two
+        notice_in_another_team
+      end
+
+      it { should contain_exactly(notice_one, notice_two) }
+    end
+  end
+
+  shared_examples "local system admin access" do
+    context "with a superuser" do
+      let(:user) { create(:superuser, team:) }
+
+      it { should be(true) }
+    end
+
+    context "with a nurse" do
+      let(:user) { create(:nurse, team:) }
+
+      it { should be(false) }
+    end
+
+    context "with a prescriber" do
+      let(:user) { create(:prescriber, team:) }
+
+      it { should be(false) }
+    end
+
+    context "with a healthcare assistant" do
+      let(:user) { create(:healthcare_assistant, team:) }
+
+      it { should be(false) }
+    end
+
+    context "with a medical secretary" do
+      let(:user) { create(:medical_secretary, team:) }
+
+      it { should be(false) }
+    end
+  end
+end