add field_names to data on content block spans

to make it easier to find and track the blocks in published host documents.
alphagov · Feb 4, 2025 · 67e0a7c · 67e0a7c
1 parent 5240941
commit 67e0a7c
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 10 deletions.
diff --git a/lib/content_block_tools/presenters/base_presenter.rb b/lib/content_block_tools/presenters/base_presenter.rb
@@ -29,12 +29,15 @@ def render
             content_block: "",
             document_type: content_block.document_type,
             content_id: content_block.content_id,
+            field_names: field_names.to_s,
           },
         )
       end
 
     private
 
+      attr_reader :content_block
+
       # The default representation of the content block - this can be overridden in a subclass
       # by overriding the content, default_content or content_for_fields methods
       #
@@ -57,14 +60,12 @@ def content_for_fields
       end
 
       def field_names
-        embed_code_match = ContentBlockReference::EMBED_REGEX.match(@content_block.embed_code)
+        embed_code_match = ContentBlockReference::EMBED_REGEX.match(content_block.embed_code)
         if embed_code_match.present?
           all_fields = embed_code_match[4]&.reverse&.chomp("/")&.reverse
           all_fields&.split("/")&.map(&:to_sym)
         end
       end
-
-      attr_reader :content_block
     end
   end
 end
diff --git a/spec/content_block_tools/presenters/base_presenter_spec.rb b/spec/content_block_tools/presenters/base_presenter_spec.rb
@@ -18,7 +18,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}">My content block</span>
+        data-content-id="#{content_id}"
+        data-field-names="">My content block</span>
     HTML
 
     expect(presenter.render.squish).to eq(expected_html.squish)
@@ -45,7 +46,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}">hello world</span>
+        data-content-id="#{content_id}"
+        data-field-names="[:first_field, :second_field, :third_field]">hello world</span>
     HTML
 
     expect(presenter.render.squish).to eq(expected_html.squish)
@@ -72,7 +74,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}"></span>
+        data-content-id="#{content_id}"
+        data-field-names="[:first_field, :second_field, :fake_field]"></span>
     HTML
 
     expect(presenter.render.squish).to eq(expected_html.squish)

diff --git a/spec/content_block_tools/presenters/email_address_presenter_spec.rb b/spec/content_block_tools/presenters/email_address_presenter_spec.rb
@@ -19,7 +19,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}">#{email_address}</span>
+        data-content-id="#{content_id}"
+        data-field-names="">#{email_address}</span>
     HTML
 
     expect(presenter.render.squish).to eq(expected_html.squish)

diff --git a/spec/content_block_tools/presenters/postal_address_presenter_spec.rb b/spec/content_block_tools/presenters/postal_address_presenter_spec.rb
@@ -29,7 +29,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}">#{postal_html_string}</span>
+        data-content-id="#{content_id}"
+        data-field-names="">#{postal_html_string}</span>
     HTML
 
     expect(presenter.render.squish).to eq(expected_html.squish)
@@ -63,7 +64,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}">Somewhereville</span>
+        data-content-id="#{content_id}"
+        data-field-names="[:town_or_city]">Somewhereville</span>
       HTML
 
       expect(presenter.render.squish).to eq(expected_html.squish)
@@ -76,7 +78,8 @@
         class="content-embed content-embed__something"
         data-content-block=""
         data-document-type="something"
-        data-content-id="#{content_id}"></span>
+        data-content-id="#{content_id}"
+        data-field-names="[:nothing]"></span>
       HTML
 
       expect(presenter.render.squish).to eq(expected_html.squish)