govspeak 6.7.7 → 6.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeb616e6f8489b589e1ddda16e92727ec5c30a9ad76b88e89184aad8590276e3
-  data.tar.gz: cc776bc6208ca7baafce665f4c92a549f2ee6c70fa96652e81e2ed8a32a45f5a
+  metadata.gz: 5613d3c42e9347e578dd2ed9d2164c08cc81cfc70f8ade79deb56fc77069056f
+  data.tar.gz: 1157c2a33c97ae726af931714252eaa460216f1254a47449c4db187fff197c1d
 SHA512:
-  metadata.gz: cb08b6e651a21f26ae42efff15d74b80401b1dc26fd516b69b02394b9eeaa20825aa4e176ef789a35ae035bb5d8be13012fb42e35c88e1e487870c81c8c4d0af
-  data.tar.gz: 1dc3a85af8fb5ecacb8c9a530739e8f3742fa9ea79bd3830c73c2c5d36b907d737aec74e028a4df197f11e1c0bd7d55eb25e3f5d0009a22a930cfb4e0b449f50
+  metadata.gz: aa8cca4a71fd2f9b029c545714ccf032ead1fe07389ce49571aa5f14093b95bd7ae05ddc2188bea959ea60ac59c042bc0b56729b8a197782291869e7e0cf947e
+  data.tar.gz: 12dcd4d62d0b6b16a651d001145f2aaa942991c972a00720d598464633f2eb8ead57d50dc0609ed1eb6a25a328399380dac55d97aa7101cdd52483b46b6c700c

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 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)
+
 ## 6.7.7
 
 * Fix broken HTML in CTA extension. [#226](https://github.com/alphagov/govspeak/pull/226)

data/README.md

@@ -28,8 +28,7 @@ Once govspeak has been updated and version incremented then:
 
 Also, consider if:
 - [whitehall](https://github.com/alphagov/whitehall) needs updating (as custom govspeak changes are present)
-- [govuk-content-schema](https://github.com/alphagov/govuk-content-schemas) needs updating
-- [govpspeak-preview](https://github.com/alphagov/govspeak-preview) is worth updating
+- [govpspeak-preview](https://github.com/alphagov/govspeak-preview) needs updating
 
 Any pages that use govspeak to generate Content will need to *republished* in order for the new changes to be reflected.  
 

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.7".freeze
+  VERSION = "6.8.1".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
@@ -464,9 +467,10 @@ module Govspeak
     end
 
     def add_acronym_alt_text(html)
-      @acronyms.each do |acronym|
-        html.gsub!(acronym[0], "<abbr title=\"#{acronym[1].strip}\">#{acronym[0]}</abbr>")
-      end
+      # FIXME: this code is buggy and replaces abbreviations in HTML tags - removing the functionality for now
+      # @acronyms.each do |acronym|
+      #   html.gsub!(acronym[0], "<abbr title=\"#{acronym[1].strip}\">#{acronym[0]}</abbr>")
+      # end
     end
   end
 end

data/test/govspeak_test.rb

@@ -1048,43 +1048,44 @@ Teston
     )
   end
 
-  test_given_govspeak "
-    $LegislativeList
-    * 1. Item 1[^1] with an ACRONYM
-    * 2. Item 2[^2]
-    * 3. Item 3
-    $EndLegislativeList
-
-    [^1]: Footnote definition one
-    [^2]: Footnote definition two with an ACRONYM
-
-    *[ACRONYM]: This is the acronym explanation
-  " do
-    assert_html_output %(
-      <ol class="legislative-list">
-        <li>1. Item 1<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup> with an <abbr title="This is the acronym explanation">ACRONYM</abbr>
-      </li>
-        <li>2. Item 2<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>
-      </li>
-        <li>3. Item 3</li>
-      </ol>
-
-      <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 with an <abbr title="This is the acronym explanation">ACRONYM</abbr><a href="#fnref:2" 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
+  #   * 1. Item 1[^1] with an ACRONYM
+  #   * 2. Item 2[^2]
+  #   * 3. Item 3
+  #   $EndLegislativeList
+  #
+  #   [^1]: Footnote definition one
+  #   [^2]: Footnote definition two with an ACRONYM
+  #
+  #   *[ACRONYM]: This is the acronym explanation
+  # " do
+  #   assert_html_output %(
+  #     <ol class="legislative-list">
+  #       <li>1. Item 1<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="footnote">[footnote 1]</a></sup> with an <abbr title="This is the acronym explanation">ACRONYM</abbr>
+  #     </li>
+  #       <li>2. Item 2<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>
+  #     </li>
+  #       <li>3. Item 3</li>
+  #     </ol>
+  #
+  #     <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 with an <abbr title="This is the acronym explanation">ACRONYM</abbr><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 "
     The quick brown

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.7
+  version: 6.8.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-03-16 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.9
 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