Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate the Reports page to GOV.UK Design System
- Adds use of the [Page Title](https://components.publishing.service.gov.uk/component-guide/title) component to `app/views/layouts/design_system.html.erb` to ensure transitioned pages use consistent formatting for the page title. - Updates the reports index view to use the [Document List](https://components.publishing.service.gov.uk/component-guide/document_list) component. - Improves the test coverage around the reports controller. Since the transitioned design splits the generated message into two separate pieces of metadata (one for the time and one for the date), there will now be twice the calls to S3 to fetch that data. This could be optimised if it becomes a problem, but this page is not used much so that is left as a potential future optimisation.
- Loading branch information
1 parent
931b5b9
commit a9b4f12
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,86 @@ | ||
| <% content_for :page_title, "Reports" %> | ||
| <% content_for :title, "CSV Reports" %> | ||
|
|
||
| <div class="govuk-grid-column-two-thirds"> | ||
| <%= render "govuk_publishing_components/components/lead_paragraph", { | ||
| text: "These reports are updated every hour.", | ||
| margin_bottom: 6 | ||
| } %> | ||
|
|
||
| <%= render "govuk_publishing_components/components/document_list", { | ||
| margin_bottom: 6, | ||
| items: [ | ||
| { | ||
| link: { | ||
| text: "All documents for departmental distribution", | ||
| path: organisation_content_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("organisation_content"), | ||
| public_updated_at: report_last_updated("organisation_content"), | ||
| } | ||
| }, | ||
| { | ||
| link: { | ||
| text: "Churn in non-archived editions", | ||
| path: edition_churn_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("edition_churn"), | ||
| public_updated_at: report_last_updated("edition_churn"), | ||
| } | ||
| }, | ||
| { | ||
| link: { | ||
| text: "Churn in all editions", | ||
| path: all_edition_churn_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("all_edition_churn"), | ||
| public_updated_at: report_last_updated("all_edition_churn"), | ||
| } | ||
| }, | ||
| { | ||
| link: { | ||
| text: "Progress on all non-archived editions", | ||
| path: progress_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("editorial_progress"), | ||
| public_updated_at: report_last_updated("editorial_progress"), | ||
| } | ||
| }, | ||
| { | ||
| link: { | ||
| text: "Content summary and workflow history for all published editions", | ||
| path: content_workflow_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("content_workflow"), | ||
| public_updated_at: report_last_updated("content_workflow"), | ||
| } | ||
| }, | ||
| { | ||
| link: { | ||
| text: "Content summary and workflow history for all editions", | ||
| path: all_content_workflow_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("all_content_workflow"), | ||
| public_updated_at: report_last_updated("all_content_workflow"), | ||
| } | ||
| }, | ||
| { | ||
| link: { | ||
| text: "All URLs", | ||
| path: all_urls_report_path(format: :csv) | ||
| }, | ||
| metadata: { | ||
| updated_at_time: report_generated_time_message("all_urls"), | ||
| public_updated_at: report_last_updated("all_urls"), | ||
| } | ||
| }, | ||
| ] | ||
| } %> | ||
|
|
||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,75 @@ | ||
| require "test_helper" | ||
|
|
||
| class ReportsControllerTest < ActionController::TestCase | ||
|
|
||
| context "When reports are available" do | ||
| setup do | ||
| login_as_stub_user | ||
|
|
||
| last_modified = Time.zone.local(2023, 12, 12, 1, 2, 3) | ||
|
|
||
| Aws.config[:s3] = { | ||
| stub_responses: { | ||
| head_object: { last_modified: }, | ||
| }, | ||
| } | ||
|
|
||
| ENV["REPORTS_S3_BUCKET_NAME"] = "example" | ||
| end | ||
|
|
||
| teardown do | ||
| ENV["REPORTS_S3_BUCKET_NAME"] = nil | ||
| end | ||
|
|
||
| should "redirect the user to S3 when following report links" do | ||
| [ | ||
| :progress, | ||
| :organisation_content, | ||
| :edition_churn, | ||
| :all_edition_churn, | ||
| :content_workflow, | ||
| :all_content_workflow, | ||
| :all_urls, | ||
| ].each do |action| | ||
| get action | ||
|
|
||
| assert_equal 302, response.status | ||
| end | ||
| end | ||
|
|
||
| should "show the last updated time on the index page" do | ||
| get :index | ||
|
|
||
| assert_select "ul.gem-c-document-list__item-metadata" do | ||
| assert_select "li.gem-c-document-list__attribute", { count: 7, text: "Generated 1:02am" } | ||
| assert_select "li.gem-c-document-list__attribute", { count: 7, text: "12 December 2023" } | ||
| end | ||
| end | ||
| end | ||
|
|
||
| context "When reports are not available" do | ||
| setup do | ||
| login_as_stub_user | ||
|
|
||
| Aws.config[:s3] = { | ||
| stub_responses: { | ||
| head_object: 'NotFound', | ||
|
Check failure on line 56 in test/functional/reports_controller_test.rb
|
||
| }, | ||
| } | ||
|
|
||
| ENV["REPORTS_S3_BUCKET_NAME"] = "example" | ||
| end | ||
|
|
||
| teardown do | ||
| ENV["REPORTS_S3_BUCKET_NAME"] = nil | ||
| end | ||
|
|
||
| should "indicate that reports are not available on the index page" do | ||
| get :index | ||
|
|
||
| assert_select "ul.gem-c-document-list__item-metadata" do | ||
| assert_select "li.gem-c-document-list__attribute", { count: 7, text: "Report currently unavailable" } | ||
| end | ||
| end | ||
| end | ||
| end | ||