Merge pull request #5624 from nhsuk/fix-cli-schools-show

misaka · web-flow · commit 96f596fe6f3f · 2026-01-06T16:14:03.000Z
Fix mavis cli to show schools with programmes
diff --git a/app/lib/mavis_cli.rb b/app/lib/mavis_cli.rb
@@ -18,6 +18,7 @@ def self.progress_bar(total)
   end
 end
 
+require_relative "mavis_cli_helpers"
 require_relative "mavis_cli/access_log"
 require_relative "mavis_cli/clinics/add_to_team"
 require_relative "mavis_cli/clinics/create"
diff --git a/app/lib/mavis_cli/schools/create.rb b/app/lib/mavis_cli/schools/create.rb
@@ -3,7 +3,7 @@
 module MavisCLI
   module Schools
     class Create < Dry::CLI::Command
-      desc "Create a new school"
+      desc "Create a new school or site"
 
       argument :urn, required: true, desc: "School URN"
       argument :name, required: true, desc: "Name of the school"
@@ -17,7 +17,7 @@ class Create < Dry::CLI::Command
                required: true,
                desc: "GIAS phase (e.g. primary or secondary)"
 
-      option :site, desc: "Additional site "
+      option :site, desc: "Additional site"
       option :status, desc: "Status of the school", default: "open"
       option :systm_one_code, desc: "SystmOne code of the school"
       option :url, desc: "URL of the school"
@@ -29,7 +29,7 @@ class Create < Dry::CLI::Command
 
       option :gias_year_groups,
              type: :array,
-             desc: "Year groups taught at the school"
+             desc: "Year groups taught at the school (e.g. \"0,1,2,3,4,5,6\")"
 
       def call(
         urn:,
diff --git a/app/lib/mavis_cli/schools/show.rb b/app/lib/mavis_cli/schools/show.rb
@@ -3,6 +3,8 @@
 module MavisCLI
   module Schools
     class Show < Dry::CLI::Command
+      include ::MavisCLIHelpers
+
       desc "Show school information"
 
       argument :urn_or_ids,
@@ -18,8 +20,19 @@ class Show < Dry::CLI::Command
              type: :boolean,
              default: false,
              desc: "Find any site when searching with URN"
+      option :show_patients,
+             aliases: %w[-p],
+             type: :boolean,
+             default: false,
+             desc: "Show patient info"
 
-      def call(urn_or_ids:, id: false, any_site: false, **)
+      def call(
+        urn_or_ids:,
+        id: false,
+        any_site: false,
+        show_patients: false,
+        **
+      )
         MavisCLI.load_rails
 
         if id && any_site
@@ -38,6 +51,8 @@ def call(urn_or_ids:, id: false, any_site: false, **)
         academic_year = AcademicYear.current
 
         locations.each do |location|
+          puts(Rainbow("-" * 64).bright) if locations.count > 1
+
           location
             .attributes
             .symbolize_keys
@@ -47,6 +62,9 @@ def call(urn_or_ids:, id: false, any_site: false, **)
               :urn,
               :site,
               :status,
+              :gias_phase,
+              :gias_establishment_number,
+              :gias_local_authority_code,
               :address_line_1,
               :address_line_2,
               :address_postcode,
@@ -72,15 +90,50 @@ def call(urn_or_ids:, id: false, any_site: false, **)
               end
             end
           else
-            puts "#{Rainbow("team:").bright}: No team assigned"
+            puts "#{Rainbow("team").bright}: No team assigned"
+          end
+
+          puts ""
+          print_attributes total_patients: location.patient_locations.count
+          if show_patients
+            patient_locations =
+              location
+                .patient_locations
+                .preload(
+                  :attendance_records,
+                  :gillick_assessments,
+                  :pre_screenings,
+                  :vaccination_records
+                )
+                .current
+
+            attendance_records =
+              location.attendance_records.for_academic_year(academic_year)
+            gillick_assessments =
+              location.gillick_assessments.for_academic_year(academic_year)
+
+            print_attributes(
+              _indent: 1,
+              in_current_academic_year: {
+                _value: patient_locations.count,
+                with_attendance_records: attendance_records.count,
+                with_gillick_assessments: gillick_assessments.count
+              },
+              safe_to_destroy: patient_locations.count(&:safe_to_destroy?)
+            )
           end
 
-          puts Rainbow("programmes:").bright
+          puts "", Rainbow("programmes:").bright
           location.programmes.each do |programme|
             year_groups =
               location
                 .location_programme_year_groups
-                .where(programme:, academic_year:)
+                .where(
+                  programme_type: programme.type,
+                  location_year_group: {
+                    academic_year:
+                  }
+                )
                 .pluck_year_groups
 
             puts "  #{Rainbow(programme.type).bright}:"
diff --git a/app/lib/mavis_cli_helpers.rb b/app/lib/mavis_cli_helpers.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rainbow/refinement"
+
+module MavisCLIHelpers
+  using Rainbow
+
+  # rubocop:disable Lint/UnderscorePrefixedVariableName
+  # rubocop:disable Rails/Output
+  def print_attributes(_indent: 0, **attributes)
+    attributes.each do |key, value|
+      if value.is_a?(Hash)
+        nested_attributes = value
+        value = nested_attributes.delete(:_value)
+      end
+      label = key.to_s.humanize(capitalize: false)
+      puts "#{" " * _indent * 2}#{Rainbow(label).bright}: #{value}"
+
+      if nested_attributes
+        print_attributes(_indent: _indent + 1, **nested_attributes)
+      end
+    end
+  end
+  # rubocop:enable Rails/Output
+  # rubocop:enable Lint/UnderscorePrefixedVariableName
+end
diff --git a/spec/features/cli_schools_show_spec.rb b/spec/features/cli_schools_show_spec.rb
@@ -3,11 +3,17 @@
 require_relative "../../app/lib/mavis_cli"
 
 describe "mavis schools show" do
+  before do
+    # To ensure Rainbow doesn't insert escape codes into the output
+    Rainbow.enabled = false
+  end
+
   context "with just a URN" do
     it "displays the school details" do
       given_a_school_exists
       when_i_run_the_command
       then_the_school_details_are_displayed
+      and_the_programme_year_groups_are_displayed
     end
   end
 
@@ -27,8 +33,111 @@
     end
   end
 
+  context "with a team that has patients in a variety of states" do
+    it "displays the school details" do
+      given_a_school_exists
+      and_the_school_has_patients_across_academic_years
+      when_i_run_the_command_with_the_show_patients_option
+      then_the_correct_patient_counts_are_displayed
+    end
+  end
+
   def given_a_school_exists
-    @school = create(:school, name: "Test School", urn: "123456")
+    team = create(:team, programme_types: %w[flu hpv])
+    @school =
+      create(
+        :school,
+        name: "Test School",
+        urn: "123456",
+        team:
+      ).tap do |location|
+        location.import_year_groups_from_gias!(
+          academic_year: AcademicYear.previous
+        )
+
+        location.import_default_programme_year_groups!(
+          [Programme.flu],
+          academic_year: AcademicYear.previous
+        )
+      end
+  end
+
+  def and_the_school_has_patients_across_academic_years
+    location = school = @school
+    session =
+      create(
+        :session,
+        location:,
+        team: @school.teams.first,
+        programmes: [Programme.flu]
+      )
+    session_last_year =
+      create(
+        :session,
+        location:,
+        team: @school.teams.first,
+        date: Date.new(AcademicYear.previous, 11, 1),
+        programmes: [Programme.flu]
+      )
+
+    # patient in current academic years
+    create(:patient, school: @school, location: @school)
+
+    # patient in previous academic years
+    create(:patient, academic_year: AcademicYear.previous, school:, location:)
+
+    # patient in current and previous academic years
+    create(
+      :patient,
+      :in_attendance,
+      school:,
+      location:,
+      session:
+    ).tap do |patient|
+      create(
+        :patient_location,
+        patient:,
+        location:,
+        academic_year: AcademicYear.previous
+      )
+    end
+
+    # patient with attendance record in previous academic year
+    create(
+      :patient,
+      academic_year: AcademicYear.previous,
+      school:,
+      location:,
+      session: session_last_year
+    ).tap do |patient|
+      create(
+        :attendance_record,
+        :present,
+        patient:,
+        session: session_last_year,
+        date: session_last_year.dates.first
+      )
+    end
+
+    # patient with gillick assessment in current academic year
+    create(:patient, school:, location:, session:).tap do |patient|
+      create(:gillick_assessment, :competent, patient:, session:)
+    end
+
+    # patient with gillick assessment record in previous academic year
+    create(
+      :patient,
+      school:,
+      location:,
+      session: session_last_year
+    ).tap do |patient|
+      create(
+        :gillick_assessment,
+        :competent,
+        patient:,
+        session: session_last_year
+      )
+    end
   end
 
   def given_a_school_with_sites_exists
@@ -61,6 +170,15 @@ def when_i_run_the_command_with_the_any_site_option
       end
   end
 
+  def when_i_run_the_command_with_the_show_patients_option
+    @output =
+      capture_output do
+        Dry::CLI.new(MavisCLI).call(
+          arguments: %w[schools show --show-patients] + [@school.urn]
+        )
+      end
+  end
+
   def then_the_school_details_are_displayed
     expect(@output).to match(/name.*Test School/)
     expect(@output).to match(/urn.*123456/)
@@ -71,4 +189,19 @@ def then_the_school_details_with_sites_are_displayed
     expect(@output).to match(/urn.*123456/)
     expect(@output).to match(/site.*B/)
   end
+
+  def and_the_programme_year_groups_are_displayed
+    expect(@output).to match(
+      /flu:\s*year groups: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11/
+    )
+    expect(@output).to match(/hpv:\s*year groups: 8, 9, 10, 11/)
+  end
+
+  def then_the_correct_patient_counts_are_displayed
+    expect(@output).to match(/^total patients: 7/)
+    expect(@output).to match(/^  in current academic year: 3/)
+    expect(@output).to match(/^    with attendance records: 1/)
+    expect(@output).to match(/^    with gillick assessments: 1/)
+    expect(@output).to match(/^  safe to destroy: 1/)
+  end
 end
