govspeak 8.0.1 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e8536931b5ec2ad23bada1b0cc94dad05779dc3d9565bc8dbd6449a6161a7a2
-  data.tar.gz: a67ea45edba261236ce6974564a3704218e69dec860fea1e782d8d20af3922a4
+  metadata.gz: 0c555468b4ecde3805f07e313973dddaeadcd14383c982982294c51e804ea1da
+  data.tar.gz: 96053a068119e22ce4c984ab23398e069c5e0389bdc3ea4defc6401d57c1e1aa
 SHA512:
-  metadata.gz: b66013937116e786786f240b72c61dbbbcc1e09af0fa5bfdc4b83aeef73133eb46078565dfa5766d252a9558d0b10b2322673ca0720deef7fd69414ca2ad158c
-  data.tar.gz: dac0b4479fc4691e41356104409a93ec0802a698107c20ab17ab524042d6571d7da606111aa4b4635c4855ade81369fbfcd7db5dbb080205f3502b7423b6bfc5
+  metadata.gz: bae3e886909c655e6bbec31accad94c3fb1603c089e5a3208d9939ea886920d1961be65f4706e0d58c6304560970771c4507163b86f7669e4b7a798b9831d72f
+  data.tar.gz: 5d0a20f844cfe0c4e451b6fb0f959be7c5aa80bf95f3db2c10382f439ac28b427c10035cad2f95a79088b0d3197ea2f2e98634f1fc715f7653b7e1acba7e21db

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 8.2.0
+
+* Reintroduce support for acronyms in Call To Action blocks and in Legislative Lists ([#285](https://github.com/alphagov/govspeak/pull/285))
+
+## 8.1.0
+
+* Allow attachment links wtihin numbered lists ([#283](https://github.com/alphagov/govspeak/pull/283))
+
 ## 8.0.1
 
 * Add margin-bottom to embedded attachments ([#281](https://github.com/alphagov/govspeak/pull/281))

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "8.0.1".freeze
+  VERSION = "8.2.0".freeze
 end

data/lib/govspeak.rb

@@ -139,12 +139,13 @@ module Govspeak
       is_legislative_list = source.scan(/\$LegislativeList.*?\[\^\d\]*.*?\$EndLegislativeList/m).size.positive?
       is_cta = source.scan(/\$CTA.*?\[\^\d\]*.*?\$CTA/m).size.positive?
       footnotes = source.scan(/^\s*\[\^(\d+)\]:(.*)/)
-      @acronyms = source.scan(/(?<=\*)\[(.*)\]:(.*)/)
+      @acronyms.concat(source.scan(/(?<=\*)\[(.*)\]:(.*)/))
       if (is_legislative_list || is_cta) && footnotes.size.positive?
         list_items = footnotes.map do |footnote|
           number = footnote[0]
           text = footnote[1].strip
           footnote_definition = Govspeak::Document.new(text).to_html[/(?<=<p>).*(?=<\/p>)/]
+          footnote_definition = add_acronym_alt_text(footnote_definition)
 
           <<~HTML_SNIPPET
             <li id="fn:#{number}" role="doc-endnote">
@@ -163,10 +164,6 @@ module Govspeak
           </div>
         HTML_CONTAINER
       end
-
-      unless @footnote_definition_html.nil? && @acronyms.size.positive?
-        add_acronym_alt_text(@footnote_definition_html)
-      end
     end
 
     def remove_forbidden_characters(source)
@@ -326,6 +323,7 @@ module Govspeak
 
     extension("call-to-action", surrounded_by("$CTA")) do |body|
       doc = Kramdown::Document.new(preprocess(body.strip), @options).to_html
+      doc = add_acronym_alt_text(doc)
       doc = %(\n<div class="call-to-action">\n#{doc}</div>\n)
       footnotes = body.scan(/\[\^(\d+)\]/).flatten
 
@@ -337,7 +335,6 @@ module Govspeak
         doc.sub!(/(\[\^#{footnote}\])/, html)
       end
 
-      add_acronym_alt_text(doc) if @acronyms.size.positive?
       doc
     end
 
@@ -358,6 +355,8 @@ module Govspeak
 
     extension("legislative list", /#{NEW_PARAGRAPH_LOOKBEHIND}\$LegislativeList\s*$(.*?)\$EndLegislativeList/m) do |body|
       Govspeak::KramdownOverrides.with_kramdown_ordered_lists_disabled do
+        body = add_acronym_alt_text(body.strip)
+
         Kramdown::Document.new(body.strip).to_html.tap do |doc|
           doc.gsub!("<ul>", "<ol>")
           doc.gsub!("</ul>", "</ol>")
@@ -372,15 +371,13 @@ module Govspeak
 
             doc.sub!(/(\[\^#{footnote}\])/, html)
           end
-
-          add_acronym_alt_text(doc) if @acronyms.size.positive?
         end
       end
     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).to_html}</li>\n"
+        "<li>#{Govspeak::Document.new(Regexp.last_match(2).strip, attachments: attachments).to_html}</li>\n"
       end
       %(<ol class="steps">\n#{body}</ol>)
     end
@@ -454,10 +451,11 @@ module Govspeak
     end
 
     def add_acronym_alt_text(html)
-      # FIXME: this code is buggy and replaces abbreviations in HTML tags - removing the functionality for now
-      # @acronyms.each do |acronym|
-      #   html.gsub!(acronym[0], "<abbr title=\"#{acronym[1].strip}\">#{acronym[0]}</abbr>")
-      # end
+      @acronyms.each do |acronym|
+        html.gsub!(acronym[0], "<abbr title=\"#{acronym[1].strip}\">#{acronym[0]}</abbr>")
+      end
+
+      html
     end
   end
 end

data/test/govspeak_attachment_link_test.rb

@@ -46,4 +46,28 @@ class GovspeakAttachmentLinkTest < Minitest::Test
     rendered = render_govspeak("[AttachmentLink: This is the name of my &%$@€? attachment]", [attachment])
     assert_match(/Attachment Title/, rendered)
   end
+
+  test "renders an attachment link inside a numbered list" do
+    attachment = {
+      id: "attachment.pdf",
+      url: "http://example.com/attachment.pdf",
+      title: "Attachment Title",
+    }
+
+    rendered = render_govspeak("s1. First item with [AttachmentLink: attachment.pdf]\ns2. Second item without attachment", [attachment])
+
+    expected_output = <<~TEXT
+      <ol class="steps">
+      <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>
+      </ol>
+    TEXT
+
+    assert_equal(expected_output, rendered)
+  end
 end

data/test/govspeak_button_test.rb

@@ -118,7 +118,7 @@ class GovspeakTest < Minitest::Test
   " do
     assert_text_output "Start now JSA"
     assert_html_output %(
-      <p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="govuk-button" draggable="false" href="https://www.apply-for-new-style-jsa.dwp.gov.uk/?lang=cy"> Start now <abbr title="Jobseeker's Allowance">JSA</abbr><svg class="govuk-button__start-icon govuk-!-display-none-print" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" focusable="false" aria-hidden="true"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>
+      <p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="govuk-button" draggable="false" href="https://www.apply-for-new-style-jsa.dwp.gov.uk/?lang=cy"><span> Start now <abbr title="Jobseeker's Allowance">JSA</abbr></span><svg class="govuk-button__start-icon govuk-!-display-none-print" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" focusable="false" aria-hidden="true"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>
     )
   end
 end

data/test/govspeak_test.rb

@@ -622,6 +622,21 @@ Teston
     )
   end
 
+  test_given_govspeak "
+    $CTA
+    Contact the SGD on 0800 000 0000 or contact the class on 0800 001 0001
+    $CTA
+
+    *[class]: Other Government Department
+    *[SGD]: Some Government Department
+    " do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p>Contact the <abbr title="Some Government Department">SGD</abbr> on 0800 000 0000 or contact the <abbr title="Other Government Department">class</abbr> on 0800 001 0001</p>
+      </div>
+    )
+  end
+
   test_given_govspeak "
     1. rod
     2. jane
@@ -1090,44 +1105,51 @@ Teston
     )
     end
 
-  # FIXME: this code is buggy and replaces abbreviations in HTML tags - removing the functionality for now
-  # test_given_govspeak "
-  #   $LegislativeList
-  #   * 1. Item 1[^1] with an ACRONYM
-  #   * 2. Item 2[^2]
-  #   * 3. Item 3
-  #   $EndLegislativeList
-  #
-  #   [^1]: Footnote definition one
-  #   [^2]: Footnote definition two with an ACRONYM
-  #
-  #   *[ACRONYM]: This is the acronym explanation
-  # " do
-  #   assert_html_output %(
-  #     <ol class="legislative-list">
-  #       <li>1. Item 1<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup> with an <abbr title="This is the acronym explanation">ACRONYM</abbr>
-  #     </li>
-  #       <li>2. Item 2<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>
-  #     </li>
-  #       <li>3. Item 3</li>
-  #     </ol>
-  #
-  #     <div class="footnotes" role="doc-endnotes">
-  #       <ol>
-  #         <li id="fn:1" role="doc-endnote">
-  #       <p>
-  #         Footnote definition one<a href="#fnref:1" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a>
-  #       </p>
-  #     </li>
-  #     <li id="fn:2" role="doc-endnote">
-  #       <p>
-  #         Footnote definition two with an <abbr title="This is the acronym explanation">ACRONYM</abbr><a href="#fnref:2" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a>
-  #       </p>
-  #     </li>
-  #       </ol>
-  #     </div>
-  #   )
-  # end
+  test_given_govspeak "
+    $LegislativeList
+    * 1. Item 1[^1] with an ACRONYM
+    * 2. Item 2[^2]
+    * 3. Item 3[^3]
+    $EndLegislativeList
+
+    [^1]: Footnote definition one
+    [^2]: Footnote definition two with an ACRONYM
+    [^3]: Footnote definition three with an acronym that matches an HTML tag class
+
+    *[ACRONYM]: This is the acronym explanation
+    *[class]: Testing HTML matching
+  " do
+    assert_html_output %(
+      <ol class="legislative-list">
+        <li>1. Item 1<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup> with an <abbr title="This is the acronym explanation">ACRONYM</abbr>
+      </li>
+        <li>2. Item 2<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>
+      </li>
+        <li>3. Item 3<sup id="fnref:3" role="doc-noteref"><a href="#fn:3" class="footnote" rel="footnote">[footnote 3]</a></sup>
+      </li>
+      </ol>
+
+      <div class="footnotes" role="doc-endnotes">
+        <ol>
+          <li id="fn:1" role="doc-endnote">
+        <p>
+          Footnote definition one<a href="#fnref:1" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a>
+        </p>
+      </li>
+      <li id="fn:2" role="doc-endnote">
+        <p>
+          Footnote definition two with an <abbr title="This is the acronym explanation">ACRONYM</abbr><a href="#fnref:2" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a>
+        </p>
+      </li>
+      <li id="fn:3" role="doc-endnote">
+        <p>
+          Footnote definition three with an acronym that matches an HTML tag <abbr title="Testing HTML matching">class</abbr><a href="#fnref:3" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a>
+        </p>
+      </li>
+        </ol>
+      </div>
+    )
+  end
 
   test_given_govspeak "
     The quick brown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.0
+        version: 4.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.0
+        version: 4.12.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -327,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain