govspeak 6.5.0 → 6.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 691092344fa56f8643bda4f29f8f0a18344515254b042fb15771375489395015
-  data.tar.gz: 529021924ad18fccfabda572204e59b33867578e548816ab093e2d51b30e059f
+  metadata.gz: 99554d6b3b3fd3287b35eebe6ff4633d6e3df24f74bede69fd65c16a81a41584
+  data.tar.gz: 300af892bfebf34b74161432f49d93131bde2d533354fd2580204c3d341b8031
 SHA512:
-  metadata.gz: a870b551730a2a07f5a85bdb06df18b56018f3a700d21469d8c1804fe51d044ae7beb5455a8d1e332f44e003ed2d6231eb9f36fd72b0578de19cc408973074f0
-  data.tar.gz: d0b4ca4cf824216c139094d33fdd1a9ddf98800db9aa94b077b454cfce35e98713b1b6e850c63817242f5cc3e381aaa9633062d1b01c3a7450ec6a64876632ee
+  metadata.gz: 033a7f0ac2134f8a7912fbb38033a07b8f51370d5631b1e6342a7b04d451b50540fc3874c5b3153af4a18b8ce892fa9f16d24ee6909ba339d2888423ea577199
+  data.tar.gz: df16ff9574a2b759b0bb75e53475e08b7164166af97e28d900ed1f44407826d4156ec7441bb07363362740542f698244dc78a712f4b4c1b59e9570ec598685e5

data/CHANGELOG.md

@@ -1,12 +1,34 @@
+## 6.5.5
+
+* Prevent links in table headers being stripped (PR#187)
+
+## 6.5.4
+
+* Require Sanitize to be at least 5.2.1 due to https://nvd.nist.gov/vuln/detail/CVE-2020-4054
+
+## 6.5.3
+
+* Use button component for buttons (PR#176)
+
+## 6.5.2
+
+* Allow `data` attributes on `div` tags (PR#173)
+
+## 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/README.md

@@ -619,8 +619,7 @@ will output
 
 An accessible way to add button links into content, that can also allow cross domain tracking with [Google Analytics](https://support.google.com/analytics/answer/7372977?hl=en)
 
-This button component is [extended from static](http://govuk-static.herokuapp.com/component-guide/button) for [use in govspeak](http://govuk-static.herokuapp.com/component-guide/govspeak/button)
-Note: Ideally we'd use the original component directly but this currently isnt possible
+This button component uses the component from the [components gem](https://components.publishing.service.gov.uk/component-guide/button) for use in govspeak.
 
 You must use the [link](https://daringfireball.net/projects/markdown/syntax#link) syntax within the button tags.
 
@@ -635,7 +634,7 @@ To get the most basic button.
 which outputs
 
 ```html
-<a role="button" class="button" href="https://gov.uk/random">
+<a role="button" class="gem-c-button govuk-button" href="https://gov.uk/random">
   Continue
 </a>
 ```
@@ -649,8 +648,9 @@ To turn a button into a ['Start now' button](https://www.gov.uk/service-manual/d
 which outputs
 
 ```html
-<a role="button" class="button button-start" href="https://gov.uk/random">
+<a role="button" class="gem-c-button govuk-button govuk-button--start" href="https://gov.uk/random">
   Start Now
+  <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg>
 </a>
 ```
 
@@ -667,12 +667,13 @@ which outputs
 ```html
 <a
   role="button"
-  class="button button-start"
+  class="gem-c-button govuk-button govuk-button--start"
   href="https://example.com/external-service/start-now"
   data-module="cross-domain-tracking"
   data-tracking-code="UA-XXXXXX-Y"
   data-tracking-name="govspeakButtonTracker"
 >
   Start Now
+  <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg>
 </a>
 ```

data/Rakefile

@@ -1,15 +1,18 @@
 require "rake"
 require "rake/testtask"
+require "rubocop/rake_task"
 require "bundler"
 
 Bundler::GemHelper.install_tasks
 
+RuboCop::RakeTask.new
+
 desc "Run basic tests"
-Rake::TestTask.new("test") { |t|
+Rake::TestTask.new("test") do |t|
   t.libs << "test"
-  t.pattern = 'test/*_test.rb'
+  t.pattern = "test/*_test.rb"
   t.verbose = true
   t.warning = true
-}
+end
 
-task default: [:test]
+task default: %i[test rubocop]

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 = {})
@@ -108,9 +108,9 @@ module Govspeak
       source = Govspeak::BlockquoteExtraQuoteRemover.remove(source)
       source = remove_forbidden_characters(source)
       self.class.extensions.each do |_, regexp, block|
-        source.gsub!(regexp) {
+        source.gsub!(regexp) do
           instance_exec(*Regexp.last_match.captures, &block)
-        }
+        end
       end
       source
     end
@@ -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)
@@ -127,27 +127,27 @@ module Govspeak
     end
 
     def self.surrounded_by(open, close = nil)
-      open = Regexp::escape(open)
+      open = Regexp.escape(open)
       if close
-        close = Regexp::escape(close)
-        %r+(?:\r|\n|^)#{open}(.*?)#{close} *(\r|\n|$)?+m
+        close = Regexp.escape(close)
+        %r{(?:\r|\n|^)#{open}(.*?)#{close} *(\r|\n|$)?}m
       else
-        %r+(?:\r|\n|^)#{open}(.*?)#{open}? *(\r|\n|$)+m
+        %r{(?:\r|\n|^)#{open}(.*?)#{open}? *(\r|\n|$)}m
       end
     end
 
     def self.wrap_with_div(class_name, character, parser = Kramdown::Document)
-      extension(class_name, surrounded_by(character)) { |body|
+      extension(class_name, surrounded_by(character)) do |body|
         content = parser ? parser.new("#{body.strip}\n").to_html : body.strip
-        %{\n<div class="#{class_name}">\n#{content}</div>\n}
-      }
+        %(\n<div class="#{class_name}">\n#{content}</div>\n)
+      end
     end
 
     def insert_strong_inside_p(body, parser = Govspeak::Document)
       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
@@ -160,11 +160,11 @@ module Govspeak
         \s*  # any whitespace between opening bracket and link
       {\/button} # match ending bracket
       (?:\r|\n|$) # non-capturing match to make sure end of line and linebreak
-    }x) { |attributes, text, href|
-      button_classes = "button"
-      button_classes << " button-start" if attributes =~ /start/
+    }x) do |attributes, text, href|
+      button_classes = "govuk-button"
       /cross-domain-tracking:(?<cross_domain_tracking>.[^\s*]+)/ =~ attributes
       data_attribute = ""
+      data_attribute << " data-start='true'" if attributes =~ /start/
       if cross_domain_tracking
         data_attribute << " data-module='cross-domain-tracking'"
         data_attribute << " data-tracking-code='#{cross_domain_tracking.strip}'"
@@ -173,54 +173,54 @@ module Govspeak
       text = text.strip
       href = href.strip
 
-      %{\n<a role="button" class="#{button_classes}" href="#{href}" #{data_attribute}>#{text}</a>\n}
-    }
+      %(\n<a role="button" class="#{button_classes}" href="#{href}" #{data_attribute}>#{text}</a>\n)
+    end
 
-    extension('highlight-answer') { |body|
-      %{\n\n<div class="highlight-answer">
-#{Govspeak::Document.new(body.strip).to_html}</div>\n}
-    }
+    extension("highlight-answer") do |body|
+      %(\n\n<div class="highlight-answer">
+#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+    end
 
-    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}
-    }
+    extension("stat-headline", %r${stat-headline}(.*?){/stat-headline}$m) do |body|
+      %(\n\n<aside class="stat-headline">
+#{Govspeak::Document.new(body.strip).to_html}</aside>\n)
+    end
 
     # FIXME: these surrounded_by arguments look dodgy
-    extension('external', surrounded_by("x[", ")x")) { |body|
+    extension("external", surrounded_by("x[", ")x")) do |body|
       Kramdown::Document.new("[#{body.strip}){:rel='external'}").to_html
-    }
+    end
 
-    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("informational", surrounded_by("^")) do |body|
+      %(\n\n<div role="note" aria-label="Information" class="application-notice info-notice">
+#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+    end
 
-    extension('important', surrounded_by("@")) { |body|
-      %{\n\n<div role="note" aria-label="Important" class="advisory">#{insert_strong_inside_p(body)}</div>\n}
-    }
+    extension("important", surrounded_by("@")) do |body|
+      %(\n\n<div role="note" aria-label="Important" class="advisory">#{insert_strong_inside_p(body)}</div>\n)
+    end
 
-    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("helpful", surrounded_by("%")) do |body|
+      %(\n\n<div role="note" aria-label="Warning" class="application-notice help-notice">\n#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+    end
 
-    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',
-       stacked,
-       compact,
-       negative,
-       '.mc-auto-outdent',
-       '}'
-      ].join(' ')
+        "{:",
+        ".js-barchart-table",
+        stacked,
+        compact,
+        negative,
+        ".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,22 +228,22 @@ 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
 
       attachment = AttachmentPresenter.new(attachment)
 
-      span_id = attachment.id ? %{ id="attachment_#{attachment.id}"} : ""
+      span_id = attachment.id ? %( id="attachment_#{attachment.id}") : ""
       # new lines inside our title cause problems with govspeak rendering as this is expected to be on one line.
       title = (attachment.title || "").tr("\n", " ")
       link = attachment.link(title, attachment.url)
       attributes = attachment.attachment_attributes.empty? ? "" : " (#{attachment.attachment_attributes})"
-      %{<span#{span_id} class="attachment-inline">#{link}#{attributes}</span>}
+      %(<span#{span_id} class="attachment-inline">#{link}#{attributes}</span>)
     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
 
@@ -261,52 +261,52 @@ module Govspeak
     #
     # This issue is not considered a bug by kramdown: https://github.com/gettalong/kramdown/issues/191
     def render_image(image)
-      id_attr = image.id ? %{ id="attachment_#{image.id}"} : ""
+      id_attr = image.id ? %( id="attachment_#{image.id}") : ""
       lines = []
-      lines << %{<figure#{id_attr} class="image embedded">}
-      lines << %{<div class="img"><img src="#{encode(image.url)}" alt="#{encode(image.alt_text)}"></div>}
+      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|
-      %{\n<div class="address"><div class="adr org fn"><p>\n#{body.sub("\n", '').gsub("\n", '<br />')}\n</p></div></div>\n}
-    }
+    extension("address", surrounded_by("$A")) do |body|
+      %(\n<div class="address"><div class="adr org fn"><p>\n#{body.sub("\n", '').gsub("\n", '<br />')}\n</p></div></div>\n)
+    end
 
     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
 
     extension("numbered list", /^[ \t]*((s\d+\.\s.*(?:\n|$))+)/) do |body|
       body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do
-        "<li>#{Govspeak::Document.new($2.strip).to_html}</li>\n"
+        "<li>#{Govspeak::Document.new(Regexp.last_match(2).strip).to_html}</li>\n"
       end
-      %{<ol class="steps">\n#{body}</ol>}
+      %(<ol class="steps">\n#{body}</ol>)
     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,31 +344,31 @@ 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>}
+      %(<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>}
+      %(<govspeak-embed-attachment-link id="#{attachment_id}"></govspeak-embed-attachment-link>)
     end
 
   private
@@ -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)),
 )