Add a filter for status

app/controllers/case_logs_controller.rb

@@ -7,7 +7,7 @@ class CaseLogsController < ApplicationController
   before_action :find_resource, except: %i[create index edit]
 
   def index
-    @pagy, @case_logs = pagy(current_user.case_logs)
+    @pagy, @case_logs = pagy(filtered_case_logs)
 
     respond_to do |format|
       format.html
@@ -78,6 +78,11 @@ class CaseLogsController < ApplicationController
     end
   end
 
+  def filter
+    cookies[:case_logs_filters] = { status: params[:status] }.to_json
+    redirect_back(fallback_location: root_path)
+  end
+
 private
 
   API_ACTIONS = %w[create show update destroy].freeze
@@ -117,4 +122,12 @@ private
   def find_resource
     @case_log = CaseLog.find_by(id: params[:id])
   end
+
+  def filtered_case_logs
+    user_case_logs = current_user.case_logs
+    status_filter = JSON.parse(cookies[:case_logs_filters])["status"] if cookies[:case_logs_filters].present?
+    return user_case_logs unless status_filter
+
+    user_case_logs.filter_by_status(status_filter)
+  end
 end

app/helpers/filters_helper.rb

@@ -0,0 +1,8 @@
+module FiltersHelper
+  def filter_selected?(filter)
+    return true unless cookies[:case_logs_filters]
+
+    selected_filters = JSON.parse(cookies[:case_logs_filters])
+    selected_filters["status"].present? && selected_filters["status"].include?(filter.to_s)
+  end
+end

app/models/case_log.rb

@@ -34,6 +34,7 @@ class CaseLog < ApplicationRecord
   belongs_to :managing_organisation, class_name: "Organisation"
 
   scope :for_organisation, ->(org) { where(owning_organisation: org).or(where(managing_organisation: org)) }
+  scope :filter_by_status, ->(status) { where status: status }
 
   AUTOGENERATED_FIELDS = %w[id status created_at updated_at discarded_at].freeze
   OPTIONAL_FIELDS = %w[postcode_known la_known first_time_property_let_as_social_housing tenant_code propcode].freeze

app/views/case_logs/_log_list.html.erb

@@ -1,61 +1,88 @@
-<figure class="app-figure">
+<div class="govuk-grid-row">
-  <figcaption id="<%= title.dasherize %>" class="app-figure__caption">
+  <div class="govuk-grid-column-one-quarter">
-    <span class="govuk-!-margin-right-4">
+    <div class="app-filter">
-      <strong><%= pagy.count %></strong> total <%= title.downcase %>
+      <div class="app-filter__header">
-    </span>
+        <h2 class="govuk-heading-m">Filters</h2>
-    <a class="govuk-link" download href="/logs.csv" type="text/csv">Download (CSV)</a>
+      </div>
-  </figcaption>
+      <div class="app-filter__content">
-  <section class="app-table-group" tabindex="0" aria-labelledby="<%= title.dasherize %>">
+        <div class="govuk-form-group app-filter__group">
-    <table class="govuk-table">
+          <%= form_with url: "/logs/filter", html: { method: :post }, builder: GOVUKDesignSystemFormBuilder::FormBuilder do |f| %>
-      <thead class="govuk-table__head">
+            <%= f.govuk_check_boxes_fieldset :status do %>
-        <tr class="govuk-table__row">
+              <% statuses = {in_progress: "In progress", submitted: "Completed", archived: "Not started"} %>
-          <th class="govuk-table__header" scope="col">Log</th>
+              <% statuses.map do |key, option| %>
-          <th class="govuk-table__header" scope="col">Tenant</th>
+                <%= f.govuk_check_box "status", "#{key}",
-          <th class="govuk-table__header" scope="col">Property</th>
+                label: { text: option },
-          <th class="govuk-table__header" scope="col">Tenancy starts</th>
+                checked: filter_selected?(key),
-          <th class="govuk-table__header" scope="col">Log created</th>
+                class: "govuk-checkboxes govuk-checkboxes--small" %>
-          <th class="govuk-table__header" scope="col">Completed</th>
+              <% end %>
-          <% if current_user.support? %>
+            <% end %>
-            <th class="govuk-table__header" scope="col">Owning organisation</th>
+            <%= f.govuk_submit "Apply filters"%>
-            <th class="govuk-table__header" scope="col">Managing organisation</th>
           <% end %>
-        </tr>
+        </div>
-      </thead>
+      </div>
-      <tbody class="govuk-table__body">
+    </div>
-        <% case_logs.map do |log| %>
+  </div>
-        <tr class="govuk-table__row">
+  <div class="govuk-grid-column-three-quarters">
-          <th class="govuk-table__header" scope="row">
+    <figure class="app-figure">
-            <%= govuk_link_to log.id, case_log_path(log) %>
+     <figcaption id="<%= title.dasherize %>" class="app-figure__caption">
-          </th>
+        <span class="govuk-!-margin-right-4">
-          <td class="govuk-table__cell app-!-font-tabular">
+          <strong><%= pagy.count %></strong> total <%= title.downcase %>
-            <%= log.tenant_code? ? log.tenant_code : '–' %>
+        </span>
-          </td>
+        <a class="govuk-link" download href="/logs.csv" type="text/csv">Download (CSV)</a>
-          <td class="govuk-table__cell app-!-font-tabular">
+      </figcaption>
-            <%= log.propcode? ? log.propcode : '–' %>
+      <section class="app-table-group" tabindex="0" aria-labelledby="<%= title.dasherize %>">
-          </td>
+        <table class="govuk-table">
-          <td class="govuk-table__cell">
+          <thead class="govuk-table__head">
-            <%= log.startdate.present? ? log.startdate.to_formatted_s(:govuk_date) : '–' %>
+            <tr class="govuk-table__row">
-          </td>
+              <th class="govuk-table__header" scope="col">Log</th>
-          <td class="govuk-table__cell">
+              <th class="govuk-table__header" scope="col">Tenant</th>
-            <%= log.created_at.to_formatted_s(:govuk_date) %>
+              <th class="govuk-table__header" scope="col">Property</th>
-          </td>
+              <th class="govuk-table__header" scope="col">Tenancy starts</th>
-          <td class="govuk-table__cell">
+              <th class="govuk-table__header" scope="col">Log created</th>
-            <%= govuk_tag(
+              <th class="govuk-table__header" scope="col">Completed</th>
-              colour: log.status == 'completed' ? 'blue' : 'grey',
+              <% if current_user.support? %>
-              text: log.status.humanize
+                <th class="govuk-table__header" scope="col">Owning organisation</th>
-            ) %>
+                <th class="govuk-table__header" scope="col">Managing organisation</th>
-          </td>
+              <% end %>
-          <% if current_user.support? %>
+            </tr>
-            <td class="govuk-table__cell">
+          </thead>
-              <%= log.owning_organisation.name %>
+          <tbody class="govuk-table__body">
-            </td>
+            <% case_logs.map do |log| %>
-            <td class="govuk-table__cell">
+            <tr class="govuk-table__row">
-              <%= log.managing_organisation.name %>
+              <th class="govuk-table__header" scope="row">
-            </td>
+                <%= govuk_link_to log.id, case_log_path(log) %>
-          <% end %>
+              </th>
-        </tr>
+              <td class="govuk-table__cell app-!-font-tabular">
-        <% end %>
+                <%= log.tenant_code? ? log.tenant_code : '–' %>
-      </tbody>
+              </td>
-    </table>
+              <td class="govuk-table__cell app-!-font-tabular">
-  </section>
+                <%= log.propcode? ? log.propcode : '–' %>
-</figure>
+              </td>
+              <td class="govuk-table__cell">
+                <%= log.startdate.present? ? log.startdate.to_formatted_s(:govuk_date) : '–' %>
+              </td>
+              <td class="govuk-table__cell">
+                <%= log.created_at.to_formatted_s(:govuk_date) %>
+              </td>
+              <td class="govuk-table__cell">
+                <%= govuk_tag(
+                  colour: log.status == 'completed' ? 'blue' : 'grey',
+                  text: log.status.humanize
+                ) %>
+              </td>
+              <% if current_user.support? %>
+                <td class="govuk-table__cell">
+                  <%= log.owning_organisation.name %>
+                </td>
+                <td class="govuk-table__cell">
+                  <%= log.managing_organisation.name %>
+                </td>
+              <% end %>
+            </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </section>
+    </figure>
+  </div>
+</div>

config/routes.rb

@@ -90,6 +90,8 @@ Rails.application.routes.draw do
     end
   end
 
+  post "/logs/filter", to: "case_logs#filter"
+
   scope via: :all do
     match "/404", to: "errors#not_found"
     match "/429", to: "errors#too_many_requests", status: 429

spec/helpers/filters_helper_spec.rb

@@ -0,0 +1,26 @@
+require "rails_helper"
+
+RSpec.describe FiltersHelper do
+  describe "#filter_selected?" do
+    context "when no filters are selected" do
+      it "returns true for all filters" do
+        expect(filter_selected?("completed")).to be_truthy
+        expect(filter_selected?("in_progress")).to be_truthy
+      end
+    end
+
+    context "one filter is selected" do
+      before do
+        cookies[:case_logs_filters] = { "status": "in_progress" }.to_json
+      end
+
+      it "returns false for non selected filters" do
+        expect(filter_selected?("completed")).to be_falsey
+      end
+
+      it "returns true for selected filter" do
+        expect(filter_selected?("in_progress")).to be_truthy
+      end
+    end
+  end
+end

spec/requests/case_logs_controller_spec.rb

@@ -172,6 +172,34 @@ RSpec.describe CaseLogsController, type: :request do
           expect(page).to have_content("Owning organisation")
           expect(page).to have_content("Managing organisation")
         end
+
+        context "when filtering" do
+          let!(:in_progress_case_log) do
+            FactoryBot.create(:case_log, :in_progress,
+                              owning_organisation: organisation,
+                              managing_organisation: organisation)
+          end
+          let!(:completed_case_log) do
+            FactoryBot.create(:case_log, :completed,
+                              owning_organisation: organisation,
+                              managing_organisation: organisation)
+          end
+
+          it "only shows case logs for selected status" do
+            in_progress_case_row_log = "<a class=\"govuk-link\" href=\"/logs/#{in_progress_case_log.id}\">#{in_progress_case_log.id}</a>"
+            completed_case_row_log = "<a class=\"govuk-link\" href=\"/logs/#{completed_case_log.id}\">#{completed_case_log.id}</a>"
+
+            cookies[:case_logs_filters] = { status: %w[in_progress completed] }.to_json
+            get "/logs", headers: headers, params: {}
+            expect(CGI.unescape_html(response.body)).to include(in_progress_case_row_log)
+            expect(CGI.unescape_html(response.body)).to include(completed_case_row_log)
+
+            cookies[:case_logs_filters] = { status: %w[in_progress] }.to_json
+            get "/logs", headers: headers, params: {}
+            expect(CGI.unescape_html(response.body)).to include(in_progress_case_row_log)
+            expect(CGI.unescape_html(response.body)).not_to include(completed_case_row_log)
+          end
+        end
       end
 
       context "when the user is not a customer support user" do
@@ -626,4 +654,23 @@ RSpec.describe CaseLogsController, type: :request do
       end
     end
   end
+
+  describe "POST #filter" do
+    let(:user) { FactoryBot.create(:user) }
+    let(:params) do
+      {
+        "status": ["In progress"],
+      }
+    end
+
+    before do
+      sign_in user
+    end
+
+    it "sets status filter in the cookies" do
+      expect(cookies[:case_logs_filters]).to be_nil
+      post "/logs/filter", headers: headers, params: params.to_json
+      expect(JSON.parse(cookies[:case_logs_filters])["status"]).to eq(["In progress"])
+    end
+  end
 end