govspeak 6.7.1 → 6.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b07175e22a88ddf687631c2a157d00f9649efc118ab3e535d95cbda00918d43
-  data.tar.gz: 430f7d18852c8fdd549812c0260b118108292f34f2767902217c9d57a80d1f8b
+  metadata.gz: 3edb8b047b41d9c15581ec77b6b4ba829dae69f64729265deaf5cad25b91744a
+  data.tar.gz: 2e899be9ea70576afb234804213e8697278483a77118dc5f03857bdf7ca0e49d
 SHA512:
-  metadata.gz: 0fd6c1d0b6e8a416fdeb6d7aba99868dfb8e9ccf80191666dc771dcdf56a9bf396297569759c172608c31daf7bf75a891914e98713fc0e99b8458220b3dd7934
-  data.tar.gz: 8a04ab8364ea6ac989b4a1549ce8c4f152ad57988144183f7db00b5b256fce4b5823d79ac611a4078f75ccee5bd1d42f5a81344140979d2066916c2693a35dc4
+  metadata.gz: 8779eb8e734e660d3ce9b7e020f18c14792ba1488fb92f59d23455e0cf5474f2ded6d376bd3c25e0b09c7e27362a5e56a271bf1f3084ce60a8cc355d07a97b34
+  data.tar.gz: 569414d843883df41a9bd9abbc286b94667e50b0156321468d01008980fd28863ef65e127a422a7e55c4793b649901000a6a474e0450903a801287880fa75af6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+* Minimum Ruby version specified at 2.6 [215](https://github.com/alphagov/govspeak/pull/215)
+
+## 6.7.2
+
+* Fix footnotes in legislative lists [216](https://github.com/alphagov/govspeak/pull/216)
+
 ## 6.7.1
 
 * Update failing test [212](https://github.com/alphagov/govspeak/pull/212)

data/lib/govspeak/header_extractor.rb

@@ -30,9 +30,10 @@ module Govspeak
     def find_headers(parent)
       headers = []
 
-      if parent.type == :header
+      case parent.type
+      when :header
         headers << build_header(parent)
-      elsif parent.type == :html_element
+      when :html_element
         parent.children.each do |child|
           if child.type == :header
             headers << build_header(child)

data/lib/govspeak/post_processor.rb

@@ -126,7 +126,7 @@ module Govspeak
         el.content = "[footnote #{footnote_number}]"
       end
       document.css("[role='doc-backlink']").map do |el|
-        backlink_number = " " + el.css("sup")[0].content if el.css("sup")[0].present?
+        backlink_number = " #{el.css('sup')[0].content}" if el.css("sup")[0].present?
         el["aria-label"] = "go to where this is referenced#{backlink_number}"
       end
     end

data/lib/govspeak/presenters/attachment_presenter.rb

@@ -4,6 +4,7 @@ require "htmlentities"
 module Govspeak
   class AttachmentPresenter
     attr_reader :attachment
+
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::NumberHelper
     include ActionView::Helpers::TextHelper
@@ -25,7 +26,7 @@ module Govspeak
     end
 
     def file_extension
-      # Note: this is a separate parameter rather than being calculated from the
+      # NOTE: this is a separate parameter rather than being calculated from the
       # filename because at the time of writing not all apps were using the effects
       # of this field.
       attachment[:file_extension]

data/lib/govspeak/presenters/contact_presenter.rb

@@ -23,30 +23,30 @@ module Govspeak
 
     def post_addresses
       @post_addresses ||= begin
-                            addresses = contact.dig(:details, :post_addresses) || []
-                            filter_post_addresses(addresses)
-                          end
+        addresses = contact.dig(:details, :post_addresses) || []
+        filter_post_addresses(addresses)
+      end
     end
 
     def email_addresses
       @email_addresses ||= begin
-                             emails = contact.dig(:details, :email_addresses) || []
-                             emails.select { |e| e[:email].present? }
-                           end
+        emails = contact.dig(:details, :email_addresses) || []
+        emails.select { |e| e[:email].present? }
+      end
     end
 
     def phone_numbers
       @phone_numbers ||= begin
-                           phone_numbers = contact.dig(:details, :phone_numbers) || []
-                           phone_numbers.select { |p| p[:number].present? }
-                         end
+        phone_numbers = contact.dig(:details, :phone_numbers) || []
+        phone_numbers.select { |p| p[:number].present? }
+      end
     end
 
     def contact_form_links
       @contact_form_links ||= begin
-                                contact_form_links = contact.dig(:details, :contact_form_links) || []
-                                contact_form_links.select { |c| c[:link].present? }
-                              end
+        contact_form_links = contact.dig(:details, :contact_form_links) || []
+        contact_form_links.select { |c| c[:link].present? }
+      end
     end
 
   private

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.7.1".freeze
+  VERSION = "6.7.2".freeze
 end

data/lib/govspeak.rb

@@ -62,18 +62,30 @@ module Govspeak
                    sanitize: true,
                    syntax_highlighter: nil }.merge(options)
       @options[:entity_output] = :symbolic
+      @footnote_definition_html = nil
+      @acronyms = []
     end
 
     def to_html
       @to_html ||= begin
-                     html = if @options[:sanitize]
-                              HtmlSanitizer.new(kramdown_doc.to_html).sanitize(allowed_elements: @allowed_elements)
-                            else
-                              kramdown_doc.to_html
-                            end
+        html = if @options[:sanitize]
+                 HtmlSanitizer.new(kramdown_doc.to_html).sanitize(allowed_elements: @allowed_elements)
+               else
+                 kramdown_doc.to_html
+               end
+
+        unless @footnote_definition_html.nil?
+          regex = /<div class="footnotes".*[<\/div>]/m
+
+          if html.scan(regex).empty?
+            html << @footnote_definition_html
+          else
+            html.gsub!(regex, @footnote_definition_html)
+          end
+        end
 
-                     Govspeak::PostProcessor.process(html, self)
-                   end
+        Govspeak::PostProcessor.process(html, self)
+      end
     end
 
     def to_liquid
@@ -110,6 +122,9 @@ module Govspeak
     def preprocess(source)
       source = Govspeak::BlockquoteExtraQuoteRemover.remove(source)
       source = remove_forbidden_characters(source)
+
+      legislative_list_footnote_definitions(source)
+
       self.class.extensions.each do |_, regexp, block|
         source.gsub!(regexp) do
           instance_exec(*Regexp.last_match.captures, &block)
@@ -118,6 +133,40 @@ module Govspeak
       source
     end
 
+    def legislative_list_footnote_definitions(source)
+      is_legislative_list = source.scan(/\$LegislativeList.*?\[\^\d\]*.*?\$EndLegislativeList/m).size.positive?
+      footnotes = source.scan(/\[\^(\d)\]:(.*)/)
+      @acronyms = source.scan(/(?<=\*)\[(.*)\]:(.*)/)
+
+      if is_legislative_list && 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>)/]
+
+          <<~HTML_SNIPPET
+            <li id="fn:#{number}" role="doc-endnote">
+              <p>
+                #{footnote_definition}<a href="#fnref:#{number}" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a>
+              </p>
+            </li>
+          HTML_SNIPPET
+        end
+
+        @footnote_definition_html = <<~HTML_CONTAINER
+          <div class="footnotes" role="doc-endnotes">
+            <ol>
+              #{list_items.join.strip}
+            </ol>
+          </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)
       # These are characters that are not deemed not suitable for
       # markup: https://www.w3.org/TR/unicode-xml/#Charlist
@@ -161,7 +210,7 @@ module Govspeak
           ([^)]+)  # capture inside of link text markdown
         \) # match end of link text markdown
         \s*  # any whitespace between opening bracket and link
-      {\/button} # match ending bracket
+      {/button} # match ending bracket
       (?:\r|\n|$) # non-capturing match to make sure end of line and linebreak
     }x) do |attributes, text, href|
       button_classes = "govuk-button"
@@ -295,6 +344,18 @@ module Govspeak
           doc.gsub!("<ul>", "<ol>")
           doc.gsub!("</ul>", "</ol>")
           doc.sub!("<ol>", '<ol class="legislative-list">')
+
+          footnotes = body.scan(/\[\^(\d+)\]/).flatten
+
+          footnotes.each do |footnote|
+            html = "<sup id=\"fnref:#{footnote}\" role=\"doc-noteref\">" \
+            "<a href=\"#fn:#{footnote}\" class=\"footnote\" rel=\"footnote\">" \
+            "[footnote #{footnote}]</a></sup>"
+
+            doc.sub!(/(\[\^#{footnote}\])/, html)
+          end
+
+          add_acronym_alt_text(doc) if @acronyms.size.positive?
         end
       end
     end
@@ -386,6 +447,12 @@ module Govspeak
     def encode(text)
       HTMLEntities.new.encode(text)
     end
+
+    def add_acronym_alt_text(html)
+      @acronyms.each do |acronym|
+        html.gsub!(acronym[0], "<abbr title=\"#{acronym[1].strip}\">#{acronym[0]}</abbr>")
+      end
+    end
   end
 end
 

data/test/govspeak_attachment_test.rb

@@ -17,7 +17,7 @@ class GovspeakAttachmentTest < Minitest::Test
     }
 
     rendered = render_govspeak("[Attachment:attachment.pdf]", [attachment])
-    assert_match(/<section class="gem-c-attachment">/, rendered)
+    assert_match(/<section class="gem-c-attachment/, rendered)
     assert_match(/Attachment Title/, rendered)
   end
 
@@ -32,7 +32,7 @@ class GovspeakAttachmentTest < Minitest::Test
     assert_equal("<p>some text [Attachment:attachment.pdf]</p>\n", rendered)
 
     rendered = render_govspeak("[Attachment:attachment.pdf] some text", [attachment])
-    assert_match(/<section class="gem-c-attachment">/, rendered)
+    assert_match(/<section class="gem-c-attachment/, rendered)
     assert_match(/<p>some text<\/p>/, rendered)
   end
 end

data/test/govspeak_attachments_image_test.rb

@@ -15,7 +15,7 @@ class GovspeakAttachmentsImageTest < Minitest::Test
   end
 
   def compress_html(html)
-    html.gsub(/[\n\r]+[\s]*/, "")
+    html.gsub(/[\n\r]+\s*/, "")
   end
 
   test "renders an empty string for an image attachment not found" do

data/test/govspeak_button_test.rb

@@ -7,34 +7,34 @@ class GovspeakTest < Minitest::Test
   include GovspeakTestHelper
 
   test_given_govspeak "{button start cross-domain-tracking:UA-23066786-5}[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="cross-domain-tracking" data-tracking-code="UA-23066786-5" data-tracking-name="govspeakButtonTracker" href="https://www.registertovote.service.gov.uk/register-to-vote/start"> Start now <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>'
+    assert_html_selector 'a.gem-c-button.govuk-button--start[data-module="cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   # The same as above but with line breaks
   test_given_govspeak "{button start cross-domain-tracking:UA-23066786-5}\n\n\n[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start)\n\n\n{/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="cross-domain-tracking" data-tracking-code="UA-23066786-5" data-tracking-name="govspeakButtonTracker" href="https://www.registertovote.service.gov.uk/register-to-vote/start"> Start now <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>'
+    assert_html_selector 'a.gem-c-button.govuk-button--start[data-module="cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   test_given_govspeak "{button cross-domain-tracking:UA-23066786-5}[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button" role="button" data-module="cross-domain-tracking" data-tracking-code="UA-23066786-5" data-tracking-name="govspeakButtonTracker" href="https://www.registertovote.service.gov.uk/register-to-vote/start">Start now</a></p>'
+    assert_html_selector 'a.gem-c-button:not(.govuk-button--start)[data-module="cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   test_given_govspeak "{button start}[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button govuk-button--start" role="button" href="https://www.registertovote.service.gov.uk/register-to-vote/start"> Start now <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>'
+    assert_html_selector 'a.gem-c-button.govuk-button--start[href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   test_given_govspeak "{button}[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button" role="button" href="https://www.registertovote.service.gov.uk/register-to-vote/start">Start now</a></p>'
+    assert_html_selector 'a.gem-c-button:not(.govuk-button--start)[href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   # Test other text outputs
   test_given_govspeak "{button}[Something else](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button" role="button" href="https://www.registertovote.service.gov.uk/register-to-vote/start">Something else</a></p>'
+    assert_html_selector 'a.gem-c-button[href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Something else"
   end
 
@@ -54,22 +54,6 @@ class GovspeakTest < Minitest::Test
     assert_text_output "Text before the button with line breaks Start Now test after the button"
   end
 
-  # Test README examples
-  test_given_govspeak "{button}[Continue](https://gov.uk/random){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>'
-    assert_text_output "Continue"
-  end
-
-  test_given_govspeak "{button start}[Start Now](https://gov.uk/random){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button govuk-button--start" role="button" href="https://gov.uk/random"> Start Now <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>'
-    assert_text_output "Start Now"
-  end
-
-  test_given_govspeak "{button start cross-domain-tracking:UA-XXXXXX-Y}[Start Now](https://example.com/external-service/start-now){/button}" do
-    assert_html_output '<p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="cross-domain-tracking" data-tracking-code="UA-XXXXXX-Y" data-tracking-name="govspeakButtonTracker" href="https://example.com/external-service/start-now"> Start Now <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>'
-    assert_text_output "Start Now"
-  end
-
   # Test indenting button govspeak results in no render, useful in guides
   test_given_govspeak "    {button start cross-domain-tracking:UA-XXXXXX-Y}[Example](https://example.com/external-service/start-now){/button}" do
     assert_html_output %{
@@ -107,7 +91,7 @@ class GovspeakTest < Minitest::Test
     lorem lorem lorem
     lorem lorem lorem
 
-    {button start}[Start Now](https://gov.uk/random){/button}
+    {button}[Random page](https://gov.uk/random){/button}
 
     lorem lorem lorem
     lorem lorem lorem
@@ -120,7 +104,7 @@ class GovspeakTest < Minitest::Test
       <p>lorem lorem lorem
       lorem lorem lorem</p>
 
-      <p><a class="gem-c-button govuk-button govuk-button--start" role="button" href="https://gov.uk/random"> Start Now <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>
+      <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Random page</a></p>
 
       <p>lorem lorem lorem
       lorem lorem lorem</p>

data/test/govspeak_contacts_test.rb

@@ -51,7 +51,7 @@ class GovspeakContactsTest < Minitest::Test
   end
 
   def compress_html(html)
-    html.gsub(/[\n\r]+[\s]*/, "")
+    html.gsub(/[\n\r]+\s*/, "")
   end
 
   test "contact is rendered when present in options[:contacts]" do

data/test/govspeak_images_bang_test.rb

@@ -18,9 +18,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax renders an image in options[:images]" do
     given_govspeak "!!1", images: [Image.new] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
   end
@@ -28,9 +26,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax escapes alt text" do
     given_govspeak "!!1", images: [Image.new(alt_text: %(my alt '&"<>))] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt '&amp;&quot;&lt;&gt;\"></div></figure>",
       )
     end
   end
@@ -48,10 +44,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax adds image caption if given" do
     given_govspeak "!!1", images: [Image.new(caption: "My Caption & so on")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
-        %(<figcaption><p>My Caption &amp; so on</p></figcaption>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div>\n<figcaption><p>My Caption &amp; so on</p></figcaption></figure>",
       )
     end
   end
@@ -59,9 +52,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax ignores a blank caption" do
     given_govspeak "!!1", images: [Image.new(caption: "  ")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
   end
@@ -69,10 +60,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "¡¡n syntax adds image credit if given" do
     given_govspeak "!!1", images: [Image.new(credit: "My Credit & so on")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
-        %(<figcaption><p>Image credit: My Credit &amp; so on</p></figcaption>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div>\n<figcaption><p>Image credit: My Credit &amp; so on</p></figcaption></figure>",
       )
     end
   end
@@ -80,9 +68,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax ignores a blank credit" do
     given_govspeak "!!1", images: [Image.new(credit: "  ")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
   end
@@ -90,13 +76,7 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax adds image caption and credit if given" do
     given_govspeak "!!1", images: [Image.new(caption: "My Caption & so on", credit: "My Credit & so on")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
-        %(<figcaption>) +
-          %(<p>My Caption &amp; so on</p>\n) +
-          %(<p>Image credit: My Credit &amp; so on</p>) +
-        %(</figcaption>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div>\n<figcaption><p>My Caption &amp; so on</p>\n<p>Image credit: My Credit &amp; so on</p></figcaption></figure>",
       )
     end
   end

data/test/govspeak_images_test.rb

@@ -14,9 +14,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax renders an image in options[:images]" do
     given_govspeak "[Image:image-id]", images: [build_image] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
   end
@@ -24,9 +22,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax escapes alt text" do
     given_govspeak "[Image:image-id]", images: [build_image(alt_text: %(my alt '&"<>))] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt '&amp;&quot;&lt;&gt;\"></div></figure>",
       )
     end
   end
@@ -39,10 +35,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax adds image caption if given" do
     given_govspeak "[Image:image-id]", images: [build_image(caption: "My Caption & so on")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
-        %(<figcaption><p>My Caption &amp; so on</p></figcaption>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div>\n<figcaption><p>My Caption &amp; so on</p></figcaption></figure>",
       )
     end
   end
@@ -50,9 +43,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax ignores a blank caption" do
     given_govspeak "[Image:image-id]", images: [build_image(caption: "  ")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
   end
@@ -60,10 +51,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax adds image credit if given" do
     given_govspeak "[Image:image-id]", images: [build_image(credit: "My Credit & so on")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
-        %(<figcaption><p>Image credit: My Credit &amp; so on</p></figcaption>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div>\n<figcaption><p>Image credit: My Credit &amp; so on</p></figcaption></figure>",
       )
     end
   end
@@ -71,9 +59,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax ignores a blank credit" do
     given_govspeak "[Image:image-id]", images: [build_image(credit: "  ")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
   end
@@ -81,13 +67,7 @@ class GovspeakImagesTest < Minitest::Test
   test "Image:image-id syntax adds image caption and credit if given" do
     given_govspeak "[Image:image-id]", images: [build_image(caption: "My Caption & so on", credit: "My Credit & so on")] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
-        %(<figcaption>) +
-          %(<p>My Caption &amp; so on</p>\n) +
-          %(<p>Image credit: My Credit &amp; so on</p>) +
-        %(</figcaption>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div>\n<figcaption><p>My Caption &amp; so on</p>\n<p>Image credit: My Credit &amp; so on</p></figcaption></figure>",
       )
     end
   end
@@ -99,18 +79,13 @@ class GovspeakImagesTest < Minitest::Test
 
     given_govspeak "[Image:image-id]", images: [build_image] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>",
       )
     end
 
     given_govspeak "[Image:image-id] some text", images: [build_image] do
       assert_html_output(
-        %(<figure class="image embedded">) +
-        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
-        %(</figure>\n) +
-        %(<p>some text</p>),
+        "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>\n<p>some text</p>",
       )
     end
   end

data/test/govspeak_test.rb

@@ -591,6 +591,213 @@ Teston
     }
   end
 
+  test_given_govspeak "
+    $LegislativeList
+    * 1. Item 1[^1]
+    * 2. Item 2[^2]
+    * 3. Item 3
+    $EndLegislativeList
+
+    [^1]: Footnote definition one
+    [^2]: Footnote definition two
+  " 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>
+      </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<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]
+    * 2. Item 2
+    * 3. Item 3
+    $EndLegislativeList
+
+    This is a paragraph with a footnote[^2].
+
+    $LegislativeList
+    * 1. Item 1
+    * 2. Item 2[^3]
+    * 3. Item 3
+    $EndLegislativeList
+
+    [^1]: Footnote definition one
+    [^2]: Footnote definition two
+    [^3]: Footnote definition two
+  " 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>
+      </li>
+        <li>2. Item 2</li>
+        <li>3. Item 3</li>
+      </ol>
+
+      <p>This is a paragraph with a footnote<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>.</p>
+
+      <ol class="legislative-list">
+        <li>1. Item 1</li>
+        <li>2. Item 2<sup id="fnref:3" role="doc-noteref"><a href="#fn:3" class="footnote" rel="footnote">[footnote 3]</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<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 two<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 "
+    $LegislativeList
+    * 1. Item 1[^1] with a [link](http://www.gov.uk)
+    * 2. Item 2
+    * 3. Item 3
+    $EndLegislativeList
+
+    This is a paragraph with a footnote[^2]
+
+    [^1]: Footnote definition one
+    [^2]: Footnote definition two
+  " 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 a <a href="http://www.gov.uk">link</a>
+      </li>
+        <li>2. Item 2</li>
+        <li>3. Item 3</li>
+      </ol>
+
+      <p>This is a paragraph with a footnote<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup></p>
+
+      <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<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 a [link](http://www.gov.uk)
+    * 2. Item 2
+    * 3. Item 3[^2]
+    $EndLegislativeList
+
+    [^1]: Footnote definition one with a [link](http://www.gov.uk) included
+    [^2]: Footnote definition two with an external [link](http://www.google.com)
+  " 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 a <a href="http://www.gov.uk">link</a>
+      </li>
+        <li>2. Item 2</li>
+        <li>3. Item 3<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>
+      </li>
+      </ol>
+
+      <div class="footnotes" role="doc-endnotes">
+        <ol>
+          <li id="fn:1" role="doc-endnote">
+        <p>
+          Footnote definition one with a <a href="http://www.gov.uk">link</a> included<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 external <a rel="external" href="http://www.google.com">link</a><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
+    $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 "
     The quick brown
     $LegislativeList

data/test/govspeak_test_helper.rb

@@ -26,6 +26,12 @@ module GovspeakTestHelper
       @testcase.assert expected.strip == actual, describe_error(@govspeak, expected.strip, actual)
     end
 
+    def assert_html_selector(selector)
+      html = document.to_html
+      fragment = Nokogiri::HTML.fragment(html)
+      @testcase.assert fragment.css(selector).any?, "Expected to find #{selector} within #{html}"
+    end
+
     def remove_indentation(raw)
       lines = raw.split("\n")
       if lines.first.empty?
@@ -33,7 +39,7 @@ module GovspeakTestHelper
         nonblanks = lines.reject { |l| l.match(/^ *$/) }
         indentation = nonblanks.map { |line| line.match(/^ */)[0].size }.min
         unindented = lines.map do |line|
-          line[indentation..-1]
+          line[indentation..]
         end
         unindented.join "\n"
       else

data/test/test_helper.rb

@@ -17,10 +17,10 @@ class Minitest::Test
       clean_name = name.gsub(/\s+/, "_")
       method = "test_#{clean_name.gsub(/\s+/, '_')}".to_sym
       already_defined = begin
-                          instance_method(method)
-                        rescue StandardError
-                          false
-                        end
+        instance_method(method)
+      rescue StandardError
+        false
+      end
       raise "#{method} exists" if already_defined
 
       define_method(method, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.7.1
+  version: 6.7.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -216,14 +216,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.1
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -360,36 +360,36 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/govspeak_images_bang_test.rb
-- test/govspeak_attachment_test.rb
-- test/govspeak_link_extractor_test.rb
-- test/govspeak_attachments_inline_test.rb
-- test/govspeak_button_test.rb
-- test/govspeak_structured_headers_test.rb
 - test/govspeak_attachments_image_test.rb
-- test/govspeak_attachment_link_test.rb
+- test/govspeak_structured_headers_test.rb
+- test/govspeak_images_bang_test.rb
+- test/govspeak_link_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
-- test/presenters/h_card_presenter_test.rb
-- test/govspeak_test.rb
-- test/html_sanitizer_test.rb
-- test/govspeak_footnote_test.rb
+- test/govspeak_test_helper.rb
 - test/blockquote_extra_quote_remover_test.rb
+- test/govspeak_attachments_inline_test.rb
+- test/govspeak_attachment_test.rb
 - test/test_helper.rb
-- test/govspeak_table_with_headers_test.rb
+- test/govspeak_test.rb
+- test/presenters/h_card_presenter_test.rb
+- test/govspeak_footnote_test.rb
+- test/govspeak_attachment_link_test.rb
+- test/govspeak_link_extractor_test.rb
+- test/govspeak_button_test.rb
 - test/govspeak_images_test.rb
-- test/govspeak_link_test.rb
 - test/html_validator_test.rb
+- test/html_sanitizer_test.rb
+- test/govspeak_table_with_headers_test.rb
 - test/govspeak_contacts_test.rb
-- test/govspeak_test_helper.rb