govspeak 6.5.6 → 6.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd25c3749cd867192b6243a3d607d83b4b53def14cfb81f9cfaec0f9194052fe
-  data.tar.gz: 9ba6512c5ff9c8a410ea424ea880baef90d0a90e1cc8b660755d3428148bb899
+  metadata.gz: a45a14e5a726d918753171dc957cc1ed29e50d4505685ff19271da6cad41945d
+  data.tar.gz: 27d874bc05f80a2c37edae5010a326b426cbcf1663d5bfcc1bedc9d6852e1e02
 SHA512:
-  metadata.gz: adc39b260589d92b0ba86e2ee04a513677fece35b50e338ba7716a927b4706c7e2782e13b50a4f5158429621dd2248b40d4dda7804bc176e60d8e73ee3f348d2
-  data.tar.gz: 46a366da4e41699f7bf182967a71e1cf3cc92f06f477b655eadd939b8ca25dfd1088591dd8d1b83f563d9ebcc49b797726c59ce2c72d9ce6b63a8dc3992f7513
+  metadata.gz: 5a01955112fab442c130f71c93e4c2a743c1c9d7a16797d5a2ef406bc7ad591f8380b90f03574d373cf8a519d40e4828b880a9a45d1e36b8c5128f423ac1e20f
+  data.tar.gz: 7ae23223d912b5753eefc4568190fd74e36968a6697e6ef5eeefeff65d88d63f0ec763122b716a4a6179b1c188121c349bb8f9fb6c74ccd346906084cdf7e184

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 6.5.11
+
+* Fix issue rendering $CTA blocks before $C (PR#202)
+
+## 6.5.10
+
+* Be optimistic in versions of govuk_publishing_components and i18n allowed (PR#200)
+
+## 6.5.9
+
+* Adjust footnote markup to accommodate multiple references (PR#198)
+
+## 6.5.8
+
+* Customise footnote markup for accessibility (PR#192)
+
+## 6.5.7
+
+* Update GOV.UK Publishing components to version to 23.0.0 or greater
+
 ## 6.5.6
 
 * Update Kramdown version to 2.3.0 or greater

data/README.md

@@ -65,7 +65,7 @@ creates an example box
 
 ## Highlights
 
-### Advisory
+### Advisory (DEPRECATED: marked for removal. Use 'Information callouts' instead.)
 
     @This is a very important message or warning@
 
@@ -77,7 +77,7 @@ highlights the enclosed text in yellow
 </h3>
 ```
 
-### Answer
+### Answer (DEPRECATED: marked for removal)
 
     {::highlight-answer}
     The VAT rate is *20%*

data/lib/govspeak.rb

@@ -272,6 +272,10 @@ module Govspeak
       lines.join
     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")
@@ -279,7 +283,6 @@ module Govspeak
     wrap_with_div("information", "$I", Govspeak::Document)
     wrap_with_div("additional-information", "$AI")
     wrap_with_div("example", "$E", Govspeak::Document)
-    wrap_with_div("call-to-action", "$CTA", Govspeak::Document)
 
     extension("address", surrounded_by("$A")) do |body|
       %(\n<div class="address"><div class="adr org fn"><p>\n#{body.sub("\n", '').gsub("\n", '<br />')}\n</p></div></div>\n)

data/lib/govspeak/post_processor.rb

@@ -120,6 +120,17 @@ module Govspeak
       end
     end
 
+    extension("use custom footnotes") do |document|
+      document.css("a.footnote").map do |el|
+        footnote_number = el[:href].gsub(/\D/, "")
+        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?
+        el["aria-label"] = "go to where this is referenced#{backlink_number}"
+      end
+    end
+
     attr_reader :input, :govspeak_document
 
     def initialize(html, govspeak_document)

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.5.6".freeze
+  VERSION = "6.5.11".freeze
 end

data/lib/kramdown/parser/govuk.rb

@@ -35,7 +35,7 @@ module Kramdown
             unless host.nil? || @document_domains.compact.include?(host)
               element.attr["rel"] = "external"
             end
-          rescue Addressable::URI::InvalidURIError # rubocop:disable Lint/SuppressedException
+          rescue Addressable::URI::InvalidURIError
             # it's safe to ignore these very *specific* exceptions
           end
 

data/test/govspeak_footnote_test.rb

@@ -0,0 +1,46 @@
+require "test_helper"
+require "govspeak_test_helper"
+
+class GovspeakFootnoteTest < Minitest::Test
+  include GovspeakTestHelper
+
+  test_given_govspeak "
+    Footnotes can be added[^1].
+
+    [^1]: And then later defined.
+
+    Footnotes can be added too[^2].
+
+    [^2]: And then later defined too.
+
+    This footnote has a reference number[^3].
+
+    And this footnote has the same reference number[^3].
+
+    [^3]: And then they both point here." do
+    assert_html_output(
+      %(
+      <p>Footnotes can be added<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote">[footnote 1]</a></sup>.</p>
+
+      <p>Footnotes can be added too<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote">[footnote 2]</a></sup>.</p>
+
+      <p>This footnote has a reference number<sup id="fnref:3" role="doc-noteref"><a href="#fn:3" class="footnote">[footnote 3]</a></sup>.</p>
+
+      <p>And this footnote has the same reference number<sup id="fnref:3:1" role="doc-noteref"><a href="#fn:3" class="footnote">[footnote 3]</a></sup>.</p>
+
+      <div class="footnotes" role="doc-endnotes">
+        <ol>
+          <li id="fn:1" role="doc-endnote">
+            <p>And then later defined. <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>And then later defined too. <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>And then they both point here. <a href="#fnref:3" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced">↩</a> <a href="#fnref:3:1" class="reversefootnote" role="doc-backlink" aria-label="go to where this is referenced 2">↩<sup>2</sup></a></p>
+          </li>
+        </ol>
+      </div>),
+    )
+  end
+end

data/test/govspeak_test.rb

@@ -440,6 +440,25 @@ Teston
       </div>)
   end
 
+  test_given_govspeak "
+    $CTA
+    Click here to start the tool
+    $CTA
+
+    $C
+    Here is some text
+    $C
+    " do
+    assert_html_output %(
+      <div class="call-to-action">
+      <p>Click here to start the tool</p>
+      </div>
+
+      <div class="contact">
+      <p>Here is some text</p>
+      </div>)
+  end
+
   test_given_govspeak "
     [internal link](http://www.not-external.com)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.5.6
+  version: 6.5.11
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -54,16 +54,16 @@ dependencies:
   name: govuk_publishing_components
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '21.4'
+        version: '23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '21.4'
+        version: '23'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -82,14 +82,14 @@ dependencies:
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
@@ -174,14 +174,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.1
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.1
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -216,14 +216,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.17.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +336,7 @@ files:
 - test/govspeak_button_test.rb
 - test/govspeak_contacts_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
+- test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb
 - test/govspeak_images_test.rb
 - test/govspeak_link_extractor_test.rb
@@ -366,28 +367,29 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/govspeak_link_extractor_test.rb
-- test/govspeak_structured_headers_test.rb
 - 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_table_with_headers_test.rb
+- test/govspeak_structured_headers_test.rb
+- test/govspeak_attachments_image_test.rb
+- test/govspeak_attachment_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/blockquote_extra_quote_remover_test.rb
-- test/govspeak_test_helper.rb
-- test/govspeak_link_test.rb
-- test/govspeak_images_test.rb
-- test/govspeak_attachment_link_test.rb
-- test/govspeak_contacts_test.rb
 - test/test_helper.rb
+- test/govspeak_table_with_headers_test.rb
+- test/govspeak_images_test.rb
+- test/govspeak_link_test.rb
 - test/html_validator_test.rb
-- test/html_sanitizer_test.rb
-- test/govspeak_attachments_inline_test.rb
-- test/govspeak_test.rb
-- test/govspeak_attachment_test.rb
-- test/govspeak_attachments_image_test.rb
-- test/presenters/h_card_presenter_test.rb
+- test/govspeak_contacts_test.rb
+- test/govspeak_test_helper.rb