Update social media accounts validations to include title logic

- We now validate for unique title as well (URL must also be unique from before).
- Channel names can now be repeated, provided their titles are distinct.
- The "Other" channel does not behave in any way differently from the rest of the channels. We won't allow multiple "Other" entries unless they have different titles. A valid scenario is if one "Other" channel has no title and the other does.
- We do not validate title uniqueness scoped to the channel, but globally - we will not allow a repeated title even if it is across different channels. This is because it could still be confusing on the screen if the title is repeated.
- If there are channels that match, and their titles match, we'll only render a single error for the titles matching.

Author: lauraghiorghisor-tw

app/validators/social_media_links_validator.rb

@@ -3,6 +3,8 @@ def initialize(opts = {})
     @attributes = opts[:attributes]
     @channel_field = opts[:fields]["service_field"]
     @url_field = opts[:fields]["url_field"]
+    @title_field = opts[:fields]["title_field"]
+
     super
   end
 
@@ -11,34 +13,52 @@ def validate(record)
       arr = record.send(attribute_name.to_sym) || []
       @channels_seen = []
       @urls_seen = []
+      @titles_seen = []
 
       arr.each_with_index do |social_media_account, index|
         channel_name = social_media_account[@channel_field]
         url = social_media_account[@url_field]
+        title = social_media_account["title"]
+        channel = { channel_name: channel_name, title: title }
 
-        validate_social_media_channel(channel_name, index, record, attribute_name)
+        validate_social_media_title(title, index, record, attribute_name)
         validate_social_media_url(url, index, record, attribute_name)
+        validate_social_media_channel(channel, index, record, attribute_name)
       end
     end
   end
 
 private
 
-  def validate_social_media_channel(channel_name, index, record, attribute_name)
-    if channel_name.blank?
+  def validate_social_media_channel(channel, index, record, attribute_name)
+    if channel[:channel_name].blank?
       record.errors.add(
         :"#{attribute_name}.#{index}.#{@channel_field}",
         :blank,
         message: "cannot be blank",
       )
-    elsif channel_name != "Other" && @channels_seen.include?(channel_name)
+    elsif @channels_seen.select { |c| c[:channel_name] == channel[:channel_name] && c[:title] == channel[:title] && c[:title].blank? }.any?
       record.errors.add(
         :"#{attribute_name}.#{index}.#{@channel_field}",
         :taken,
         message: "must be unique",
       )
     else
-      @channels_seen << channel_name
+      @channels_seen << channel
+    end
+  end
+
+  def validate_social_media_title(title, index, record, attribute_name)
+    return if title.blank?
+
+    if @titles_seen.include?(title)
+      record.errors.add(
+        :"#{attribute_name}.#{index}.#{@title_field}",
+        :taken,
+        message: "must be unique",
+      )
+    else
+      @titles_seen << title
     end
   end
 

test/unit/app/validators/social_media_links_validator_test.rb

@@ -7,6 +7,7 @@ class SocialMediaLinksValidatorTest < ActiveSupport::TestCase
       fields: {
         "service_field" => "social_media_service_name",
         "url_field" => "url",
+        "title_field" => "title",
       },
     })
   end
@@ -78,46 +79,102 @@ class SocialMediaLinksValidatorTestClass
     assert_includes block_content.errors["social_media_links.0.url".to_sym], "is invalid - use the full URL, including https://"
   end
 
-  test "social media links are invalid if two of the same channel are provided" do
+  test "social media links are invalid if two channels have the same URL" do
     block_content = SocialMediaLinksValidatorTestClass.new
     block_content.social_media_links = [
+      { "social_media_service_name" => "Twitter", "url" => "http://facebook.com/govuk" },
       { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govuk" },
-      { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govukpage2" },
     ]
     @validator.validate(block_content)
 
-    assert_empty block_content.errors["social_media_links.0.social_media_service_name".to_sym]
-    assert_includes block_content.errors["social_media_links.1.social_media_service_name".to_sym], "must be unique"
+    assert_empty block_content.errors["social_media_links.0.url".to_sym]
+    assert_includes block_content.errors["social_media_links.1.url".to_sym], "must be unique"
   end
 
-  test "social media links are invalid if two channels have the same URL" do
+  test "social media links are valid when a channel is chosen and a well-formed URL is provided" do
     block_content = SocialMediaLinksValidatorTestClass.new
     block_content.social_media_links = [
-      { "social_media_service_name" => "Twitter", "url" => "http://facebook.com/govuk" },
       { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govuk" },
+      { "social_media_service_name" => "LinkedIn", "url" => "https://linkedin.com/company/govuk" },
     ]
     @validator.validate(block_content)
 
-    assert_empty block_content.errors["social_media_links.0.url".to_sym]
-    assert_includes block_content.errors["social_media_links.1.url".to_sym], "must be unique"
+    assert block_content.errors.empty?
   end
 
-  test "social media links are valid when multiple 'Other' channels are provided with different URLs" do
+  test "social media links are valid when titles are unique" do
     block_content = SocialMediaLinksValidatorTestClass.new
     block_content.social_media_links = [
-      { "social_media_service_name" => "Other", "url" => "http://example.com/one" },
-      { "social_media_service_name" => "Other", "url" => "http://example.com/two" },
+      { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govuk", "title" => "GOV.UK on Facebook" },
+      { "social_media_service_name" => "Twitter", "url" => "http://twitter.com/govuk", "title" => "GOV.UK on Twitter" },
     ]
     @validator.validate(block_content)
 
     assert block_content.errors.empty?
   end
 
-  test "social media links are valid when a channel is chosen and a well-formed URL is provided" do
+  test "social media links are valid when titles are blank" do
+    block_content = SocialMediaLinksValidatorTestClass.new
+    block_content.social_media_links = [
+      { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govuk", "title" => "" },
+      { "social_media_service_name" => "Twitter", "url" => "http://twitter.com/govuk", "title" => "" },
+    ]
+    @validator.validate(block_content)
+
+    assert block_content.errors.empty?
+  end
+
+  test "social media links are invalid when any two accounts have the same title" do
+    block_content = SocialMediaLinksValidatorTestClass.new
+    block_content.social_media_links = [
+      { "social_media_service_name" => "Facebook", "title" => "Our updates", "url" => "http://facebook.com/govuk" },
+      { "social_media_service_name" => "Twitter", "title" => "Our updates", "url" => "http://twitter.com/govuk" },
+    ]
+    @validator.validate(block_content)
+
+    assert_includes block_content.errors["social_media_links.1.title".to_sym], "must be unique"
+  end
+
+  test "social media links are invalid when multiple instances of the same channel are provided, with no distinct titles" do
     block_content = SocialMediaLinksValidatorTestClass.new
     block_content.social_media_links = [
       { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govuk" },
-      { "social_media_service_name" => "LinkedIn", "url" => "https://linkedin.com/company/govuk" },
+      { "social_media_service_name" => "Facebook", "url" => "http://facebook.com/govukpage2" },
+    ]
+    @validator.validate(block_content)
+
+    assert_empty block_content.errors["social_media_links.0.social_media_service_name".to_sym]
+    assert_includes block_content.errors["social_media_links.1.social_media_service_name".to_sym], "must be unique"
+  end
+
+  test "social media links are invalid when multiple 'Other' channels are provided, with no distinct titles" do
+    block_content = SocialMediaLinksValidatorTestClass.new
+    block_content.social_media_links = [
+      { "social_media_service_name" => "Other", "url" => "http://example.com/one" },
+      { "social_media_service_name" => "Other", "url" => "http://example.com/two" },
+    ]
+    @validator.validate(block_content)
+
+    assert_includes block_content.errors["social_media_links.1.social_media_service_name".to_sym], "must be unique"
+  end
+
+  test "social media links are invalid and only display title uniqueness error, if multiple instances of the same channel are provided, and their titles match" do
+    block_content = SocialMediaLinksValidatorTestClass.new
+    block_content.social_media_links = [
+      { "social_media_service_name" => "Facebook", "title" => "Facebook", "url" => "http://facebook.com/govuk" },
+      { "social_media_service_name" => "Facebook", "title" => "Facebook", "url" => "http://facebook.com/govukpage2" },
+    ]
+    @validator.validate(block_content)
+
+    assert_includes block_content.errors["social_media_links.1.title".to_sym], "must be unique"
+    assert block_content.errors["social_media_links.1.social_media_service_name".to_sym].empty?
+  end
+
+  test "social media links are valid when multiple instances of the same channel are provided with different titles and different URLs" do
+    block_content = SocialMediaLinksValidatorTestClass.new
+    block_content.social_media_links = [
+      { "social_media_service_name" => "Facebook", "title" => "Facebook Corporate", "url" => "http://example.com/one" },
+      { "social_media_service_name" => "Facebook", "title" => "Facebook Fun", "url" => "http://example.com/two" },
     ]
     @validator.validate(block_content)