|
<%= formatted_financial_year(builder.object.funding_value.financial_year) %>
diff --git a/config/locales/en.yml b/config/locales/en.yml
index 0bd050942..642d86762 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -21,6 +21,7 @@ en:
back_to_home_label: "Back to home page"
back_to_start_label: "Back to start page"
overview_link: "Project overview"
+ previous_years_label: "Previous years"
complete_project_label: "Submit"
submit_project_label: "Submit"
unlock_project_label: "Revert to draft"
diff --git a/lib/pafs_core/data_migration/remove_previous_years.rb b/lib/pafs_core/data_migration/remove_previous_years.rb
index 62fda8419..9b3afeea7 100644
--- a/lib/pafs_core/data_migration/remove_previous_years.rb
+++ b/lib/pafs_core/data_migration/remove_previous_years.rb
@@ -1,35 +1,45 @@
# frozen_string_literal: true
-require "csv"
-
module PafsCore
module DataMigration
class RemovePreviousYears
- attr_reader :project, :current_year
- def self.perform_all
- PafsCore::Project.find_each do |project|
- new(project).perform
- end
- end
+ def self.perform(max_projects = 100)
+ processed_project_count = 0
+
+ # The funding_values cleanup for a given project will also clear out any previous
+ # years data for the other annualised attributes. We run the service for each of
+ # those attributes to handle any cases where previous years funding_values were not
+ # present but previous years data was present for another attribute.
+ %i[funding_values
+ flood_protection_outcomes
+ flood_protection2040_outcomes
+ coastal_erosion_protection_outcomes].each do |attribute|
+ projects = qualifying_projects(attribute, max_projects - processed_project_count)
+ puts "Processing #{projects.length}/#{max_projects} projects based on #{attribute}" unless Rails.env.test?
+ projects.each do |project|
+ PafsCore::RemovePreviousYearsService.new(project).run
+ end
- def initialize(project)
- @project = project
+ processed_project_count += projects.length
+ break if processed_project_count >= max_projects
+ end
end
- def perform
- @current_year = Time.zone.today.uk_financial_year
+ def self.qualifying_projects(attribute, project_limit)
+ sanitized_attribute = ActiveRecord::Base.sanitize_sql(attribute)
- ActiveRecord::Base.transaction do
- prune_years(:funding_values)
- prune_years(:flood_protection_outcomes)
- prune_years(:flood_protection2040_outcomes)
- prune_years(:coastal_erosion_protection_outcomes)
- end
+ PafsCore::Project
+ .joins(:state)
+ .where.not(pafs_core_states: { state: :submitted })
+ .joins(attribute)
+ .distinct
+ .where(["pafs_core_#{sanitized_attribute}.financial_year < ?", current_year])
+ .limit(project_limit)
end
- def prune_years(annual_attribute)
- @project.send(annual_attribute).where("financial_year < ?", current_year).destroy_all
+ def self.current_year
+ @current_year = Time.zone.today.uk_financial_year
end
end
end
diff --git a/lib/tasks/pafs_core_tasks.rake b/lib/tasks/pafs_core_tasks.rake
index 86a613c20..3015a198a 100644
--- a/lib/tasks/pafs_core_tasks.rake
+++ b/lib/tasks/pafs_core_tasks.rake
@@ -40,8 +40,13 @@ namespace :pafs do
end
desc "Remove data for financial years before the current financial year"
- task remove_previous_years: :environment do
- PafsCore::DataMigration::RemovePreviousYears.perform_all
+ task :remove_previous_years, [:max_projects] => :environment do |_t, args|
+ project_limit = if args[:max_projects].present?
+ args[:max_projects].to_i
+ else
+ ENV.fetch("REMOVE_PREVIOUS_YEARS_MAX_PROJECTS", 100).to_i
+ end
+ PafsCore::DataMigration::RemovePreviousYears.perform(project_limit)
end
end
# rubocop:enable Metrics/BlockLength
diff --git a/spec/helpers/pafs_core/projects_helper_spec.rb b/spec/helpers/pafs_core/projects_helper_spec.rb
index 331f3de95..b3ff02f2a 100644
--- a/spec/helpers/pafs_core/projects_helper_spec.rb
+++ b/spec/helpers/pafs_core/projects_helper_spec.rb
@@ -35,6 +35,12 @@ module PafsCore
end
describe "#formatted_financial_year" do
+ context "when given a year less than zero" do
+ it "returns the string 'Previous years'" do
+ expect(helper.formatted_financial_year(-1)).to eq "Previous years"
+ end
+ end
+
it "returns the financial year range as a string" do
expect(helper.formatted_financial_year(2016)).to eq "2016 to 2017"
end
diff --git a/spec/lib/pafs_core/data_migration/remove_previous_years_spec.rb b/spec/lib/pafs_core/data_migration/remove_previous_years_spec.rb
index 6e31f3d4c..a6aca0500 100644
--- a/spec/lib/pafs_core/data_migration/remove_previous_years_spec.rb
+++ b/spec/lib/pafs_core/data_migration/remove_previous_years_spec.rb
@@ -5,61 +5,94 @@
RSpec.describe PafsCore::DataMigration::RemovePreviousYears do
describe "#perform_all" do
- let!(:project_1) { create(:project) }
- let!(:project_2) { create(:project) }
-
- before { allow(described_class).to receive(:new).and_call_original }
-
- it "processes each project" do
- described_class.perform_all
-
- expect(described_class).to have_received(:new).with(project_1)
- expect(described_class).to have_received(:new).with(project_2)
+ let(:projects_with_previous_years_data) do
+ create_list(:project, 5, funding_values: [],
+ flood_protection_outcomes: [],
+ flood_protection2040_outcomes: [],
+ coastal_erosion_protection_outcomes: [])
+ end
+ let(:projects_without_previous_years_data) do
+ create_list(:project, 2, funding_values: [],
+ flood_protection_outcomes: [],
+ flood_protection2040_outcomes: [],
+ coastal_erosion_protection_outcomes: [])
end
- end
-
- describe "#perform" do
- let(:project) { create(:project) }
- let(:step) { create(:funding_sources_step) }
let(:current_year) { Time.zone.today.uk_financial_year }
let(:data_start_year) { current_year - 2 }
let(:data_end_year) { current_year + 2 }
before do
- (data_start_year..data_end_year).each do |year|
- project.funding_values <<
- create(:funding_value, financial_year: year)
- project.flood_protection_outcomes <<
- create(:flood_protection_outcomes, financial_year: year)
- project.flood_protection2040_outcomes <<
- create(:flood_protection2040_outcomes, financial_year: year)
- project.coastal_erosion_protection_outcomes <<
- create(:coastal_erosion_protection_outcomes, financial_year: year)
+ projects_with_previous_years_data.each do |project|
+ (data_start_year..data_end_year).each do |year|
+ add_financial_year_data(project, year)
+ end
+ end
+ projects_without_previous_years_data.each do |project|
+ (current_year..data_end_year - 1).each do |year|
+ add_financial_year_data(project, year)
+ end
+ end
+
+ allow(described_class).to receive(:new).and_call_original
+ allow(PafsCore::RemovePreviousYearsService).to receive(:new).and_call_original
+ end
+
+ context "with a project limit greater than the number of qualifying projects" do
+
+ it "processes all projects with previous years data" do
+ described_class.perform(10)
+
+ expect(PafsCore::RemovePreviousYearsService).to have_received(:new)
+ .exactly(projects_with_previous_years_data.length).times
end
+ end
+
+ context "with a project limit less than the number of qualifying projects" do
+
+ it "processes only the specified number of projects" do
+ described_class.perform(3)
- described_class.new(project).perform
+ expect(PafsCore::RemovePreviousYearsService).to have_received(:new)
+ .exactly(3).times
+ end
end
- shared_examples "prunes year values correctly" do |attribute|
- it "removes #{attribute} values for previous years" do
- expect(project.public_send(attribute).pluck(:financial_year))
- .not_to include(current_year - 2, current_year - 1)
+ context "when a project has outcomes but not funding values for previous years" do
+ let(:project) { projects_without_previous_years_data.sample }
+
+ before do
+ project.flood_protection_outcomes <<
+ create(:flood_protection_outcomes, project: project, financial_year: current_year - 1)
end
- it "does not remove #{attribute} values for the current financial year" do
- expect(project.public_send(attribute).pluck(:financial_year))
- .to include(current_year)
+ it "processes the project" do
+ described_class.perform
+
+ expect(PafsCore::RemovePreviousYearsService).to have_received(:new).with(project)
end
+ end
+
+ context "when a project is in a submitted state" do
+ let(:submitted_project) { projects_with_previous_years_data.sample }
- it "does not remove #{attribute} values for future financial years" do
- expect(project.public_send(attribute).pluck(:financial_year))
- .to include(current_year + 1, current_year + 2)
+ before { submitted_project.state.update(state: "submitted") }
+
+ it "does not call the service for the submitted project" do
+ described_class.perform
+
+ expect(PafsCore::RemovePreviousYearsService).not_to have_received(:new).with(submitted_project)
end
end
+ end
- it_behaves_like "prunes year values correctly", :funding_values
- it_behaves_like "prunes year values correctly", :flood_protection_outcomes
- it_behaves_like "prunes year values correctly", :flood_protection2040_outcomes
- it_behaves_like "prunes year values correctly", :coastal_erosion_protection_outcomes
+ def add_financial_year_data(project, year)
+ project.funding_values <<
+ create(:funding_value, project: project, financial_year: year)
+ project.flood_protection_outcomes <<
+ create(:flood_protection_outcomes, project: project, financial_year: year)
+ project.flood_protection2040_outcomes <<
+ create(:flood_protection2040_outcomes, project: project, financial_year: year)
+ project.coastal_erosion_protection_outcomes <<
+ create(:coastal_erosion_protection_outcomes, project: project, financial_year: year)
end
end
diff --git a/spec/lib/tasks/pafs_core_tasks_spec.rb b/spec/lib/tasks/pafs_core_tasks_spec.rb
index c9b5e654f..4c92c0d3f 100644
--- a/spec/lib/tasks/pafs_core_tasks_spec.rb
+++ b/spec/lib/tasks/pafs_core_tasks_spec.rb
@@ -52,11 +52,11 @@
subject(:task) { Rake::Task["pafs:remove_previous_years"] }
it "runs without error" do
- allow(PafsCore::DataMigration::RemovePreviousYears).to receive(:perform_all)
+ allow(PafsCore::DataMigration::RemovePreviousYears).to receive(:perform)
expect { task.invoke }.not_to raise_error
- expect(PafsCore::DataMigration::RemovePreviousYears).to have_received(:perform_all)
+ expect(PafsCore::DataMigration::RemovePreviousYears).to have_received(:perform)
end
end
end
diff --git a/spec/presenters/pafs_core/camc3_presenter_spec.rb b/spec/presenters/pafs_core/camc3_presenter_spec.rb
index 53786210e..72cafb4fc 100644
--- a/spec/presenters/pafs_core/camc3_presenter_spec.rb
+++ b/spec/presenters/pafs_core/camc3_presenter_spec.rb
@@ -22,6 +22,7 @@
end
let(:funding_values) do
[
+ { year: -1, value: 2000 },
{ year: 2015, value: 200 },
{ year: 2016, value: 250 },
{ year: 2017, value: 350 },
@@ -31,6 +32,7 @@
end
let(:funding_years) do
[
+ -1,
2015,
2016,
2017,
@@ -41,6 +43,7 @@
end
let(:outcome_measurements) do
[
+ { year: -1, value: 2000 },
{ year: 2015, value: 200 },
{ year: 2016, value: 250 },
{ year: 2017, value: 350 },
diff --git a/spec/services/pafs_core/remove_previous_years_service_spec.rb b/spec/services/pafs_core/remove_previous_years_service_spec.rb
new file mode 100644
index 000000000..b214953e5
--- /dev/null
+++ b/spec/services/pafs_core/remove_previous_years_service_spec.rb
@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe PafsCore::RemovePreviousYearsService do
+ describe "#run" do
+
+ subject(:service) { described_class.new(project) }
+
+ let(:project) { create(:project) }
+ let(:current_year) { Time.zone.today.uk_financial_year }
+ let(:data_start_year) { current_year - 2 }
+ let(:data_end_year) { current_year + 2 }
+
+ before do
+
+ project.state.update(state: state)
+
+ (data_start_year..data_end_year).each do |year|
+ project.funding_values <<
+ create(:funding_value, financial_year: year)
+ project.flood_protection_outcomes <<
+ create(:flood_protection_outcomes, financial_year: year)
+ project.flood_protection2040_outcomes <<
+ create(:flood_protection2040_outcomes, financial_year: year)
+ project.coastal_erosion_protection_outcomes <<
+ create(:coastal_erosion_protection_outcomes, financial_year: year)
+ end
+
+ described_class.new(project).run
+ end
+
+ shared_examples "removes previous year values" do |attribute|
+ it "removes #{attribute} values for previous years" do
+ expect(project.public_send(attribute).pluck(:financial_year))
+ .not_to include(current_year - 2, current_year - 1)
+ end
+
+ it "does not remove #{attribute} values for the current financial year" do
+ expect(project.public_send(attribute).pluck(:financial_year))
+ .to include(current_year)
+ end
+
+ it "does not remove #{attribute} values for future financial years" do
+ expect(project.public_send(attribute).pluck(:financial_year))
+ .to include(current_year + 1, current_year + 2)
+ end
+ end
+
+ shared_examples "removes previous years values for financial year attributes" do
+ it_behaves_like "removes previous year values", :funding_values
+ it_behaves_like "removes previous year values", :flood_protection_outcomes
+ it_behaves_like "removes previous year values", :flood_protection2040_outcomes
+ it_behaves_like "removes previous year values", :coastal_erosion_protection_outcomes
+ end
+
+ shared_examples "does not remove previous year values" do |attribute|
+ it "does not remove #{attribute} values for any year" do
+ expect(project.public_send(attribute).pluck(:financial_year))
+ .to include(current_year - 2, current_year + 2)
+ end
+ end
+
+ context "with a submitted project" do
+ let(:state) { "submitted" }
+
+ it_behaves_like "does not remove previous year values", :funding_values
+ it_behaves_like "does not remove previous year values", :flood_protection_outcomes
+ it_behaves_like "does not remove previous year values", :flood_protection2040_outcomes
+ it_behaves_like "does not remove previous year values", :coastal_erosion_protection_outcomes
+ end
+
+ context "with a draft project" do
+ let(:state) { "draft" }
+
+ it_behaves_like "removes previous years values for financial year attributes"
+ end
+
+ context "with an archived project" do
+ let(:state) { "archived" }
+
+ it_behaves_like "removes previous years values for financial year attributes"
+ end
+ end
+end
diff --git a/spec/steps/pafs_core/flood_protection_outcomes_details_spec.rb b/spec/steps/pafs_core/flood_protection_outcomes_details_spec.rb
index 42e25832a..ad6bf2f54 100644
--- a/spec/steps/pafs_core/flood_protection_outcomes_details_spec.rb
+++ b/spec/steps/pafs_core/flood_protection_outcomes_details_spec.rb
@@ -32,4 +32,4 @@
.total_households_flood_protected_by_category(:households_protected_from_loss_in_20_percent_most_deprived)).to eq 100
end
end
-end
\ No newline at end of file
+end
|