govspeak 6.7.4 → 6.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78fc27fd0a2e9e6796195ebd2c5cc4b509d825e8c2d74cf1fb074e2dc13333a4
-  data.tar.gz: ea33d0c2b76441a115dc891ffe638745b5afa3366318f9c90d1fb8a7d7649f5f
+  metadata.gz: 709c3fbb62a1b1e54cae82fd1539785acaaf3586c0a094b402880bf4608df065
+  data.tar.gz: 1300878c1001b40ade71a2e5446ea1f62ea8cd1e5d764e97ef9450da6124d74a
 SHA512:
-  metadata.gz: 25d885461cdf12ffd1e338c1083183d7f5412b3334e3a2fce873234919643452931bb19cbf255abea5e27650a1d28d97d110ff5a43a3e60d22b1624c34e03a5b
-  data.tar.gz: 81634215fd9936b191c6e7be565e235ea2aa1a08cf95c326a6bee088faba21ebf7d040886aead25d963430e174db67e7deff6f4aa395ca8e5f58274c6e632c14
+  metadata.gz: dcf825ebf9e77452c200104606486d9c0ad26c5f00855ce69c3c127d5e6cd7357d804fb3df77b3362fe797e814ed2cffe3823c2a835d1784e89b25c459abfd12
+  data.tar.gz: 607b7b974bf443801e83ec7afaab1449e00a50d63134dc90b912f62a5a5c0635ea2e54afece268dbe6c4471cc232c4f12033bef6f8961aee1816a4cd6f1fcc25

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 6.7.8
+
+* Fixes bug which reverts acronyms from being converted into abbr tags [#229](https://github.com/alphagov/govspeak/pull/229)
+
+## 6.7.7
+
+* Fix broken HTML in CTA extension. [#226](https://github.com/alphagov/govspeak/pull/226)
+
+## 6.7.6
+
+* Add draggable false to button markup and validation [#224](https://github.com/alphagov/govspeak/pull/224)
+
+## 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/README.md

@@ -28,8 +28,7 @@ Once govspeak has been updated and version incremented then:
 
 Also, consider if:
 - [whitehall](https://github.com/alphagov/whitehall) needs updating (as custom govspeak changes are present)
-- [govuk-content-schema](https://github.com/alphagov/govuk-content-schemas) needs updating
-- [govpspeak-preview](https://github.com/alphagov/govspeak-preview) is worth updating
+- [govpspeak-preview](https://github.com/alphagov/govspeak-preview) needs updating
 
 Any pages that use govspeak to generate Content will need to *republished* in order for the new changes to be reflected.  
 

data/lib/govspeak/html_sanitizer.rb

@@ -55,7 +55,7 @@ class Govspeak::HtmlSanitizer
       elements: Sanitize::Config::RELAXED[:elements] + %w[govspeak-embed-attachment govspeak-embed-attachment-link svg path].concat(allowed_elements),
       attributes: {
         :all => Sanitize::Config::RELAXED[:attributes][:all] + %w[role aria-label],
-        "a" => Sanitize::Config::RELAXED[:attributes]["a"] + [:data],
+        "a" => Sanitize::Config::RELAXED[:attributes]["a"] + [:data] + %w[draggable],
         "svg" => Sanitize::Config::RELAXED[:attributes][:all] + %w[xmlns width height viewbox focusable],
         "path" => Sanitize::Config::RELAXED[:attributes][:all] + %w[fill d],
         "div" => [:data],

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.7.4".freeze
+  VERSION = "6.7.8".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
@@ -224,7 +224,7 @@ module Govspeak
       text = text.strip
       href = href.strip
 
-      %(\n<a role="button" class="#{button_classes}" href="#{href}" #{data_attribute}>#{text}</a>\n)
+      %(\n<a role="button" draggable="false" class="#{button_classes}" href="#{href}" #{data_attribute}>#{text}</a>\n)
     end
 
     extension("highlight-answer") do |body|
@@ -321,10 +321,26 @@ module Govspeak
       lines.join
     end
 
+    extension("call-to-action", surrounded_by("$CTA")) do |body|
+      doc = Kramdown::Document.new(preprocess(body.strip), @options).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")
@@ -448,9 +464,10 @@ module Govspeak
     end
 
     def add_acronym_alt_text(html)
-      @acronyms.each do |acronym|
-        html.gsub!(acronym[0], "<abbr title=\"#{acronym[1].strip}\">#{acronym[0]}</abbr>")
-      end
+      # 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
     end
   end
 end

data/test/govspeak_button_test.rb

@@ -47,7 +47,7 @@ class GovspeakTest < Minitest::Test
     assert_html_output %(
       <p>Text before the button with line breaks</p>
 
-      <p><a class="gem-c-button govuk-button" role="button" href="http://www.gov.uk">Start Now</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="http://www.gov.uk">Start Now</a></p>
 
       <p>test after the button</p>
     )
@@ -65,21 +65,21 @@ class GovspeakTest < Minitest::Test
   # Make sure button renders when typical linebreaks are before it, seen in publishing applications
   test_given_govspeak "{button}[Line breaks](https://gov.uk/random){/button}\r\n\r\n{button}[Continue](https://gov.uk/random){/button}\r\n\r\n{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">Line breaks</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Line breaks</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
     )
   end
 
   test_given_govspeak "{button}[More line breaks](https://gov.uk/random){/button}\n\n{button}[Continue](https://gov.uk/random){/button}\n\n{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">More line breaks</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">More line breaks</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
     )
   end
 
@@ -104,7 +104,7 @@ class GovspeakTest < Minitest::Test
       <p>lorem lorem lorem
       lorem lorem lorem</p>
 
-      <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Random page</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Random page</a></p>
 
       <p>lorem lorem lorem
       lorem lorem lorem</p>

data/test/govspeak_test.rb

@@ -440,6 +440,60 @@ Teston
       </div>)
   end
 
+  test_given_govspeak "
+    $CTA
+
+    This is a test:
+
+    s1. This is number 1.
+    s2. This is number 2.
+    s3. This is number 3.
+    s4. This is number 4.
+
+    $CTA" do
+    assert_html_output %(
+        <div class="call-to-action">
+        <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 "
+    $CTA
+    [external link](http://www.external.com) some text
+    $CTA
+    " do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p><a rel="external" href="http://www.external.com">external link</a> some text</p>
+      </div>)
+  end
+
+  test_given_govspeak "
+    $CTA
+    [internal link](http://www.not-external.com) some text
+    $CTA", document_domains: %w[www.not-external.com] do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p><a href="http://www.not-external.com">internal link</a> some text</p>
+      </div>)
+  end
+
   test_given_govspeak "
     $CTA
     Click here to start the tool
@@ -473,6 +527,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
@@ -899,43 +1048,44 @@ Teston
     )
   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
+  # 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 "
     The quick brown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.7.4
+  version: 6.7.8
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -196,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement