govspeak 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 726774ba404422dd313e1afb12bbc3d1c2e036fd
-  data.tar.gz: 4f7e5f0f7b4c9e67c33120050f3021048c13dec7
+  metadata.gz: 177a638111a0d8d422e3201f0e3e265218fb1cb9
+  data.tar.gz: 5be0baf8e84b10bfd28f0f5ed6e1c5e292fe4c1e
 SHA512:
-  metadata.gz: a144b4353edd665f01109bd1eae1ff569f22ea6133bf564024e973d7df730e9f318d9eb76e76df5917e130b10dbf9897dcbcd75ccfdb816ba291b16e3e9349a0
-  data.tar.gz: 8370760f5a9929f8c33b001d99fc5409900182d815bbae0059c33360d47ef7ccd560ae4b206bdec7940747b73ce9e544edffd10751a7107070b8a9aa49006e8f
+  metadata.gz: 77ca5d6c13299db9221804e96b01fb15412d0c38d3017219304992d225dab4382dec796015fd2533e62e7ad734d6f0199b216b175e4f45d099cc913b8ed24a6a
+  data.tar.gz: b52ed84b08d05f85c44a2a3bb3fe2d86835f2cf9934e9ead9b7c143b9be9fcbea03b84d8af70ca2245426a9ea1676b54a35a2714d7a3e679ad890d1ee87f46d9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.0.1
+* Move presenters into the Govspeak namespace [#93](https://github.com/alphagov/govspeak/pull/93)
+* Embedded links now will automatically be marked with `rel="external"` [#96](https://github.com/alphagov/govspeak/pull/96)
+
 ## 5.0.0
 * Update Kramdown version to 1.12.0
 * Add pry-byebug to development dependencies

data/README.md

@@ -43,7 +43,7 @@ In addition to the [standard Markdown syntax](http://daringfireball.net/projects
 creates a callout with an info (i) icon.
 
     <div role="note" aria-label="Information" class="application-notice info-notice">
-    	<p>This is an information callout</p>
+      <p>This is an information callout</p>
     </div>
 
 ### Warning callouts
@@ -53,7 +53,7 @@ creates a callout with an info (i) icon.
 creates a callout with a warning or alert (!) icon
 
     <div role="note" aria-label="Help" class="application-notice help-notice">
-    	<p>This is a warning callout</p>
+      <p>This is a warning callout</p>
     </div>
 
 ### Example callout
@@ -158,6 +158,74 @@ creates a file download box
     <p><a href="http://example.com/" title="Example form" rel="external">An example form download link.</a></p>
     </div>
 
+## Place
+
+    $P
+    This is a place
+    $P
+
+creates a place box
+
+    <div class="place">
+    <p>This is a place</p>
+    </div>
+
+## Information
+
+    $I
+    This is information
+    $I
+
+creates an information box
+
+    <div class="information">
+    <p>This is information</p>
+    </div>
+
+## Additional Information
+
+    $AI
+    This is additional information
+    $AI
+
+creates an additional information box
+
+    <div class="additional-information">
+    <p>This is additional information</p>
+    </div>
+
+## Call to Action
+
+    $CTA
+    This is a call to action
+    $CTA
+
+creates an additional information box
+
+    <div class="call-to-action">
+    <p>This is a call to action</p>
+    </div>
+
+## Summary
+
+    $!
+    This is a summary
+    $!
+
+creates a summary box
+
+    <div class="summary">
+    <p>This is a summary</p>
+    </div>
+
+## External Link
+
+    x[External Report](https://example.com/report)x
+
+creates a link specified as external
+
+    <a href="https://example.com/report" rel="external">External Report</a>
+
 ## Steps
 
 Steps can be created similar to an ordered list:
@@ -183,17 +251,26 @@ For lists where you want to specify the numbering and have multiple indent level
     $EndLegislativeList
     (to indent, add 2 spaces)
 
-## Abbreviations
-
-Abbreviations can be defined at the end of the document, and any occurrences elswhere in the document will wrapped in an `<abbr>` tag. They are parsed in the order in which they are defined, so `PCSOs` should be defined before `PCSO`, for example.
+## Priority Lists
 
-    Special rules apply if you’re exporting a vehicle outside the EU.
+For lists where you want to specify a number of items to be highlighted as priority.
 
-    *[EU]:European Union
+    $PriorityList:3
+    - Item 1
+    - Item 2
+    - Item 3
+    - Item 4
+    - Item 5
 
-becomes
+creates a list with priority items flagged with a class
 
-    <p>Special rules apply if you’re exporting a vehicle outside the <abbr title="European Union">EU</abbr>.</p>
+    <ul>
+      <li class="primary-item">Item 1</li>
+      <li class="primary-item">Item 2</li>
+      <li class="primary-item">Item 3</li>
+      <li>Item 4</li>
+      <li>Item 5</li>
+    </ul>
 
 ## Devolved content
 
@@ -203,3 +280,190 @@ becomes
     :wales:content goes here:wales:
     :northern-ireland:content goes here:northern-ireland:
     :england-wales:content goes here:england-wales:
+
+will create a box for the specified locality
+
+    <div class="devolved-content england">
+      <p class="devolved-header">This section applies to England</p>
+      <div class="devolved-body">
+        <p>content goes here</p>
+      </div>
+    </div>
+
+## Barcharts
+
+For when you want a table to be progressively enhanced by Javascript to be
+rendered as a bar chart.
+
+    |col|
+    |---|
+    |val|
+    {barchart}
+
+will be rendered as
+    <table class="js-barchart-table mc-auto-outdent">
+      <thead>
+        <tr>
+          <th>col</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>val</td>
+        </tr>
+      </tbody>
+    </table>
+
+## Embedded Content
+
+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
+
+    <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
+
+    Details referenced in [embed:attachments:inline:34f6dda0-21b1-4e78-8120-3ff4dcea522d]
+
+with options provided
+
+    {
+      attachments: [
+        {
+          content_id: "34f6dda0-21b1-4e78-8120-3ff4dcea522d",
+          title: "My Thorough Study",
+          url: "http://example.com/my-thorough-study.pdf",
+        }
+      ]
+    }
+
+will output an attachment within a block of text
+
+    <p>Details referenced in <span class="attachment-inline"><a href="http://example.com/my-thorough-study.pdf">My Thorough Study</a></span>
+
+### Image Attachments
+
+Attachments can be used to embed an image within the document
+
+    [embed:attachments:image:45ee0eea-bc53-4f14-81eb-9e75d33c4d5e]
+
+with options provided
+
+    {
+      attachments: [
+        {
+          content_id: "45ee0eea-bc53-4f14-81eb-9e75d33c4d5e",
+          title: "A lovely landscape",
+          url: "http://example.com/lovely-landscape.jpg",
+        }
+      ]
+    }
+
+will output a image section
+
+    <figure class="image embedded"><div class="img"><img src="http://example.com/lovely-landscape.jpg" alt="A Lovely Landscape"></div></figure>
+
+### Link
+
+Links to different documents can be embedded so they change when the documents
+they reference change.
+
+    A link to [embed:link:c636b433-1e5c-46d4-96b0-b5a168fac26c]
+
+with options provided
+
+    {
+      links: [
+        {
+          url: "http://example.com",
+          title: "An excellent website",
+        }
+      ]
+    }
+
+will output
+
+    <p>A link to <a href="http://example.com">An excellent website</a></p>
+
+### Contact
+
+    [Contact:df62690f-34a0-4840-a7fa-4ef5acc18666]
+
+with options provided
+
+    {
+      contacts: [
+        {
+          id: 123,
+          content_id: "df62690f-34a0-4840-a7fa-4ef5acc18666",
+          title: "Government Digital Service",
+          email: "people@digital.cabinet-office.gov.uk",
+          contact_numbers: [
+            { label: "helpdesk", number: "+4412345 67890"}
+          ]
+        }
+      ]
+    }
+
+will output
+
+    <div id="contact_123" class="contact">
+      <div class="content">
+        <h3>Government Digital Service</h3>
+        <div class="vcard contact-inner">
+          <div class="email-url-number">
+            <p class="email">
+              <span class="type">Email</span>
+              <a href="mailto:people@digital.cabinet-office.gov.uk" class="email">people@digital.cabinet-office.gov.uk</a>
+            </p>
+            <p class="tel">
+              <span class="type">helpdesk</span>
+              +4412345 67890
+            </p>
+          </div>
+        </div>
+      </div>
+    </div>

data/lib/govspeak.rb

@@ -1,6 +1,9 @@
-require 'kramdown'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/array'
+require 'erb'
+require 'htmlentities'
+require 'kramdown'
+require 'kramdown/parser/kramdown_with_automatic_external_links'
 require 'govspeak/header_extractor'
 require 'govspeak/structured_header_extractor'
 require 'govspeak/html_validator'
@@ -8,12 +11,9 @@ 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/contact_presenter'
-require 'presenters/h_card_presenter'
-require 'erb'
+require 'govspeak/presenters/attachment_presenter'
+require 'govspeak/presenters/contact_presenter'
+require 'govspeak/presenters/h_card_presenter'
 
 module Govspeak
 
@@ -32,7 +32,7 @@ module Govspeak
     end
 
     def initialize(source, options = {})
-      options.deep_symbolize_keys!
+      options = options.dup.deep_symbolize_keys
       @source = source ? source.dup : ""
       @images = options.delete(:images) || []
       @attachments = Array.wrap(options.delete(:attachments))
@@ -303,7 +303,7 @@ module Govspeak
       link = links.detect { |l| l[:content_id].match(content_id) }
       next "" unless link
       if link[:url]
-        %Q{<a href="#{encode(link[:url])}">#{link[:title]}</a>}
+        "[#{link[:title]}](#{link[:url]})"
       else
         link[:title]
       end

data/lib/govspeak/presenters/attachment_presenter.rb

@@ -0,0 +1,288 @@
+require "action_view"
+require "money"
+require "htmlentities"
+
+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)
+      @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-#{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)
+      <<-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
+
+    # 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?]
+    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)
+    end
+
+    def attachment_attributes
+      attributes = []
+      if file_extension == "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(file_extension), class: 'type') if file_extension
+        attributes << content_tag(:span, number_to_human_size(attachment[:file_size]), class: 'file-size') if attachment[:file_size]
+        attributes << content_tag(:span, pluralize(attachment[:number_of_pages], "page"), class: 'page-length') if attachment[:number_of_pages]
+      end
+      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
+
+    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?
+      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>}
+    end
+
+  private
+
+    def encode(text)
+      HTMLEntities.new.encode(text)
+    end
+
+    def urlencode(text)
+      ERB::Util.url_encode(text)
+    end
+  end
+end

data/lib/govspeak/presenters/contact_presenter.rb

@@ -0,0 +1,24 @@
+require 'active_support/core_ext/array'
+require 'ostruct'
+
+module Govspeak
+  class ContactPresenter
+    attr_reader :contact
+    delegate :id, :content_id, :title, :recipient, :street_address, :postal_code,
+      :locality, :region, :country_code, :country_name, :email, :contact_form_url,
+      :comments, :worldwide_organisation_path, to: :contact
+
+    def initialize(contact)
+      @contact = OpenStruct.new(contact)
+    end
+
+    def contact_numbers
+      Array.wrap(contact[:contact_numbers])
+    end
+
+    def has_postal_address?
+      recipient.present? || street_address.present? || locality.present? ||
+        region.present? || postal_code.present?
+    end
+  end
+end

data/lib/govspeak/presenters/h_card_presenter.rb

@@ -0,0 +1,71 @@
+module Govspeak
+  class HCardPresenter
+    def self.from_contact(contact)
+      new(contact_properties(contact), contact.country_code)
+    end
+
+    def self.contact_properties(contact)
+      { 'fn' => contact.recipient,
+        'street-address' => contact.street_address,
+        'postal-code' => contact.postal_code,
+        'locality' => contact.locality,
+        'region' => contact.region,
+        'country-name' => country_name(contact) }
+    end
+
+    def self.country_name(contact)
+      contact.country_name unless contact.country_code == 'GB'
+    end
+
+    def self.property_keys
+      ['fn', 'street-address', 'postal-code', 'locality', 'region', 'country-name']
+    end
+
+    def self.address_formats
+      @address_formats ||= YAML.load_file('config/address_formats.yml')
+    end
+
+    attr_reader :properties, :country_code
+
+    def initialize(properties, country_code)
+      @properties = properties
+      @country_code = country_code
+    end
+
+    def render
+      "<p class=\"adr\">\n#{interpolate_address_template}\n</p>\n".html_safe
+    end
+
+    def interpolate_address_property(property_name)
+      value = properties[property_name]
+
+      if value.present?
+        "<span class=\"#{property_name}\">#{ERB::Util.html_escape(value)}</span>"
+      else
+        ""
+      end
+    end
+
+  private
+
+    def interpolate_address_template
+      address = address_template
+
+      self.class.property_keys.each do |key|
+        address.gsub!(/\{\{#{key}\}\}/, interpolate_address_property(key))
+      end
+
+      address.gsub(/^\n/, '')         # get  rid of blank lines
+             .strip                   # get rid of any trailing whitespace
+             .gsub(/\n/, "<br />\n")  # add break tags where appropriate
+    end
+
+    def address_template
+      (self.class.address_formats[country_code.to_s.downcase] || default_format_string).dup
+    end
+
+    def default_format_string
+      self.class.address_formats['gb']
+    end
+  end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "5.0.0"
+  VERSION = "5.0.1"
 end

data/test/govspeak_link_test.rb

@@ -6,27 +6,38 @@ class GovspeakLinkTest < Minitest::Test
   test "embedded link with link provided" do
     link = {
       content_id: "5572fee5-f38f-4641-8ffa-64fed9230ad4",
-      url: "https://www.example.com/",
-      title: "Example website"
+      url: "https://www.gov.uk/example",
+      title: "Example page",
     }
     govspeak = "[embed:link:5572fee5-f38f-4641-8ffa-64fed9230ad4]"
     rendered = Govspeak::Document.new(govspeak, links: link).to_html
-    expected = %r{<a href="https://www.example.com/">Example website</a>}
+    expected = %r{<a href="https://www.gov.uk/example">Example page</a>}
     assert_match(expected, rendered)
   end
 
   test "embedded link with markdown title" do
     link = {
       content_id: "5572fee5-f38f-4641-8ffa-64fed9230ad4",
-      url: "https://www.example.com/",
-      title: "**Example website**"
+      url: "https://www.gov.uk/example",
+      title: "**Example page**",
     }
     govspeak = "[embed:link:5572fee5-f38f-4641-8ffa-64fed9230ad4]"
     rendered = Govspeak::Document.new(govspeak, links: link).to_html
-    expected = %r{<a href="https://www.example.com/"><strong>Example website</strong></a>}
+    expected = %r{<a href="https://www.gov.uk/example"><strong>Example page</strong></a>}
     assert_match(expected, rendered)
   end
 
+  test "embedded link with external url" do
+    link = {
+      content_id: "5572fee5-f38f-4641-8ffa-64fed9230ad4",
+      url: "https://www.example.com/",
+      title: "Example website",
+    }
+    govspeak = "[embed:link:5572fee5-f38f-4641-8ffa-64fed9230ad4]"
+    rendered = Govspeak::Document.new(govspeak, links: link).to_html
+    expected = %r{<a rel="external" href="https://www.example.com/">Example website</a>}
+    assert_match(expected, rendered)
+  end
   test "embedded link with url not provided" do
     link = {
       content_id: "e510f1c1-4862-4333-889c-8d3acd443fbf",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Ben Griffiths
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -251,12 +251,12 @@ files:
 - lib/govspeak/html_validator.rb
 - lib/govspeak/kramdown_overrides.rb
 - lib/govspeak/post_processor.rb
+- lib/govspeak/presenters/attachment_presenter.rb
+- lib/govspeak/presenters/contact_presenter.rb
+- lib/govspeak/presenters/h_card_presenter.rb
 - lib/govspeak/structured_header_extractor.rb
 - lib/govspeak/version.rb
 - lib/kramdown/parser/kramdown_with_automatic_external_links.rb
-- lib/presenters/attachment_presenter.rb
-- lib/presenters/contact_presenter.rb
-- lib/presenters/h_card_presenter.rb
 - lib/templates/attachment.html.erb
 - lib/templates/contact.html.erb
 - lib/templates/inline_attachment.html.erb

data/lib/presenters/attachment_presenter.rb

@@ -1,286 +0,0 @@
-require "action_view"
-require "money"
-require "htmlentities"
-
-class AttachmentPresenter
-  attr_reader :attachment
-  include ActionView::Helpers::TagHelper
-  include ActionView::Helpers::NumberHelper
-  include ActionView::Helpers::AssetTagHelper
-  include ActionView::Helpers::TextHelper
-
-  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-#{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)
-    <<-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
-
-  # 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?]
-  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)
-  end
-
-  def attachment_attributes
-    attributes = []
-    if file_extension == "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(file_extension), class: 'type') if file_extension
-      attributes << content_tag(:span, number_to_human_size(attachment[:file_size]), class: 'file-size') if attachment[:file_size]
-      attributes << content_tag(:span, pluralize(attachment[:number_of_pages], "page"), class: 'page-length') if attachment[:number_of_pages]
-    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?
-    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>}
-  end
-
-private
-
-  def encode(text)
-    HTMLEntities.new.encode(text)
-  end
-
-  def urlencode(text)
-    ERB::Util.url_encode(text)
-  end
-end

data/lib/presenters/contact_presenter.rb

@@ -1,22 +0,0 @@
-require 'active_support/core_ext/array'
-require 'ostruct'
-
-class ContactPresenter
-  attr_reader :contact
-  delegate :id, :content_id, :title, :recipient, :street_address, :postal_code,
-    :locality, :region, :country_code, :country_name, :email, :contact_form_url,
-    :comments, :worldwide_organisation_path, to: :contact
-
-  def initialize(contact)
-    @contact = OpenStruct.new(contact)
-  end
-
-  def contact_numbers
-    Array.wrap(contact[:contact_numbers])
-  end
-
-  def has_postal_address?
-    recipient.present? || street_address.present? || locality.present? ||
-    region.present? || postal_code.present?
-  end
-end

data/lib/presenters/h_card_presenter.rb

@@ -1,69 +0,0 @@
-class HCardPresenter
-  def self.from_contact(contact)
-    new(contact_properties(contact), contact.country_code)
-  end
-
-  def self.contact_properties(contact)
-    { 'fn' => contact.recipient,
-      'street-address' => contact.street_address,
-      'postal-code' => contact.postal_code,
-      'locality' => contact.locality,
-      'region' => contact.region,
-      'country-name' => country_name(contact) }
-  end
-
-  def self.country_name(contact)
-    contact.country_name unless contact.country_code == 'GB'
-  end
-
-  def self.property_keys
-    ['fn', 'street-address', 'postal-code', 'locality', 'region', 'country-name']
-  end
-
-  def self.address_formats
-    @address_formats ||= YAML.load_file('config/address_formats.yml')
-  end
-
-  attr_reader :properties, :country_code
-
-  def initialize(properties, country_code)
-    @properties = properties
-    @country_code = country_code
-  end
-
-  def render
-    "<p class=\"adr\">\n#{interpolate_address_template}\n</p>\n".html_safe
-  end
-
-  def interpolate_address_property(property_name)
-    value = properties[property_name]
-
-    if value.present?
-      "<span class=\"#{property_name}\">#{ERB::Util.html_escape(value)}</span>"
-    else
-      ""
-    end
-  end
-
-  private
-
-  def interpolate_address_template
-    address = address_template
-
-    self.class.property_keys.each do |key|
-      address.gsub!(/\{\{#{key}\}\}/, interpolate_address_property(key))
-    end
-
-    address.gsub(/^\n/, '')         # get  rid of blank lines
-           .strip                   # get rid of any trailing whitespace
-           .gsub(/\n/, "<br />\n")  # add break tags where appropriate
-  end
-
-  def address_template
-    (self.class.address_formats[country_code.to_s.downcase] || default_format_string).dup
-  end
-
-  def default_format_string
-    self.class.address_formats['gb']
-  end
-end