govspeak 6.7.3 → 6.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3fb6617b89131244243bd9fcc7317e6c28266122a75eb01f7e2164cd2d46775
-  data.tar.gz: d6241111b4db6cee72273862559d27abd842a83171cd044069ca370c20f3e0e8
+  metadata.gz: eeb616e6f8489b589e1ddda16e92727ec5c30a9ad76b88e89184aad8590276e3
+  data.tar.gz: cc776bc6208ca7baafce665f4c92a549f2ee6c70fa96652e81e2ed8a32a45f5a
 SHA512:
-  metadata.gz: 7ed67517b5fdf63bd9e5e8e95510d801ea4457ed7fb290777f72d263802b67bd9cf30a4644b99edc6c11571bd93a9b61862e076e2d68fe43973b083d6bab98df
-  data.tar.gz: 58f86183335235a8b07cd059fe82e509e5e9701bbbbab02af250598778a720c65e136fb29e505acfe3a68727aeb09ae5e7b4d18cca20b93f67bfd3d940082fb1
+  metadata.gz: cb08b6e651a21f26ae42efff15d74b80401b1dc26fd516b69b02394b9eeaa20825aa4e176ef789a35ae035bb5d8be13012fb42e35c88e1e487870c81c8c4d0af
+  data.tar.gz: 1dc3a85af8fb5ecacb8c9a530739e8f3742fa9ea79bd3830c73c2c5d36b907d737aec74e028a4df197f11e1c0bd7d55eb25e3f5d0009a22a930cfb4e0b449f50

data/CHANGELOG.md

@@ -1,14 +1,26 @@
-## Unreleased
+## 6.7.7
 
-* Minimum Ruby version specified at 2.6 [215](https://github.com/alphagov/govspeak/pull/215)
+* 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)
 
 ## 6.7.3
 
-* Fix regex for footnotes in legislative lists [218](
-https://github.com/alphagov/govspeak/pull/218
+* Fix regex for footnotes in legislative lists [218](https://github.com/alphagov/govspeak/pull/218)
 
 ## 6.7.2
 
+* Minimum Ruby version specified at 2.6 [215](https://github.com/alphagov/govspeak/pull/215)
 * Fix footnotes in legislative lists [216](https://github.com/alphagov/govspeak/pull/216)
 
 ## 6.7.1

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.3".freeze
+  VERSION = "6.7.7".freeze
 end

data/lib/govspeak.rb

@@ -6,7 +6,6 @@ require "htmlentities"
 require "kramdown"
 require "kramdown/parser/govuk"
 require "nokogiri"
-require "nokogumbo"
 require "rinku"
 require "sanitize"
 require "govspeak/header_extractor"
@@ -123,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
@@ -133,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
@@ -225,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|
@@ -322,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")

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.7.3
+  version: 6.7.7
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -112,28 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: nokogumbo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rinku
   requirement: !ruby/object:Gem::Requirement
@@ -152,20 +138,14 @@ dependencies:
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
@@ -216,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement