govspeak 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e0eb446c6565462c24ad3f78801c202917e9b20
-  data.tar.gz: 16455957358cc36b9e743974e885c61b48259227
+SHA256:
+  metadata.gz: c250f0022f95612e9050bc43e02f6af31655be6565d682c6eccea811c6a1988f
+  data.tar.gz: fcfe4cda98fa73030bcb4136c188b3e40e2dd66a0d2ecc51fb85fa9907aa68a0
 SHA512:
-  metadata.gz: 4e89a5cc8e001699815ea701efef079fbf2ede8a25b99a0493f880135919c913f2186a3a2745fb4bd9bfa2331da156ba0b86da7e5b5a206eca4665dcf55a94a0
-  data.tar.gz: e5295b34106249a7bc73751852688f0e00a80242380eaa6a09c94b2e185f6d5648132881148fdbc2d6658cbadd5b4352da340a7c89e5cdadf3b990b7654fa41b
+  metadata.gz: a4b73be188a3c99f33c02993c7dac9a6771e70d7c3d790b070da2c62208614dde600ce4c290a1906059d1bffd4a65c03796ff1996ff699a23ab706c9c950cd54
+  data.tar.gz: 7cc81ad911890c7baa0c1119b1733fad6e90b05d85ee748740e97fc82de093be9419bb909a51f80f94b9638f342889cc367c42a584ea191367812dbee496ce8c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 5.7.0
+
+* Update ActionView to 5.x
+* Fix translation files not loading when gem is used in an app
+* Change the data inputted into Contacts to match contacts schema [#130](https://github.com/alphagov/govspeak/pull/130)
+
 ## 5.6.0
 
 * Update sanitize version to 4.6.x [#127](https://github.com/alphagov/govspeak/issues/127)

data/Rakefile

@@ -12,10 +12,4 @@ Rake::TestTask.new("test") { |t|
   t.warning = true
 }
 
-require "gem_publisher"
-task :publish_gem do |t|
-  gem = GemPublisher.publish_if_updated("govspeak.gemspec", :rubygems)
-  puts "Published #{gem}" if gem
-end
-
-task :default => [:test]
+task default: [:test]

data/bin/govspeak

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path("../../lib", __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "govspeak/cli"

data/lib/govspeak.rb

@@ -4,6 +4,7 @@ require 'erb'
 require 'htmlentities'
 require 'kramdown'
 require 'kramdown/parser/kramdown_with_automatic_external_links'
+require 'rinku'
 require 'govspeak/header_extractor'
 require 'govspeak/structured_header_extractor'
 require 'govspeak/html_validator'
@@ -16,14 +17,18 @@ require 'govspeak/presenters/attachment_presenter'
 require 'govspeak/presenters/contact_presenter'
 require 'govspeak/presenters/h_card_presenter'
 
+
 module Govspeak
+  def self.root
+    File.expand_path('..', File.dirname(__FILE__))
+  end
 
   class Document
-
     Parser = Kramdown::Parser::KramdownWithAutomaticExternalLinks
     PARSER_CLASS_NAME = Parser.name.split("::").last
+    UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.freeze
 
-    @@extensions = []
+    @extensions = []
 
     attr_accessor :images
     attr_reader :attachments, :contacts, :links, :locale
@@ -32,6 +37,10 @@ module Govspeak
       new(source, options).to_html
     end
 
+    def self.extensions
+      @extensions
+    end
+
     def initialize(source, options = {})
       options = options.dup.deep_symbolize_keys
       @source = source ? source.dup : ""
@@ -40,25 +49,12 @@ module Govspeak
       @links = Array.wrap(options.delete(:links))
       @contacts = Array.wrap(options.delete(:contacts))
       @locale = options.fetch(:locale, "en")
-      @options = {input: PARSER_CLASS_NAME}.merge(options)
+      @options = { input: PARSER_CLASS_NAME }.merge(options)
       @options[:entity_output] = :symbolic
-      i18n_load_paths
-    end
-
-    def i18n_load_paths
-      Dir.glob('locales/*.yml') do |f|
-        I18n.load_path << f
-      end
-    end
-    private :i18n_load_paths
-
-    def kramdown_doc
-      @kramdown_doc ||= Kramdown::Document.new(preprocess(@source), @options)
     end
-    private :kramdown_doc
 
     def to_html
-      @html ||= Govspeak::PostProcessor.process(kramdown_doc.to_html)
+      @to_html ||= Govspeak::PostProcessor.process(kramdown_doc.to_html)
     end
 
     def to_liquid
@@ -68,7 +64,11 @@ 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)
+      ERB::Util.html_escape(string || "").strip.gsub(/(?:\r?\n)/, "<br/>").html_safe
     end
 
     def to_sanitized_html
@@ -99,9 +99,16 @@ module Govspeak
       Govspeak::LinkExtractor.new(self, website_root: website_root).call
     end
 
+    def extract_contact_content_ids
+      _, regex = self.class.extensions.find { |(title)| title == "Contact" }
+      return [] unless regex
+
+      @source.scan(regex).map(&:first).uniq.select { |id| id.match(UUID_REGEX) }
+    end
+
     def preprocess(source)
       source = Govspeak::BlockquoteExtraQuoteRemover.remove(source)
-      @@extensions.each do |title,regexp,block|
+      self.class.extensions.each do |_, regexp, block|
         source.gsub!(regexp) {
           instance_exec(*Regexp.last_match.captures, &block)
         }
@@ -109,17 +116,12 @@ module Govspeak
       source
     end
 
-    def encode(text)
-      HTMLEntities.new.encode(text)
-    end
-    private :encode
-
     def self.extension(title, regexp = nil, &block)
       regexp ||= %r${::#{title}}(.*?){:/#{title}}$m
-      @@extensions << [title, regexp, block]
+      @extensions << [title, regexp, block]
     end
 
-    def self.surrounded_by(open, close=nil)
+    def self.surrounded_by(open, close = nil)
       open = Regexp::escape(open)
       if close
         close = Regexp::escape(close)
@@ -129,15 +131,15 @@ module Govspeak
       end
     end
 
-    def self.wrap_with_div(class_name, character, parser=Kramdown::Document)
+    def self.wrap_with_div(class_name, character, parser = Kramdown::Document)
       extension(class_name, surrounded_by(character)) { |body|
         content = parser ? parser.new("#{body.strip}\n").to_html : body.strip
         %{\n<div class="#{class_name}">\n#{content}</div>\n}
       }
     end
 
-    def insert_strong_inside_p(body, parser=Govspeak::Document)
-      parser.new(body.strip).to_html.sub(/^<p>(.*)<\/p>$/,"<p><strong>\\1</strong></p>")
+    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{
@@ -197,7 +199,7 @@ module Govspeak
       %{\n\n<div role="note" aria-label="Help" class="application-notice help-notice">\n#{Govspeak::Document.new(body.strip).to_html}</div>\n}
     }
 
-    extension('barchart', /{barchart(.*?)}/) do |captures, body|
+    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'
@@ -226,6 +228,7 @@ module Govspeak
     extension('attachment', /\[embed:attachments:(?!inline:|image:)\s*(.*?)\s*\]/) do |content_id, body|
       attachment = attachments.detect { |a| a[:content_id] == content_id }
       next "" unless attachment
+
       attachment = AttachmentPresenter.new(attachment)
       content = File.read(__dir__ + '/templates/attachment.html.erb')
       ERB.new(content).result(binding)
@@ -234,6 +237,7 @@ module Govspeak
     extension('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}"} : ""
       # new lines inside our title cause problems with govspeak rendering as this is expected to be on one line.
@@ -246,6 +250,7 @@ module Govspeak
     extension('attachment image', /\[embed:attachments:image:\s*(.*?)\s*\]/) do |content_id|
       attachment = attachments.detect { |a| a[:content_id] == content_id }
       next "" unless attachment
+
       attachment = AttachmentPresenter.new(attachment)
       title = (attachment.title || "").tr("\n", " ")
       render_image(attachment.url, title, nil, attachment.id)
@@ -265,8 +270,8 @@ module Govspeak
       id_attr = id ? %{ id="attachment_#{id}"} : ""
       lines = []
       lines << %{<figure#{id_attr} class="image embedded">}
-      lines << %Q{<div class="img"><img src="#{encode(url)}" alt="#{encode(alt_text)}"></div>}
-      lines << %Q{<figcaption>#{caption.strip}</figcaption>} if caption && !caption.strip.empty?
+      lines << %{<div class="img"><img src="#{encode(url)}" alt="#{encode(alt_text)}"></div>}
+      lines << %{<figcaption>#{caption.strip}</figcaption>} if caption && !caption.strip.empty?
       lines << '</figure>'
       lines.join
     end
@@ -281,7 +286,7 @@ module Govspeak
     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}
+      %{\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", /(?<=\A|\n\n|\r\n\r\n)^\$LegislativeList\s*$(.*?)\$EndLegislativeList/m) do |body|
@@ -295,28 +300,29 @@ module Govspeak
     end
 
     extension("numbered list", /^[ \t]*((s\d+\.\s.*(?:\n|$))+)/) do |body|
-      steps ||= 0
-      body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do |b|
-          "<li>#{Govspeak::Document.new($2.strip).to_html}</li>\n"
+      body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do
+        "<li>#{Govspeak::Document.new($2.strip).to_html}</li>\n"
       end
       %{<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' }
-    end
-
-    devolved_options.each do |k,v|
-      extension("devolved-#{k}",/:#{k}:(.*?):#{k}:/m) do |body|
-%{<div class="devolved-content #{k}">
-<p class="devolved-header">This section applies to #{v}</p>
-<div class="devolved-body">#{Govspeak::Document.new(body.strip).to_html}</div>
-</div>\n}
+      { 'scotland' => 'Scotland',
+        'england' => 'England',
+        'england-wales' => 'England and Wales',
+        'northern-ireland' => 'Northern Ireland',
+        'wales' => 'Wales',
+        'london' => 'London' }
+    end
+
+    devolved_options.each do |k, v|
+      extension("devolved-#{k}", /:#{k}:(.*?):#{k}:/m) do |body|
+        <<~HTML
+          <div class="devolved-content #{k}">
+          <p class="devolved-header">This section applies to #{v}</p>
+          <div class="devolved-body">#{Govspeak::Document.new(body.strip).to_html}</div>
+          </div>
+        HTML
       end
     end
 
@@ -336,6 +342,7 @@ module Govspeak
     extension('embed link', /\[embed:link:\s*(.*?)\s*\]/) do |content_id|
       link = links.detect { |l| l[:content_id] == content_id }
       next "" unless link
+
       if link[:url]
         "[#{link[:title]}](#{link[:url]})"
       else
@@ -343,17 +350,31 @@ module Govspeak
       end
     end
 
-    def render_hcard_address(contact)
-      HCardPresenter.from_contact(contact).render
-    end
-    private :render_hcard_address
-
     extension('Contact', /\[Contact:\s*(.*?)\s*\]/) do |content_id|
       contact = contacts.detect { |c| c[:content_id] == content_id }
       next "" unless contact
+
       contact = ContactPresenter.new(contact)
       @renderer ||= ERB.new(File.read(__dir__ + '/templates/contact.html.erb'))
       @renderer.result(binding)
     end
+
+  private
+
+    def kramdown_doc
+      @kramdown_doc ||= Kramdown::Document.new(preprocess(@source), @options)
+    end
+
+    def encode(text)
+      HTMLEntities.new.encode(text)
+    end
+
+    def render_hcard_address(contact_address)
+      HCardPresenter.new(contact_address).render
+    end
   end
 end
+
+I18n.load_path.unshift(
+  *Dir.glob(File.expand_path('locales/*.yml', Govspeak.root))
+)

data/lib/govspeak/blockquote_extra_quote_remover.rb

@@ -1,7 +1,7 @@
 module Govspeak
   module BlockquoteExtraQuoteRemover
-    QUOTE = '"\u201C\u201D\u201E\u201F\u2033\u2036'
-    LINE_BREAK = '\r\n?|\n'
+    QUOTE = '"\u201C\u201D\u201E\u201F\u2033\u2036'.freeze
+    LINE_BREAK = '\r\n?|\n'.freeze
 
     # used to remove quotes from a markdown blockquote, as these will be inserted
     # as part of the rendering
@@ -13,6 +13,7 @@ module Govspeak
     # > test
     def self.remove(source)
       return if source.nil?
+
       source.gsub(/^>[ \t]*[#{QUOTE}]*([^ \t\n].+?)[#{QUOTE}]*[ \t]*(#{LINE_BREAK}?)$/, '> \1\2')
     end
   end

data/lib/govspeak/cli.rb

@@ -20,6 +20,7 @@ module Govspeak
         command.action do |args, options|
           input = get_input($stdin, args, options)
           raise "Nothing to render. Use --help for assistance" unless input
+
           puts Govspeak::Document.new(input, govspeak_options(options)).to_html
         end
       end
@@ -31,6 +32,7 @@ module Govspeak
     def get_input(stdin, args, options)
       return stdin.read unless stdin.tty?
       return read_file(options.file) if options.file
+
       args.empty? ? nil : args.join(" ")
     end
 
@@ -41,11 +43,11 @@ module Govspeak
 
     def govspeak_options(command_options)
       string = if command_options.options_file
-                read_file(command_options.options_file)
+                 read_file(command_options.options_file)
                else
-                command_options.options
+                 command_options.options
                end
-      string ? JSON.load(string) : {}
+      string ? JSON.parse(string) : {}
     end
   end
 end

data/lib/govspeak/header_extractor.rb

@@ -18,12 +18,13 @@ module Govspeak
     end
 
   private
-    def id(el)
-      el.attr.fetch('id', generate_id(el.options[:raw_text]))
+
+    def id(element)
+      element.attr.fetch('id', generate_id(element.options[:raw_text]))
     end
 
-    def build_header(el)
-      Header.new(el.options[:raw_text], el.options[:level], id(el))
+    def build_header(element)
+      Header.new(element.options[:raw_text], element.options[:level], id(element))
     end
 
     def find_headers(parent)
@@ -35,7 +36,7 @@ module Govspeak
         parent.children.each do |child|
           if child.type == :header
             headers << build_header(child)
-          elsif child.children.size > 0
+          elsif !child.children.empty?
             headers << find_headers(child)
           end
         end

data/lib/govspeak/html_sanitizer.rb

@@ -2,7 +2,6 @@ require 'addressable/uri'
 require 'sanitize'
 
 class Govspeak::HtmlSanitizer
-
   class ImageSourceWhitelister
     def initialize(allowed_image_hosts)
       @allowed_image_hosts = allowed_image_hosts
@@ -21,7 +20,8 @@ class Govspeak::HtmlSanitizer
 
   class TableCellTextAlignWhitelister
     def call(sanitize_context)
-      return unless ["td", "th"].include?(sanitize_context[:node_name])
+      return unless %w[td th].include?(sanitize_context[:node_name])
+
       node = sanitize_context[:node]
 
       # Kramdown uses text-align to allow table cells to be aligned
@@ -51,7 +51,7 @@ class Govspeak::HtmlSanitizer
 
   def sanitize_without_images
     config = sanitize_config
-    Sanitize.clean(@dirty_html, Sanitize::Config.merge(config, elements: config[:elements] - ["img"]))
+    Sanitize.clean(@dirty_html, Sanitize::Config.merge(config, elements: config[:elements] - %w[img]))
   end
 
   def button_sanitize_config
@@ -68,8 +68,8 @@ class Govspeak::HtmlSanitizer
       attributes: {
         :all => Sanitize::Config::RELAXED[:attributes][:all] + ["role", "aria-label"],
         "a"  => Sanitize::Config::RELAXED[:attributes]["a"] + button_sanitize_config,
-        "th"  => Sanitize::Config::RELAXED[:attributes]["th"] + ["style"],
-        "td"  => Sanitize::Config::RELAXED[:attributes]["td"] + ["style"],
+        "th"  => Sanitize::Config::RELAXED[:attributes]["th"] + %w[style],
+        "td"  => Sanitize::Config::RELAXED[:attributes]["td"] + %w[style],
       }
     )
   end

data/lib/govspeak/kramdown_overrides.rb

@@ -7,7 +7,7 @@ module Govspeak
     # match Kramdown's internals.
 
     def self.with_kramdown_ordered_lists_disabled
-      original_list_start = list_start 
+      original_list_start = list_start
       redefine_kramdown_const(:LIST_START, list_start_ul)
       list_parser = kramdown_parsers.delete(:list)
       Kramdown::Parser::Kramdown.define_parser(:list, list_start_ul)
@@ -18,7 +18,6 @@ module Govspeak
       kramdown_parsers[:list] = list_parser
     end
 
-  private
     def self.list_start
       Kramdown::Parser::Kramdown::LIST_START
     end