From 3eacbcb0d8abafbdbee059cd7e4778e56e2144bb Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:24:06 +0000 Subject: [PATCH 1/9] CLDC-2951 Display postcodes error on ownership type (#2111) * Display postcodes error on ownership type * Add error to uprn --- app/models/validations/sales/property_validations.rb | 2 ++ .../models/validations/sales/property_validations_spec.rb | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/app/models/validations/sales/property_validations.rb b/app/models/validations/sales/property_validations.rb index b1bdb5b62..3a8f6a463 100644 --- a/app/models/validations/sales/property_validations.rb +++ b/app/models/validations/sales/property_validations.rb @@ -5,6 +5,8 @@ module Validations::Sales::PropertyValidations if record.discounted_ownership_sale? && record.ppostcode_full != record.postcode_full record.errors.add :postcode_full, I18n.t("validations.property.postcode.must_match_previous") record.errors.add :ppostcode_full, I18n.t("validations.property.postcode.must_match_previous") + record.errors.add :ownershipsch, I18n.t("validations.property.postcode.must_match_previous") + record.errors.add :uprn, I18n.t("validations.property.postcode.must_match_previous") end end diff --git a/spec/models/validations/sales/property_validations_spec.rb b/spec/models/validations/sales/property_validations_spec.rb index af65446fc..0152428d8 100644 --- a/spec/models/validations/sales/property_validations_spec.rb +++ b/spec/models/validations/sales/property_validations_spec.rb @@ -25,12 +25,16 @@ RSpec.describe Validations::Sales::PropertyValidations do record.postcode_full = "SW1A 1AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to be_empty + expect(record.errors["ppostcode_full"]).to be_empty + expect(record.errors["ownershipsch"]).to be_empty end it "when postcode_full is not present no error is added" do record.ppostcode_full = "SW1A 1AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to be_empty + expect(record.errors["ppostcode_full"]).to be_empty + expect(record.errors["ownershipsch"]).to be_empty end it "when postcodes match no error is added" do @@ -38,6 +42,8 @@ RSpec.describe Validations::Sales::PropertyValidations do record.ppostcode_full = "SW1A 1AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to be_empty + expect(record.errors["ppostcode_full"]).to be_empty + expect(record.errors["ownershipsch"]).to be_empty end it "when postcodes do not match an error is added" do @@ -45,6 +51,8 @@ RSpec.describe Validations::Sales::PropertyValidations do record.ppostcode_full = "SW1A 0AA" property_validator.validate_postcodes_match_if_discounted_ownership(record) expect(record.errors["postcode_full"]).to include(match I18n.t("validations.property.postcode.must_match_previous")) + expect(record.errors["ppostcode_full"]).to include(match I18n.t("validations.property.postcode.must_match_previous")) + expect(record.errors["ownershipsch"]).to include(match I18n.t("validations.property.postcode.must_match_previous")) end end end From 991d3a5ffa5d3881c5ef3ce889405c404d939910 Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:37:21 +0000 Subject: [PATCH 2/9] CLDC-3067 Surface organisation and date errors in summary (#2104) * Surface organisation and date errors in summary * Refactor * Refactor sales row parser * Check that question is present --- .../lettings/year2023/row_parser.rb | 8 ++++++- .../bulk_upload/sales/year2023/row_parser.rb | 8 ++++++- .../lettings/year2023/row_parser_spec.rb | 23 +++++++++++++++++++ .../sales/year2023/row_parser_spec.rb | 23 +++++++++++++++++++ 4 files changed, 60 insertions(+), 2 deletions(-) diff --git a/app/services/bulk_upload/lettings/year2023/row_parser.rb b/app/services/bulk_upload/lettings/year2023/row_parser.rb index 3c5069063..094c63d45 100644 --- a/app/services/bulk_upload/lettings/year2023/row_parser.rb +++ b/app/services/bulk_upload/lettings/year2023/row_parser.rb @@ -415,7 +415,13 @@ class BulkUpload::Lettings::Year2023::RowParser fields = field_mapping_for_errors[error.attribute] || [] fields.each do |field| - unless errors.include?(field) + next if errors.include?(field) + + question = log.form.get_question(error.attribute, log) + + if question.present? && setup_question?(question) + errors.add(field, error.message, category: :setup) + else errors.add(field, error.message) end end diff --git a/app/services/bulk_upload/sales/year2023/row_parser.rb b/app/services/bulk_upload/sales/year2023/row_parser.rb index d5dca1c04..6ed79f3af 100644 --- a/app/services/bulk_upload/sales/year2023/row_parser.rb +++ b/app/services/bulk_upload/sales/year2023/row_parser.rb @@ -509,7 +509,13 @@ class BulkUpload::Sales::Year2023::RowParser fields = field_mapping_for_errors[error.attribute] || [] fields.each do |field| - unless errors.include?(field) + next if errors.include?(field) + + question = log.form.get_question(error.attribute, log) + + if question.present? && setup_question?(question) + errors.add(field, error.message, category: :setup) + else errors.add(field, error.message) end end diff --git a/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb b/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb index 8ced94e45..d172321df 100644 --- a/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb +++ b/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb @@ -1465,6 +1465,29 @@ RSpec.describe BulkUpload::Lettings::Year2023::RowParser do expect(parser.errors.where(:field_3)).not_to be_present end end + + context "when user's org has absorbed owning organisation before the startdate" do + let(:merged_org) { create(:organisation, :with_old_visible_id, holds_own_stock: true) } + + let(:attributes) { setup_section_params.merge({ field_1: merged_org.old_visible_id, field_2: merged_org.old_visible_id, field_3: user.email }) } + + before do + merged_org.update!(absorbing_organisation: user.organisation, merge_date: Time.zone.today - 5.years) + merged_org.reload + user.organisation.reload + end + + it "is not permitted" do + parser = described_class.new(attributes) + + parser.valid? + expect(parser.errors[:field_1]).to include(/The owning organisation must be active on the tenancy start date/) + expect(parser.errors[:field_2]).to include(/The managing organisation must be active on the tenancy start date/) + expect(parser.errors[:field_7]).to include(/Enter a date when the owning and managing organisation was active/) + expect(parser.errors[:field_8]).to include(/Enter a date when the owning and managing organisation was active/) + expect(parser.errors[:field_9]).to include(/Enter a date when the owning and managing organisation was active/) + end + end end describe "#field_2" do # managing org diff --git a/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb b/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb index 58a077a1b..6f617b584 100644 --- a/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb +++ b/spec/services/bulk_upload/sales/year2023/row_parser_spec.rb @@ -420,6 +420,29 @@ RSpec.describe BulkUpload::Sales::Year2023::RowParser do expect(parser.errors.where(:field_2)).not_to be_present end end + + context "when user's org has absorbed owning organisation before the startdate" do + let(:merged_org) { create(:organisation, :with_old_visible_id, holds_own_stock: true) } + + let(:attributes) { setup_section_params.merge({ field_1: merged_org.old_visible_id, field_2: user.email }) } + + before do + merged_org.update!(absorbing_organisation: user.organisation, merge_date: Time.zone.today - 3.years) + merged_org.reload + user.organisation.reload + user.reload + end + + it "is not permitted" do + parser = described_class.new(attributes) + + parser.valid? + expect(parser.errors[:field_1]).to include(/The owning organisation must be active on the sale completion date/) + expect(parser.errors[:field_3]).to include(/Enter a date when the owning organisation was active/) + expect(parser.errors[:field_4]).to include(/Enter a date when the owning organisation was active/) + expect(parser.errors[:field_5]).to include(/Enter a date when the owning organisation was active/) + end + end end describe "#field_2" do # username for created_by From d3a893522d60c7a7a77ae00a71bd3e9c2c04f936 Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:47:12 +0000 Subject: [PATCH 3/9] CLDC-3061 Add guidance page (#2121) * Add guidance page * Link to guidance from start page --- app/views/start/guidance.html.erb | 68 ++++++++++++++++++++++++++ app/views/start/index.html.erb | 1 + config/routes.rb | 1 + spec/requests/start_controller_spec.rb | 56 +++++++++++++++++++++ 4 files changed, 126 insertions(+) create mode 100644 app/views/start/guidance.html.erb create mode 100644 spec/requests/start_controller_spec.rb diff --git a/app/views/start/guidance.html.erb b/app/views/start/guidance.html.erb new file mode 100644 index 000000000..127b56b3b --- /dev/null +++ b/app/views/start/guidance.html.erb @@ -0,0 +1,68 @@ +

+ Guidance for submitting social housing lettings and sales data +

+ +
+
+

This page includes details of when a CORE log is and is not required, what to do if a tenant or buyer is reluctant to answer questions in a log, and other information about submitting logs using CORE.

+ <%= govuk_accordion do |accordion| %> + <%= accordion.with_section(heading_text: "How to create logs", expanded: true) do %> +

There are 2 ways to create logs on CORE.

+

You can create logs one at a time by answering questions using the online form. Click the “Create a new log” button on the logs page to create logs this way.

+

You can also create many logs at once by uploading a CSV file. This might be faster than creating logs individually if your organisation has its own database and a way to export the data. Click the “Upload logs in bulk” button on the logs page to create logs this way. For more information, <%= govuk_link_to "read the full guidance on bulk upload", bulk_upload_lettings_log_path(id: "guidance", form: { year: current_collection_start_year }) %>.

+

Once you have created and completed a log, there is nothing more you need to do to submit the data.

+ <% end %> + + <%= accordion.with_section(heading_text: "What scenarios require a new log?") do %> +

For general needs, you should complete a log for each new tenancy intended to last 2 years or more if it is social rent or affordable rent, or of any length if it is intermediate rent.

+

For supported housing, you should complete a log for each new letting of any length.

+

If a new tenancy agreement is signed, create a new log.

+ <% end %> + + <%= accordion.with_section(heading_text: "Types of lettings you should create logs for") do %> +

You’ll need to create a log for:

+ + <% end %> + + <%= accordion.with_section(heading_text: "Types of lettings you should not create logs for") do %> +

You don’t need to create a log for:

+ + <% end %> + + <%= accordion.with_section(heading_text: "What if someone is reluctant to answer any questions?") do %> +

If a tenant or buyer is reluctant to answer questions as part of a log, you should explain that:

+ +

If a tenant or buyer is still unwilling or unable to answer questions, select the ‘Don’t know’ or ‘Tenant/person prefers not to say’ options.

+ <% end %> + <% end %> +
+
diff --git a/app/views/start/index.html.erb b/app/views/start/index.html.erb index 3c10232d2..d6ec6d392 100644 --- a/app/views/start/index.html.erb +++ b/app/views/start/index.html.erb @@ -20,6 +20,7 @@

Use your account details to sign in.

If you need to set up a new account, speak to your organisation’s CORE data coordinator. If you don’t know who that is, <%= govuk_link_to("contact the helpdesk", GlobalConstants::HELPDESK_URL) %>.

You can <%= govuk_mail_to("dluhc.digital-services@levellingup.gov.uk", "request an account", subject: "CORE: Request a new account") %> if your organisation doesn’t have one.

+

<%= govuk_link_to guidance_path do %>Guidance for submitting social housing lettings and sales data (CORE)<% end %>

diff --git a/config/routes.rb b/config/routes.rb index af0b95d07..94626f34d 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -30,6 +30,7 @@ Rails.application.routes.draw do resource :cookies, only: %i[show update] root to: "start#index" + get "/guidance", to: "start#guidance" get "/logs", to: redirect("lettings-logs") get "/accessibility-statement", to: "content#accessibility_statement" diff --git a/spec/requests/start_controller_spec.rb b/spec/requests/start_controller_spec.rb new file mode 100644 index 000000000..f24249749 --- /dev/null +++ b/spec/requests/start_controller_spec.rb @@ -0,0 +1,56 @@ +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 } + + before do + allow(DeviseNotifyMailer).to receive(:new).and_return(devise_notify_mailer) + allow(devise_notify_mailer).to receive(:notify_client).and_return(notify_client) + allow(notify_client).to receive(:send_email).and_return(true) + end + + describe "GET" do + context "when the user is not signed in" do + it "routes user to the start in page" do + get "/", headers: headers, params: {} + expect(path).to include("/") + expect(page).to have_content("Start now") + end + end + + context "when the user is signed in" do + before do + sign_in user + end + + it "routes user to the home page" do + get "/", headers:, params: {} + expect(page).to have_content("Welcome back") + end + end + end + + 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: {} + expect(page).to have_content("Guidance for submitting social housing lettings and sales data") + end + end + + context "when the user is signed in" do + before do + sign_in user + end + + it "routes user to the guidance page" do + get "/guidance", headers:, params: {} + expect(page).to have_content("Guidance for submitting social housing lettings and sales data") + end + end + end +end From 6201a4d5490fa082aca41e73eb805cbd6184ff30 Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Fri, 5 Jan 2024 11:56:22 +0000 Subject: [PATCH 4/9] CLDC-2984 Update bulk upload guidance (#2114) * Update BU prepare your file pages * Add step by step guidance * Content tweaks * lint --- .../forms/bulk_upload_lettings/guidance.rb | 18 +++- .../forms/bulk_upload_sales/guidance.rb | 18 +++- .../forms/prepare_your_file_2023.html.erb | 13 ++- .../forms/prepare_your_file_2023.html.erb | 16 +-- .../bulk_upload_shared/guidance.html.erb | 101 ++++++++++-------- 5 files changed, 107 insertions(+), 59 deletions(-) diff --git a/app/models/forms/bulk_upload_lettings/guidance.rb b/app/models/forms/bulk_upload_lettings/guidance.rb index 862a8af51..66683eb9b 100644 --- a/app/models/forms/bulk_upload_lettings/guidance.rb +++ b/app/models/forms/bulk_upload_lettings/guidance.rb @@ -15,17 +15,29 @@ module Forms bulk_upload_lettings_log_path(id: "prepare-your-file", form: { year: }) end - def legacy_template_path + def lettings_legacy_template_path Forms::BulkUploadLettings::PrepareYourFile.new.legacy_template_path end - def template_path + def lettings_template_path Forms::BulkUploadLettings::PrepareYourFile.new(year:).template_path end - def specification_path + def lettings_specification_path Forms::BulkUploadLettings::PrepareYourFile.new(year:).specification_path end + + def sales_legacy_template_path + Forms::BulkUploadSales::PrepareYourFile.new.legacy_template_path + end + + def sales_template_path + Forms::BulkUploadSales::PrepareYourFile.new(year:).template_path + end + + def sales_specification_path + Forms::BulkUploadSales::PrepareYourFile.new(year:).specification_path + end end end end diff --git a/app/models/forms/bulk_upload_sales/guidance.rb b/app/models/forms/bulk_upload_sales/guidance.rb index eb472ad3a..44987cd87 100644 --- a/app/models/forms/bulk_upload_sales/guidance.rb +++ b/app/models/forms/bulk_upload_sales/guidance.rb @@ -15,15 +15,27 @@ module Forms bulk_upload_sales_log_path(id: "prepare-your-file", form: { year: }) end - def legacy_template_path + def lettings_legacy_template_path + Forms::BulkUploadLettings::PrepareYourFile.new.legacy_template_path + end + + def lettings_template_path + Forms::BulkUploadLettings::PrepareYourFile.new(year:).template_path + end + + def lettings_specification_path + Forms::BulkUploadLettings::PrepareYourFile.new(year:).specification_path + end + + def sales_legacy_template_path Forms::BulkUploadSales::PrepareYourFile.new.legacy_template_path end - def template_path + def sales_template_path Forms::BulkUploadSales::PrepareYourFile.new(year:).template_path end - def specification_path + def sales_specification_path Forms::BulkUploadSales::PrepareYourFile.new(year:).specification_path end end diff --git a/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb b/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb index 0dbd25c46..41564c7b2 100644 --- a/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb +++ b/app/views/bulk_upload_lettings_logs/forms/prepare_your_file_2023.html.erb @@ -9,27 +9,30 @@ Upload lettings logs in bulk (<%= @form.year_combo %>)

Prepare your file

+

<%= govuk_link_to "Read the full guidance", bulk_upload_lettings_log_path(id: "guidance", form: { year: @form.year }) %> before you start if you have not used bulk upload before.

Download template

Use one of these templates to upload logs for 2023/24:

+

There are 7 or 8 rows of content in the templates. These rows are called the ‘headers’. They contain the CORE form questions and guidance about which questions are required and how to format your answers.

Create your file

<%= govuk_inset_text(text: "You can upload both general needs and supported housing logs in the same file for 2023/24 data.") %> diff --git a/app/views/bulk_upload_sales_logs/forms/prepare_your_file_2023.html.erb b/app/views/bulk_upload_sales_logs/forms/prepare_your_file_2023.html.erb index 0d2d8831c..9b25b67ef 100644 --- a/app/views/bulk_upload_sales_logs/forms/prepare_your_file_2023.html.erb +++ b/app/views/bulk_upload_sales_logs/forms/prepare_your_file_2023.html.erb @@ -9,20 +9,24 @@ Upload sales logs in bulk (<%= @form.year_combo %>)

Prepare your file

+

<%= govuk_link_to "Read the full guidance", bulk_upload_sales_log_path(id: "guidance", form: { year: @form.year }) %> before you start if you have not used bulk upload before.

Download template

+ +

Use one of these templates to upload logs for 2023/24:

+

There are 7 or 8 rows of content in the templates. These rows are called the ‘headers’. They contain the CORE form questions and guidance about which questions are required and how to format your answers.

Create your file

Save your file

diff --git a/app/views/bulk_upload_shared/guidance.html.erb b/app/views/bulk_upload_shared/guidance.html.erb index d2fdc9230..daca50456 100644 --- a/app/views/bulk_upload_shared/guidance.html.erb +++ b/app/views/bulk_upload_shared/guidance.html.erb @@ -8,61 +8,78 @@

How to upload logs in bulk

-

Uploading sales and lettings logs

You can upload one sales or lettings log at a time, or many at once (known as ‘bulk upload’) with a comma-separated values (CSV) spreadsheet file.

-

Bulk upload may be easier if your organisation deals with many logs, or if you can export CSV data from your Housing Management System (HMS). If your organisation only deals with a small amount of logs, or you cannot export CSV data, it’s probably easier to enter logs individually.

- <%= govuk_warning_text text: "You cannot upload lettings and sales logs with the same template - you must export each data type separately, then upload them" %> -
+

Bulk upload may be easier if your organisation deals with many logs, or if you can export CSV data from your Housing Management System (HMS).

-
-

Creating your CSV files

-

To bulk upload successfully, all spreadsheets must be in the correct CSV format.

-

In most programs, you must resave files as CSV - it’s not usually the default setting. CSV files are also unformatted, so any formatting added before saving (for example colours) will automatically disappear.

- <%= govuk_details(summary_text: "More about CSV") do %> -

A CSV file is a basic spreadsheet with data values in plain text, and columns separated by commas. Each data row is a new text line.

-

CSV data is easier to process than more common advanced spreadsheet formats, for example Excel. It means CSV is well suited to upload large, or multiple data sets.

- <% end %> +

If your organisation only deals with a small amount of logs, or you cannot export CSV data, it’s probably easier to create logs individually using the online form.

-
-

Exporting CSV data

- -

Export CSV data directly from your current systems, or export then adjust it to CSV.

-

You can then upload it via a button at the top of the lettings and sales logs pages.

- - <%= govuk_details(summary_text: "My organisation has a HMS") do %> -

Some HMS providers sell an add-on "eCORE" module, which exports CSV data for you.

-

It can take HMS providers a while to update these per new collection year, so you may have to wait for updates to export, or adjust your data manually post-export.

+ <%= govuk_accordion do |accordion| %> + <%= accordion.with_section(heading_text: "Exporting your data", expanded: true) do %> +

Export CSV data directly from your current systems.

+

You should export lettings and sales data separately, and data from different collection years separately.

+

The exported CSV file should have one row per log so that the data can fit into the bulk upload template.

+

If your organisation has an HMS

+

Some HMS providers sell an add-on "eCORE" module, which exports CSV data in the format we require.

+

If your organisation does not have an HMS

+

Your organisation’s IT team may be able to export CSV data for you, depending on how data is stored in your organisation.

+

Review the bulk upload template and specification carefully to understand how we expect data to be mapped and formatted. The next 2 sections explain more about these documents.

<% end %> - <%= govuk_details(summary_text: "My organisation does not have a HMS") do %> -

Your organisation’s IT team may be able to export CSV data for you - <%= govuk_link_to "find out more about data specification", @form.specification_path, target: "_blank" %>. This document outlines:

+ <%= accordion.with_section(heading_text: "Using the bulk upload template") do %> +

For each collection year, we publish a bulk upload template and specification.

+

The bulk upload templates contain 7 or 8 rows of ‘headers’ with information about how to fill in the template, including:

- <% if @form.year == 2022 %> -

Fields must be in the same order as <%= govuk_link_to "the template", @form.template_path %>. Copy each column of your exported data one at a time and paste into the correct template column.

- <% else %> -

Fields can appear in any order, as long as you include the <%= govuk_link_to "template document", @form.template_path %> headers, to easily identify what each column represents. You can rearrange data columns to match your system exports, copy-pasting multiple columns at once. For data stored in multiple systems, you can copy-paste all columns for one system next to each other, repeating this for subsequent system exports.

- <% end %> +

You can paste your data below the headers or copy the headers and insert them above the data in your file. The bulk upload fields start at column B. Leave column A blank.

+

Make sure that each column of data aligns with the corresponding question in the headers. We recommend ordering your data to match the headers, but you can also reorder the headers to match your data. When processing the file, we check what each column of data represents based on the headers above.

+

For 2023/24 uploads, there are 2 templates to choose from, a new template and a legacy template. They outline suggested ways of ordering your data.

+

You must include the headers in your file when you upload, unless your data matches the exact order of the legacy template. If you choose to remove the headers, you must also remove the blank column A.

+ +

New template: In this template, the questions are in the same order as the 2023/24 paper form and web form. Use this template if your organisation is new to bulk upload or if your housing management system matches the new column ordering.

+

<%= govuk_link_to "Download the lettings bulk upload template (2023 to 2024) – New question ordering", @form.lettings_template_path %>

+

<%= govuk_link_to "Download the sales bulk upload template (2023 to 2024) – New question ordering", @form.sales_template_path %>

+ +

Legacy template: In this template, the questions are in the same order as the 2022/23 template, with new questions added on to the end. Use this template if you have not updated your system to match the new template yet.

+

<%= govuk_link_to "Download the lettings bulk upload template (2023 to 2024) - Legacy version", @form.lettings_legacy_template_path %>

+

<%= govuk_link_to "Download the sales bulk upload template (2023 to 2024) – Legacy version", @form.sales_legacy_template_path %>

<% end %> -
-
-

Getting help

-

There is no step-by-step bulk upload guide like there is with single log upload. However, you can download <%= @form.year == 2022 ? govuk_link_to("our template", @form.template_path) : "one of our templates" %>, which you can copy-paste data into from your systems column-by-column. You can also view a post-upload report showing any data errors, and our <%= govuk_link_to "data specification", @form.specification_path, target: "_blank" %> can help fix these.

- <% if @form.year == 2023 %> - <%= govuk_details(summary_text: "How to choose the right template") do %> -

Use one of these templates to upload logs for 2023/24:

-

<%= govuk_link_to "New template", @form.template_path %>: In this template, the questions are in the same order as the 2023/24 paper form and web form. Use this template if your organisation is new to bulk upload or if your housing management system matches the new column ordering.

-

<%= govuk_link_to "Legacy template", @form.legacy_template_path %>: In this template, the questions are in the same order as the 2022/23 template, with new questions added on to the end. Use this template if you have not updated your system to match the new template yet.

- <% end %> + <%= accordion.with_section(heading_text: "Using the bulk upload specification") do %> +

The bulk upload specification contains the same information as the template headers, as well as more details about the accepted responses for each question. For multiple-choice questions, we use number or letter codes to represent each option, and the specification shows what answer each code represents.

+

There is a separate specification for lettings and sales:

+

<%= govuk_link_to "Download the lettings bulk upload specification (2023 to 2024)", @form.lettings_specification_path, target: "_blank" %>

+

<%= govuk_link_to "Download the sales bulk upload specification (2023 to 2024)", @form.sales_specification_path, target: "_blank" %>

+

If your upload fails because there are errors in the data, you can use the specification to help correct the errors. Having your file, the error report, and the specification open at the same time will make it easy to cross-reference field numbers and check accepted responses.

<% end %> -

If you still need support mapping data in the way we need, DLUHC’s helpdesk can help. If your data is across multiple systems, or is hard to export as a single file in the correct format, you could try different exports, or copy-pasting data by hand.

-
+ + <%= accordion.with_section(heading_text: "Saving your file as a CSV") do %> +

To bulk upload successfully, all spreadsheets must be in the correct CSV format.

+

If you’ve pasted your data into the template, you will need to resave the file as a CSV.

+

CSV files are unformatted, so any formatting added before saving (for example colours) will automatically disappear.

+

What is a CSV?

+

A CSV file is a basic spreadsheet with data values in plain text, and columns separated by commas. Each data row is a new text line.

+

CSV data is easier to process than more common advanced spreadsheet formats, for example Excel. It means CSV is well suited to upload large data sets.

+

+ <% end %> + + <%= accordion.with_section(heading_text: "Next steps") do %> +

Once you've saved your CSV file, you can upload it via a button at the top of the lettings and sales logs pages.

+

When your file is done processing, you will receive an email explaining your next steps. If all your data is valid, your logs will be created. If some data is invalid, you’ll receive an email with instructions about how to resolve the errors.

+

If your file has errors on fields 1 through 17, you must fix these in the CSV. This is because we need to know these answers to validate the rest of the data. Any errors in these fields will be featured in the error report’s summary tab.

+

If none of your errors are in fields 1 through 17, you can choose how to fix the errors. You can either fix them in the CSV and reupload, or create partially complete logs and answer the remaining questions on the CORE site. Any errors that affect a significant number of logs will be featured in the error report’s summary tab to help you decide.

+

+ <% end %> + + <%= accordion.with_section(heading_text: "Getting help") do %> +

The bulk upload template and specification should contain all the information you need to format your data correctly and fix any errors found during processing. If you still need support with your bulk upload, <%= govuk_link_to "contact the helpdesk", GlobalConstants::HELPDESK_URL %>.

+ <% end %> + <% end %>
From 7d93fbdc32e1d8e97c786ca00e24552ab0de8650 Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Fri, 5 Jan 2024 14:52:28 +0000 Subject: [PATCH 5/9] Update error count for BU logs (#2116) --- app/models/bulk_upload.rb | 8 ++++++++ app/models/log.rb | 6 ++++++ app/views/logs/index.html.erb | 2 +- spec/requests/lettings_logs_controller_spec.rb | 8 +++++++- spec/requests/sales_logs_controller_spec.rb | 8 +++++++- 5 files changed, 29 insertions(+), 3 deletions(-) diff --git a/app/models/bulk_upload.rb b/app/models/bulk_upload.rb index 9db828184..70b591b91 100644 --- a/app/models/bulk_upload.rb +++ b/app/models/bulk_upload.rb @@ -116,6 +116,14 @@ class BulkUpload < ApplicationRecord bulk_upload_errors.distinct.count("row") end + def remaining_logs_with_errors_count + logs.filter_by_status("in_progress").count + end + + def remaining_errors_count + logs.filter_by_status("in_progress").map(&:missing_answers_count).sum(0) + end + private def generate_identifier diff --git a/app/models/log.rb b/app/models/log.rb index b588e1269..8814e771d 100644 --- a/app/models/log.rb +++ b/app/models/log.rb @@ -203,6 +203,12 @@ class Log < ApplicationRecord }.compact end + def missing_answers_count + form.questions.count do |question| + !optional_fields.include?(question.id) && question.displayed_to_user?(self) && question.unanswered?(self) && !question.is_derived_or_has_inferred_check_answers_value?(self) + end + end + private # Handle logs that are older than previous collection start date diff --git a/app/views/logs/index.html.erb b/app/views/logs/index.html.erb index 15b8f79d4..66f50c3d7 100644 --- a/app/views/logs/index.html.erb +++ b/app/views/logs/index.html.erb @@ -48,7 +48,7 @@

- You have uploaded <%= pluralize(@bulk_upload.logs.count, "log") %>. There are errors in <%= pluralize(@bulk_upload.logs_with_errors_count, "log") %>, and <%= pluralize(@bulk_upload.bulk_upload_errors.count, "error") %> in total. Select the log to fix the errors. + You have uploaded <%= pluralize(@bulk_upload.logs.count, "log") %>. There are errors in <%= pluralize(@bulk_upload.remaining_logs_with_errors_count, "log") %>, and <%= pluralize(@bulk_upload.remaining_errors_count, "error") %> in total. Select the log to fix the errors.

diff --git a/spec/requests/lettings_logs_controller_spec.rb b/spec/requests/lettings_logs_controller_spec.rb index d2ea715ff..6a33ee027 100644 --- a/spec/requests/lettings_logs_controller_spec.rb +++ b/spec/requests/lettings_logs_controller_spec.rb @@ -552,7 +552,7 @@ RSpec.describe LettingsLogsController, type: :request do let(:user) { create(:user, organisation:) } let(:bulk_upload) { create(:bulk_upload, :lettings, user:) } - let!(:included_log) { create(:lettings_log, :in_progress, bulk_upload:, owning_organisation: organisation) } + let!(:included_log) { create(:lettings_log, :completed, age1: nil, bulk_upload:, owning_organisation: organisation) } let!(:excluded_log) { create(:lettings_log, :in_progress, owning_organisation: organisation, tenancycode: "fake_code") } before do @@ -602,6 +602,12 @@ RSpec.describe LettingsLogsController, type: :request do expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 1 error in total. Select the log to fix the errors.") end + it "displays dynamic error number" do + included_log.update!(age2: nil) + get "/lettings-logs?bulk_upload_id[]=#{bulk_upload.id}" + expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 2 errors in total. Select the log to fix the errors.") + end + it "displays meta info about the bulk upload" do get "/lettings-logs?bulk_upload_id[]=#{bulk_upload.id}" expect(page).to have_content(bulk_upload.filename) diff --git a/spec/requests/sales_logs_controller_spec.rb b/spec/requests/sales_logs_controller_spec.rb index e837a21dc..a9bf07883 100644 --- a/spec/requests/sales_logs_controller_spec.rb +++ b/spec/requests/sales_logs_controller_spec.rb @@ -449,7 +449,7 @@ RSpec.describe SalesLogsController, type: :request do let(:user) { create(:user, organisation:) } let(:bulk_upload) { create(:bulk_upload, :sales, user:) } - let!(:included_log) { create(:sales_log, :in_progress, purchid: "included_id", bulk_upload:, owning_organisation: organisation) } + let!(:included_log) { create(:sales_log, :completed, age1: nil, purchid: "included_id", bulk_upload:, owning_organisation: organisation) } let!(:excluded_log) { create(:sales_log, :in_progress, purchid: "excluded_id", owning_organisation: organisation) } before do @@ -499,6 +499,12 @@ RSpec.describe SalesLogsController, type: :request do expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 1 error in total. Select the log to fix the errors.") end + it "displays dynamic error number" do + included_log.update!(age2: nil) + get "/lettings-logs?bulk_upload_id[]=#{bulk_upload.id}" + expect(page).to have_content("You have uploaded 1 log. There are errors in 1 log, and 2 errors in total. Select the log to fix the errors.") + end + it "displays meta info about the bulk upload" do get "/sales-logs?bulk_upload_id[]=#{bulk_upload.id}" expect(page).to have_content(bulk_upload.filename) From fc011f1d3f9fb992ecf497d72442b2e62578e37e Mon Sep 17 00:00:00 2001 From: natdeanlewissoftwire Date: Mon, 8 Jan 2024 10:26:59 +0000 Subject: [PATCH 6/9] feat: test home/start paths explicitly --- spec/requests/start_controller_spec.rb | 4 ++-- spec/requests/users_controller_spec.rb | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spec/requests/start_controller_spec.rb b/spec/requests/start_controller_spec.rb index f24249749..1bfd2b4b9 100644 --- a/spec/requests/start_controller_spec.rb +++ b/spec/requests/start_controller_spec.rb @@ -15,9 +15,9 @@ RSpec.describe StartController, type: :request do describe "GET" do context "when the user is not signed in" do - it "routes user to the start in page" do + it "routes user to the start page" do get "/", headers: headers, params: {} - expect(path).to include("/") + expect(path).to eq("/") expect(page).to have_content("Start now") end end diff --git a/spec/requests/users_controller_spec.rb b/spec/requests/users_controller_spec.rb index 59d4e27c9..38458eb7f 100644 --- a/spec/requests/users_controller_spec.rb +++ b/spec/requests/users_controller_spec.rb @@ -76,7 +76,7 @@ RSpec.describe UsersController, type: :request do it "routes user to the home page" do sign_in user get "/", headers:, params: {} - expect(path).to include("/") + expect(path).to eq("/") expect(page).to have_content("Welcome back") expected_link = "" expect(CGI.unescape_html(response.body)).to include(expected_link) @@ -2027,7 +2027,7 @@ RSpec.describe UsersController, type: :request do it "routes user to the home page" do get "/", headers:, params: {} - expect(path).to include("/") + expect(path).to eq("/") expect(page).to have_content("Welcome back") expected_link = "" expect(CGI.unescape_html(response.body)).to include(expected_link) From 763094eb0b478b8f4b2056ac8405339382681c57 Mon Sep 17 00:00:00 2001 From: natdeanlewissoftwire <94526761+natdeanlewissoftwire@users.noreply.github.com> Date: Mon, 8 Jan 2024 13:27:24 +0000 Subject: [PATCH 7/9] CLDC-3034 Ignore household charge in general needs bulk uploads (#2123) * feat: ignore household_charge for general needs logs * feat: add tests * feat: add tests * refactor: lint --- .../bulk_upload/lettings/year2023/row_parser.rb | 2 +- .../lettings/year2023/row_parser_spec.rb | 16 +++++++++++++--- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/app/services/bulk_upload/lettings/year2023/row_parser.rb b/app/services/bulk_upload/lettings/year2023/row_parser.rb index 094c63d45..c1a19ef93 100644 --- a/app/services/bulk_upload/lettings/year2023/row_parser.rb +++ b/app/services/bulk_upload/lettings/year2023/row_parser.rb @@ -1193,7 +1193,7 @@ private attributes["tcharge"] = field_132 attributes["chcharge"] = field_127 attributes["is_carehome"] = field_127.present? ? 1 : 0 - attributes["household_charge"] = field_125 + attributes["household_charge"] = supported_housing? ? field_125 : nil attributes["hbrentshortfall"] = field_133 attributes["tshortfall_known"] = tshortfall_known attributes["tshortfall"] = field_134 diff --git a/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb b/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb index d172321df..63531deb5 100644 --- a/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb +++ b/spec/services/bulk_upload/lettings/year2023/row_parser_spec.rb @@ -2258,10 +2258,20 @@ RSpec.describe BulkUpload::Lettings::Year2023::RowParser do end describe "#household_charge" do - let(:attributes) { { bulk_upload:, field_125: "1" } } + context "when log is general needs" do + let(:attributes) { { bulk_upload:, field_4: 1, field_125: "1" } } - it "sets correct value from mapping" do - expect(parser.log.household_charge).to eq(1) + it "sets correct value from mapping" do + expect(parser.log.household_charge).to eq(nil) + end + end + + context "when log is supported housing" do + let(:attributes) { { bulk_upload:, field_4: 2, field_125: "1" } } + + it "sets correct value from mapping" do + expect(parser.log.household_charge).to eq(1) + end end end From c912696e143003aee6d43a3f814ddcdb8f97c4f7 Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Tue, 9 Jan 2024 11:28:30 +0000 Subject: [PATCH 8/9] CLDC-2253 Add collection resources (#2120) * Update collection resources, add to homepage * Add guidance link to an empty page * Update headings * Rebase fix * Update title * Update file names * Add section break --- app/frontend/styles/_document-list.scss | 2 +- app/views/home/index.html.erb | 5 + .../layouts/_collection_resources.html.erb | 115 ++++++------------ app/views/organisations/show.html.erb | 4 - app/views/start/index.html.erb | 7 +- .../requests/organisations_controller_spec.rb | 36 ------ spec/requests/start_controller_spec.rb | 29 +++++ 7 files changed, 81 insertions(+), 117 deletions(-) diff --git a/app/frontend/styles/_document-list.scss b/app/frontend/styles/_document-list.scss index 47936a365..e8cef0625 100644 --- a/app/frontend/styles/_document-list.scss +++ b/app/frontend/styles/_document-list.scss @@ -12,7 +12,7 @@ } .app-document-list__item-title { - @include govuk-font($size: 16, $weight: "bold"); + @include govuk-font($size: 16); margin: 0 0 govuk-spacing(1); } diff --git a/app/views/home/index.html.erb b/app/views/home/index.html.erb index e691b3e5b..7469ed18f 100644 --- a/app/views/home/index.html.erb +++ b/app/views/home/index.html.erb @@ -1 +1,6 @@

<%= "Welcome back, #{@current_user.name}" %>

+
+
+ <%= render partial: "layouts/collection_resources" %> +
+
diff --git a/app/views/layouts/_collection_resources.html.erb b/app/views/layouts/_collection_resources.html.erb index e2d56e4a5..0c084596e 100644 --- a/app/views/layouts/_collection_resources.html.erb +++ b/app/views/layouts/_collection_resources.html.erb @@ -1,94 +1,59 @@ -
+<% if current_user %> +

Collection resources

+

<%= govuk_link_to "Guidance for submitting social housing lettings and sales data (CORE)", guidance_path %>

+<% else %>

Collection resources

-

For lettings starting during 1 April 2023 to 31 March 2024 and sales completing during the same period, use the 2023/24 forms.

- +<% end %> +

Use the 2023 to 2024 forms for lettings that start and sales that complete between 1 April 2023 and 31 March 2024.

+<%= govuk_tabs(title: "Collection resources") do |c| %> <% if FormHandler.instance.lettings_form_for_start_year(2023) && FormHandler.instance.lettings_form_for_start_year(2023).edit_end_date > Time.zone.today %> -

Lettings 2023/24

- <%= render DocumentListComponent.new(items: [ + <% c.with_tab(label: "Lettings 2023/24") do %> + <%= render DocumentListComponent.new(items: [ { - name: "Lettings log for tenants (2023/24)", + name: "Download the lettings log for tenants (2023 to 2024)", href: download_23_24_lettings_form_path, metadata: file_type_size_and_pages("2023_24_lettings_paper_form.pdf", number_of_pages: 8), }, { - name: "Lettings bulk upload template (2023/24) – New question ordering", + name: "Download the lettings bulk upload template (2023 to 2024) – New question ordering", href: download_23_24_lettings_bulk_upload_template_path, metadata: file_type_size_and_pages("bulk-upload-lettings-template-2023-24.xlsx"), }, { - name: "Lettings bulk upload template (2023/24)", + name: "Download the lettings bulk upload template (2023 to 2024) – Legacy version", href: download_23_24_lettings_bulk_upload_legacy_template_path, metadata: file_type_size_and_pages("bulk-upload-lettings-legacy-template-2023-24.xlsx"), }, { - name: "Lettings bulk upload specification (2023/24)", + name: "Download the lettings bulk upload specification (2023 to 2024)", href: download_23_24_lettings_bulk_upload_specification_path, metadata: file_type_size_and_pages("bulk-upload-lettings-specification-2023-24.xlsx"), }, - ]) %> - -

Sales 2023/24

- <%= render DocumentListComponent.new(items: [ - { - name: "Sales log for buyers (2023/24)", - href: download_23_24_sales_form_path, - metadata: file_type_size_and_pages("2023_24_sales_paper_form.pdf", number_of_pages: 8), - }, - { - name: "Sales bulk upload template (2023/24) – New question ordering", - href: download_23_24_sales_bulk_upload_template_path, - metadata: file_type_size_and_pages("bulk-upload-sales-template-2023-24.xlsx"), - }, - { - name: "Sales bulk upload template (2023/24)", - href: download_23_24_sales_bulk_upload_legacy_template_path, - metadata: file_type_size_and_pages("bulk-upload-sales-legacy-template-2023-24.xlsx"), - }, - { - name: "Sales bulk upload specification (2023/24)", - href: download_23_24_sales_bulk_upload_specification_path, - metadata: file_type_size_and_pages("bulk-upload-sales-specification-2023-24.xlsx"), - }, - ]) %> - <% end %> - - <% if FormHandler.instance.lettings_form_for_start_year(2022) && FormHandler.instance.lettings_form_for_start_year(2022).edit_end_date > Time.zone.today %> -

Lettings 2022/23

- <%= render DocumentListComponent.new(items: [ - { - name: "Lettings log for tenants (2022/23)", - href: download_22_23_lettings_form_path, - metadata: file_type_size_and_pages("2022_23_lettings_paper_form.pdf", number_of_pages: 4), - }, - { - name: "Lettings bulk upload template (2022/23)", - href: download_22_23_lettings_bulk_upload_template_path, - metadata: file_type_size_and_pages("bulk-upload-lettings-template-2022-23.xlsx"), - }, - { - name: "Lettings bulk upload specification (2022/23)", - href: download_22_23_lettings_bulk_upload_specification_path, - metadata: file_type_size_and_pages("bulk-upload-lettings-specification-2022-23.xlsx"), - }, - ]) %> - -

Sales 2022/23

- <%= render DocumentListComponent.new(items: [ - { - name: "Sales log for buyers (2022/23)", - href: download_22_23_sales_form_path, - metadata: file_type_size_and_pages("2022_23_sales_paper_form.pdf", number_of_pages: 5), - }, - { - name: "Sales bulk upload template (2022/23)", - href: download_22_23_sales_bulk_upload_template_path, - metadata: file_type_size_and_pages("bulk-upload-sales-template-2022-23.xlsx"), - }, - { - name: "Sales bulk upload specification (2022/23)", - href: download_22_23_sales_bulk_upload_specification_path, - metadata: file_type_size_and_pages("bulk-upload-sales-template-2022-23.xlsx"), - }, - ]) %> + ]) %> + <% end %> + <% c.with_tab(label: "Sales 2023/24") do %> + <%= render DocumentListComponent.new(items: [ + { + name: "Download the sales log for buyers (2023 to 2024)", + href: download_23_24_sales_form_path, + metadata: file_type_size_and_pages("2023_24_sales_paper_form.pdf", number_of_pages: 8), + }, + { + name: "Download the sales bulk upload template (2023 to 2024) – New question ordering", + href: download_23_24_sales_bulk_upload_template_path, + metadata: file_type_size_and_pages("bulk-upload-sales-template-2023-24.xlsx"), + }, + { + name: "Download the sales bulk upload template (2023 to 2024) – Legacy version", + href: download_23_24_sales_bulk_upload_legacy_template_path, + metadata: file_type_size_and_pages("bulk-upload-sales-legacy-template-2023-24.xlsx"), + }, + { + name: "Download the sales bulk upload specification (2023 to 2024)", + href: download_23_24_sales_bulk_upload_specification_path, + metadata: file_type_size_and_pages("bulk-upload-sales-specification-2023-24.xlsx"), + }, + ]) %> + <% end %> <% end %> -
+<% end %> diff --git a/app/views/organisations/show.html.erb b/app/views/organisations/show.html.erb index 9cfecda26..93b47fb03 100644 --- a/app/views/organisations/show.html.erb +++ b/app/views/organisations/show.html.erb @@ -41,8 +41,4 @@ <% end %> <%= render partial: "organisations/merged_organisation_details" %>
- -
- <%= render partial: "layouts/collection_resources" %> -
diff --git a/app/views/start/index.html.erb b/app/views/start/index.html.erb index d6ec6d392..17e15d34e 100644 --- a/app/views/start/index.html.erb +++ b/app/views/start/index.html.erb @@ -16,14 +16,19 @@ href: start_path, ) %> +
+

Before you start

Use your account details to sign in.

If you need to set up a new account, speak to your organisation’s CORE data coordinator. If you don’t know who that is, <%= govuk_link_to("contact the helpdesk", GlobalConstants::HELPDESK_URL) %>.

You can <%= govuk_mail_to("dluhc.digital-services@levellingup.gov.uk", "request an account", subject: "CORE: Request a new account") %> if your organisation doesn’t have one.

<%= govuk_link_to guidance_path do %>Guidance for submitting social housing lettings and sales data (CORE)<% end %>

+ -

+
+
+
<%= render partial: "layouts/collection_resources" %>
diff --git a/spec/requests/organisations_controller_spec.rb b/spec/requests/organisations_controller_spec.rb index 97665f8ca..68de93c51 100644 --- a/spec/requests/organisations_controller_spec.rb +++ b/spec/requests/organisations_controller_spec.rb @@ -310,42 +310,6 @@ RSpec.describe OrganisationsController, type: :request do it "redirects to details" do expect(response).to have_http_status(:redirect) end - - context "and 2022 collection window is open" do - let(:set_time) { allow(Time).to receive(:now).and_return(Time.zone.local(2023, 1, 1)) } - - it "displays correct resources for 2022/23 and 2023/24 collection years" do - follow_redirect! - expect(page).to have_content("Lettings 2023/24") - expect(page).to have_content("Sales 2023/24") - expect(page).to have_content("Lettings 2022/23") - expect(page).to have_content("Sales 2022/23") - end - end - - context "and 2022 collection window is closed for editing" do - let(:set_time) { allow(Time).to receive(:now).and_return(Time.zone.local(2024, 1, 1)) } - - it "displays correct resources for 2022/23 and 2023/24 collection years" do - follow_redirect! - expect(page).to have_content("Lettings 2023/24") - expect(page).to have_content("Sales 2023/24") - expect(page).not_to have_content("Lettings 2022/23") - expect(page).not_to have_content("Sales 2022/23") - end - end - - context "and 2023 collection window is closed for editing" do - let(:set_time) { allow(Time).to receive(:now).and_return(Time.zone.local(2025, 1, 1)) } - - it "displays correct resources for 2022/23 and 2023/24 collection years" do - follow_redirect! - expect(page).not_to have_content("Lettings 2023/24") - expect(page).not_to have_content("Sales 2023/24") - expect(page).not_to have_content("Lettings 2022/23") - expect(page).not_to have_content("Sales 2022/23") - end - end end context "with an organisation that are not in scope for the user, i.e. that they do not belong to" do diff --git a/spec/requests/start_controller_spec.rb b/spec/requests/start_controller_spec.rb index 1bfd2b4b9..2287280dc 100644 --- a/spec/requests/start_controller_spec.rb +++ b/spec/requests/start_controller_spec.rb @@ -31,6 +31,35 @@ RSpec.describe StartController, type: :request do get "/", headers:, params: {} expect(page).to have_content("Welcome back") 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 2022/23 and 2023/24 collection years" do + get "/", headers: headers, params: {} + expect(page).to have_content("Lettings 2023/24") + expect(page).to have_content("Sales 2023/24") + end + end + + context "and 2023 collection window is closed for editing" do + before do + allow(Time).to receive(:now).and_return(Time.zone.local(2025, 1, 1)) + end + + it "displays correct resources for 2022/23 and 2023/24 collection years" do + get "/", headers: headers, params: {} + expect(page).not_to have_content("Lettings 2023/24") + expect(page).not_to have_content("Sales 2023/24") + end + end + + it "shows guidance link" do + get "/", headers: headers, params: {} + expect(page).to have_content("Guidance for submitting social housing lettings and sales data (CORE)") + end end end From bf92c52635b4c06df66e81ff7ff3ddaf6127bdc4 Mon Sep 17 00:00:00 2001 From: kosiakkatrina <54268893+kosiakkatrina@users.noreply.github.com> Date: Tue, 9 Jan 2024 12:05:42 +0000 Subject: [PATCH 9/9] CLDC-2593 Add upcoming deadlines section (#2119) * Add upcoming deadlines section * Update the content to use the correct dates * Update content * lint * typos --- app/helpers/collection_time_helper.rb | 20 ++++++++++++ app/models/form_handler.rb | 4 +++ app/views/home/_upcoming_deadlines.html.erb | 35 +++++++++++++++++++++ app/views/home/index.html.erb | 2 ++ spec/helpers/collection_time_helper_spec.rb | 30 ++++++++++++++++++ 5 files changed, 91 insertions(+) create mode 100644 app/views/home/_upcoming_deadlines.html.erb diff --git a/app/helpers/collection_time_helper.rb b/app/helpers/collection_time_helper.rb index ea7601c70..6f8ef62fc 100644 --- a/app/helpers/collection_time_helper.rb +++ b/app/helpers/collection_time_helper.rb @@ -45,4 +45,24 @@ module CollectionTimeHelper def previous_collection_start_date current_collection_start_date - 1.year end + + def quarter_for_date(date: Time.zone.now) + quarters = [ + { quarter: "Q3", cutoff_date: Time.zone.local(2024, 1, 12), start_date: Time.zone.local(2023, 10, 1), end_date: Time.zone.local(2023, 12, 31) }, + { quarter: "Q1", cutoff_date: Time.zone.local(2024, 7, 12), start_date: Time.zone.local(2024, 4, 1), end_date: Time.zone.local(2024, 6, 30) }, + { quarter: "Q2", cutoff_date: Time.zone.local(2024, 10, 11), start_date: Time.zone.local(2024, 7, 1), end_date: Time.zone.local(2024, 9, 30) }, + { quarter: "Q3", cutoff_date: Time.zone.local(2025, 1, 10), start_date: Time.zone.local(2024, 10, 1), end_date: Time.zone.local(2024, 12, 31) }, + ] + + quarter = quarters.find { |q| date.between?(q[:start_date], q[:cutoff_date] + 1.day) } + + return unless quarter + + OpenStruct.new( + quarter: quarter[:quarter], + cutoff_date: quarter[:cutoff_date], + quarter_start_date: quarter[:start_date], + quarter_end_date: quarter[:end_date], + ) + end end diff --git a/app/models/form_handler.rb b/app/models/form_handler.rb index 83bfb0f8a..d9a3d4a35 100644 --- a/app/models/form_handler.rb +++ b/app/models/form_handler.rb @@ -28,6 +28,10 @@ class FormHandler forms["current_lettings"] end + def previous_lettings_form + forms["previous_lettings"] + end + def current_sales_form forms["current_sales"] end diff --git a/app/views/home/_upcoming_deadlines.html.erb b/app/views/home/_upcoming_deadlines.html.erb new file mode 100644 index 000000000..ffed67ca1 --- /dev/null +++ b/app/views/home/_upcoming_deadlines.html.erb @@ -0,0 +1,35 @@ +

Upcoming deadlines

+ +<% current_lettings_form = FormHandler.instance.in_crossover_period? ? FormHandler.instance.previous_lettings_form : FormHandler.instance.current_lettings_form %> +<% formatted_deadline = "#{current_lettings_form.submission_deadline.strftime('%A')} #{current_lettings_form.submission_deadline.to_formatted_s(:govuk_date)}" %> +<% if FormHandler.instance.in_crossover_period? %> +

End of year deadline - <%= formatted_deadline %>: Deadline to submit logs for tenancies starting between <%= collection_start_date(Time.zone.now).to_formatted_s(:govuk_date) %> to <%= collection_end_date(Time.zone.now).to_formatted_s(:govuk_date) %>

+<% end %> + +<% current_quarter = quarter_for_date(date: Time.zone.now) %> +<% if current_quarter.present? %> +

<%= "#{current_quarter.quarter} - #{current_quarter.cutoff_date.strftime('%A')} #{current_quarter.cutoff_date.to_formatted_s(:govuk_date)}" %>: Quarterly cut off date for tenancies and sales starting between <%= current_quarter.quarter_start_date.to_formatted_s(:govuk_date) %> and <%= current_quarter.quarter_end_date.to_formatted_s(:govuk_date) %>.

+<% end %> + +<% if !FormHandler.instance.in_crossover_period? %> +

Try to complete your logs for each quarter by the cut-off date.

+

You can still create logs for a previous quarter after its cut-off date, as long as you complete them by the end-of-year deadline: <%= formatted_deadline %>.

+<% end %> + +<% if FormHandler.instance.in_crossover_period? %> +<% previous_lettings_form = FormHandler.instance.previous_lettings_form %> +

Prioritise completing logs for the closing collection year. You must complete all <%= previous_lettings_form.start_date.year %> to <%= previous_lettings_form.submission_deadline.year %> logs must by the end-of-year deadline. You can still create <%= current_lettings_form.start_date.year %> to <%= current_lettings_form.submission_deadline.year %> logs for this quarter after the quarterly cut-off date.

+<% end %> + +<%= govuk_details(summary_text: "Quarterly cut-off dates for 2023 to 2024") do %> +

The 2023 to 2024 quarterly cut-off dates are:

+ +

It is important that you meet these cut-off dates because we submit data to the Office for National Statistics quarterly, helping them create essential inflation statistics.

+

Meeting these cut-off dates also gives you more accurate data for your own analysis, and reduces the burden at the end of the year.

+

If you are not able to meet these quarterly dates, submit your logs as soon as you can so that they can be included in the annual data.

+<% end %> diff --git a/app/views/home/index.html.erb b/app/views/home/index.html.erb index 7469ed18f..e87fde287 100644 --- a/app/views/home/index.html.erb +++ b/app/views/home/index.html.erb @@ -2,5 +2,7 @@
<%= render partial: "layouts/collection_resources" %> +
+ <%= render partial: "home/upcoming_deadlines" %>
diff --git a/spec/helpers/collection_time_helper_spec.rb b/spec/helpers/collection_time_helper_spec.rb index 3eef01b5e..859431c57 100644 --- a/spec/helpers/collection_time_helper_spec.rb +++ b/spec/helpers/collection_time_helper_spec.rb @@ -109,4 +109,34 @@ RSpec.describe CollectionTimeHelper do end end end + + describe "#quarter_for_date" do + it "returns correct cutoff date for curent quarter" do + quarter = quarter_for_date(date: Time.zone.local(2023, 10, 1)) + expect(quarter.cutoff_date).to eq(Time.zone.local(2024, 1, 12)) + expect(quarter.quarter_start_date).to eq(Time.zone.local(2023, 10, 1)) + expect(quarter.quarter_end_date).to eq(Time.zone.local(2023, 12, 31)) + end + + it "returns correct cutoff date for the first quarter of 2024/25" do + quarter = quarter_for_date(date: Time.zone.local(2024, 4, 1)) + expect(quarter.cutoff_date).to eq(Time.zone.local(2024, 7, 12)) + expect(quarter.quarter_start_date).to eq(Time.zone.local(2024, 4, 1)) + expect(quarter.quarter_end_date).to eq(Time.zone.local(2024, 6, 30)) + end + + it "returns correct cutoff date for the second quarter of 2024/25" do + quarter = quarter_for_date(date: Time.zone.local(2024, 9, 30)) + expect(quarter.cutoff_date).to eq(Time.zone.local(2024, 10, 11)) + expect(quarter.quarter_start_date).to eq(Time.zone.local(2024, 7, 1)) + expect(quarter.quarter_end_date).to eq(Time.zone.local(2024, 9, 30)) + end + + it "returns correct cutoff date for the third quarter of 2024/25" do + quarter = quarter_for_date(date: Time.zone.local(2024, 10, 25)) + expect(quarter.cutoff_date).to eq(Time.zone.local(2025, 1, 10)) + expect(quarter.quarter_start_date).to eq(Time.zone.local(2024, 10, 1)) + expect(quarter.quarter_end_date).to eq(Time.zone.local(2024, 12, 31)) + end + end end