Add a new optional title field to social media links

This title is primarily intended to be used for the "Other" service type. We need to be able to distinguish between the various channels. Nonetheless, the title input can also be used to provide multiple instances of any other channel type. Future commit will add the necessary validations.

Author: jamiestamp

app/models/configurable_document_types/topical_event.json

@@ -111,6 +111,12 @@
               "block": "default_string",
               "attribute_path": ["url"],
               "translatable": true
+            },
+            "title": {
+              "title": "Title",
+              "block": "default_string",
+              "attribute_path": ["title"],
+              "translatable": true
             }
           }
         }
@@ -130,6 +136,9 @@
           },
           "url": {
             "type": "string"
+          },
+          "title": {
+            "type": "string"
           }
         }
       }
@@ -156,7 +165,8 @@
         "attributes": ["social_media_links"],
         "fields": {
           "service_field": "social_media_service_name",
-          "url_field": "url"
+          "url_field": "url",
+          "title_field": "title"
         }
       }
     }

app/presenters/publishing_api/payload_builder/block_content.rb

@@ -44,11 +44,12 @@ def social_media_links(attribute)
         return [] if content.blank?
 
         content.map do |item|
-          # `item` looks something like `{"url"=>"foo", "social_media_service_name"=>"Facebook"}`
+          # `item` looks something like `{"url"=>"foo", "social_media_service_name"=>"Facebook", "title"=> "Optional title"}`
           service_name = item["social_media_service_name"]
           service_url = item["url"]
+          title = item["title"]
           {
-            title: service_name,
+            title: title.presence || service_name,
             service_type: service_name.parameterize, # "Google Plus" => "google-plus"
             href: service_url,
           }

features/fixtures/test_configurable_document_type.json

@@ -138,6 +138,12 @@
               "block": "default_string",
               "attribute_path": ["url"],
               "translatable": true
+            },
+            "title": {
+              "title": "Title",
+              "block": "default_string",
+              "attribute_path": ["title"],
+              "translatable": true
             }
           }
         }
@@ -184,6 +190,9 @@
           },
           "url": {
             "type": "string"
+          },
+          "title": {
+            "type": "string"
           }
         }
       }

test/unit/app/presenters/publishing_api/payload_builder/block_content_test.rb

@@ -161,16 +161,78 @@ class PublishingApi::PayloadBuilder::BlockContentTest < ActiveSupport::TestCase
     end
 
     test "social_media_links returns array of social media links" do
+      value_of_links = [
+        { "social_media_service_name" => "Twitter", "url" => "https://twitter.com" },
+        { "social_media_service_name" => "Other", "title" => "Other 1", "url" => "https://example.com" },
+        { "social_media_service_name" => "Other", "title" => "Other 2", "url" => "https://personal.com" },
+      ]
+      @block_content.stubs(:some_attribute).returns(value_of_links)
+
+      builder = PublishingApi::PayloadBuilder::BlockContent.new(@item)
+
+      expected_payload = [
+        {
+          title: "Twitter",
+          service_type: "twitter",
+          href: "https://twitter.com",
+        },
+        {
+          title: "Other 1",
+          service_type: "other",
+          href: "https://example.com",
+        },
+        {
+          title: "Other 2",
+          service_type: "other",
+          href: "https://personal.com",
+        },
+      ]
+      assert_equal expected_payload, builder.send(:social_media_links, :some_attribute)
+    end
+
+    test "social_media_links defaults title to service name when no title provided" do
       value_of_links = [{ "social_media_service_name" => "twitter", "url" => "https://example.com" }]
       @block_content.stubs(:some_attribute).returns(value_of_links)
 
       builder = PublishingApi::PayloadBuilder::BlockContent.new(@item)
 
       expected_payload = [
         {
-          title: value_of_links.first["social_media_service_name"],
-          service_type: value_of_links.first["social_media_service_name"].parameterize,
-          href: value_of_links.first["url"],
+          title: "twitter",
+          service_type: "twitter",
+          href: "https://example.com",
+        },
+      ]
+      assert_equal expected_payload, builder.send(:social_media_links, :some_attribute)
+    end
+
+    test "social_media_links uses custom title when provided" do
+      value_of_links = [{ "social_media_service_name" => "Twitter", "url" => "https://twitter.com/govuk", "title" => "GOV.UK on Twitter" }]
+      @block_content.stubs(:some_attribute).returns(value_of_links)
+
+      builder = PublishingApi::PayloadBuilder::BlockContent.new(@item)
+
+      expected_payload = [
+        {
+          title: "GOV.UK on Twitter",
+          service_type: "twitter",
+          href: "https://twitter.com/govuk",
+        },
+      ]
+      assert_equal expected_payload, builder.send(:social_media_links, :some_attribute)
+    end
+
+    test "social_media_links falls back to service name when title is blank" do
+      value_of_links = [{ "social_media_service_name" => "Facebook", "url" => "https://facebook.com/govuk", "title" => "" }]
+      @block_content.stubs(:some_attribute).returns(value_of_links)
+
+      builder = PublishingApi::PayloadBuilder::BlockContent.new(@item)
+
+      expected_payload = [
+        {
+          title: "Facebook",
+          service_type: "facebook",
+          href: "https://facebook.com/govuk",
         },
       ]
       assert_equal expected_payload, builder.send(:social_media_links, :some_attribute)