govspeak 6.5.0 → 6.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 691092344fa56f8643bda4f29f8f0a18344515254b042fb15771375489395015
-  data.tar.gz: 529021924ad18fccfabda572204e59b33867578e548816ab093e2d51b30e059f
+  metadata.gz: d1153c71bd7cd224750aa162c1ea63c89a902309cd08238a888d07a60f079d89
+  data.tar.gz: a7efca4529a1c6017224a77965e45994d30eba3a3e05f6d209dadff85a516cd9
 SHA512:
-  metadata.gz: a870b551730a2a07f5a85bdb06df18b56018f3a700d21469d8c1804fe51d044ae7beb5455a8d1e332f44e003ed2d6231eb9f36fd72b0578de19cc408973074f0
-  data.tar.gz: d0b4ca4cf824216c139094d33fdd1a9ddf98800db9aa94b077b454cfce35e98713b1b6e850c63817242f5cc3e381aaa9633062d1b01c3a7450ec6a64876632ee
+  metadata.gz: 33209bc51e340ccc5a2a0dc3b43f887eddbd464b687232fb4a17c6c34ae0a3097321f7f51da3ba17762e6ad1307424204872c3374dfa99eeb0100992641f4911
+  data.tar.gz: ab00d13be257f7730b4b7c2a858a9a9eba3802148dfc851f60fdf91eb65acdb80510a5c67a1e599f2cedbf945502cf29d6567526d695872118025ebb384318f9

data/CHANGELOG.md

@@ -1,12 +1,17 @@
+## 6.5.1
+* Change unicode testing characters after external gem change
+* Move from govuk-lint to rubocop-govuk
+* Allow version 6 of actionview
+
 ## 6.5.0
 
 * Allow data attributes on links
 
 ## 6.4.0
 
- * Add table heading syntax that allows a table cell outside of `thead` to be marked as a table heading with a scope of row. (PR#161)
+* Add table heading syntax that allows a table cell outside of `thead` to be marked as a table heading with a scope of row. (PR#161)
 
- ## 6.3.0
+## 6.3.0
 
 * Unicode characters forbidden in HTML are stripped from input
 * Validation is now more lenient for HTML input

data/Rakefile

@@ -7,7 +7,7 @@ Bundler::GemHelper.install_tasks
 desc "Run basic tests"
 Rake::TestTask.new("test") { |t|
   t.libs << "test"
-  t.pattern = 'test/*_test.rb'
+  t.pattern = "test/*_test.rb"
   t.verbose = true
   t.warning = true
 }

data/lib/govspeak.rb

@@ -1,32 +1,32 @@
-require 'active_support/core_ext/hash'
-require 'active_support/core_ext/array'
-require 'erb'
-require 'govuk_publishing_components'
-require 'htmlentities'
-require 'kramdown'
-require 'kramdown/parser/govuk'
-require 'nokogiri'
-require 'nokogumbo'
-require 'rinku'
-require 'sanitize'
-require 'govspeak/header_extractor'
-require 'govspeak/structured_header_extractor'
-require 'govspeak/html_validator'
-require 'govspeak/html_sanitizer'
-require 'govspeak/kramdown_overrides'
-require 'govspeak/blockquote_extra_quote_remover'
-require 'govspeak/post_processor'
-require 'govspeak/link_extractor'
-require 'govspeak/template_renderer'
-require 'govspeak/presenters/attachment_presenter'
-require 'govspeak/presenters/contact_presenter'
-require 'govspeak/presenters/h_card_presenter'
-require 'govspeak/presenters/image_presenter'
-require 'govspeak/presenters/attachment_image_presenter'
+require "active_support/core_ext/hash"
+require "active_support/core_ext/array"
+require "erb"
+require "govuk_publishing_components"
+require "htmlentities"
+require "kramdown"
+require "kramdown/parser/govuk"
+require "nokogiri"
+require "nokogumbo"
+require "rinku"
+require "sanitize"
+require "govspeak/header_extractor"
+require "govspeak/structured_header_extractor"
+require "govspeak/html_validator"
+require "govspeak/html_sanitizer"
+require "govspeak/kramdown_overrides"
+require "govspeak/blockquote_extra_quote_remover"
+require "govspeak/post_processor"
+require "govspeak/link_extractor"
+require "govspeak/template_renderer"
+require "govspeak/presenters/attachment_presenter"
+require "govspeak/presenters/contact_presenter"
+require "govspeak/presenters/h_card_presenter"
+require "govspeak/presenters/image_presenter"
+require "govspeak/presenters/attachment_image_presenter"
 
 module Govspeak
   def self.root
-    File.expand_path('..', File.dirname(__FILE__))
+    File.expand_path("..", File.dirname(__FILE__))
   end
 
   class Document
@@ -44,8 +44,8 @@ module Govspeak
       new(source, options).to_html
     end
 
-    def self.extensions
-      @extensions
+    class << self
+      attr_reader :extensions
     end
 
     def initialize(source, options = {})
@@ -118,7 +118,7 @@ module Govspeak
     def remove_forbidden_characters(source)
       # These are characters that are not deemed not suitable for
       # markup: https://www.w3.org/TR/unicode-xml/#Charlist
-      source.gsub(Sanitize::REGEX_UNSUITABLE_CHARS, '')
+      source.gsub(Sanitize::REGEX_UNSUITABLE_CHARS, "")
     end
 
     def self.extension(title, regexp = nil, &block)
@@ -147,7 +147,7 @@ module Govspeak
       parser.new(body.strip).to_html.sub(/^<p>(.*)<\/p>$/, "<p><strong>\\1</strong></p>")
     end
 
-    extension('button', %r{
+    extension("button", %r{
       (?:\r|\n|^) # non-capturing match to make sure start of line and linebreak
       {button(.*?)} # match opening bracket and capture attributes
         \s* # any whitespace between opening bracket and link
@@ -176,51 +176,51 @@ module Govspeak
       %{\n<a role="button" class="#{button_classes}" href="#{href}" #{data_attribute}>#{text}</a>\n}
     }
 
-    extension('highlight-answer') { |body|
+    extension("highlight-answer") { |body|
       %{\n\n<div class="highlight-answer">
 #{Govspeak::Document.new(body.strip).to_html}</div>\n}
     }
 
-    extension('stat-headline', %r${stat-headline}(.*?){/stat-headline}$m) { |body|
+    extension("stat-headline", %r${stat-headline}(.*?){/stat-headline}$m) { |body|
       %{\n\n<aside class="stat-headline">
 #{Govspeak::Document.new(body.strip).to_html}</aside>\n}
     }
 
     # FIXME: these surrounded_by arguments look dodgy
-    extension('external', surrounded_by("x[", ")x")) { |body|
+    extension("external", surrounded_by("x[", ")x")) { |body|
       Kramdown::Document.new("[#{body.strip}){:rel='external'}").to_html
     }
 
-    extension('informational', surrounded_by("^")) { |body|
+    extension("informational", surrounded_by("^")) { |body|
       %{\n\n<div role="note" aria-label="Information" class="application-notice info-notice">
 #{Govspeak::Document.new(body.strip).to_html}</div>\n}
     }
 
-    extension('important', surrounded_by("@")) { |body|
+    extension("important", surrounded_by("@")) { |body|
       %{\n\n<div role="note" aria-label="Important" class="advisory">#{insert_strong_inside_p(body)}</div>\n}
     }
 
-    extension('helpful', surrounded_by("%")) { |body|
+    extension("helpful", surrounded_by("%")) { |body|
       %{\n\n<div role="note" aria-label="Warning" class="application-notice help-notice">\n#{Govspeak::Document.new(body.strip).to_html}</div>\n}
     }
 
-    extension('barchart', /{barchart(.*?)}/) do |captures|
-      stacked = '.mc-stacked' if captures.include? 'stacked'
-      compact = '.compact' if captures.include? 'compact'
-      negative = '.mc-negative' if captures.include? 'negative'
+    extension("barchart", /{barchart(.*?)}/) do |captures|
+      stacked = ".mc-stacked" if captures.include? "stacked"
+      compact = ".compact" if captures.include? "compact"
+      negative = ".mc-negative" if captures.include? "negative"
 
       [
-       '{:',
-       '.js-barchart-table',
+       "{:",
+       ".js-barchart-table",
        stacked,
        compact,
        negative,
-       '.mc-auto-outdent',
-       '}'
-      ].join(' ')
+       ".mc-auto-outdent",
+       "}",
+      ].join(" ")
     end
 
-    extension('attached-image', /^!!([0-9]+)/) do |image_number|
+    extension("attached-image", /^!!([0-9]+)/) do |image_number|
       image = images[image_number.to_i - 1]
       next "" unless image
 
@@ -228,7 +228,7 @@ module Govspeak
     end
 
     # DEPRECATED: use 'AttachmentLink:attachment-id' instead
-    extension('embed attachment inline', /\[embed:attachments:inline:\s*(.*?)\s*\]/) do |content_id|
+    extension("embed attachment inline", /\[embed:attachments:inline:\s*(.*?)\s*\]/) do |content_id|
       attachment = attachments.detect { |a| a[:content_id] == content_id }
       next "" unless attachment
 
@@ -243,7 +243,7 @@ module Govspeak
     end
 
     # DEPRECATED: use 'Image:image-id' instead
-    extension('attachment image', /\[embed:attachments:image:\s*(.*?)\s*\]/) do |content_id|
+    extension("attachment image", /\[embed:attachments:image:\s*(.*?)\s*\]/) do |content_id|
       attachment = attachments.detect { |a| a[:content_id] == content_id }
       next "" unless attachment
 
@@ -266,29 +266,29 @@ module Govspeak
       lines << %{<figure#{id_attr} class="image embedded">}
       lines << %{<div class="img"><img src="#{encode(image.url)}" alt="#{encode(image.alt_text)}"></div>}
       lines << image.figcaption_html if image.figcaption?
-      lines << '</figure>'
+      lines << "</figure>"
       lines.join
     end
 
-    wrap_with_div('summary', '$!')
-    wrap_with_div('form-download', '$D')
-    wrap_with_div('contact', '$C')
-    wrap_with_div('place', '$P', Govspeak::Document)
-    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)
+    wrap_with_div("summary", "$!")
+    wrap_with_div("form-download", "$D")
+    wrap_with_div("contact", "$C")
+    wrap_with_div("place", "$P", Govspeak::Document)
+    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")) { |body|
+    extension("address", surrounded_by("$A")) { |body|
       %{\n<div class="address"><div class="adr org fn"><p>\n#{body.sub("\n", '').gsub("\n", '<br />')}\n</p></div></div>\n}
     }
 
     extension("legislative list", /#{NEW_PARAGRAPH_LOOKBEHIND}\$LegislativeList\s*$(.*?)\$EndLegislativeList/m) do |body|
       Govspeak::KramdownOverrides.with_kramdown_ordered_lists_disabled do
         Kramdown::Document.new(body.strip).to_html.tap do |doc|
-          doc.gsub!('<ul>', '<ol>')
-          doc.gsub!('</ul>', '</ol>')
-          doc.sub!('<ol>', '<ol class="legislative-list">')
+          doc.gsub!("<ul>", "<ol>")
+          doc.gsub!("</ul>", "</ol>")
+          doc.sub!("<ol>", '<ol class="legislative-list">')
         end
       end
     end
@@ -301,12 +301,12 @@ module Govspeak
     end
 
     def self.devolved_options
-      { 'scotland' => 'Scotland',
-        'england' => 'England',
-        'england-wales' => 'England and Wales',
-        'northern-ireland' => 'Northern Ireland',
-        'wales' => 'Wales',
-        'london' => 'London' }
+      { "scotland" => "Scotland",
+        "england" => "England",
+        "england-wales" => "England and Wales",
+        "northern-ireland" => "Northern Ireland",
+        "wales" => "Wales",
+        "london" => "London" }
     end
 
     devolved_options.each do |k, v|
@@ -333,7 +333,7 @@ module Govspeak
       end
     end
 
-    extension('embed link', /\[embed:link:\s*(.*?)\s*\]/) do |content_id|
+    extension("embed link", /\[embed:link:\s*(.*?)\s*\]/) do |content_id|
       link = links.detect { |l| l[:content_id] == content_id }
       next "" unless link
 
@@ -344,28 +344,28 @@ module Govspeak
       end
     end
 
-    extension('Contact', /\[Contact:\s*(.*?)\s*\]/) do |content_id|
+    extension("Contact", /\[Contact:\s*(.*?)\s*\]/) do |content_id|
       contact = contacts.detect { |c| c[:content_id] == content_id }
       next "" unless contact
 
-      renderer = TemplateRenderer.new('contact.html.erb', locale)
+      renderer = TemplateRenderer.new("contact.html.erb", locale)
       renderer.render(contact: ContactPresenter.new(contact))
     end
 
-    extension('Image', /#{NEW_PARAGRAPH_LOOKBEHIND}\[Image:\s*(.*?)\s*\]/) do |image_id|
+    extension("Image", /#{NEW_PARAGRAPH_LOOKBEHIND}\[Image:\s*(.*?)\s*\]/) do |image_id|
       image = images.detect { |c| c.is_a?(Hash) && c[:id] == image_id }
       next "" unless image
 
       render_image(ImagePresenter.new(image))
     end
 
-    extension('Attachment', /#{NEW_PARAGRAPH_LOOKBEHIND}\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|
+    extension("Attachment", /#{NEW_PARAGRAPH_LOOKBEHIND}\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|
       next "" if attachments.none? { |a| a[:id] == attachment_id }
 
       %{<govspeak-embed-attachment id="#{attachment_id}"></govspeak-embed-attachment>}
     end
 
-    extension('AttachmentLink', /\[AttachmentLink:\s*(.*?)\s*\]/) do |attachment_id|
+    extension("AttachmentLink", /\[AttachmentLink:\s*(.*?)\s*\]/) do |attachment_id|
       next "" if attachments.none? { |a| a[:id] == attachment_id }
 
       %{<govspeak-embed-attachment-link id="#{attachment_id}"></govspeak-embed-attachment-link>}
@@ -384,5 +384,5 @@ module Govspeak
 end
 
 I18n.load_path.unshift(
-  *Dir.glob(File.expand_path('locales/*.yml', Govspeak.root))
+  *Dir.glob(File.expand_path("locales/*.yml", Govspeak.root)),
 )

data/lib/govspeak/header_extractor.rb

@@ -20,7 +20,7 @@ module Govspeak
   private
 
     def id(element)
-      element.attr.fetch('id', generate_id(element.options[:raw_text]))
+      element.attr.fetch("id", generate_id(element.options[:raw_text]))
     end
 
     def build_header(element)

data/lib/govspeak/html_sanitizer.rb

@@ -1,4 +1,4 @@
-require 'addressable/uri'
+require "addressable/uri"
 
 class Govspeak::HtmlSanitizer
   class ImageSourceWhitelister
@@ -10,7 +10,7 @@ class Govspeak::HtmlSanitizer
       return unless sanitize_context[:node_name] == "img"
 
       node = sanitize_context[:node]
-      image_uri = Addressable::URI.parse(node['src'])
+      image_uri = Addressable::URI.parse(node["src"])
       unless image_uri.relative? || @allowed_image_hosts.include?(image_uri.host)
         node.unlink # the node isn't sanitary. Remove it from the document.
       end
@@ -25,8 +25,8 @@ class Govspeak::HtmlSanitizer
 
       # Kramdown uses text-align to allow table cells to be aligned
       # http://kramdown.gettalong.org/quickref.html#tables
-      if invalid_style_attribute?(node['style'])
-        node.remove_attribute('style')
+      if invalid_style_attribute?(node["style"])
+        node.remove_attribute("style")
       end
     end
 
@@ -58,7 +58,7 @@ class Govspeak::HtmlSanitizer
         "th"  => Sanitize::Config::RELAXED[:attributes]["th"] + %w[style],
         "td"  => Sanitize::Config::RELAXED[:attributes]["td"] + %w[style],
         "govspeak-embed-attachment" => %w[content-id],
-      }
+      },
     )
   end
 end

data/lib/govspeak/link_extractor.rb

@@ -20,8 +20,8 @@ module Govspeak
     end
 
     def extract_href_from_link(link)
-      href = link['href'] || ''
-      if website_root && href.start_with?('/')
+      href = link["href"] || ""
+      if website_root && href.start_with?("/")
         "#{website_root}#{href}"
       else
         href
@@ -29,7 +29,7 @@ module Govspeak
     end
 
     def document_anchors
-      processed_govspeak.css('a[href]').css('a:not([href^="mailto"])').css('a:not([href^="#"])')
+      processed_govspeak.css("a[href]").css('a:not([href^="mailto"])').css('a:not([href^="#"])')
     end
 
     def processed_govspeak

data/lib/govspeak/post_processor.rb

@@ -2,8 +2,8 @@ module Govspeak
   class PostProcessor
     @extensions = []
 
-    def self.extensions
-      @extensions
+    class << self
+      attr_reader :extensions
     end
 
     def self.process(html, govspeak_document)
@@ -38,11 +38,11 @@ module Govspeak
         el.children = xml
           .gsub(
             %r{&lt;(div class="img")&gt;(.*?)&lt;(/div)&gt;},
-            "<\\1>\\2<\\3>"
+            "<\\1>\\2<\\3>",
           )
           .gsub(
             %r{&lt;(figcaption)&gt;(.*?)&lt;(/figcaption&)gt;},
-            "<\\1>\\2<\\3>"
+            "<\\1>\\2<\\3>",
           )
       end
     end
@@ -59,7 +59,7 @@ module Govspeak
         attachment_html = GovukPublishingComponents.render(
           "govuk_publishing_components/components/attachment",
           attachment: attachment,
-          locale: govspeak_document.locale
+          locale: govspeak_document.locale,
         )
         el.swap(attachment_html)
       end
@@ -77,7 +77,7 @@ module Govspeak
         attachment_html = GovukPublishingComponents.render(
           "govuk_publishing_components/components/attachment_link",
           attachment: attachment,
-          locale: govspeak_document.locale
+          locale: govspeak_document.locale,
         )
         el.swap(attachment_html)
       end
@@ -85,17 +85,17 @@ module Govspeak
 
     extension("Add table headers and row / column scopes") do |document|
       document.css("thead th").map do |el|
-        el.content = el.content.gsub(/^# /, '')
-        el.content = el.content.gsub(/[[:space:]]/, '') if el.content.blank? # Removes a strange whitespace in the cell if the cell is already blank.
-        el.name = 'td' if el.content.blank? # This prevents a `th` with nothing inside it; a `td` is preferable.
+        el.content = el.content.gsub(/^# /, "")
+        el.content = el.content.gsub(/[[:space:]]/, "") if el.content.blank? # Removes a strange whitespace in the cell if the cell is already blank.
+        el.name = "td" if el.content.blank? # This prevents a `th` with nothing inside it; a `td` is preferable.
         el[:scope] = "col" if el.content.present? # `scope` shouldn't be used if there's nothing in the table heading.
       end
 
       document.css(":not(thead) tr td:first-child").map do |el|
         if el.content.match?(/^#($|\s.*$)/)
-          el.content = el.content.gsub(/^#($|\s)/, '') # Replace '# ' and '#', but not '#Word'.
-          el.name = 'th' if el.content.present? # This also prevents a `th` with nothing inside it; a `td` is preferable.
-          el[:scope] = 'row' if el.content.present? # `scope` shouldn't be used if there's nothing in the table heading.
+          el.content = el.content.gsub(/^#($|\s)/, "") # Replace '# ' and '#', but not '#Word'.
+          el.name = "th" if el.content.present? # This also prevents a `th` with nothing inside it; a `td` is preferable.
+          el[:scope] = "row" if el.content.present? # `scope` shouldn't be used if there's nothing in the table heading.
         end
       end
     end