Add programmes option to add-to-organisation

When adding schools to an organisation we will sometimes want that
school to only administer a subset of programmes. This commit makes that
possible by adding a `--programmes` option to the CLI tool.

Jira-Issue: MAV-1293

Author: thomasleese

app/lib/mavis_cli/schools/add_to_organisation.rb

@@ -14,7 +14,11 @@ class AddToOrganisation < Dry::CLI::Command
                required: true,
                desc: "The URN of the school"
 
-      def call(ods_code:, team:, urns:, **)
+      option :programmes,
+             type: :array,
+             desc: "The programmes administered at the school"
+
+      def call(ods_code:, team:, urns:, programmes: [], **)
         organisation = Organisation.find_by(ods_code:)
 
         if organisation.nil?
@@ -29,6 +33,13 @@ def call(ods_code:, team:, urns:, **)
           return
         end
 
+        programmes =
+          if programmes.empty?
+            organisation.programmes
+          else
+            Programme.where(type: programmes)
+          end
+
         ActiveRecord::Base.transaction do
           urns.each do |urn|
             location = Location.school.find_by(urn:)
@@ -43,9 +54,7 @@ def call(ods_code:, team:, urns:, **)
             end
 
             location.update!(team:)
-            location.create_default_programme_year_groups!(
-              organisation.programmes
-            )
+            location.create_default_programme_year_groups!(programmes)
           end
         end
 

app/models/location.rb

@@ -49,6 +49,7 @@ class Location < ApplicationRecord
   has_many :sessions
 
   has_one :organisation, through: :team
+  has_many :programmes, -> { distinct }, through: :programme_year_groups
 
   # This is based on the school statuses from the DfE GIAS data.
   enum :status,

spec/features/cli_schools_add_to_organisation_spec.rb

@@ -40,6 +40,17 @@
     end
   end
 
+  context "when customising the programmes" do
+    it "runs successfully" do
+      given_the_organisation_exists
+      and_the_team_exists
+      and_the_school_exists
+
+      when_i_run_the_command_with_flu_only
+      then_the_school_is_added_to_the_organisation_with_flu_only
+    end
+  end
+
   private
 
   def command
@@ -48,22 +59,42 @@ def command
     )
   end
 
+  def command_with_flu_only
+    Dry::CLI.new(MavisCLI).call(
+      arguments: %w[
+        schools
+        add-to-organisation
+        ABC
+        Team
+        123456
+        --programmes
+        flu
+      ]
+    )
+  end
+
   def given_the_organisation_exists
-    @organisation = create(:organisation, ods_code: "ABC")
+    @programmes = [create(:programme, :flu), create(:programme, :hpv)]
+    @organisation =
+      create(:organisation, ods_code: "ABC", programmes: @programmes)
   end
 
   def and_the_team_exists
     @team = create(:team, name: "Team", organisation: @organisation)
   end
 
   def and_the_school_exists
-    @school = create(:school, name: "School", urn: "123456", team: @team)
+    @school = create(:school, name: "School", urn: "123456")
   end
 
   def when_i_run_the_command
     @output = capture_error { command }
   end
 
+  def when_i_run_the_command_with_flu_only
+    @output = capture_error { command_with_flu_only }
+  end
+
   def when_i_run_the_command_expecting_an_error
     @output = capture_error { command }
   end
@@ -82,5 +113,11 @@ def then_a_school_not_found_error_message_is_displayed
 
   def then_the_school_is_added_to_the_organisation
     expect(@organisation.schools).to include(@school)
+    expect(@school.programmes).to eq(@programmes)
+  end
+
+  def then_the_school_is_added_to_the_organisation_with_flu_only
+    expect(@organisation.schools).to include(@school)
+    expect(@school.programmes).to contain_exactly(@programmes.first)
   end
 end