write request specs for the homepage

spec/requests/start_controller_spec.rb

@@ -2,7 +2,6 @@ require "rails_helper"
 
 RSpec.describe StartController, type: :request do
   let(:user) { create(:user) }
-  let(:headers) { { "Accept" => "text/html" } }
   let(:page) { Capybara::Node::Simple.new(response.body) }
   let(:notify_client) { instance_double(Notifications::Client) }
   let(:devise_notify_mailer) { DeviseNotifyMailer.new }
@@ -16,7 +15,7 @@ RSpec.describe StartController, type: :request do
   describe "GET" do
     context "when the user is not signed in" do
       it "routes user to the start page" do
-        get "/", headers: headers, params: {}
+        get root_path
         expect(path).to eq("/")
         expect(page).to have_content("Start now")
       end
@@ -24,21 +23,342 @@ RSpec.describe StartController, type: :request do
 
     context "when the user is signed in" do
       before do
+        allow(user).to receive(:need_two_factor_authentication?).and_return(false)
         sign_in user
       end
 
       it "routes user to the home page" do
-        get "/", headers:, params: {}
+        get root_path
         expect(page).to have_content("Welcome back")
       end
 
+      context "when testing the data displayed at the top of the home page" do
+        let(:current_year) { FormHandler.instance.current_collection_start_year }
+        let(:in_crossover_period) { false }
+
+        before do
+          allow(FormHandler.instance).to receive(:in_crossover_period?).and_return in_crossover_period
+        end
+
+        context "when in the crossover period" do
+          let(:in_crossover_period) { true }
+
+          it "shows both open collection years with last year first" do
+            get root_path
+
+            logs_headers = page.find_all("h2").map(&:text).select { |header| header.include? "Logs" }
+
+            expected_headers = [
+              "#{current_year - 1} to #{current_year} Logs",
+              "#{current_year} to #{current_year + 1} Logs",
+            ]
+
+            expect(logs_headers).to eq expected_headers
+          end
+        end
+
+        context "when not in the crossover period" do
+          let(:in_crossover_period) { false }
+
+          it "shows this year first, with last year's after marked as closed" do
+            get root_path
+
+            logs_headers = page.find_all("h2").map(&:text).select { |header| header.include? "Logs" }
+
+            expected_headers = [
+              "#{current_year} to #{current_year + 1} Logs",
+              "#{current_year - 1} to #{current_year} Logs (Closed collection year)",
+            ]
+
+            expect(logs_headers).to eq expected_headers
+          end
+        end
+
+        context "when the user's org has never submitted sales" do
+          it "does not display data related to sales" do
+            get root_path
+
+            databox_texts = page.find_all(".app-data-box__upper").map(&:text)
+            any_sales_boxes = databox_texts.map(&:downcase).any? { |text| text.include? "sales" }
+
+            expect(any_sales_boxes).to be false
+          end
+        end
+
+        context "when the user's org has submitted sales logs" do
+          before do
+            create(:sales_log, created_by: user)
+          end
+
+          it "displays data related to sales" do
+            get root_path
+
+            databox_texts = page.find_all(".app-data-box__upper").map(&:text)
+            any_sales_boxes = databox_texts.map(&:downcase).any? { |text| text.include? "sales" }
+
+            expect(any_sales_boxes).to be true
+          end
+        end
+
+        context "when the user is a data provider" do
+          let(:user) { create(:user, :data_provider) }
+
+          it "does not display data related to schemes" do
+            get root_path
+
+            databox_texts = page.find_all(".app-data-box__upper").map(&:text)
+            any_schemes_boxes = databox_texts.map(&:downcase).any? { |text| text.include? "schemes" }
+
+            expect(any_schemes_boxes).to be false
+          end
+        end
+
+        context "when the user is a data coordinator" do
+          let(:user) { create(:user, :data_coordinator) }
+
+          it "does display data related to schemes" do
+            get root_path
+
+            databox_texts = page.find_all(".app-data-box__upper").map(&:text)
+            any_schemes_boxes = databox_texts.map(&:downcase).any? { |text| text.include? "schemes" }
+
+            expect(any_schemes_boxes).to be true
+          end
+        end
+
+        context "when the user is a support user" do
+          let(:user) { create(:user, :support) }
+
+          it "does display data related to schemes" do
+            get root_path
+
+            databox_texts = page.find_all(".app-data-box__upper").map(&:text)
+            any_schemes_boxes = databox_texts.map(&:downcase).any? { |text| text.include? "schemes" }
+
+            expect(any_schemes_boxes).to be true
+          end
+        end
+
+        context "when testing the links in the data boxes" do
+          let(:user) { create(:user, :data_coordinator) }
+          let(:in_crossover_period) { true }
+
+          before do
+            create(:sales_log, created_by: user)
+            get root_path
+          end
+
+          it "shows the correct links for in progress lettings" do
+            type = "lettings"
+            status = "in_progress"
+            databoxes = all_databoxes(type, status)
+
+            expect(databoxes.count).to be 2
+
+            links = databoxes.map { |databox| link_from_databox databox }
+
+            expect(links.map(&:path)).to all eq lettings_logs_path
+
+            params = links.map { |link| CGI.parse(link.query) }
+
+            expect(params.map { |prms| prms["status[]"] }).to all eq [status]
+            expect(params.first["years[]"]).to eq [(current_year - 1).to_s]
+            expect(params.second["years[]"]).to eq [current_year.to_s]
+          end
+
+          it "shows the correct links for completed lettings" do
+            type = "lettings"
+            status = "completed"
+            databoxes = all_databoxes(type, status)
+
+            expect(databoxes.count).to be 2
+
+            links = databoxes.map { |databox| link_from_databox databox }
+
+            expect(links.map(&:path)).to all eq lettings_logs_path
+
+            params = links.map { |link| CGI.parse(link.query) }
+
+            expect(params.map { |prms| prms["status[]"] }).to all eq [status]
+            expect(params.first["years[]"]).to eq [(current_year - 1).to_s]
+            expect(params.second["years[]"]).to eq [current_year.to_s]
+          end
+
+          it "shows the correct links for in progress sales" do
+            type = "sales"
+            status = "in_progress"
+            databoxes = all_databoxes(type, status)
+
+            expect(databoxes.count).to be 2
+
+            links = databoxes.map { |databox| link_from_databox databox }
+
+            expect(links.map(&:path)).to all eq sales_logs_path
+
+            params = links.map { |link| CGI.parse(link.query) }
+
+            expect(params.map { |prms| prms["status[]"] }).to all eq [status]
+            expect(params.first["years[]"]).to eq [(current_year - 1).to_s]
+            expect(params.second["years[]"]).to eq [current_year.to_s]
+          end
+
+          it "shows the correct links for completed sales" do
+            type = "sales"
+            status = "completed"
+            databoxes = all_databoxes(type, status)
+
+            expect(databoxes.count).to be 2
+
+            links = databoxes.map { |databox| link_from_databox databox }
+
+            expect(links.map(&:path)).to all eq sales_logs_path
+
+            params = links.map { |link| CGI.parse(link.query) }
+
+            expect(params.map { |prms| prms["status[]"] }).to all eq [status]
+            expect(params.first["years[]"]).to eq [(current_year - 1).to_s]
+            expect(params.second["years[]"]).to eq [current_year.to_s]
+          end
+
+          it "shows the correct links for incomplete schemes" do
+            type = "schemes"
+            status = "incomplete"
+            databoxes = all_databoxes(type, status)
+
+            expect(databoxes.count).to be 1
+
+            link = databoxes.map { |databox| link_from_databox databox }.first
+
+            expect(link.path).to eq schemes_path
+
+            params = CGI.parse(link.query)
+
+            expect(params["status[]"]).to eq [status]
+          end
+        end
+
+        context "when testing the counts displayed" do
+          let(:in_crossover_period) { true }
+          let(:org_1) { create(:organisation) }
+          let(:org_2) { create(:organisation) }
+          let(:provider_1) { create(:user, :data_provider, organisation: org_1) }
+          let(:provider_2) { create(:user, :data_provider, organisation: org_2) }
+          let(:coordinator) { create(:user, :data_coordinator, organisation: org_1) }
+          let(:support_user) { create(:user, :support) }
+
+          context "and logged in as a provider" do
+            let(:user) { provider_1 }
+
+            it "shows the correct counts of logs created by them" do
+              last_year_in_progress_count = 2
+              this_year_in_progress_count = 3
+              create_list(:lettings_log, last_year_in_progress_count, :in_progress, created_by: provider_1, startdate: Time.zone.today - 1.year)
+              create_list(:lettings_log, this_year_in_progress_count, :in_progress, created_by: provider_1, startdate: Time.zone.today)
+
+              get root_path
+
+              type = "lettings"
+              status = "in_progress"
+              databoxes = all_databoxes(type, status)
+              counts = databoxes.map { |databox| count_from_databox databox }
+
+              expect(counts).to eq [last_year_in_progress_count, this_year_in_progress_count]
+            end
+
+            it "does not include logs created by other users in the count, whether in their organisation or not" do
+              create(:lettings_log, :in_progress, created_by: coordinator, startdate: Time.zone.today - 1.year)
+              create(:lettings_log, :in_progress, created_by: provider_2, startdate: Time.zone.today)
+
+              get root_path
+
+              type = "lettings"
+              status = "in_progress"
+              databoxes = all_databoxes(type, status)
+              counts = databoxes.map { |databox| count_from_databox databox }
+
+              expect(counts).to eq [0, 0]
+            end
+          end
+
+          context "and logged in as a coordinator" do
+            let(:user) { coordinator }
+
+            it "shows the correct counts of logs created by all users in their organisation" do
+              last_year_in_progress_count = 2
+              this_year_in_progress_count = 3
+              create_list(:lettings_log, last_year_in_progress_count, :in_progress, created_by: provider_1, startdate: Time.zone.today - 1.year)
+              create_list(:lettings_log, this_year_in_progress_count, :in_progress, created_by: coordinator, startdate: Time.zone.today)
+
+              get root_path
+
+              type = "lettings"
+              status = "in_progress"
+              databoxes = all_databoxes(type, status)
+              counts = databoxes.map { |databox| count_from_databox databox }
+
+              expect(counts).to eq [last_year_in_progress_count, this_year_in_progress_count]
+            end
+
+            it "does not include logs created by users from other organisations in the count" do
+              create(:lettings_log, :in_progress, created_by: provider_2, startdate: Time.zone.today)
+
+              get root_path
+
+              type = "lettings"
+              status = "in_progress"
+              databoxes = all_databoxes(type, status)
+
+              counts = databoxes.map { |databox| count_from_databox databox }
+              expect(counts).to eq [0, 0]
+            end
+          end
+
+          context "and logged in as a support user" do
+            let(:user) { support_user }
+
+            it "shows the correct counts of all logs from all orgs" do
+              provider_1_lettings_last_year_in_progress_count = 2
+              coordinator_lettings_this_year_in_progress_count = 3
+              provider_2_lettings_last_year_in_progress_count = 2
+              provider_2_sales_this_year_in_progress_count = 3
+              create_list(:lettings_log, provider_1_lettings_last_year_in_progress_count, :in_progress, created_by: provider_1, startdate: Time.zone.today - 1.year)
+              create_list(:lettings_log, coordinator_lettings_this_year_in_progress_count, :in_progress, created_by: coordinator, startdate: Time.zone.today)
+              create_list(:lettings_log, provider_2_lettings_last_year_in_progress_count, :in_progress, created_by: provider_2, startdate: Time.zone.today - 1.year)
+              create_list(:sales_log, provider_2_sales_this_year_in_progress_count, :in_progress, created_by: provider_2, saledate: Time.zone.today)
+
+              get root_path
+
+              type = "lettings"
+              status = "in_progress"
+              lettings_databoxes = all_databoxes(type, status)
+              lettings_counts = lettings_databoxes.map { |databox| count_from_databox databox }
+
+              expect(lettings_counts).to eq [
+                provider_1_lettings_last_year_in_progress_count + provider_2_lettings_last_year_in_progress_count,
+                coordinator_lettings_this_year_in_progress_count,
+              ]
+
+              type = "sales"
+              status = "in_progress"
+              sales_databoxes = all_databoxes(type, status)
+              sales_counts = sales_databoxes.map { |databox| count_from_databox databox }
+
+              expect(sales_counts).to eq [
+                0,
+                provider_2_sales_this_year_in_progress_count,
+              ]
+            end
+          end
+        end
+      end
+
       context "and 2023 collection window is open for editing" do
         before do
           allow(Time).to receive(:now).and_return(Time.zone.local(2024, 1, 1))
         end
 
         it "displays correct resources for 2023/24 and 2024/25 collection years" do
-          get "/", headers: headers, params: {}
+          get root_path
           expect(page).to have_content("Lettings 24/25")
           expect(page).to have_content("Lettings 23/24")
           expect(page).to have_content("Lettings 2024 to 2025")
@@ -56,7 +376,7 @@ RSpec.describe StartController, type: :request do
         end
 
         it "displays correct resources for 2023/24 and 2024/25 collection years" do
-          get "/", headers: headers, params: {}
+          get root_path
           expect(page).to have_content("Lettings 24/25")
           expect(page).not_to have_content("Lettings 23/24")
           expect(page).to have_content("Lettings 2024 to 2025")
@@ -69,12 +389,12 @@ RSpec.describe StartController, type: :request do
       end
 
       it "shows guidance link" do
-        get "/", headers: headers, params: {}
+        get root_path
         expect(page).to have_content("Guidance for submitting social housing lettings and sales data (CORE)")
       end
 
       it "displays About this service section" do
-        get "/", headers:, params: {}
+        get root_path
         expect(page).to have_content("About this service")
       end
     end
@@ -83,7 +403,7 @@ RSpec.describe StartController, type: :request do
   describe "guidance page" do
     context "when the user is not signed in" do
       it "routes user to the guidance page" do
-        get "/guidance", headers:, params: {}
+        get guidance_path
         expect(page).to have_content("Guidance for submitting social housing lettings and sales data")
       end
     end
@@ -94,9 +414,27 @@ RSpec.describe StartController, type: :request do
       end
 
       it "routes user to the guidance page" do
-        get "/guidance", headers:, params: {}
+        get guidance_path
         expect(page).to have_content("Guidance for submitting social housing lettings and sales data")
       end
     end
   end
+
+private
+
+  def all_databoxes(type, status)
+    databoxes = page.find_all(".app-data-box__upper")
+    databoxes.select do |box|
+      box.text.downcase.include?(type) &&
+        box.text.downcase.include?(status.humanize.downcase)
+    end
+  end
+
+  def link_from_databox(databox)
+    URI.parse(databox.first("a")[:href])
+  end
+
+  def count_from_databox(databox)
+    databox.first("a").text.to_i
+  end
 end