From 3a38b25c36c4e800a5d0e33300134e3e088a91d9 Mon Sep 17 00:00:00 2001
From: dp-daly <danpatdaly@gmail.com>
Date: Wed, 27 Nov 2024 16:45:27 +0000
Subject: [PATCH] Add phase filter to placements search

---
 .../providers/placements_controller.rb        |  19 ++
 .../placements/placements/filter_form.rb      |  10 +
 app/queries/placements/placements_query.rb    |  11 +
 .../providers/placements/_filter.html.erb     |  51 +++++
 .../en/placements/providers/placements.yml    |   3 +
 .../placements/placements/filter_form_spec.rb |  57 +++++
 ...r_user_filters_placements_by_phase_spec.rb | 210 ++++++++++++++++++
 7 files changed, 361 insertions(+)
 create mode 100644 spec/system/placements/providers/placements/provider_user_filters_placements_by_phase_spec.rb

diff --git a/app/controllers/placements/providers/placements_controller.rb b/app/controllers/placements/providers/placements_controller.rb
index 1a30424086..05d4e2d46b 100644
--- a/app/controllers/placements/providers/placements_controller.rb
+++ b/app/controllers/placements/providers/placements_controller.rb
@@ -14,6 +14,8 @@ def index
     @pagy, @placements = pagy(placements.merge(query))
     @placements = @placements.decorate
 
+    filter_subjects_by_phase
+    filter_schools_by_phase
     calculate_travel_time
   end
 
@@ -78,6 +80,7 @@ def filter_params
       school_ids: [],
       subject_ids: [],
       term_ids: [],
+      phases: [],
       establishment_groups: [],
       year_groups: [],
     )
@@ -99,4 +102,20 @@ def compact_school_attribute_values(attribute)
     all_schools.where.not(attribute => nil)
                .distinct(attribute).order(attribute).pluck(attribute)
   end
+
+  def filter_subjects_by_phase
+    if filter_form.primary_selected? && !filter_form.secondary_selected?
+      @subjects = @subjects.where(subject_area: "primary")
+    elsif !filter_form.primary_selected? && filter_form.secondary_selected?
+      @subjects = @subjects.where(subject_area: "secondary")
+    end
+  end
+
+  def filter_schools_by_phase
+    if filter_form.primary_selected? && !filter_form.secondary_selected?
+      @schools = @schools.where.not(phase: "Secondary")
+    elsif !filter_form.primary_selected? && filter_form.secondary_selected?
+      @schools = @schools.where.not(phase: "Primary")
+    end
+  end
 end
diff --git a/app/forms/placements/placements/filter_form.rb b/app/forms/placements/placements/filter_form.rb
index 028d756b93..dd65cb6c31 100644
--- a/app/forms/placements/placements/filter_form.rb
+++ b/app/forms/placements/placements/filter_form.rb
@@ -6,6 +6,7 @@ class Placements::Placements::FilterForm < ApplicationForm
   attribute :search_location, default: nil
   attribute :year_groups, default: []
   attribute :term_ids, default: []
+  attribute :phases, default: []
   attribute :placements_to_show, default: "available_placements"
   attribute :academic_year_id, default: Placements::AcademicYear.current.id
   attribute :only_partner_schools, :boolean, default: false
@@ -50,6 +51,7 @@ def query_params
       placements_to_show:,
       academic_year_id:,
       term_ids:,
+      phases:,
       search_location:,
     }
   end
@@ -66,6 +68,14 @@ def terms
     @terms ||= Placements::Term.where(id: term_ids).order_by_term
   end
 
+  def primary_selected?
+    phases.include?("primary")
+  end
+
+  def secondary_selected?
+    phases.include?("secondary")
+  end
+
   private
 
   SINGULAR_ATTRIBUTES = %w[only_partner_schools placements_to_show search_location].freeze
diff --git a/app/queries/placements/placements_query.rb b/app/queries/placements/placements_query.rb
index 7569bdc1e2..d4847cb145 100644
--- a/app/queries/placements/placements_query.rb
+++ b/app/queries/placements/placements_query.rb
@@ -11,6 +11,7 @@ def call
     scope = academic_year_condition(scope)
     scope = term_condition(scope)
     scope = year_group_condition(scope)
+    scope = phase_condition(scope)
     order_condition(scope)
   end
 
@@ -59,6 +60,16 @@ def term_condition(scope)
          .or(scope.where.missing(:terms))
   end
 
+  def phase_condition(scope)
+    return scope if filter_params[:phases].blank?
+
+    if filter_params[:phases].include?("primary") && filter_params[:phases].include?("secondary")
+      scope.joins(:subject)
+    else
+      scope.joins(:subject).where(subjects: { subject_area: filter_params[:phases] })
+    end
+  end
+
   def year_group_condition(scope)
     return scope if filter_params[:year_groups].blank?
 
diff --git a/app/views/placements/providers/placements/_filter.html.erb b/app/views/placements/providers/placements/_filter.html.erb
index 516f9cd510..6beec9588b 100644
--- a/app/views/placements/providers/placements/_filter.html.erb
+++ b/app/views/placements/providers/placements/_filter.html.erb
@@ -62,6 +62,39 @@
             </ul>
           <% end %>
 
+          <% if filter_form.primary_selected? || filter_form.secondary_selected? %>
+            <h3 class="govuk-heading-s govuk-!-margin-bottom-0"><%= t(".phase") %></h3>
+            <ul class="app-filter-tags">
+              <% if filter_form.primary_selected? %>
+                <li>
+                  <%= govuk_link_to(
+                    t(".primary"),
+                    filter_form.index_path_without_filter(
+                      filter: "phases",
+                      value: "primary",
+                    ),
+                    class: "app-filter__tag",
+                    no_visited_state: true,
+                  ) %>
+                </li>
+              <% end %>
+
+              <% if filter_form.secondary_selected? %>
+                <li>
+                  <%= govuk_link_to(
+                    t(".secondary"),
+                    filter_form.index_path_without_filter(
+                      filter: "phases",
+                      value: "secondary",
+                    ),
+                    class: "app-filter__tag",
+                    no_visited_state: true,
+                  ) %>
+                </li>
+              <% end %>
+            </ul>
+          <% end %>
+
           <% if filter_form.subject_ids.present? %>
             <h3 class="govuk-heading-s govuk-!-margin-bottom-0"><%= t(".subject") %></h3>
             <ul class="app-filter-tags">
@@ -220,6 +253,22 @@
             <% end %>
           </div>
 
+          <div class="app-filter__option">
+            <%= form.govuk_check_boxes_fieldset(
+                :phases,
+                legend: { text: t(".phase"), size: "s" },
+                small: true,
+                multiple: true,
+              ) do %>
+              <%= form.govuk_check_box :phases,
+                                      "primary",
+                                      label: { text: t(".primary") } %>
+              <%= form.govuk_check_box :phases,
+                                      "secondary",
+                                      label: { text: t(".secondary") } %>
+            <% end %>
+          </div>
+
           <div class="app-filter__option" data-controller="filter-search">
             <%= form.govuk_check_boxes_fieldset(
               :subject_ids,
@@ -237,6 +286,7 @@
             <% end %>
           </div>
 
+          <% if filter_form.primary_selected? || filter_form.phases.blank? %>
           <div class="app-filter__option">
             <%= form.govuk_check_boxes_fieldset(
               :year_groups,
@@ -250,6 +300,7 @@
               <% end %>
             <% end %>
           </div>
+          <% end %>
 
           <div class="app-filter__option">
             <%= form.govuk_check_boxes_fieldset(
diff --git a/config/locales/en/placements/providers/placements.yml b/config/locales/en/placements/providers/placements.yml
index 49cb5c5e79..042f18fe84 100644
--- a/config/locales/en/placements/providers/placements.yml
+++ b/config/locales/en/placements/providers/placements.yml
@@ -21,6 +21,9 @@ en:
           location_search_prompt: Enter a town, city or postcode
           partner_schools: Schools I work with
           terms: Expected date
+          phase: Phase
+          primary: Primary
+          secondary: Secondary
           only_show_partner_schools: Only show placements from schools I work with
           school: School
           search_location: Location
diff --git a/spec/forms/placements/placements/filter_form_spec.rb b/spec/forms/placements/placements/filter_form_spec.rb
index 1e479253ba..fe90fe1008 100644
--- a/spec/forms/placements/placements/filter_form_spec.rb
+++ b/spec/forms/placements/placements/filter_form_spec.rb
@@ -33,6 +33,14 @@
       end
     end
 
+    context "when given phase params" do
+      let(:params) { { phases: %w[primary secondary] } }
+
+      it "returns true" do
+        expect(filter_form).to be(true)
+      end
+    end
+
     context "when given year group params" do
       let(:params) { { year_groups: %w[year_group] } }
 
@@ -172,6 +180,30 @@
       end
     end
 
+    context "when removing phase params" do
+      let(:params) do
+        { phases: %w[primary secondary] }
+      end
+
+      it "returns the placements index page path without the given phase param" do
+        expect(
+          filter_form.index_path_without_filter(
+            filter: "phases",
+            value: "primary",
+          ),
+        ).to eq(
+          placements_provider_placements_path(
+            provider,
+            filters: {
+              placements_to_show: "available_placements",
+              academic_year_id: current_academic_year.id,
+              phases: %w[secondary],
+            },
+          ),
+        )
+      end
+    end
+
     context "when removing year group params" do
       let(:params) do
         { year_groups: %w[year_group_1 year_group_2] }
@@ -208,6 +240,7 @@
           search_location: nil,
           subject_ids: [],
           term_ids: [],
+          phases: [],
           year_groups: [],
         },
       )
@@ -243,4 +276,28 @@
       ).to match_array(terms)
     end
   end
+
+  describe "#primary_selected?" do
+    subject(:filter_form) { described_class.new(provider, params).primary_selected? }
+
+    context "when primary is included in the phases param" do
+      let(:params) { { phases: %w[primary] } }
+
+      it "returns true" do
+        expect(filter_form).to be(true)
+      end
+    end
+  end
+
+  describe "#secondary_selected?" do
+    subject(:filter_form) { described_class.new(provider, params).secondary_selected? }
+
+    context "when secondary is included in the phases param" do
+      let(:params) { { phases: %w[secondary] } }
+
+      it "returns true" do
+        expect(filter_form).to be(true)
+      end
+    end
+  end
 end
diff --git a/spec/system/placements/providers/placements/provider_user_filters_placements_by_phase_spec.rb b/spec/system/placements/providers/placements/provider_user_filters_placements_by_phase_spec.rb
new file mode 100644
index 0000000000..9af6d1b51d
--- /dev/null
+++ b/spec/system/placements/providers/placements/provider_user_filters_placements_by_phase_spec.rb
@@ -0,0 +1,210 @@
+require "rails_helper"
+
+RSpec.describe "Provider user filters placements by phase", service: :placements, type: :system do
+  scenario do
+    given_that_placements_exist
+    and_i_am_signed_in
+
+    when_i_am_on_the_placements_index_page
+    then_i_see_all_placements
+    and_i_see_the_phase_filter
+
+    when_i_select_secondary_from_the_phases_filter
+    and_i_click_on_apply_filters
+    then_i_see_the_secondary_placements
+    and_i_do_not_see_the_primary_placement
+    and_i_no_longer_see_the_primary_year_group_filter
+    and_i_see_only_secondary_subjects_listed_in_the_subjects_filter
+    and_i_see_that_springfield_elementary_is_no_longer_listed_in_the_schools_filter
+    and_i_see_that_ogdenville_observatoire_is_still_listed_in_the_schools_filter
+    and_i_see_that_the_secondary_phase_checkbox_is_selected
+    and_i_see_the_secondary_filter_tag
+
+    when_i_select_primary_from_the_phases_filter
+    and_i_click_on_apply_filters
+    then_i_see_all_placements
+    and_i_see_the_primary_year_group_filter
+    and_i_see_all_subjects_listed_in_the_subjects_filter
+    and_i_see_all_schools_listed_in_the_schools_filter
+    and_i_see_that_the_primary_and_secondary_phases_checkbox_are_selected
+    and_i_see_the_primary_and_secondary_filter_tags
+
+    when_i_click_on_the_secondary_phase_tag
+    then_i_see_the_primary_placement
+    and_i_do_not_see_the_secondary_placements
+    and_i_do_not_see_the_secondary_phase_checkbox_selected
+    and_i_do_not_see_the_secondary_filter_tag
+
+    when_i_click_on_the_primary_phase_tag
+    then_i_see_all_placements
+    and_i_see_all_schools_listed_in_the_schools_filter
+    and_i_see_all_subjects_listed_in_the_subjects_filter
+    and_i_do_not_see_any_selected_phase_checkboxes
+    and_i_do_not_see_any_phase_filter_tags
+  end
+
+  private
+
+  def given_that_placements_exist
+    @provider = build(:placements_provider, name: "Aes Sedai Trust")
+    @primary_school = build(:placements_school, phase: "Primary", name: "Springfield Elementary")
+    @secondary_school = build(:placements_school, phase: "Secondary", name: "Shelbyville High School")
+    @all_through_school = build(:placements_school, phase: "All-through", name: "Ogdenville Observatoire")
+
+    @primary_subject = build(:subject, name: "Primary with mathematics", subject_area: "primary")
+    @springfield_primary_placement = create(:placement, school: @primary_school, subject: @primary_subject)
+
+    @secondary_subject = build(:subject, name: "Music", subject_area: "secondary")
+    @shelbyville_secondary_placement = create(:placement, school: @secondary_school, subject: @secondary_subject)
+    @ogdenville_secondary_placement = create(:placement, school: @all_through_school, subject: @secondary_subject)
+  end
+
+  def and_i_am_signed_in
+    sign_in_placements_user(organisations: [@provider])
+  end
+
+  def when_i_am_on_the_placements_index_page
+    expect(page).to have_title("Find placements - Manage school placements - GOV.UK")
+    expect(primary_navigation).to have_current_item("Placements")
+    expect(page).to have_h1("Find placements")
+    expect(page).to have_h2("Filter")
+
+    # to contrast with primary year group filter hidden state
+    expect(page).to have_element(:legend, text: "Primary year group", class: "govuk-fieldset__legend")
+    expect(page).to have_field("Nursery", type: "checkbox", checked: false)
+  end
+
+  def then_i_see_all_placements
+    expect(page).to have_h2("Music – Ogdenville Observatoire")
+    expect(page).to have_h2("Music – Shelbyville High School")
+    expect(page).to have_h2("Primary with mathematics – Springfield Elementary")
+  end
+
+  def and_i_see_the_phase_filter
+    expect(page).to have_element(:legend, text: "Phase", class: "govuk-fieldset__legend")
+    expect(page).to have_field("Primary", type: "checkbox", checked: false)
+    expect(page).to have_field("Secondary", type: "checkbox", checked: false)
+  end
+
+  def when_i_select_secondary_from_the_phases_filter
+    check "Secondary"
+  end
+
+  def and_i_click_on_apply_filters
+    click_on "Apply filters"
+  end
+
+  def then_i_see_the_secondary_placements
+    expect(page).to have_h2("Music – Ogdenville Observatoire")
+    expect(page).to have_h2("Music – Shelbyville High School")
+  end
+
+  def and_i_do_not_see_the_primary_placement
+    expect(page).not_to have_h2("Primary with mathematics – Springfield Elementary")
+  end
+
+  def and_i_no_longer_see_the_primary_year_group_filter
+    expect(page).not_to have_element(:legend, text: "Primary year group", class: "govuk-fieldset__legend")
+    expect(page).not_to have_field("Nursery", type: "checkbox")
+  end
+
+  def and_i_see_only_secondary_subjects_listed_in_the_subjects_filter
+    expect(page).to have_element(:legend, text: "Subject", class: "govuk-fieldset__legend")
+    expect(page).to have_field("Music", type: "checkbox", checked: false)
+
+    expect(page).not_to have_field("Primary with mathematics", type: "checkbox", checked: false)
+  end
+
+  def and_i_see_that_springfield_elementary_is_no_longer_listed_in_the_schools_filter
+    expect(page).to have_element(:legend, text: "School", class: "govuk-fieldset__legend")
+    expect(page).not_to have_field("Springfield Elementary", type: "checkbox", checked: false)
+  end
+
+  def and_i_see_that_ogdenville_observatoire_is_still_listed_in_the_schools_filter
+    expect(page).to have_field("Ogdenville Observatoire", type: "checkbox", checked: false)
+  end
+
+  def and_i_see_that_the_secondary_phase_checkbox_is_selected
+    expect(page).to have_field("Secondary", type: "checkbox", checked: true)
+  end
+
+  def and_i_see_the_secondary_filter_tag
+    expect(page).to have_h3("Phase")
+    expect(page).to have_filter_tag("Secondary")
+    expect(page).not_to have_filter_tag("Primary")
+  end
+
+  def when_i_select_primary_from_the_phases_filter
+    check "Primary"
+  end
+
+  def and_i_see_the_primary_year_group_filter
+    expect(page).to have_element(:legend, text: "Primary year group", class: "govuk-fieldset__legend")
+    expect(page).to have_field("Nursery", type: "checkbox")
+  end
+
+  def and_i_see_all_subjects_listed_in_the_subjects_filter
+    expect(page).to have_field("Music", type: "checkbox", checked: false)
+    expect(page).to have_field("Primary with mathematics", type: "checkbox", checked: false)
+  end
+
+  def and_i_see_all_schools_listed_in_the_schools_filter
+    expect(page).to have_field("Ogdenville Observatoire", type: "checkbox", checked: false)
+    expect(page).to have_field("Shelbyville High School", type: "checkbox", checked: false)
+    expect(page).to have_field("Springfield Elementary", type: "checkbox", checked: false)
+  end
+
+  def and_i_see_that_the_primary_and_secondary_phases_checkbox_are_selected
+    expect(page).to have_field("Primary", type: "checkbox", checked: true)
+    expect(page).to have_field("Secondary", type: "checkbox", checked: true)
+  end
+
+  def and_i_see_the_primary_and_secondary_filter_tags
+    expect(page).to have_h3("Phase")
+    expect(page).to have_filter_tag("Secondary")
+    expect(page).to have_filter_tag("Primary")
+  end
+
+  def when_i_click_on_the_secondary_phase_tag
+    within ".app-filter-tags" do
+      click_on "Secondary"
+    end
+  end
+
+  def then_i_see_the_primary_placement
+    expect(page).to have_h2("Primary with mathematics – Springfield Elementary")
+  end
+
+  def and_i_do_not_see_the_secondary_placements
+    expect(page).not_to have_h2("Music – Ogdenville Observatoire")
+    expect(page).not_to have_h2("Music – Shelbyville High School")
+  end
+
+  def and_i_do_not_see_the_secondary_phase_checkbox_selected
+    expect(page).to have_field("Secondary", type: "checkbox", checked: false)
+    expect(page).to have_field("Primary", type: "checkbox", checked: true)
+  end
+
+  def and_i_do_not_see_the_secondary_filter_tag
+    expect(page).to have_h3("Phase")
+    expect(page).not_to have_filter_tag("Secondary")
+    expect(page).to have_filter_tag("Primary")
+  end
+
+  def when_i_click_on_the_primary_phase_tag
+    within ".app-filter-tags" do
+      click_on "Primary"
+    end
+  end
+
+  def and_i_do_not_see_any_selected_phase_checkboxes
+    expect(page).to have_field("Secondary", type: "checkbox", checked: false)
+    expect(page).to have_field("Primary", type: "checkbox", checked: false)
+  end
+
+  def and_i_do_not_see_any_phase_filter_tags
+    expect(page).not_to have_h3("Phase")
+    expect(page).not_to have_filter_tag("Secondary")
+    expect(page).not_to have_filter_tag("Primary")
+  end
+end