govspeak 10.0.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b920cf6948fc17a6bc0046c71bc4a92cde77dd1f1fab57b58be2d8a4d077ea9
-  data.tar.gz: d60959650aae08193cfedc1ad48cf1a6e3eb65c584b825d60701c2bbdf0dae31
+  metadata.gz: d9ca524477e38e4b0b37849295da93aaf71e8701f6eaf280da50fcf89ccbde01
+  data.tar.gz: 637af4d5351f4cb1a18435b8ee5e615403cbc663981bd8d6e9d67cd4f5a86607
 SHA512:
-  metadata.gz: bc7e37cc770324bad3ad12fadba04eeb24fcf894411b052312029753a5532e647006f417e77f3080ea88c8ff43b67ad7c1f9834a9bc14ffa9e983cc1e59f2360
-  data.tar.gz: 9c93d9f23dfc2387b64f3280a431b28f110737b784811c31aa58a5045cb18797a0eac13fb18c3579393aa5c07054e6739ed9f9035e57b95353ee75d00acb16f8
+  metadata.gz: 1e69a7260c483ee4b9dff69a1be6dd733163f8bfc12777b55acbaea1e014b3ffd1c6ec0104ec4fc55141db551405b83f8980e57d912bb0f32cb6ab5ae64418a5
+  data.tar.gz: a71a0f62fe42ec52ea7123d1e1aad7f2d7fa54fcd45315250e74b42b4cf8fe322a34d1380a4402f5ed69cfab62474203bf5e220bbe41a7fffa65753bbd1828d8

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 10.1.0
+
+* Allow acronyms/abbreviations in steps ([#387](https://github.com/alphagov/govspeak/pull/387)).
+* Add GA4 indexes to attachments that render a details component ([#385](https://github.com/alphagov/govspeak/pull/385))
+
+## 10.0.1
+
+* Update dependencies
+
 ## 10.0.0
 
 * Drop support for Ruby <3.2
@@ -11,7 +20,7 @@
 
 ## 8.8.3
 
-* Update dependencies (actionview < 8.0.2, sanitize < 8, rubocop-govuk = 5.0.7) 
+* Update dependencies (actionview < 8.0.2, sanitize < 8, rubocop-govuk = 5.0.7)
 
 ## 8.8.2
 

data/lib/govspeak/post_processor.rb

@@ -57,6 +57,11 @@ module Govspeak
     end
 
     extension("embed attachment HTML") do |document|
+      # Attachments with details components need indexes set for GA4 tracking purposes
+      details_attachments = govspeak_document.attachments.select { |attachment| attachment[:alternative_format_contact_email] }
+      details_attachments_size = details_attachments.size
+      details_attachment_index = 0
+
       document.css("govspeak-embed-attachment").map do |el|
         attachment = govspeak_document.attachments.detect { |a| a[:id] == el["id"] }
 
@@ -65,11 +70,17 @@ module Govspeak
           next
         end
 
+        if attachment[:alternative_format_contact_email]
+          details_attachment_index += 1
+          details_ga4_attributes = { index_section: details_attachment_index, index_section_count: details_attachments_size }
+        end
+
         attachment_html = GovukPublishingComponents.render(
           "govuk_publishing_components/components/attachment",
           attachment:,
           margin_bottom: 6,
           locale: govspeak_document.locale,
+          details_ga4_attributes:,
         )
         el.swap(attachment_html)
       end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "10.0.0".freeze
+  VERSION = "10.1.0".freeze
 end

data/lib/govspeak.rb

@@ -317,10 +317,19 @@ module Govspeak
     end
 
     extension("numbered list", /^[ \t]*((s\d+\.\s.*(?:\n|$))+)/) do |body|
-      body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do
-        "<li>#{Govspeak::Document.new(Regexp.last_match(2).strip, attachments:).to_html}</li>\n"
+      li_elements = body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/).map do
+        element = <<~BODY
+          <li markdown="1">
+            #{Regexp.last_match(2).strip}
+          </li>
+        BODY
+        element.strip
       end
-      %(<ol class="steps">\n#{body}</ol>)
+      <<~BODY
+        <ol class="steps">
+          #{li_elements.join("\n  ")}
+        </ol>
+      BODY
     end
 
     def self.devolved_options

data/test/govspeak_attachment_link_test.rb

@@ -58,13 +58,13 @@ class GovspeakAttachmentLinkTest < Minitest::Test
 
     expected_output = <<~TEXT
       <ol class="steps">
-      <li>
-      <p>First item with <span class="gem-c-attachment-link">
+        <li>
+          <p>First item with <span class="gem-c-attachment-link">
         <a class="govuk-link" href="http://example.com/attachment.pdf">Attachment Title</a>  </span></p>
-      </li>
-      <li>
-      <p>Second item without attachment</p>
-      </li>
+        </li>
+        <li>
+          <p>Second item without attachment</p>
+        </li>
       </ol>
     TEXT
 

data/test/govspeak_attachment_test.rb

@@ -52,4 +52,32 @@ class GovspeakAttachmentTest < Minitest::Test
     assert html_has_selector?(rendered, "section.gem-c-attachment")
     assert_match(/<p>some more text<\/p>/, rendered)
   end
+
+  test "renders attachments with details elements with the correct GA4 index" do
+    attachments = []
+
+    (1..3).each do |index|
+      attachments << {
+        id: "attachment#{index}.ods",
+        url: "http://example.com/attachment#{index}",
+        title: "Attachment Title #{index}",
+        alternative_format_contact_email: "example@gov.uk",
+      }
+    end
+
+    # Insert an attachment without a details element, to ensure our code to increment the index ignores these
+    attachments.insert(1, {
+      id: "attachment.pdf",
+      url: "http://example.com/attachment.pdf",
+      title: "Attachment Title",
+    })
+
+    rendered = render_govspeak("[Attachment:attachment1.ods]\n[Attachment:attachment.pdf]\n[Attachment:attachment2.ods]\n[Attachment:attachment3.ods]", attachments)
+    node = Nokogiri::HTML(rendered)
+    node.css(".gem-c-details").each_with_index.map do |details, index|
+      ga4_event = JSON.parse(details.attribute("data-ga4-event"))
+      assert_equal ga4_event["index_section"], index + 1
+      assert_equal ga4_event["index_section_count"], 3
+    end
+  end
 end

data/test/govspeak_test.rb

@@ -582,21 +582,38 @@ Teston
           <p>This is a test:</p>
 
           <ol class="steps">
+          <li>
+              <p>This is number 1.</p>
+            </li>
+          <li>
+              <p>This is number 2.</p>
+            </li>
+          <li>
+              <p>This is number 3.</p>
+            </li>
+          <li>
+              <p>This is number 4.</p>
+            </li>
+        </ol>
+        </div>
+        )
+  end
+
+  test_given_govspeak "
+    s1. This is number 1.
+    s2. This is number 2 with an ACRONYM.
+
+    *[ACRONYM]: This is the acronym explanation" do
+    assert_html_output <<~HTML
+      <ol class="steps">
         <li>
-        <p>This is number 1.</p>
-        </li>
-        <li>
-        <p>This is number 2.</p>
-        </li>
-        <li>
-        <p>This is number 3.</p>
+          <p>This is number 1.</p>
         </li>
         <li>
-        <p>This is number 4.</p>
+          <p>This is number 2 with an <abbr title="This is the acronym explanation">ACRONYM</abbr>.</p>
         </li>
-        </ol>
-        </div>
-        )
+      </ol>
+    HTML
   end
 
   test_given_govspeak "
@@ -841,15 +858,15 @@ Teston
     " do
     assert_html_output %(
       <ol class="steps">
-      <li>
-      <p>zippy</p>
-      </li>
-      <li>
-      <p>bungle</p>
-      </li>
-      <li>
-      <p>george</p>
-      </li>
+        <li>
+          <p>zippy</p>
+        </li>
+        <li>
+          <p>bungle</p>
+        </li>
+        <li>
+          <p>george</p>
+        </li>
       </ol>)
     assert_text_output "zippy bungle george"
   end
@@ -868,12 +885,12 @@ Teston
       </ul>
 
       <ol class="steps">
-      <li>
-      <p>step</p>
-      </li>
-      <li>
-      <p>list</p>
-      </li>
+        <li>
+          <p>step</p>
+        </li>
+        <li>
+          <p>list</p>
+        </li>
       </ol>)
     assert_text_output "unordered list step list"
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 10.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 bindir: bin
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -86,7 +86,7 @@ dependencies:
         version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.14.7
+        version: 1.14.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -96,7 +96,7 @@ dependencies:
         version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.14.7
+        version: 1.14.8
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -213,14 +213,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.7
+        version: 5.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.7
+        version: 5.0.8
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -349,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Markup language for single domain
 test_files: