baarkerlounger
/
submit-social-housing-lettings-and-sales-data
mirror of https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

correct various linter complaints and tech review suggestions

pull/1568/head
Arthur Campbell 3 years ago
parent
88fe0b296e
commit
072bc8bbbc
7 changed files with 43 additions and 47 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 15
      app/jobs/email_csv_job.rb
  2. 6
      app/models/form_handler.rb
  3. 8
      app/services/csv/sales_log_csv_service.rb
  4. 4
      spec/jobs/email_csv_job_spec.rb
  5. 16
      spec/models/form_handler_spec.rb
  6. 32
      spec/requests/organisations_controller_spec.rb
  7. 9
      spec/services/csv/sales_log_csv_service_spec.rb

15
app/jobs/email_csv_job.rb
Unescape View File

@ -8,19 +8,16 @@ class EmailCsvJob < ApplicationJob
def perform(user, search_term = nil, filters = {}, all_orgs = false, organisation = nil, codes_only_export = false, log_type = "lettings") # rubocop:disable Style/OptionalBooleanParameter - sidekiq can't serialise named params def perform(user, search_term = nil, filters = {}, all_orgs = false, organisation = nil, codes_only_export = false, log_type = "lettings") # rubocop:disable Style/OptionalBooleanParameter - sidekiq can't serialise named params
if log_type == "lettings" if log_type == "lettings"
unfiltered_logs = organisation.present? && user.support? ? LettingsLog.visible.where(owning_organisation_id: organisation.id) : user.lettings_logs.visible unfiltered_logs = organisation.present? && user.support? ? LettingsLog.visible.where(owning_organisation_id: organisation.id) : user.lettings_logs.visible
filtered_logs = FilterService.filter_logs(unfiltered_logs, search_term, filters, all_orgs, user)
csv_string = filtered_logs.to_csv(user, codes_only_export:)
else else
unfiltered_logs = organisation.present? && user.support? ? SalesLog.visible.where(owning_organisation_id: organisation.id) : user.sales_logs.visible unfiltered_logs = organisation.present? && user.support? ? SalesLog.visible.where(owning_organisation_id: organisation.id) : user.sales_logs.visible
filtered_logs = FilterService.filter_logs(unfiltered_logs, search_term, filters, all_orgs, user)
export_type = codes_only_export ? "codes" : "labels"
csv_string = Csv::SalesLogCsvService.new(export_type:).prepare_csv(filtered_logs)
end end
filtered_logs = FilterService.filter_logs(unfiltered_logs, search_term, filters, all_orgs, user)
filename = [log_type, "logs", organisation&.name, Time.zone.now].compact.join("-") + ".csv" filename = "#{[log_type, 'logs', organisation&.name, Time.zone.now].compact.join('-')}.csv"
csv_string = if log_type == "sales"
export_type = codes_only_export ? "codes" : "labels"
Csv::SalesLogCsvService.new(export_type:).prepare_csv(filtered_logs)
else
filtered_logs.to_csv(user, codes_only_export:)
end
storage_service = Storage::S3Service.new(Configuration::EnvConfigurationService.new, ENV["CSV_DOWNLOAD_PAAS_INSTANCE"]) storage_service = Storage::S3Service.new(Configuration::EnvConfigurationService.new, ENV["CSV_DOWNLOAD_PAAS_INSTANCE"])
storage_service.write_file(filename, BYTE_ORDER_MARK + csv_string) storage_service.write_file(filename, BYTE_ORDER_MARK + csv_string)

6
app/models/form_handler.rb
Unescape View File

@ -49,10 +49,10 @@ class FormHandler
# sales_forms = [2021..2023].each { |year| Form.new(nil, year, SALES_SECTIONS, sales) } # sales_forms = [2021..2023].each { |year| Form.new(nil, year, SALES_SECTIONS, sales) }
# sidenote, why do we save a reference to the next years sales log in the FormHandler? # sidenote, why do we save a reference to the next years sales log in the FormHandler?
def ordered_sales_questions_for_all_years def ordered_sales_questions_for_all_years
sales_forms = forms.filter { |name, _form| name.end_with? 'sales' }.values sales_forms = forms.filter { |name, _form| name.end_with? "sales" }.values
ordered_questions = sales_forms.pop.questions.uniq { |q| q.id } ordered_questions = sales_forms.pop.questions.uniq(&:id)
index_of_last_question = 0 index_of_last_question = 0
sales_forms.flat_map(&:questions).each_with_index do |question, i| sales_forms.flat_map(&:questions).each do |question|
index = ordered_questions.index { |q| q.id == question.id } index = ordered_questions.index { |q| q.id == question.id }
if index if index
index_of_last_question = index index_of_last_question = index

8
app/services/csv/sales_log_csv_service.rb
Unescape View File

@ -21,7 +21,7 @@ module Csv
created_by_name: %i[created_by name], created_by_name: %i[created_by name],
is_dpo: %i[created_by is_dpo], is_dpo: %i[created_by is_dpo],
owning_organisation_name: %i[owning_organisation name], owning_organisation_name: %i[owning_organisation name],
} }.freeze
# can this be made so general it can also be extracted? quite possibly # can this be made so general it can also be extracted? quite possibly
def value(attribute, log) def value(attribute, log)
@ -66,7 +66,7 @@ module Csv
"ppostcode_full" => %w[ppostc1 ppostc2], "ppostcode_full" => %w[ppostc1 ppostc2],
"la" => %w[la la_label], "la" => %w[la la_label],
"prevloc" => %w[prevloc prevloc_label], "prevloc" => %w[prevloc prevloc_label],
} }.freeze
def sales_log_attributes def sales_log_attributes
ordered_questions = FormHandler.instance.ordered_sales_questions_for_all_years ordered_questions = FormHandler.instance.ordered_sales_questions_for_all_years
@ -81,7 +81,7 @@ module Csv
end end
end end
non_question_fields = %w[id status created_at updated_at created_by_name is_dpo owning_organisation_name collection_start_year creation_method] non_question_fields = %w[id status created_at updated_at created_by_name is_dpo owning_organisation_name collection_start_year creation_method]
attributes = non_question_fields + attributes non_question_fields + attributes
end end
end end
end end

4
spec/jobs/email_csv_job_spec.rb
Unescape View File

@ -41,7 +41,7 @@ describe EmailCsvJob do
allow(storage_service).to receive(:get_presigned_url).and_return(test_url) allow(storage_service).to receive(:get_presigned_url).and_return(test_url)
allow(Csv::SalesLogCsvService).to receive(:new).and_return(sales_log_csv_service) allow(Csv::SalesLogCsvService).to receive(:new).and_return(sales_log_csv_service)
allow(sales_log_csv_service).to receive(:prepare_csv).and_return ("") allow(sales_log_csv_service).to receive(:prepare_csv).and_return("")
allow(CsvDownloadMailer).to receive(:new).and_return(mailer) allow(CsvDownloadMailer).to receive(:new).and_return(mailer)
allow(mailer).to receive(:send_csv_download_mail) allow(mailer).to receive(:send_csv_download_mail)
@ -59,7 +59,7 @@ describe EmailCsvJob do
end end
end end
context "When exporting sales logs" do context "when exporting sales logs" do
it "uses an appropriate filename in S3" do it "uses an appropriate filename in S3" do
expect(storage_service).to receive(:write_file).with(/sales-logs-.*\.csv/, anything) expect(storage_service).to receive(:write_file).with(/sales-logs-.*\.csv/, anything)
job.perform(user, nil, {}, nil, nil, nil, "sales") job.perform(user, nil, {}, nil, nil, nil, "sales")

16
spec/models/form_handler_spec.rb
Unescape View File

@ -221,11 +221,11 @@ RSpec.describe FormHandler do
end end
describe "#ordered_sales_questions_for_all_years" do describe "#ordered_sales_questions_for_all_years" do
let(:result) { FormHandler.instance.ordered_sales_questions_for_all_years } let(:result) { described_class.instance.ordered_sales_questions_for_all_years }
let(:now) { Time.zone.now } let(:now) { Time.zone.now }
it "returns an array of questions" do it "returns an array of questions" do
expect(result).to satisfy { |result| result.all? { |element| element.is_a?(Form::Question) } } expect(result).to(satisfy { |result| result.all? { |element| element.is_a?(Form::Question) } })
end end
it "does not return multiple questions with the same id" do it "does not return multiple questions with the same id" do
@ -237,7 +237,7 @@ RSpec.describe FormHandler do
household_situation_question_ids = %w[prevten ppcodenk ppostcode_full previous_la_known prevloc buyers_organisations] household_situation_question_ids = %w[prevten ppcodenk ppostcode_full previous_la_known prevloc buyers_organisations]
index_of_household_situation_start = 0 index_of_household_situation_start = 0
household_situation_question_ids.each_with_index do |id, i| household_situation_question_ids.each_with_index do |id, i|
if i = 0 if i == 0
index_of_household_situation_start = result.index { |q| q.id == id } index_of_household_situation_start = result.index { |q| q.id == id }
else else
question_index = result.index { |q| q.id == id } question_index = result.index { |q| q.id == id }
@ -247,21 +247,21 @@ RSpec.describe FormHandler do
end end
it "returns questions form all years" do it "returns questions form all years" do
current_sales_question_ids = FormHandler.instance.forms["current_sales"].questions.map(&:id).uniq current_sales_question_ids = described_class.instance.forms["current_sales"].questions.map(&:id).uniq
previous_sales_question_ids = FormHandler.instance.forms["previous_sales"].questions.map(&:id).uniq previous_sales_question_ids = described_class.instance.forms["previous_sales"].questions.map(&:id).uniq
expect(result.count).to be > current_sales_question_ids.count expect(result.count).to be > current_sales_question_ids.count
expect(result.count).to be > previous_sales_question_ids.count expect(result.count).to be > previous_sales_question_ids.count
end end
it "inserts questions from previous years that do not appear in more recent years in the correct position" do it "inserts questions from previous years that do not appear in more recent years in the correct position" do
current_sales_question_ids = FormHandler.instance.forms["current_sales"].questions.map(&:id).uniq current_sales_question_ids = described_class.instance.forms["current_sales"].questions.map(&:id).uniq
previous_sales_question_ids = FormHandler.instance.forms["previous_sales"].questions.map(&:id).uniq previous_sales_question_ids = described_class.instance.forms["previous_sales"].questions.map(&:id).uniq
obsolete_question_ids = previous_sales_question_ids - current_sales_question_ids obsolete_question_ids = previous_sales_question_ids - current_sales_question_ids
expect(obsolete_question_ids.count).to be_positive expect(obsolete_question_ids.count).to be_positive
obsolete_question_ids.each do |obsolete_id| obsolete_question_ids.each do |obsolete_id|
index = previous_sales_question_ids.index(obsolete_id) index = previous_sales_question_ids.index(obsolete_id)
previous_question_id = previous_sales_question_ids[index - 1] previous_question_id = previous_sales_question_ids[index - 1]
expect(result).to include { |q| q.id == id } expect(result).to(include { |q| q.id == id })
index_of_previous_question_in_result = result.index { |q| q.id == previous_question_id } index_of_previous_question_in_result = result.index { |q| q.id == previous_question_id }
index_of_obsolete_question_in_result = result.index { |q| q.id == obsolete_id } index_of_obsolete_question_in_result = result.index { |q| q.id == obsolete_id }
expect(index_of_obsolete_question_in_result).to be index_of_previous_question_in_result + 1 expect(index_of_obsolete_question_in_result).to be index_of_previous_question_in_result + 1

32
spec/requests/organisations_controller_spec.rb
Unescape View File

@ -375,7 +375,7 @@ RSpec.describe OrganisationsController, type: :request do
it "prevents CSV download" do it "prevents CSV download" do
expect { expect {
post "/organisations/#{unauthorised_organisation.id}/logs/email-csv", headers:, params: {} post "/organisations/#{unauthorised_organisation.id}/lettings-logs/email-csv", headers:, params: {}
}.not_to enqueue_job(EmailCsvJob) }.not_to enqueue_job(EmailCsvJob)
expect(response).to have_http_status(:unauthorized) expect(response).to have_http_status(:unauthorized)
end end
@ -389,7 +389,7 @@ RSpec.describe OrganisationsController, type: :request do
it "prevents CSV download" do it "prevents CSV download" do
expect { expect {
post "/organisations/#{organisation.id}/logs/email-csv", headers:, params: {} post "/organisations/#{organisation.id}/lettings-logs/email-csv", headers:, params: {}
}.not_to enqueue_job(EmailCsvJob) }.not_to enqueue_job(EmailCsvJob)
expect(response).to have_http_status(:unauthorized) expect(response).to have_http_status(:unauthorized)
end end
@ -552,7 +552,7 @@ RSpec.describe OrganisationsController, type: :request do
it "prevents CSV download" do it "prevents CSV download" do
expect { expect {
post "/organisations/#{unauthorised_organisation.id}/logs/email-csv", headers:, params: {} post "/organisations/#{unauthorised_organisation.id}/lettings-logs/email-csv", headers:, params: {}
}.not_to enqueue_job(EmailCsvJob) }.not_to enqueue_job(EmailCsvJob)
expect(response).to have_http_status(:unauthorized) expect(response).to have_http_status(:unauthorized)
end end
@ -566,7 +566,7 @@ RSpec.describe OrganisationsController, type: :request do
it "prevents CSV download" do it "prevents CSV download" do
expect { expect {
post "/organisations/#{organisation.id}/logs/email-csv", headers:, params: {} post "/organisations/#{organisation.id}/lettings-logs/email-csv", headers:, params: {}
}.not_to enqueue_job(EmailCsvJob) }.not_to enqueue_job(EmailCsvJob)
expect(response).to have_http_status(:unauthorized) expect(response).to have_http_status(:unauthorized)
end end
@ -1183,8 +1183,8 @@ RSpec.describe OrganisationsController, type: :request do
it "has CSV download buttons with the correct paths if at least 1 log exists" do it "has CSV download buttons with the correct paths if at least 1 log exists" do
get "/organisations/#{organisation.id}/lettings-logs" get "/organisations/#{organisation.id}/lettings-logs"
expect(page).to have_link("Download (CSV)", href: "/organisations/#{organisation.id}/logs/csv-download?codes_only=false") expect(page).to have_link("Download (CSV)", href: "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=false")
expect(page).to have_link("Download (CSV, codes only)", href: "/organisations/#{organisation.id}/logs/csv-download?codes_only=true") expect(page).to have_link("Download (CSV, codes only)", href: "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=true")
end end
context "when you download the CSV" do context "when you download the CSV" do
@ -1197,25 +1197,25 @@ RSpec.describe OrganisationsController, type: :request do
end end
it "only includes logs from that organisation" do it "only includes logs from that organisation" do
get "/organisations/#{organisation.id}/logs/csv-download?codes_only=false" get "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=false"
expect(page).to have_text("You've selected 3 logs.") expect(page).to have_text("You've selected 3 logs.")
end end
it "provides the organisation to the mail job" do it "provides the organisation to the mail job" do
expect { expect {
post "/organisations/#{organisation.id}/logs/email-csv?status[]=completed&codes_only=false", headers:, params: {} post "/organisations/#{organisation.id}/lettings-logs/email-csv?status[]=completed&codes_only=false", headers:, params: {}
}.to enqueue_job(EmailCsvJob).with(user, nil, { "status" => %w[completed] }, false, organisation, false) }.to enqueue_job(EmailCsvJob).with(user, nil, { "status" => %w[completed] }, false, organisation, false)
end end
it "provides the export type to the mail job" do it "provides the export type to the mail job" do
codes_only_export_type = false codes_only_export_type = false
expect { expect {
post "/organisations/#{organisation.id}/logs/email-csv?codes_only=#{codes_only_export_type}", headers:, params: {} post "/organisations/#{organisation.id}/lettings-logs/email-csv?codes_only=#{codes_only_export_type}", headers:, params: {}
}.to enqueue_job(EmailCsvJob).with(user, nil, {}, false, organisation, codes_only_export_type) }.to enqueue_job(EmailCsvJob).with(user, nil, {}, false, organisation, codes_only_export_type)
codes_only_export_type = true codes_only_export_type = true
expect { expect {
post "/organisations/#{organisation.id}/logs/email-csv?codes_only=#{codes_only_export_type}", headers:, params: {} post "/organisations/#{organisation.id}/lettings-logs/email-csv?codes_only=#{codes_only_export_type}", headers:, params: {}
}.to enqueue_job(EmailCsvJob).with(user, nil, {}, false, organisation, codes_only_export_type) }.to enqueue_job(EmailCsvJob).with(user, nil, {}, false, organisation, codes_only_export_type)
end end
end end
@ -1223,36 +1223,36 @@ RSpec.describe OrganisationsController, type: :request do
describe "GET #download_csv" do describe "GET #download_csv" do
it "renders a page with the correct header" do it "renders a page with the correct header" do
get "/organisations/#{organisation.id}/logs/csv-download?codes_only=false", headers:, params: {} get "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=false", headers:, params: {}
header = page.find_css("h1") header = page.find_css("h1")
expect(header.text).to include("Download CSV") expect(header.text).to include("Download CSV")
end end
it "renders a form with the correct target containing a button with the correct text" do it "renders a form with the correct target containing a button with the correct text" do
get "/organisations/#{organisation.id}/logs/csv-download?codes_only=false", headers:, params: {} get "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=false", headers:, params: {}
form = page.find("form.button_to") form = page.find("form.button_to")
expect(form[:method]).to eq("post") expect(form[:method]).to eq("post")
expect(form[:action]).to eq("/organisations/#{organisation.id}/logs/email-csv") expect(form[:action]).to eq("/organisations/#{organisation.id}/lettings-logs/email-csv")
expect(form).to have_button("Send email") expect(form).to have_button("Send email")
end end
it "when codes_only query parameter is false, form contains hidden field with correct value" do it "when codes_only query parameter is false, form contains hidden field with correct value" do
codes_only = false codes_only = false
get "/organisations/#{organisation.id}/logs/csv-download?codes_only=#{codes_only}", headers:, params: {} get "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=#{codes_only}", headers:, params: {}
hidden_field = page.find("form.button_to").find_field("codes_only", type: "hidden") hidden_field = page.find("form.button_to").find_field("codes_only", type: "hidden")
expect(hidden_field.value).to eq(codes_only.to_s) expect(hidden_field.value).to eq(codes_only.to_s)
end end
it "when codes_only query parameter is true, form contains hidden field with correct value" do it "when codes_only query parameter is true, form contains hidden field with correct value" do
codes_only = true codes_only = true
get "/organisations/#{organisation.id}/logs/csv-download?codes_only=#{codes_only}", headers:, params: {} get "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=#{codes_only}", headers:, params: {}
hidden_field = page.find("form.button_to").find_field("codes_only", type: "hidden") hidden_field = page.find("form.button_to").find_field("codes_only", type: "hidden")
expect(hidden_field.value).to eq(codes_only.to_s) expect(hidden_field.value).to eq(codes_only.to_s)
end end
it "when query string contains search parameter, form contains hidden field with correct value" do it "when query string contains search parameter, form contains hidden field with correct value" do
search_term = "blam" search_term = "blam"
get "/organisations/#{organisation.id}/logs/csv-download?codes_only=true&search=#{search_term}", headers:, params: {} get "/organisations/#{organisation.id}/lettings-logs/csv-download?codes_only=true&search=#{search_term}", headers:, params: {}
hidden_field = page.find("form.button_to").find_field("search", type: "hidden") hidden_field = page.find("form.button_to").find_field("search", type: "hidden")
expect(hidden_field.value).to eq(search_term) expect(hidden_field.value).to eq(search_term)
end end

9
spec/services/csv/sales_log_csv_service_spec.rb
Unescape View File

@ -2,6 +2,9 @@ require "rails_helper"
RSpec.describe Csv::SalesLogCsvService do RSpec.describe Csv::SalesLogCsvService do
let(:form_handler_mock) { instance_double(FormHandler) } let(:form_handler_mock) { instance_double(FormHandler) }
let!(:log) { create(:sales_log, :completed) }
let(:service) { described_class.new(export_type: "labels") }
let(:csv) { CSV.parse(service.prepare_csv(SalesLog.all)) }
it "calls the form handler to get all questions in order when initialized" do it "calls the form handler to get all questions in order when initialized" do
allow(FormHandler).to receive(:instance).and_return(form_handler_mock) allow(FormHandler).to receive(:instance).and_return(form_handler_mock)
@ -10,10 +13,6 @@ RSpec.describe Csv::SalesLogCsvService do
expect(form_handler_mock).to have_received(:ordered_sales_questions_for_all_years) expect(form_handler_mock).to have_received(:ordered_sales_questions_for_all_years)
end end
let!(:log) { create(:sales_log, :completed) }
let(:service) { described_class.new(export_type: "labels") }
let(:csv) { CSV.parse(service.prepare_csv(SalesLog.all)) }
it "returns a string" do it "returns a string" do
result = service.prepare_csv(SalesLog.all) result = service.prepare_csv(SalesLog.all)
expect(result).to be_a String expect(result).to be_a String
@ -125,4 +124,4 @@ RSpec.describe Csv::SalesLogCsvService do
expect(la_label_value).to eq "Barnet" expect(la_label_value).to eq "Barnet"
end end
end end
end end

Write Preview
Loading…
Cancel
Save