govspeak 6.7.4 → 6.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78fc27fd0a2e9e6796195ebd2c5cc4b509d825e8c2d74cf1fb074e2dc13333a4
-  data.tar.gz: ea33d0c2b76441a115dc891ffe638745b5afa3366318f9c90d1fb8a7d7649f5f
+  metadata.gz: fb4fa452bfd1c6f1cdff6b638f91dfbc9961ea2bd7568f4feadd12fe73772532
+  data.tar.gz: 925ff3efcbb3b3a9a1aa6e0319e9f5a3ec1540febd0168b8517c5aa884e6e69c
 SHA512:
-  metadata.gz: 25d885461cdf12ffd1e338c1083183d7f5412b3334e3a2fce873234919643452931bb19cbf255abea5e27650a1d28d97d110ff5a43a3e60d22b1624c34e03a5b
-  data.tar.gz: 81634215fd9936b191c6e7be565e235ea2aa1a08cf95c326a6bee088faba21ebf7d040886aead25d963430e174db67e7deff6f4aa395ca8e5f58274c6e632c14
+  metadata.gz: 574ea02a4f90e336a7c2a3b6642a7c1fe91924e8d71f4c55eb71053875c607c19de73aefbb34218d0cbe563c8e95982baf18ce42860a1002e58008efab20a93e
+  data.tar.gz: db21f5a85823c27024ff78970ec8d8dab64584910f90fdbed5649516abfbf5110fca8c52c99b978c54db3e060e1c654ac46e0995b87f5b8ab400c9dfa971b756

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 6.7.5
+
+* Fix footnotes in call-to-action boxes [222](https://github.com/alphagov/govspeak/pull/222)
+
 ## 6.7.4
 
 * Remove Nokogumbo dependency to [resolve warning](https://github.com/sparklemotion/nokogiri/issues/2205) [220](https://github.com/alphagov/govspeak/pull/220)

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.7.4".freeze
+  VERSION = "6.7.5".freeze
 end

data/lib/govspeak.rb

@@ -122,7 +122,7 @@ module Govspeak
       source = Govspeak::BlockquoteExtraQuoteRemover.remove(source)
       source = remove_forbidden_characters(source)
 
-      legislative_list_footnote_definitions(source)
+      footnote_definitions(source)
 
       self.class.extensions.each do |_, regexp, block|
         source.gsub!(regexp) do
@@ -132,12 +132,12 @@ module Govspeak
       source
     end
 
-    def legislative_list_footnote_definitions(source)
+    def footnote_definitions(source)
       is_legislative_list = source.scan(/\$LegislativeList.*?\[\^\d\]*.*?\$EndLegislativeList/m).size.positive?
+      is_cta = source.scan(/\$CTA.*?\[\^\d\]*.*?\$CTA/m).size.positive?
       footnotes = source.scan(/\[\^(\d+)\]:(.*)/)
       @acronyms = source.scan(/(?<=\*)\[(.*)\]:(.*)/)
-
-      if is_legislative_list && footnotes.size.positive?
+      if (is_legislative_list || is_cta) && footnotes.size.positive?
         list_items = footnotes.map do |footnote|
           number = footnote[0]
           text = footnote[1].strip
@@ -321,10 +321,26 @@ module Govspeak
       lines.join
     end
 
+    extension("call-to-action", surrounded_by("$CTA")) do |body|
+      doc = Kramdown::Document.new(body.strip).to_html
+      doc = %(\n<div class="call-to-action">\n#{doc}</div>\n)
+      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?
+      doc
+    end
+
     # More specific tags must be defined first. Those defined earlier have a
     # higher precedence for being matched. For example $CTA must be defined
     # before $C otherwise the first ($C)TA fill be matched to a contact tag.
-    wrap_with_div("call-to-action", "$CTA", Govspeak::Document)
     wrap_with_div("summary", "$!")
     wrap_with_div("form-download", "$D")
     wrap_with_div("contact", "$C")

data/test/govspeak_test.rb

@@ -473,6 +473,101 @@ Teston
       </div>)
   end
 
+  test_given_govspeak "
+    $CTA
+    Click here to start the tool[^1]
+    $CTA
+    [^1]: Footnote definition one
+    " do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p>Click here to start the tool<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup></p>
+      </div>
+      <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>
+        </ol>
+      </div>
+    )
+  end
+
+  test_given_govspeak "
+    $CTA
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    Fusce felis ante[^1], lobortis non quam sit amet, tempus interdum justo.
+    $CTA
+    $CTA
+    Pellentesque quam enim, egestas sit amet congue sit amet[^2], ultrices vitae arcu.
+    Fringilla, metus dui scelerisque est.
+    $CTA
+    [^1]: Footnote definition one
+    [^2]: Footnote definition two
+    " do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+      Fusce felis ante<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup>, lobortis non quam sit amet, tempus interdum justo.</p>
+      </div>
+
+      <div class="call-to-action">
+      <p>Pellentesque quam enim, egestas sit amet congue sit amet<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>, ultrices vitae arcu.
+      Fringilla, metus dui scelerisque est.</p>
+      </div>
+      <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 "
+    $CTA
+    Click here to start the tool[^1]
+    $CTA
+
+    Lorem ipsum dolor sit amet[^2]
+
+    [^1]: Footnote definition 1
+    [^2]: Footnote definition 2
+    " do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p>Click here to start the tool<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup></p>
+      </div>
+
+      <p>Lorem ipsum dolor sit amet<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 1<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 2<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 "
     1. rod
     2. jane

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.7.4
+  version: 6.7.5
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview