Make can_be_associated_with_topical_events? config-driven

For configurable document types only, we now check the configuration
of the content type to decide whether or not the content type
can be associated with topical events. This method is/may be used
to determine which bits of the UI to render to the publisher, etc.

Author: ChrisBAshton

app/models/concerns/edition/topical_events.rb

@@ -32,6 +32,8 @@ def process_associations_before_save(edition)
     add_trait Trait
   end
 
+  # This method can be deleted when all legacy content types have been migrated to
+  # being config-driven (which has its own implementation of the method).
   def can_be_associated_with_topical_events?
     true
   end

app/models/standard_edition.rb

@@ -78,6 +78,13 @@ def allows_features?
     type_instance.settings["features_enabled"]
   end
 
+  def can_be_associated_with_topical_events?
+    [
+      ConfigurableContentBlocks::Path.new("topical_event_ids"), # Legacy: delete when topical events migrated
+      ConfigurableContentBlocks::Path.new("topical_event_document_ids"),
+    ].any? { |path| field_paths.include?(path) }
+  end
+
   def can_be_marked_political?
     type_instance.settings["history_mode_enabled"]
   end

test/unit/app/models/edition/topical_events_test.rb

@@ -62,4 +62,26 @@ class Edition::TopicalEventsTest < ActiveSupport::TestCase
 
     assert_equal topical_event.document, new_edition.topical_event_documents.first
   end
+
+  test "can_be_associated_with_topical_events? returns true for legacy content types that include the module" do
+    self.class.const_set("DummyLegacyEdition", Class.new(Edition) do
+      include Edition::TopicalEvents
+    end)
+
+    edition = DummyLegacyEdition.new
+    assert edition.can_be_associated_with_topical_events?
+  end
+
+  test "can_be_associated_with_topical_events? can be overridden by the class that includes it (e.g. to make its return value config-driven)" do
+    self.class.const_set("DummyStandardEdition", Class.new(Edition) do
+      include Edition::TopicalEvents
+
+      def can_be_associated_with_topical_events?
+        false
+      end
+    end)
+
+    edition = DummyStandardEdition.new
+    assert_not edition.can_be_associated_with_topical_events?
+  end
 end

test/unit/app/models/standard_edition_test.rb

@@ -410,6 +410,81 @@ class StandardEditionTest < ActiveSupport::TestCase
     assert_not_includes missing_translations, :en
   end
 
+  test "it allows topical event associations if the configurable document type configuration references it" do
+    test_type_with_config_driven_topical_events =
+      build_configurable_document_type(
+        "test_type_with_config_driven_topical_events", {
+          "forms" => {
+            "documents" => {
+              "fields" => {
+                "topical_event_documents" => {
+                  "title" => "Topical events",
+                  "block" => "select_with_search_tagging",
+                  "container" => "topical_event_documents",
+                  "attribute_path" => %w[topical_event_document_ids],
+                  "translatable" => false,
+                },
+              },
+            },
+          },
+        }
+      )
+
+    ConfigurableDocumentType.setup_test_types(test_type_with_config_driven_topical_events)
+
+    assert StandardEdition.new(configurable_document_type: "test_type_with_config_driven_topical_events").can_be_associated_with_topical_events?
+  end
+
+  test "it does not allow topical event associations if the configurable document type configuration doesn't reference it" do
+    test_type_without_topical_events =
+      build_configurable_document_type(
+        "test_type_without_topical_events", {
+          "forms" => {
+            "documents" => {
+              "fields" => {
+                "field_attribute" => {
+                  "title" => "Test Attribute",
+                  "block" => "govspeak",
+                  "attribute_path" => %w[block_content field_attribute],
+                  "translatable" => true,
+                },
+              },
+            },
+          },
+        }
+      )
+
+    ConfigurableDocumentType.setup_test_types(test_type_without_topical_events)
+
+    assert_not StandardEdition.new(configurable_document_type: "test_type_without_topical_events").can_be_associated_with_topical_events?
+  end
+
+  # Legacy: delete when topical events have been migrated
+  test "it allows topical event associations if the configurable document type configuration references legacy topical events" do
+    test_type_with_legacy_topical_events =
+      build_configurable_document_type(
+        "test_type_with_legacy_topical_events", {
+          "forms" => {
+            "documents" => {
+              "fields" => {
+                "topical_events" => {
+                  "title" => "Topical events",
+                  "block" => "select_with_search_tagging",
+                  "container" => "topical_events",
+                  "attribute_path" => %w[topical_event_ids],
+                  "translatable" => false,
+                },
+              },
+            },
+          },
+        }
+      )
+
+    ConfigurableDocumentType.setup_test_types(test_type_with_legacy_topical_events)
+
+    assert StandardEdition.new(configurable_document_type: "test_type_with_legacy_topical_events").can_be_associated_with_topical_events?
+  end
+
   test "conditionally requires worldwide organisation and world location associations" do
     test_type = build_configurable_document_type(
       "test_type", {