Surface topical event hint text and label from schema

We want to show a bit of hint text under the document type, which should come from the schema description, in the same way it does for other "single" document (sub)types such as news stories. The label should also come from the schema title. Topical events do not have subtypes so there is no additional choose type screen.

Calling `ConfigurableDocumentType.find` with a "real" document type key put us in a position where we needed to either build a test type with that key or stub the call. I opted to do the latter, since we have generally kept our tests agnostic to any real types.

I stubbed inside the test, in the "base" and "new document" controller tests, but opted for a test helper for the feature tests. This is because for unit tests we have a lot of granular scenarios where the "schema" needs to be built in place. Tests will break if I try to stub the `find` first with a generic document type instance. Nonetheless, for the feature tests, because all of them use the same json fixture, we can set up the document types and stub our find method for all tests. There are some "group" tests that use a different json where additional stubbing was required.

Because the setup is now done in the helper, I was able to remove a lot of feature test steps that were ensuring the document type is set up.

Author: lauraghiorghisor-tw

app/controllers/admin/new_document_controller.rb

@@ -84,8 +84,8 @@ def types_hash
     }
     types["topical_event"] = {
       "klass" => StandardEdition,
-      "hint_text" => "Use this to create config-driven topical events.",
-      "label" => "Topical Event (experimental)",
+      "hint_text" => ConfigurableDocumentType.find("topical_event").description,
+      "label" => "#{ConfigurableDocumentType.find('topical_event').label} (experimental)",
       "redirect" => new_admin_standard_edition_path(configurable_document_type: "topical_event"),
     }
 

features/edition-images.feature

@@ -44,7 +44,6 @@ Feature: Images tab on edit edition
 
 Scenario: User uploads a header image
     And the configurable document types feature flag is enabled
-    And the test configurable document type is defined
     And I draft a new "Test configurable document type" configurable document titled "The history of GOV.UK"
     When I visit the images tab of the document "The history of GOV.UK"
     Then I should see a card associated with the header image usage
@@ -55,7 +54,6 @@ Scenario: User uploads a header image
 
   Scenario: User uploads multiple images for a usage
     Given the configurable document types feature flag is enabled
-    And the test configurable document type is defined
     And I draft a new "Test configurable document type" configurable document titled "The history of GOV.UK"
     When I visit the images tab of the document "The history of GOV.UK"
     When I upload multiple images including a 960x960 image

features/fixtures/test_configurable_document_type.json

@@ -1,5 +1,5 @@
 {
-  "key": "test",
+  "key": "test_type",
   "title": "Test configurable document type",
   "description": "A test configurable document on GOV.UK",
   "forms": {
@@ -100,6 +100,7 @@
     "organisations": null,
     "backdating_enabled": false,
     "translations_enabled": true,
+    "features_enabled": true,
     "images": {
       "enabled": true,
       "usages": {

features/standard-edition.feature

@@ -3,7 +3,6 @@ Feature: Standard Editions
   Scenario: Creating a new draft configurable document
     Given I am a writer
     And the configurable document types feature flag is enabled
-    And the test configurable document type is defined
     When I draft a new "Test configurable document type" configurable document titled "The history of GOV.UK"
     Then I am on the summary page of the draft titled "The history of GOV.UK"
     And when I switch to the Images tab to fill in the other configurable fields
@@ -13,15 +12,13 @@ Feature: Standard Editions
   Scenario: Force publishing an existing draft configurable document
     Given I am an editor
     And the configurable document types feature flag is enabled
-    And the test configurable document type is defined
     When I publish a submitted draft of a test configurable document titled "The history of GOV.UK"
     Then I can see that the draft edition of "The history of GOV.UK" was published successfully
     And a new draft of "The history of GOV.UK" is created with the correct field values
 
   Scenario: Adding translations with all content block types
     Given I am a writer
     And the configurable document types feature flag is enabled
-    And the test configurable document type is defined with translations enabled
     And I have drafted an English configurable document titled "Digital transformation report"
     When I go to add a Welsh translation
     Then configured content blocks should appear on the translation page
@@ -34,15 +31,13 @@ Feature: Standard Editions
   Scenario: Editing translations on a persisted edition
     Given I am a writer
     And the configurable document types feature flag is enabled
-    And the test configurable document type is defined with translations enabled
     And I have published an English document with a Welsh translation
     When I create a new draft and visit the Welsh translation
     Then the Welsh translations should have persisted
 
   Scenario: Creating a non-English primary locale configurable document
     Given I am a writer
     And the configurable document types feature flag is enabled
-    And the test configurable document type is defined with translations enabled
     When I create a new "Test configurable document type" with Welsh as the primary locale titled "Strategaeth Ddigidol Cymru"
     Then I am on the summary page of the draft titled "Strategaeth Ddigidol Cymru"
     And the language of the document should be Welsh

features/step_definitions/standard_edition_featurings_steps.rb

@@ -1,52 +1,5 @@
 And(/^a featurable standard edition called "([^"]*)" exists$/) do |title|
-  ConfigurableDocumentType.setup_test_types({ "test_type" => {
-    "key" => "test_type",
-    "title" => "Test Type",
-    "forms" => {
-      "documents" => {
-        "fields" => {
-          "body" => {
-            "title" => "Body",
-            "description" => "The main content of the page",
-            "block" => "govspeak",
-          },
-        },
-      },
-    },
-    "schema" => {
-      "properties" => {
-        "test_attribute" => {
-          "title" => "Test Attribute",
-          "type" => "string",
-        },
-      },
-    },
-    "presenters" => {
-      "publishing_api" => {
-        "details" => {},
-        "links" => [],
-      },
-    },
-    "associations" => [],
-    "settings" => {
-      "edit_screens" => {
-        "document" => %w[test_attribute],
-      },
-      "base_path_prefix" => "/government/test",
-      "publishing_api_schema_name" => "test_article",
-      "publishing_api_document_type" => "test_story",
-      "rendering_app" => "frontend",
-      "images" => {
-        "enabled" => false,
-      },
-      "organisations" => nil,
-      "backdating_enabled" => false,
-      "history_mode_enabled" => false,
-      "translations_enabled" => false,
-      "features_enabled" => true,
-    },
-  } })
-  @featurable_edition = create(:standard_edition, configurable_document_type: "test_type", title:)
+  @featurable_edition = create(:standard_edition, title:)
 end
 
 Given(/^the featurable standard edition is linked to an edition with the title "([^"]*)"$/) do |title|
@@ -57,8 +10,8 @@
 end
 
 And(/^two featurings exist for the edition$/) do
-  featured_edition_1 = create(:published_standard_edition, configurable_document_type: "test_type", title: "Featured Edition 1")
-  featured_edition_2 = create(:published_standard_edition, configurable_document_type: "test_type", title: "Featured Edition 2")
+  featured_edition_1 = create(:published_standard_edition, title: "Featured Edition 1")
+  featured_edition_2 = create(:published_standard_edition, title: "Featured Edition 2")
   feature_list = @featurable_edition.feature_lists.create!(locale: @featurable_edition.primary_locale)
   create(:feature, feature_list:, document: featured_edition_1.document)
   create(:feature, feature_list:, document: featured_edition_2.document)

features/step_definitions/standard_edition_steps.rb

@@ -8,7 +8,6 @@ def create_configurable_document(title:, locale: "en", summary: nil, body: nil,
     create(
       :draft_standard_edition,
       {
-        configurable_document_type: "test",
         images:,
         title: title,
         summary: summary || defaults[:summary],
@@ -158,7 +157,6 @@ def default_content_for_locale(locale)
   standard_edition = create(
     :submitted_standard_edition,
     {
-      configurable_document_type: "test",
       images: [image],
       title: title,
       block_content: default_block_content_for_locale("en").merge("lead_image" => image.image_data.id.to_s),
@@ -291,7 +289,6 @@ def default_content_for_locale(locale)
   @standard_edition = create(
     :published_standard_edition,
     {
-      configurable_document_type: "test",
       title: default_content_for_locale("en")[:title],
       summary: default_content_for_locale("en")[:summary],
       block_content: default_block_content_for_locale("en"),
@@ -325,6 +322,7 @@ def default_content_for_locale(locale)
   types = {}
   type_definitions.each do |type_definition|
     types[type_definition["key"]] = type_definition
+    ConfigurableDocumentType.stubs(:find).returns(ConfigurableDocumentType.new(type_definition))
   end
   ConfigurableDocumentType.setup_test_types(types)
 end

features/support/configurable_document_type_helper.rb

@@ -0,0 +1,7 @@
+require_relative "mocha"
+
+Before do
+  type_definition = JSON.parse(File.read(Rails.root.join("features/fixtures/test_configurable_document_type.json")))
+  ConfigurableDocumentType.setup_test_types({ "test_type" => type_definition })
+  ConfigurableDocumentType.stubs(:find).returns(ConfigurableDocumentType.new(type_definition))
+end

test/functional/admin/base_controller_test.rb

@@ -3,6 +3,10 @@
 class Admin::BaseControllerTest < ActionController::TestCase
   include GdsApi::TestHelpers::PublishingApi
 
+  setup do
+    ConfigurableDocumentType.stubs(:find).returns(ConfigurableDocumentType.new({}))
+  end
+
   view_test "renders header component with correct links" do
     login_as :gds_editor, create(:organisation, name: "my-test-org")
     @controller = Admin::NewDocumentController.new

test/functional/admin/new_document_controller_test.rb

@@ -3,6 +3,8 @@
 class Admin::NewDocumentControllerTest < ActionController::TestCase
   setup do
     login_as :writer
+
+    ConfigurableDocumentType.stubs(:find).returns(ConfigurableDocumentType.new({}))
   end
 
   view_test "GET #index renders the 'New Document' page with the header, all permitted radio selection options and inset text" do