govspeak 6.5.7 → 6.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6cd5f76c1c1a80f74d86785f10b591bdfc1f75f2e6b2dcf874e8b39ab0e213c
-  data.tar.gz: 4be63d972c6fd0acd9a09120930760230e45ffd59522689177602d977b9443ba
+  metadata.gz: 26ef4d3bfb3ed9dcf07d44a1428e815928a4fa1ee94f388de829bb999b3cd79c
+  data.tar.gz: c2982f083911dcaf38a0883d48e9ca302a3b514b7bc05b99b827830c02db884d
 SHA512:
-  metadata.gz: 6ef225809fc1434259a89d44f5d5c48f9afed99dabe5b81306347a19fe50df08ecbc1c906fa2ee704a9f63b3d9448d88ddeaa1ef110a49c99ba6441da299a0c5
-  data.tar.gz: ce7ec875cb1b33b353469846ba9c5226fbffc13551ef74cb92508e5ca7f76f1519b1c6a9b288d9978b52c16cc9fa9cb7c7500c5f3fedbc35c9c846e0faa029e2
+  metadata.gz: f75532f9905ae86df812be38a837d60abe1007cad72e8d886c95019f2563734a9e136368b74c1d1499d41bc8c83b2c3a41f415128c93c7025c4f4aacb9765e6f
+  data.tar.gz: e6ef52ca611f2b3e74e77a3330ddaf602385eb90685b3839c8bd28f4bdf06c21652c50cff4a85fc2b157e8e009e11c5ce9c7c439a92d5abdf78821725fbaba2c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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

data/lib/govspeak/post_processor.rb

@@ -120,6 +120,16 @@ 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|
+        el.content = "[go to where this is referenced]"
+      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.7".freeze
+  VERSION = "6.5.8".freeze
 end

data/test/govspeak_footnote_test.rb

@@ -0,0 +1,31 @@
+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." 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>
+
+      <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">[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">[go to where this is referenced]</a></p>
+          </li>
+        </ol>
+      </div>'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.5.7
+  version: 6.5.8
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -54,16 +54,22 @@ dependencies:
   name: govuk_publishing_components
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '23.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 23.0.0
+        version: '23.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '23.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 23.0.0
+        version: '23.4'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +342,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
@@ -371,23 +378,24 @@ signing_key:
 specification_version: 4
 summary: Markup language for single domain
 test_files:
+- test/govspeak_footnote_test.rb
+- test/html_sanitizer_test.rb
+- test/govspeak_test.rb
 - test/test_helper.rb
 - test/blockquote_extra_quote_remover_test.rb
-- test/govspeak_images_bang_test.rb
-- test/govspeak_contacts_test.rb
-- test/govspeak_table_with_headers_test.rb
-- test/govspeak_link_extractor_test.rb
-- test/govspeak_attachments_image_test.rb
-- test/html_validator_test.rb
 - test/govspeak_button_test.rb
-- test/govspeak_extract_contact_content_ids_test.rb
-- test/govspeak_test_helper.rb
+- test/html_validator_test.rb
+- test/govspeak_link_extractor_test.rb
+- test/govspeak_attachment_link_test.rb
 - test/govspeak_link_test.rb
+- test/govspeak_contacts_test.rb
 - test/govspeak_structured_headers_test.rb
-- test/html_sanitizer_test.rb
 - test/govspeak_images_test.rb
-- test/govspeak_test.rb
-- test/govspeak_attachment_link_test.rb
+- test/govspeak_extract_contact_content_ids_test.rb
+- test/govspeak_table_with_headers_test.rb
 - test/govspeak_attachment_test.rb
-- test/presenters/h_card_presenter_test.rb
 - test/govspeak_attachments_inline_test.rb
+- test/presenters/h_card_presenter_test.rb
+- test/govspeak_test_helper.rb
+- test/govspeak_images_bang_test.rb
+- test/govspeak_attachments_image_test.rb