govspeak 6.7.8 → 6.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709c3fbb62a1b1e54cae82fd1539785acaaf3586c0a094b402880bf4608df065
-  data.tar.gz: 1300878c1001b40ade71a2e5446ea1f62ea8cd1e5d764e97ef9450da6124d74a
+  metadata.gz: a8509b4c394ef305fd80454c6c6bdb13561332bcdedc5d0292c271387a34043c
+  data.tar.gz: a73d8175cbea307d6b8028931bd15e9b99b97f7ae7708247cc833873622a8574
 SHA512:
-  metadata.gz: dcf825ebf9e77452c200104606486d9c0ad26c5f00855ce69c3c127d5e6cd7357d804fb3df77b3362fe797e814ed2cffe3823c2a835d1784e89b25c459abfd12
-  data.tar.gz: 607b7b974bf443801e83ec7afaab1449e00a50d63134dc90b912f62a5a5c0635ea2e54afece268dbe6c4471cc232c4f12033bef6f8961aee1816a4cd6f1fcc25
+  metadata.gz: ae280e29132e39a4d85f6f095bfd45cfc0da7505b7148e0b48756c4c9fccd29af2a550257a6f972837b8f1c1495f817ee61653ee069db868e66fc5a149386553
+  data.tar.gz: d3e0c5858ebe636a50d44bb360c68bc2bee4cad547529872c51be3f42a5630d5444ccc29e4ef5437d096ecdc43386f18c27363f9bcfbeff801a86fb3f6bbc486

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 6.8.2
+
+* Fix footnote numbering [#239](https://github.com/alphagov/govspeak/pull/239)
+
+## 6.8.1
+
+* Fix a bug which resulted in validation errors on 'Start Button' elements [#237](https://github.com/alphagov/govspeak/pull/237)
+
+## 6.8.0
+
+* Drop support for Ruby 2.6 which reaches End of Life (EOL) on 31/03/2022
+* Add support for Rails 7 by loosening the version constraint on `activeview` gem
+* Fix deprecation notices caused by the bump in Ruby version
+
 ## 6.7.8
 
 * Fixes bug which reverts acronyms from being converted into abbr tags [#229](https://github.com/alphagov/govspeak/pull/229)

data/lib/govspeak/html_sanitizer.rb

@@ -46,7 +46,17 @@ class Govspeak::HtmlSanitizer
       transformers << ImageSourceWhitelister.new(@allowed_image_hosts)
     end
 
-    Sanitize.clean(@dirty_html, Sanitize::Config.merge(sanitize_config(allowed_elements: allowed_elements), transformers: transformers))
+    # It would be cleaner to move this `transformers` key into the `sanitize_config` method rather
+    # than having to use Sanitize::Config.merge() twice in succession. However, `sanitize_config`
+    # is a public method and it looks like other projects depend on it behaving the way it
+    # currently does – i.e. to return Sanitize config without any transformers.
+    # e.g. https://github.com/alphagov/hmrc-manuals-api/blob/4a83f78d0bb839520155623fd9b63b3b12a3b13a/app/validators/no_dangerous_html_in_text_fields_validator.rb#L44
+    config_with_transformers = Sanitize::Config.merge(
+      sanitize_config(allowed_elements: allowed_elements),
+      transformers: transformers,
+    )
+
+    Sanitize.clean(@dirty_html, config_with_transformers)
   end
 
   def sanitize_config(allowed_elements: [])

data/lib/govspeak/html_validator.rb

@@ -1,9 +1,9 @@
 class Govspeak::HtmlValidator
   attr_reader :govspeak_string
 
-  def initialize(govspeak_string, sanitization_options = {})
+  def initialize(govspeak_string, options = {})
     @govspeak_string = govspeak_string.dup.force_encoding(Encoding::UTF_8)
-    @sanitization_options = sanitization_options
+    @allowed_image_hosts = options[:allowed_image_hosts]
   end
 
   def invalid?
@@ -11,17 +11,23 @@ class Govspeak::HtmlValidator
   end
 
   def valid?
-    dirty_html = govspeak_to_html
-    clean_html = Govspeak::HtmlSanitizer.new(dirty_html, @sanitization_options).sanitize
+    dirty_html = govspeak_to_html(sanitize: false)
+    clean_html = govspeak_to_html(sanitize: true)
     normalise_html(dirty_html) == normalise_html(clean_html)
   end
 
+private
+
   # Make whitespace in html tags consistent
   def normalise_html(html)
     Nokogiri::HTML5.fragment(html).to_s
   end
 
-  def govspeak_to_html
-    Govspeak::Document.new(govspeak_string, sanitize: false).to_html
+  def govspeak_to_html(sanitize:)
+    Govspeak::Document.new(
+      govspeak_string,
+      sanitize: sanitize,
+      allowed_image_hosts: @allowed_image_hosts,
+    ).to_html
   end
 end

data/lib/govspeak/template_renderer.rb

@@ -17,7 +17,7 @@ module Govspeak
     def t(*args)
       options = args.last.is_a?(Hash) ? args.last.dup : {}
       key = args.shift
-      I18n.t!(key, options.merge(locale: locale))
+      I18n.t!(key, **options.merge(locale: locale))
     end
 
     def format_with_html_line_breaks(string)

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.7.8".freeze
+  VERSION = "6.8.2".freeze
 end

data/lib/govspeak.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/array"
 require "erb"
@@ -53,6 +54,7 @@ module Govspeak
 
       @images = options.delete(:images) || []
       @allowed_elements = options.delete(:allowed_elements) || []
+      @allowed_image_hosts = options.delete(:allowed_image_hosts) || []
       @attachments = Array.wrap(options.delete(:attachments))
       @links = Array.wrap(options.delete(:links))
       @contacts = Array.wrap(options.delete(:contacts))
@@ -68,7 +70,8 @@ module Govspeak
     def to_html
       @to_html ||= begin
         html = if @options[:sanitize]
-                 HtmlSanitizer.new(kramdown_doc.to_html).sanitize(allowed_elements: @allowed_elements)
+                 HtmlSanitizer.new(kramdown_doc.to_html, allowed_image_hosts: @allowed_image_hosts)
+                              .sanitize(allowed_elements: @allowed_elements)
                else
                  kramdown_doc.to_html
                end
@@ -135,7 +138,7 @@ module Govspeak
     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+)\]:(.*)/)
+      footnotes = source.scan(/^\s*\[\^(\d+)\]:(.*)/)
       @acronyms = source.scan(/(?<=\*)\[(.*)\]:(.*)/)
       if (is_legislative_list || is_cta) && footnotes.size.positive?
         list_items = footnotes.map do |footnote|

data/test/govspeak_test.rb

@@ -1048,6 +1048,48 @@ Teston
     )
   end
 
+  test_given_govspeak "
+    $LegislativeList
+    1.  some text[^1]:
+    $EndLegislativeList
+    [^1]: footnote text
+  " do
+    assert_html_output %(
+      <p>1.  some text<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup>:</p>
+
+      <div class="footnotes" role="doc-endnotes">
+        <ol>
+          <li id="fn:1" role="doc-endnote">
+        <p>
+          footnote text<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 "
+    $LegislativeList
+    1.  some text[^1]: extra
+    $EndLegislativeList
+    [^1]: footnote text
+    " do
+      assert_html_output %(
+      <p>1.  some text<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup>: extra</p>
+
+      <div class="footnotes" role="doc-endnotes">
+        <ol>
+          <li id="fn:1" role="doc-endnote">
+        <p>
+          footnote text<a href="#fnref:1" 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

data/test/test_helper.rb

@@ -1,8 +1,6 @@
 require "simplecov"
-require "simplecov-rcov"
 
 SimpleCov.start
-SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
 
 $LOAD_PATH.unshift(File.expand_path("../lib")) unless $LOAD_PATH.include?(File.expand_path("../lib"))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.7.8
+  version: 6.8.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -194,16 +188,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -218,20 +212,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-rcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   A set of extensions to markdown layered on top of the kramdown
   library for use in the UK Government Single Domain project
@@ -340,36 +320,36 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.10
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/test_helper.rb
+- test/govspeak_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_images_test.rb
+- test/govspeak_link_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
-- test/govspeak_test_helper.rb
 - test/govspeak_footnote_test.rb
-- test/govspeak_link_test.rb
+- test/presenters/h_card_presenter_test.rb
+- test/govspeak_attachments_inline_test.rb
 - test/govspeak_structured_headers_test.rb
+- test/test_helper.rb
+- test/govspeak_button_test.rb
+- test/govspeak_attachment_test.rb
 - test/html_sanitizer_test.rb
-- test/govspeak_images_test.rb
+- test/govspeak_contacts_test.rb
+- test/govspeak_attachments_image_test.rb
+- test/govspeak_images_bang_test.rb
 - test/govspeak_test.rb
+- test/govspeak_table_with_headers_test.rb
+- test/html_validator_test.rb
 - test/govspeak_attachment_link_test.rb
-- test/govspeak_attachment_test.rb
-- test/presenters/h_card_presenter_test.rb
-- test/govspeak_attachments_inline_test.rb