govspeak 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b2022644e3af2c929faf57f33c9fe70680977e599bde24d59c71ee20402713
-  data.tar.gz: 7dec8938eedb2183514c54665dd9609f130ac535fbb336739f0f8b6e3d528bc3
+  metadata.gz: ec0c2e0694235f631985feeea77f20f07f8ce6ccaf55a8317a83b42583a6bcd2
+  data.tar.gz: f98e90a503d00b4dd7c92c9b4dd9e1ff4e3a14494787a344f3722cd788515294
 SHA512:
-  metadata.gz: 7b96f54ac8cfdf3e0595cb2de3bc205df86c7efc9869c4e9d06f22623067f4e114d878e9f31c72817d76657b9d759e0b3344ae87724db8394a5a79a727765407
-  data.tar.gz: 9fc03735199e9fe6016ffe1196e57eac617a744c7aaa3421fc1a57a4ba53190c3dc85c5dda7f76b202aaf29c7c5da51f47ed0fcf71ff43a5b504097bcf8b6ebb
+  metadata.gz: b45e92bd8d25ef8a0674de0aba0ac4785589a3af588bf07893b567e09792b13deb15101ba85aef05c45b4429982add8ff52669abfa8b273a9ce29d51591c908b
+  data.tar.gz: b193767c7dd265bf61ac851cdc2b0caafd249f63057f5b2008e9dea991ae8d79166fa86169305cf099d3a3ddf1fbe0f1c256f02216d27ae95d2ad2f7a2f17d1e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 6.1.0
+
+* Remove `[embed:attachments:content-id]` this isn't used by any apps and has never worked
+* Add dependency on govuk_publishing_components
+* Add new `AttachementLink:attachment-id` extension and mark as experimental
+* Add new `Attachement:attachment-id` extension and mark as experimental
+* Blockquote quote remover is now more forgiving to spaces before or after quote characters
+
 ## 6.0.0
 
 * BREAKING CHANGE: Input is sanitized by default, to use unsafe HTML initialize with a sanitize option of false

data/README.md

@@ -352,53 +352,9 @@ Embedded content allows authors to reference a supporting item of a document by
 referencing an id. The details of this content is passed to the publishing
 application to govspeak at the time of rendering.
 
-### Attachments
-
-To create an attachment callout
-
-    [embed:attachment:2b4d92f3-f8cd-4284-aaaa-25b3a640d26c]
-
-with options provided
-
-    {
-      attachments: [
-        {
-          id: 123,
-          content_id: "2b4d92f3-f8cd-4284-aaaa-25b3a640d26c",
-          title: "Attachment Title",
-          url: "http://example.com/test.pdf",
-          order_url: "http://example.com/order",
-          price: 12.3,
-          isbn: "isbn-123",
-          attachment?: true,
-        }
-      ]
-    }
-
-will output an attachment box
-
-```html
-<section class="attachment embedded">
-  <div class="attachment-thumb">
-    <a href="http://example.com/test.pdf" aria-hidden="true" class="embedded"><img src="/images/pub-cover.png" alt="Pub cover"></a>
-  </div>
-  <div class="attachment-details">
-    <h2 class="title">
-      <a href="http://example.com/test.pdf" aria-describedby="attachment-123-accessibility-help">Attachment Title</a>
-    </h2>
-    <p class="metadata">
-      <span class="references">Ref: ISBN <span class="isbn">isbn-123</span></span>
-    </p>
-    <p>
-      <a href="http://example.com/order" class="order_url" title="Order a copy of the publication">Order a copy</a>(<span class="price">£12.30</span>)
-    </p>
-  </div>
-</section>
-```
-
 ### Inline Attachment
 
-Attachments can be linked to inline as well
+Attachments can be linked to inline
 
     Details referenced in [embed:attachments:inline:34f6dda0-21b1-4e78-8120-3ff4dcea522d]
 

data/lib/govspeak.rb

@@ -5,6 +5,7 @@ require 'htmlentities'
 require 'kramdown'
 require 'kramdown/parser/kramdown_with_automatic_external_links'
 require 'rinku'
+require 'govuk_publishing_components'
 require 'govspeak/header_extractor'
 require 'govspeak/structured_header_extractor'
 require 'govspeak/html_validator'
@@ -217,18 +218,12 @@ module Govspeak
       render_image(ImagePresenter.new(image))
     end
 
-    extension('attachment', /\[embed:attachments:(?!inline:|image:)\s*(.*?)\s*\]/) do |content_id|
-      # not treating this as a self closing tag seems to avoid some oddities
-      # such as an extra new line being inserted when explicitly closed or
-      # swallowing subsequent elements when not closed
-      %{<govspeak-embed-attachment content-id="#{content_id}"></govspeak-embed-attachment>}
-    end
-
-    extension('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}"} : ""
       # new lines inside our title cause problems with govspeak rendering as this is expected to be on one line.
       title = (attachment.title || "").tr("\n", " ")
@@ -354,6 +349,21 @@ module Govspeak
       render_image(ImagePresenter.new(image))
     end
 
+    # This is an alternative syntax for embedding attachments using a readable id (expected
+    # to be a unique variation of a filename). This syntax is being used by
+    # Content Publisher and should be considered experimental as it is likely
+    # to be iterated in the short term.
+    extension('Attachment', /#{NEW_PARAGRAPH_LOOKBEHIND}\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|
+      %{<govspeak-embed-attachment id="#{attachment_id}"></govspeak-embed-attachment>}
+    end
+
+    # This is an alternative syntax for embedding attachments as links. This
+    # syntax is being used by Content Publisher and should be considered
+    # experimental
+    extension('AttachmentLink', /\[AttachmentLink:\s*(.*?)\s*\]/) do |attachment_id|
+      %{<govspeak-embed-attachment-link id="#{attachment_id}"></govspeak-embed-attachment-link>}
+    end
+
   private
 
     def kramdown_doc

data/lib/govspeak/blockquote_extra_quote_remover.rb

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

data/lib/govspeak/html_sanitizer.rb

@@ -60,7 +60,7 @@ class Govspeak::HtmlSanitizer
   def sanitize_config
     Sanitize::Config.merge(
       Sanitize::Config::RELAXED,
-      elements: Sanitize::Config::RELAXED[:elements] + %w[govspeak-embed-attachment],
+      elements: Sanitize::Config::RELAXED[:elements] + %w[govspeak-embed-attachment govspeak-embed-attachment-link],
       attributes: {
         :all => Sanitize::Config::RELAXED[:attributes][:all] + ["role", "aria-label"],
         "a"  => Sanitize::Config::RELAXED[:attributes]["a"] + button_sanitize_config,

data/lib/govspeak/post_processor.rb

@@ -51,14 +51,36 @@ module Govspeak
 
     extension("embed attachment HTML") do |document|
       document.css("govspeak-embed-attachment").map do |el|
-        attachment = govspeak_document.attachments.detect { |a| a[:content_id] == el["content-id"] }
+        attachment = govspeak_document.attachments.detect { |a| a[:id] == el["id"] }
+
+        unless attachment
+          el.remove
+          next
+        end
+
+        attachment_html = GovukPublishingComponents.render(
+          "govuk_publishing_components/components/attachment",
+          attachment: attachment,
+          locale: govspeak_document.locale
+        )
+        el.swap(attachment_html)
+      end
+    end
+
+    extension("embed attachment link HTML") do |document|
+      document.css("govspeak-embed-attachment-link").map do |el|
+        attachment = govspeak_document.attachments.detect { |a| a[:id] == el["id"] }
+
         unless attachment
           el.remove
           next
         end
 
-        renderer = TemplateRenderer.new('attachment.html.erb', govspeak_document.locale)
-        attachment_html = renderer.render(attachment: AttachmentPresenter.new(attachment))
+        attachment_html = GovukPublishingComponents.render(
+          "govuk_publishing_components/components/attachment_link",
+          attachment: attachment,
+          locale: govspeak_document.locale
+        )
         el.swap(attachment_html)
       end
     end

data/lib/govspeak/presenters/attachment_presenter.rb

@@ -1,15 +1,11 @@
 require "action_view"
-require "money"
 require "htmlentities"
 
-Money.locale_backend = :currency
-
 module Govspeak
   class AttachmentPresenter
     attr_reader :attachment
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::NumberHelper
-    include ActionView::Helpers::AssetTagHelper
     include ActionView::Helpers::TextHelper
 
     def initialize(attachment)
@@ -20,158 +16,19 @@ module Govspeak
       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-#{id}-accessibility-request"
-    end
-
-    def section_class
-      attachment[:external?] ? "hosted-externally" : "embedded"
-    end
-
-    def mail_to(email_address, name, options = {})
-      query_string = options.slice(:subject, :body).map { |k, v| "#{urlencode(k)}=#{urlencode(v)}" }.join("&")
-      "<a href='mailto:#{encode(email_address)}?#{encode(query_string)}'>#{name}</a>"
-    end
-
-    def alternative_format_order_link
-      attachment_info = []
-      attachment_info << "  Title: #{title}"
-      attachment_info << "  Original format: #{file_extension}" if file_extension.present?
-      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 '#{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)
-      <<~TEXT
-        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?
-      TEXT
-    end
-
-    def alternative_format_contact_email
-      "govuk-feedback@digital.cabinet-office.gov.uk"
-    end
-
-    # FIXME: usage of image_tag will cause these to render at /images/ which seems
-    # very host dependent. I assume this will need links to static urls.
-    def attachment_thumbnail
-      if file_extension == "pdf" && attachment[:thumbnail_url]
-        image_tag(attachment[:thumbnail_url])
-      elsif file_extension == "html"
-        image_tag('pub-cover-html.png')
-      elsif %w{doc docx odt}.include?(file_extension)
-        image_tag('pub-cover-doc.png')
-      elsif %w{xls xlsx ods csv}.include?(file_extension)
-        image_tag('pub-cover-spreadsheet.png')
-      else
-        image_tag('pub-cover.png')
-      end
-    end
-
-    def reference
-      ref = []
-      if attachment[:isbn].present?
-        ref << "ISBN " + content_tag(:span, attachment[:isbn], class: "isbn")
-      end
-
-      if attachment[:unique_reference].present?
-        ref << content_tag(:span, attachment[:unique_reference], class: "unique_reference")
-      end
-
-      if attachment[:command_paper_number].present?
-        ref << content_tag(:span, attachment[:command_paper_number], class: "command_paper_number")
-      end
-
-      if attachment[:hoc_paper_number].present?
-        ref << content_tag(:span, "HC #{attachment[:hoc_paper_number]}", class: 'house_of_commons_paper_number') + ' ' +
-          content_tag(:span, attachment[:parliamentary_session], class: 'parliamentary_session')
-      end
-
-      ref.join(', ').html_safe
-    end
-
-    # FIXME this has english in it so will cause problems if the locale is not en
-    def references_for_title
-      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?]
+    def title
+      attachment[:title]
     end
 
-    def download_link
-      options = {}
-      options[:title] = number_to_human_size(attachment[:file_size]) if attachment[:file_size].present?
-      link("<strong>Download #{file_extension.upcase}</strong>", attachment[:url], options)
+    def file_extension
+      # Note: this is a separate parameter rather than being calculated from the
+      # filename because at the time of writing not all apps were using the effects
+      # of this field.
+      attachment[:file_extension]
     end
 
     def attachment_attributes
@@ -188,10 +45,6 @@ module Govspeak
       attributes.join(', ').html_safe
     end
 
-    def preview_url
-      url + '/preview'
-    end
-
     MS_WORD_DOCUMENT_HUMANIZED_CONTENT_TYPE = "MS Word Document".freeze
     MS_EXCEL_SPREADSHEET_HUMANIZED_CONTENT_TYPE = "MS Excel Spreadsheet".freeze
     MS_POWERPOINT_PRESENTATION_HUMANIZED_CONTENT_TYPE = "MS Powerpoint Presentation".freeze
@@ -239,42 +92,6 @@ module Govspeak
       file_extension_vs_humanized_content_type.fetch(file_extension.to_s.downcase, '')
     end
 
-    def previewable?
-      file_extension == "csv"
-    end
-
-    def title
-      attachment[:title]
-    end
-
-    def file_extension
-      # Note: this is a separate parameter rather than being calculated from the
-      # filename because at the time of writing not all apps were using the effects
-      # of this field.
-      attachment[:file_extension]
-    end
-
-    def hide_thumbnail?
-      defined?(hide_thumbnail) && hide_thumbnail
-    end
-
-    def attachment_details
-      return if previewable?
-
-      link(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?]
-      title_link_options
-    end
-
-    def help_block_id
-      "attachment-#{id}-accessibility-help"
-    end
-
     def link(body, url, options = {})
       options_str = options.map { |k, v| %{#{encode(k)}="#{encode(v)}"} }.join(" ")
       %{<a href="#{encode(url)}" #{options_str}>#{body}</a>}
@@ -285,9 +102,5 @@ module Govspeak
     def encode(text)
       HTMLEntities.new.encode(text)
     end
-
-    def urlencode(text)
-      ERB::Util.url_encode(text)
-    end
   end
 end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.0.0".freeze
+  VERSION = "6.1.0".freeze
 end