govspeak 3.6.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 580a0caf181b2fdc0f51d15207150dba05668db6
-  data.tar.gz: f745c4bdd7df05441c0e82f1b4cae4e9cc70af30
+  metadata.gz: 6e737eca62f51b5b954bc37b5fc55d2ba680bb8b
+  data.tar.gz: bf6f399b9badf4708ee7f4f9c6ca50a157493ac5
 SHA512:
-  metadata.gz: 5a04e402f7e2224e20fb06ab180370b41addcd5036f56a93c012bb1b79fb9761bcdc35ebaf5c0f0d3457d91be8ad0455a2e9712578d5951b35238e6f89b6b654
-  data.tar.gz: e47d74513a6d3f0a150fba13372f102b6399ed8ea3c5d0effcc28722f4a8cb001f6799ce0b4f4039d0b7d509049260d545eef89ee204e1ac454820353a26202b
+  metadata.gz: 9363e23283391abf19861ce9522b7cf30874aeecf37b7274dd19411a7539f1956ba3043218601fbc694acde33f2c062fc71f8bd1f113ce9884ca2e7938f1784f
+  data.tar.gz: efe6a7cda89d313ef06470fa0a5e71acc40d85b16ebe8ab95928865e4f20295e7663a4fa43a1e428a5edd2943a6949a96cbc9ec7c31bac28c2322f3a5ba5f353

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 4.0.0
+
+* Drop support for Ruby 1.9.3
+* Update Ruby to 2.3.1
+* Adds support for the following items for feature parity with [whitehall](https://github.com/alphagov/whitehall):
+  * `{barchart}`
+  * `[embed:attachments:%content_id%]`
+  * `[embed:attachments:inline:%content_id%]`
+  * `[embed:link:%content_id%]`
+  * `[Contact:%content_id%]`
+* Changes blockquote rendering to match whitehall [#81](https://github.com/alphagov/govspeak/pull/81)
+
+## 3.7.0
+
+* Update Addressable version from 2.3.8 to 2.4.0
+
 ## 3.6.2
 
 * Fix bug with link parsing introduced in Kramdown 1.6.0 with the "inline attribute lists" feature which clashed with our monkey patch [#75](https://github.com/alphagov/govspeak/pull/75)

data/lib/govspeak.rb

@@ -4,8 +4,13 @@ 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 'kramdown/parser/kramdown_with_automatic_external_links'
 require 'htmlentities'
+require 'presenters/attachment_presenter'
+require 'presenters/h_card_presenter'
+require 'erb'
 
 module Govspeak
 
@@ -17,6 +22,7 @@ module Govspeak
     @@extensions = []
 
     attr_accessor :images
+    attr_reader :attachments, :contacts, :links, :locale
 
     def self.to_html(source, options = {})
       new(source, options).to_html
@@ -25,22 +31,41 @@ module Govspeak
     def initialize(source, options = {})
       @source = source ? source.dup : ""
       @images = options.delete(:images) || []
-      @options = {input: PARSER_CLASS_NAME, entity_output: :symbolic}.merge(options)
+      @attachments = Array(options.delete(:attachments))
+      @links = Array(options.delete(:links))
+      @contacts = Array(options.delete(:contacts))
+      @locale = options.fetch(:locale, "en")
+      @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
-      kramdown_doc.to_html
+      @html ||= Govspeak::PostProcessor.process(kramdown_doc.to_html)
     end
 
     def to_liquid
       to_html
     end
 
+    def t(*args)
+      options = args.last.is_a?(Hash) ? args.last.dup : {}
+      key = args.shift
+      I18n.t(key, options.merge(locale: locale))
+    end
+
     def to_sanitized_html
       HtmlSanitizer.new(to_html).sanitize
     end
@@ -66,6 +91,7 @@ module Govspeak
     end
 
     def preprocess(source)
+      source = Govspeak::BlockquoteExtraQuoteRemover.remove(source)
       @@extensions.each do |title,regexp,block|
         source.gsub!(regexp) {
           instance_exec(*Regexp.last_match.captures, &block)
@@ -105,10 +131,6 @@ module Govspeak
       parser.new(body.strip).to_html.sub(/^<p>(.*)<\/p>$/,"<p><strong>\\1</strong></p>")
     end
 
-    extension('reverse') { |body|
-      body.reverse
-    }
-
     extension('highlight-answer') { |body|
       %{\n\n<div class="highlight-answer">
 #{Govspeak::Document.new(body.strip).to_html}</div>\n}
@@ -137,6 +159,22 @@ 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|
+      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(' ')
+    end
+
     extension('attached-image', /^!!([0-9]+)/) do |image_number|
       image = images[image_number.to_i - 1]
       if image
@@ -147,6 +185,22 @@ module Govspeak
       end
     end
 
+    extension('attachment', /\[embed:attachments:([0-9a-f-]+)\]/) do |content_id, body|
+      attachment = attachments.detect { |a| a.content_id.match(content_id) }
+      next "" unless attachment
+      attachment = AttachmentPresenter.new(attachment)
+      content = File.read('lib/govspeak/extension/attachment.html.erb')
+      ERB.new(content).result(binding)
+    end
+
+    extension('attachment inline', /\[embed:attachments:inline:([0-9a-f-]+)\]/) do |content_id, body|
+      attachment = attachments.detect { |a| a.content_id.match(content_id) }
+      next "" unless attachment
+      attachment = AttachmentPresenter.new(attachment)
+      content = File.read('lib/govspeak/extension/inline_attachment.html.erb')
+      ERB.new(content).result(binding)
+    end
+
     def render_image(url, alt_text, caption = nil)
       lines = []
       lines << '<figure class="image embedded">'
@@ -217,5 +271,27 @@ module Govspeak
         end
       end
     end
+
+    extension('embed link', /\[embed:link:([0-9a-f-]+)\]/) do |content_id|
+      link = links.detect { |l| l.content_id.match(content_id) }
+      next "" unless link
+      if link.url
+        %Q{<a href="#{encode(link.url)}">#{encode(link.title)}</a>}
+      else
+        encode(link.title)
+      end
+    end
+
+    def render_hcard_address(contact)
+      HCardPresenter.from_contact(contact).render
+    end
+    private :render_hcard_address
+
+    extension('Contact', /\[Contact:([0-9a-f-]+)\]/) do |content_id|
+      contact = contacts.detect { |c| c.content_id.match(content_id) }
+      next "" unless contact
+      @renderer ||= ERB.new(File.read('lib/templates/contact.html.erb'))
+      @renderer.result(binding)
+    end
   end
 end

data/lib/govspeak/blockquote_extra_quote_remover.rb

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

data/lib/govspeak/extension/attachment.html.erb

@@ -0,0 +1,65 @@
+<section class="attachment <%= attachment.section_class %>">
+  <div class="attachment-thumb">
+    <%= attachment.thumbnail_link %>
+  </div>
+  <div class="attachment-details">
+    <h2 class="title"><%= attachment.attachement_details %></h2>
+    <p class="metadata">
+      <% if attachment.references? %>
+        <span class="references">
+          <%= t('attachment.headings.reference') %>: <%= attachment.references %>
+        </span>
+      <% end %>
+      <% if attachment.unnumbered_paper? %>
+        <span class="unnumbered-paper">
+          <% if attachment.unnumbered_command_paper? %>
+            <%= t('attachment.headings.unnumbered_command_paper') %>
+          <% else %>
+            <%= t('attachment.headings.unnumbered_hoc_paper') %>
+          <% end %>
+        </span>
+      <% end %>
+      <% if attachment.previewable? %>
+        <span class="preview">
+          <strong>
+            <%= attachment.link("View online", attachment.preview_url) %>
+          </strong>
+        </span>
+        <span class="download">
+          attachment.download_link
+        </span>
+      <% else %>
+        <%= attachment.attachment_attributes %>
+      <% end %>
+    </p>
+    <% if attachment.order_url.present? %>
+      <p>
+        <%= attachment.link t('attachment.headings.order_a_copy'), attachment.order_url,
+            class: "order_url", title: t('attachment.headings.order_a_copy_full') %>
+        <% if attachment.price %>
+          (<span class="price"><%= attachment.price %></span>)
+        <% end %>
+      </p>
+    <% end %>
+
+    <% if attachment.opendocument? %>
+      <p class="opendocument-help">
+        <%= t('attachment.opendocument.help_html') %>
+      </p>
+    <% end %>
+
+    <% unless attachment.accessible? %>
+      <div data-module="toggle" class="accessibility-warning" id="<%= attachment.help_block_id %>">
+        <h2><%= t('attachment.accessibility.heading') %>
+          <a class="toggler" href="#<%= attachment.help_block_toggle_id %>" data-controls="<%= attachment.help_block_toggle_id %>" data-expanded="false"><%= t('attachment.accessibility.request_a_different_format') %></a>
+        </h2>
+        <p id="<%= attachment.help_block_toggle_id %>" class="js-hidden">
+          <%= t('attachment.accessibility.full_help_html',
+                email: attachment.alternative_format_order_link,
+                title: attachment.title,
+                references: attachment.references) %>
+        </p>
+      </div>
+    <% end %>
+  </div>
+</section>

data/lib/govspeak/extension/inline_attachment.html.erb

@@ -0,0 +1,4 @@
+<span id="attachment_<%= attachment.id %>" class="attachment-inline">
+  <%= attachment.link attachment.title, attachment.url %>
+  (<%= attachment.attachment_attributes %>)
+</span>

data/lib/govspeak/post_processor.rb

@@ -0,0 +1,42 @@
+require 'nokogiri'
+
+module Govspeak
+  class PostProcessor
+    attr_reader :input
+
+    @@extensions = []
+
+    def initialize(html)
+      @input = html
+    end
+
+    def nokogiri_document
+      doc = Nokogiri::HTML::Document.new
+      doc.encoding = "UTF-8"
+      doc.fragment(input)
+    end
+    private :nokogiri_document
+
+    def self.process(html)
+      new(html).output
+    end
+
+    def self.extension(title, &block)
+      @@extensions << [title, block]
+    end
+
+    def output
+      document = nokogiri_document
+      @@extensions.each do |_, block|
+        instance_exec(document, &block)
+      end
+      document.to_html
+    end
+
+    extension("add class to last p of blockquote") do |document|
+      document.css("blockquote p:last-child").map do |el|
+        el[:class] = "last-child"
+      end
+    end
+  end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "3.6.2"
+  VERSION = "4.0.0"
 end

data/lib/presenters/attachment_presenter.rb

@@ -0,0 +1,241 @@
+require "action_view"
+require "money"
+
+class AttachmentPresenter
+  attr_reader :attachment
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::NumberHelper
+  include ActionView::Helpers::AssetTagHelper
+
+  def initialize(attachment)
+    @attachment = attachment
+  end
+
+  def id
+    attachment.id
+  end
+
+  def order_url
+    attachment.order_url
+  end
+
+  def opendocument?
+    attachment.opendocument?
+  end
+
+  def url
+    attachment.url
+  end
+
+  def external?
+    attachment.external?
+  end
+
+  def price
+    return unless attachment.price
+    Money.from_amount(attachment.price, 'GBP').format
+  end
+
+  def accessible?
+    attachment.accessible?
+  end
+
+  def thumbnail_link
+    return if hide_thumbnail?
+    return if previewable?
+    link(attachment_thumbnail, url, "aria-hidden=true class=#{attachment_class}")
+  end
+
+  def help_block_toggle_id
+    "attachment-#{attachment.id}-accessibility-request"
+  end
+
+  def section_class
+    attachment.external? ? "hosted-externally" : "embedded"
+  end
+
+  def mail_to(email_address, name, options = {})
+    "<a href='mailto:#{email_address}?Subject=#{options[:subject]}&body=#{options[:body]}'>#{name}</a>"
+  end
+
+  def alternative_format_order_link
+    attachment_info = []
+    attachment_info << "  Title: #{attachment.title}"
+    attachment_info << "  Original format: #{attachment.file_extension}"
+    attachment_info << "  ISBN: #{attachment.isbn}" if attachment.isbn.present?
+    attachment_info << "  Unique reference: #{attachment.unique_reference}" if attachment.unique_reference.present?
+    attachment_info << "  Command paper number: #{attachment.command_paper_number}" if attachment.command_paper_number.present?
+    if attachment.hoc_paper_number.present?
+      attachment_info << "  House of Commons paper number: #{attachment.hoc_paper_number}"
+      attachment_info << "  Parliamentary session: #{attachment.parliamentary_session}"
+    end
+
+    options = {
+      subject: "Request for '#{attachment.title}' in an alternative format",
+      body: body_for_mail(attachment_info)
+    }
+
+    mail_to(alternative_format_contact_email, alternative_format_contact_email, options)
+  end
+
+  def body_for_mail(attachment_info)
+    <<-END
+    Details of document required:
+
+#{attachment_info.join("\n")}
+
+Please tell us:
+
+  1. What makes this format unsuitable for you?
+  2. What format you would prefer?
+   END
+  end
+
+  def alternative_format_contact_email
+    "govuk-feedback@digital.cabinet-office.gov.uk"
+  end
+
+  def attachment_thumbnail
+    if attachment.pdf?
+      image_tag(attachment.file.thumbnail.url)
+    elsif attachment.html?
+      image_tag('pub-cover-html.png')
+    elsif %w{doc docx odt}.include? attachment.file_extension
+      image_tag('pub-cover-doc.png')
+    elsif %w{xls xlsx ods csv}.include? attachment.file_extension
+      image_tag('pub-cover-spreadsheet.png')
+    else
+      image_tag('pub-cover.png')
+    end
+  end
+
+  def references
+    references = []
+    references << "ISBN: #{attachment.isbn}" if attachment.isbn.present?
+    references << "Unique reference: #{attachment.unique_reference}" if attachment.unique_reference.present?
+    references << "Command paper number: #{attachment.command_paper_number}" if attachment.command_paper_number.present?
+    references << "HC: #{attachment.hoc_paper_number} #{attachment.parliamentary_session}" if attachment.hoc_paper_number.present?
+    prefix = references.size == 1 ? "and its reference" : "and its references"
+    references.any? ? ", #{prefix} (" + references.join(", ") + ")" : ""
+  end
+
+  def references?
+    !attachment.isbn.to_s.empty? || !attachment.unique_reference.to_s.empty? || !attachment.command_paper_number.to_s.empty? || !attachment.hoc_paper_number.to_s.empty?
+  end
+
+  def attachment_class
+    attachment.external? ? "hosted-externally" : "embedded"
+  end
+
+  def unnumbered_paper?
+    attachment.unnumbered_command_paper? || attachment.unnumbered_hoc_paper?
+  end
+
+  def unnumbered_command_paper?
+    attachment.unnumbered_command_paper?
+  end
+
+  def download_link
+    link(attachment.preview_url, "<strong>Download #{attachment.file_extension.upcase}</strong>", number_to_human_size(attachment.file_size))
+  end
+
+  def attachment_attributes
+    attributes = []
+    if attachment.html?
+      attributes << content_tag(:span, 'HTML', class: 'type')
+    elsif attachment.external?
+      attributes << content_tag(:span, url, class: 'url')
+    else
+      attributes << content_tag(:span, humanized_content_type(attachment.file_extension), class: 'type')
+      attributes << content_tag(:span, number_to_human_size(attachment.file_size), class: 'file-size')
+      attributes << content_tag(:span, pluralize(attachment.number_of_pages, "page") , class: 'page-length') if attachment.number_of_pages.present?
+    end
+    attributes.join(', ').html_safe
+  end
+
+  def preview_url
+    url << '/preview'
+  end
+
+  MS_WORD_DOCUMENT_HUMANIZED_CONTENT_TYPE = "MS Word Document"
+  MS_EXCEL_SPREADSHEET_HUMANIZED_CONTENT_TYPE = "MS Excel Spreadsheet"
+  MS_POWERPOINT_PRESENTATION_HUMANIZED_CONTENT_TYPE = "MS Powerpoint Presentation"
+
+  def file_abbr_tag(abbr, title)
+    content_tag(:abbr, abbr, title: title)
+  end
+
+  def humanized_content_type(file_extension)
+    file_extension_vs_humanized_content_type = {
+      "chm"  => file_abbr_tag('CHM', 'Microsoft Compiled HTML Help'),
+      "csv"  => file_abbr_tag('CSV', 'Comma-separated Values'),
+      "diff" => file_abbr_tag('DIFF', 'Plain text differences'),
+      "doc"  => MS_WORD_DOCUMENT_HUMANIZED_CONTENT_TYPE,
+      "docx" => MS_WORD_DOCUMENT_HUMANIZED_CONTENT_TYPE,
+      "dot"  => file_abbr_tag('DOT', 'MS Word Document Template'),
+      "dxf"  => file_abbr_tag('DXF', 'AutoCAD Drawing Exchange Format'),
+      "eps"  => file_abbr_tag('EPS', 'Encapsulated PostScript'),
+      "gif"  => file_abbr_tag('GIF', 'Graphics Interchange Format'),
+      "gml"  => file_abbr_tag('GML', 'Geography Markup Language'),
+      "html" => file_abbr_tag('HTML', 'Hypertext Markup Language'),
+      "ics" => file_abbr_tag('ICS', 'iCalendar file'),
+      "jpg"  => "JPEG",
+      "odp"  => file_abbr_tag('ODP', 'OpenDocument Presentation'),
+      "ods"  => file_abbr_tag('ODS', 'OpenDocument Spreadsheet'),
+      "odt"  => file_abbr_tag('ODT', 'OpenDocument Text document'),
+      "pdf"  => file_abbr_tag('PDF', 'Portable Document Format'),
+      "png"  => file_abbr_tag('PNG', 'Portable Network Graphic'),
+      "ppt"  => MS_POWERPOINT_PRESENTATION_HUMANIZED_CONTENT_TYPE,
+      "pptx" => MS_POWERPOINT_PRESENTATION_HUMANIZED_CONTENT_TYPE,
+      "ps"   => file_abbr_tag('PS', 'PostScript'),
+      "rdf"  => file_abbr_tag('RDF', 'Resource Description Framework'),
+      "rtf"  => file_abbr_tag('RTF', 'Rich Text Format'),
+      "sch"  => file_abbr_tag('SCH', 'XML based Schematic'),
+      "txt"  => "Plain text",
+      "wsdl" => file_abbr_tag('WSDL', 'Web Services Description Language'),
+      "xls"  => MS_EXCEL_SPREADSHEET_HUMANIZED_CONTENT_TYPE,
+      "xlsm" => file_abbr_tag('XLSM', 'MS Excel Macro-Enabled Workbook'),
+      "xlsx" => MS_EXCEL_SPREADSHEET_HUMANIZED_CONTENT_TYPE,
+      "xlt"  => file_abbr_tag('XLT', 'MS Excel Spreadsheet Template'),
+      "xsd"  => file_abbr_tag('XSD', 'XML Schema'),
+      "xslt" => file_abbr_tag('XSLT', 'Extensible Stylesheet Language Transformation'),
+      "zip"  => file_abbr_tag('ZIP', 'Zip archive'),
+    }
+    file_extension_vs_humanized_content_type.fetch(file_extension.to_s.downcase, '')
+  end
+
+  def previewable?
+    attachment.csv?
+  end
+
+  def title
+    attachment.title
+  end
+
+  def hide_thumbnail?
+    defined?(hide_thumbnail) && hide_thumbnail
+  end
+
+  def attachement_details
+    return if previewable?
+    link(attachment.title, url, title_link_options)
+  end
+
+  def title_link_options
+    title_link_options = ''
+    title_link_options << "rel=external" if attachment.external?
+    title_link_options << "aria-describedby=#{help_block_id}" unless attachment.accessible?
+  end
+
+  def help_block_id
+    "attachment-#{attachment.id}-accessibility-help"
+  end
+
+  def link(body, url, options={})
+    <<-END
+      <a href="#{url} #{options}">
+        #{body}
+      </a>
+    END
+  end
+end