govspeak 6.5.5 → 6.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99554d6b3b3fd3287b35eebe6ff4633d6e3df24f74bede69fd65c16a81a41584
-  data.tar.gz: 300af892bfebf34b74161432f49d93131bde2d533354fd2580204c3d341b8031
+  metadata.gz: 3e54143d6d1df165694cae9c5ffeef35267bf25fb91d999e9e8b46dd0b76877f
+  data.tar.gz: a01f9c44fec457bc296fd217c51b4e4b332728895c0ade749b26190ff74528c0
 SHA512:
-  metadata.gz: 033a7f0ac2134f8a7912fbb38033a07b8f51370d5631b1e6342a7b04d451b50540fc3874c5b3153af4a18b8ce892fa9f16d24ee6909ba339d2888423ea577199
-  data.tar.gz: df16ff9574a2b759b0bb75e53475e08b7164166af97e28d900ed1f44407826d4156ec7441bb07363362740542f698244dc78a712f4b4c1b59e9570ec598685e5
+  metadata.gz: 42dbc03399dde648c4a89f2237ba0e7320d066d20cd8ce8d0b05caee2ef5bb69af7cbfc1aebe60a1577a04fc8fc63769fe5f4b284232fea317f45775599694bd
+  data.tar.gz: b96148ecb4e143bab160517d4c997782a946f3ba75a8ce045ad2ce0893a578aa8d83df275e7239d0bb0a335bf3486e386d0c901a29328eddd26fd39b7c6b9e7c

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 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
+
 ## 6.5.5
 
 * Prevent links in table headers being stripped (PR#187)

data/lib/govspeak.rb

@@ -57,7 +57,9 @@ module Govspeak
       @links = Array.wrap(options.delete(:links))
       @contacts = Array.wrap(options.delete(:contacts))
       @locale = options.fetch(:locale, "en")
-      @options = { input: PARSER_CLASS_NAME, sanitize: true }.merge(options)
+      @options = { input: PARSER_CLASS_NAME,
+                   sanitize: true,
+                   syntax_highlighter: nil }.merge(options)
       @options[:entity_output] = :symbolic
     end
 

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.5".freeze
+  VERSION = "6.5.10".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/blockquote_extra_quote_remover_test.rb

@@ -12,7 +12,7 @@ class BlockquoteExtraQuoteRemoverTest < Minitest::Test
   end
 
   test "ignores nil" do
-    assert_leaves_untouched nil
+    assert_nil Govspeak::BlockquoteExtraQuoteRemover.remove(nil)
   end
 
   test "ignores text without double quotes" do

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.5.5
+  version: 6.5.10
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-11-10 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,30 +82,30 @@ 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
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -200,30 +200,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     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/blockquote_extra_quote_remover_test.rb
-- test/govspeak_test_helper.rb
-- test/govspeak_structured_headers_test.rb
-- test/govspeak_attachment_link_test.rb
-- test/govspeak_attachments_image_test.rb
-- test/test_helper.rb
-- test/govspeak_attachments_inline_test.rb
-- test/html_sanitizer_test.rb
-- test/govspeak_button_test.rb
 - test/govspeak_images_bang_test.rb
-- test/govspeak_images_test.rb
-- test/html_validator_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_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/govspeak_link_extractor_test.rb
+- test/html_sanitizer_test.rb
+- test/govspeak_footnote_test.rb
+- test/blockquote_extra_quote_remover_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/govspeak_contacts_test.rb
-- test/presenters/h_card_presenter_test.rb
-- test/govspeak_table_with_headers_test.rb
+- test/govspeak_test_helper.rb