govspeak 5.6.0 → 5.7.0

data/lib/govspeak/link_extractor.rb

@@ -6,7 +6,7 @@ module Govspeak
     end
 
     def call
-      @links ||= extract_links
+      @call ||= extract_links
     end
 
   private

data/lib/govspeak/post_processor.rb

@@ -2,35 +2,18 @@ require 'nokogiri'
 
 module Govspeak
   class PostProcessor
-    attr_reader :input
-
-    @@extensions = []
-
-    def initialize(html)
-      @input = html
-    end
+    @extensions = []
 
-    def nokogiri_document
-      doc = Nokogiri::HTML::Document.new
-      doc.encoding = "UTF-8"
-      doc.fragment(input)
+    def self.extensions
+      @extensions
     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
+      @extensions << [title, block]
     end
 
     extension("add class to last p of blockquote") do |document|
@@ -53,6 +36,7 @@ module Govspeak
       document.css("figure.image").map do |el|
         xml = el.children.to_s
         next unless xml =~ /&lt;div class="img"&gt;|&lt;figcaption&gt;/
+
         el.children = xml
           .gsub(
             %r{&lt;(div class="img")&gt;(.*?)&lt;(/div)&gt;},
@@ -64,5 +48,28 @@ module Govspeak
           )
       end
     end
+
+    attr_reader :input
+
+    def initialize(html)
+      @input = html
+    end
+
+    def output
+      document = nokogiri_document
+      self.class.extensions.each do |_, block|
+        instance_exec(document, &block)
+      end
+      document.to_html
+    end
+
+
+  private
+
+    def nokogiri_document
+      doc = Nokogiri::HTML::Document.new
+      doc.encoding = "UTF-8"
+      doc.fragment(input)
+    end
   end
 end

data/lib/govspeak/presenters/attachment_presenter.rb

@@ -2,6 +2,8 @@ require "action_view"
 require "money"
 require "htmlentities"
 
+Money.locale_backend = :currency
+
 module Govspeak
   class AttachmentPresenter
     attr_reader :attachment
@@ -36,6 +38,7 @@ module Govspeak
 
     def price
       return unless attachment[:price]
+
       Money.from_amount(attachment[:price], 'GBP').format
     end
 
@@ -46,6 +49,7 @@ module Govspeak
     def thumbnail_link
       return if hide_thumbnail?
       return if previewable?
+
       link(attachment_thumbnail, url, "aria-hidden" => "true", "class" => attachment_class)
     end
 
@@ -83,16 +87,16 @@ module Govspeak
     end
 
     def body_for_mail(attachment_info)
-      <<-END
-Details of document required:
+      <<~TEXT
+        Details of document required:
 
-#{attachment_info.join("\n")}
+        #{attachment_info.join("\n")}
 
-Please tell us:
+        Please tell us:
 
-  1. What makes this format unsuitable for you?
-  2. What format you would prefer?
-END
+          1. What makes this format unsuitable for you?
+          2. What format you would prefer?
+      TEXT
     end
 
     def alternative_format_contact_email
@@ -256,6 +260,7 @@ END
 
     def attachment_details
       return if previewable?
+
       link(title, url, title_link_options)
     end
 

data/lib/govspeak/presenters/contact_presenter.rb

@@ -1,24 +1,69 @@
 require 'active_support/core_ext/array'
-require 'ostruct'
+require 'active_support/core_ext/hash'
 
 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)
+      @contact = ActiveSupport::HashWithIndifferentAccess.new(contact)
     end
 
-    def contact_numbers
-      Array.wrap(contact[:contact_numbers])
+    def content_id
+      contact[:content_id]
     end
 
-    def has_postal_address?
-      recipient.present? || street_address.present? || locality.present? ||
-        region.present? || postal_code.present?
+    def title
+      contact[:title]
+    end
+
+    def description
+      contact[:description]
+    end
+
+    def post_addresses
+      @post_addresses ||= begin
+                            addresses = contact.dig(:details, :post_addresses) || []
+                            filter_post_addresses(addresses)
+                          end
+    end
+
+    def email_addresses
+      @email_addresses ||= begin
+                             emails = contact.dig(:details, :email_addresses) || []
+                             emails.select { |e| e[:email].present? }
+                           end
+    end
+
+    def phone_numbers
+      @phone_numbers ||= begin
+                           phone_numbers = contact.dig(:details, :phone_numbers) || []
+                           phone_numbers.select { |p| p[:number].present? }
+                         end
+    end
+
+    def contact_form_links
+      @contact_form_links ||= begin
+                                contact_form_links = contact.dig(:details, :contact_form_links) || []
+                                contact_form_links.select { |c| c[:link].present? }
+                              end
+    end
+
+  private
+
+    def filter_post_addresses(addresses)
+      addresses.each do |address|
+        # A lot of the postal addresses published to the Publishing API have
+        # a populated array of postal addresses but each field an empty string :-(
+        address.delete_if do |key, value|
+          # Not showing United Kingdom country is a "feature" lifted and shifted
+          # from Whitehall:
+          # https://github.com/alphagov/whitehall/blob/c67d53d80f9856549c2da1941a10dbb9170be494/lib/address_formatter/formatter.rb#L17
+          (key == "world_location" && value.strip == "United Kingdom" || value == "")
+        end
+      end
+
+      addresses.reject(&:empty?)
     end
   end
 end

data/lib/govspeak/presenters/h_card_presenter.rb

@@ -1,46 +1,26 @@
 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')
+      @address_formats ||= YAML.load_file(
+        File.expand_path('config/address_formats.yml', Govspeak.root)
+      )
     end
 
-    attr_reader :properties, :country_code
+    attr_reader :contact_address
 
-    def initialize(properties, country_code)
-      @properties = properties
-      @country_code = country_code
+    def initialize(contact_address)
+      @contact_address = contact_address
     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]
+    def interpolate_address_property(our_name, hcard_name)
+      value = contact_address[our_name]
 
       if value.present?
-        "<span class=\"#{property_name}\">#{ERB::Util.html_escape(value)}</span>"
+        "<span class=\"#{hcard_name}\">#{ERB::Util.html_escape(value)}</span>"
       else
         ""
       end
@@ -51,8 +31,17 @@ module Govspeak
     def interpolate_address_template
       address = address_template
 
-      self.class.property_keys.each do |key|
-        address.gsub!(/\{\{#{key}\}\}/, interpolate_address_property(key))
+      properties = {
+        title: "fn",
+        street_address: "street-address",
+        locality: "locality",
+        region: "region",
+        postal_code: "postal-code",
+        world_location: "country-name",
+      }
+
+      properties.each do |our_name, hcard_name|
+        address.gsub!(/\{\{#{hcard_name}\}\}/, interpolate_address_property(our_name, hcard_name))
       end
 
       address.gsub(/^\n/, '')         # get  rid of blank lines
@@ -61,7 +50,8 @@ module Govspeak
     end
 
     def address_template
-      (self.class.address_formats[country_code.to_s.downcase] || default_format_string).dup
+      country_code = contact_address[:iso2_country_code].to_s.downcase
+      (self.class.address_formats[country_code] || default_format_string).dup
     end
 
     def default_format_string

data/lib/govspeak/structured_header_extractor.rb

@@ -1,5 +1,4 @@
 module Govspeak
-
   StructuredHeader = Struct.new(:text, :level, :id, :headers) do
     def top_level
       2

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "5.6.0".freeze
+  VERSION = "5.7.0".freeze
 end

data/lib/kramdown/parser/kramdown_with_automatic_external_links.rb

@@ -4,17 +4,17 @@ require "kramdown/options"
 module Kramdown
   module Options
     class AlwaysEqual
-      def ==(other)
+      def ==(_other)
         true
       end
     end
 
-    define(:document_domains, Object, %w{www.gov.uk}, <<EOF) do |val|
-Defines the domains which are considered local to the document
+    define(:document_domains, Object, %w{www.gov.uk}, <<~DESCRIPTION) do |val|
+      Defines the domains which are considered local to the document
 
-Default: www.gov.uk
-Used by: KramdownWithAutomaticExternalLinks
-EOF
+      Default: www.gov.uk
+      Used by: KramdownWithAutomaticExternalLinks
+    DESCRIPTION
       simple_array_validator(val, :document_domains, AlwaysEqual.new)
     end
   end
@@ -26,16 +26,18 @@ EOF
         super
       end
 
-      def add_link(el, href, title, alt_text = nil, ial = nil)
-        if el.type == :a
+      def add_link(element, href, title, alt_text = nil, ial = nil)
+        if element.type == :a
           begin
             host = Addressable::URI.parse(href).host
-            unless host.nil? || (@document_domains.compact.include?(host))
-              el.attr['rel'] = 'external'
+            unless host.nil? || @document_domains.compact.include?(host)
+              element.attr['rel'] = 'external'
             end
+          # rubocop:disable Lint/HandleExceptions
           rescue Addressable::URI::InvalidURIError
             # it's safe to ignore these very *specific* exceptions
           end
+          # rubocop:enable Lint/HandleExceptions
         end
         super
       end

data/lib/templates/attachment.html.erb

@@ -6,14 +6,14 @@
     <h2 class="title"><%= attachment.attachment_details %></h2>
     <p class="metadata">
       <% if attachment.references? %>
-        <span class="references"><%= t('attachment.headings.reference') %>: <%= attachment.reference %></span>
+        <span class="references"><%= t('govspeak.attachment.headings.reference') %>: <%= attachment.reference %></span>
       <% end %>
       <% if attachment.unnumbered_paper? %>
         <span class="unnumbered-paper">
           <% if attachment.unnumbered_command_paper? %>
-            <%= t('attachment.headings.unnumbered_command_paper') %>
+            <%= t('govspeak.attachment.headings.unnumbered_command_paper') %>
           <% else %>
-            <%= t('attachment.headings.unnumbered_hoc_paper') %>
+            <%= t('govspeak.attachment.headings.unnumbered_hoc_paper') %>
           <% end %>
         </span>
       <% end %>
@@ -28,25 +28,25 @@
     </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')
+        <%= attachment.link t('govspeak.attachment.headings.order_a_copy'), attachment.order_url,
+          class: "order_url", title: t('govspeak.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') %>
+        <%= t('govspeak.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><%= t('govspeak.attachment.accessibility.heading') %>
+          <a class="toggler" href="#<%= attachment.help_block_toggle_id %>" data-controls="<%= attachment.help_block_toggle_id %>" data-expanded="false"><%= t('govspeak.attachment.accessibility.request_a_different_format') %></a>
         </h2>
         <p id="<%= attachment.help_block_toggle_id %>" class="js-hidden">
-          <%= t('attachment.accessibility.full_help_html',
+          <%= t('govspeak.attachment.accessibility.full_help_html',
                 email: attachment.alternative_format_order_link,
                 title: attachment.title,
                 references: attachment.references_for_title) %>

data/lib/templates/contact.html.erb

@@ -1,41 +1,38 @@
 <%
   extra_class = []
-  extra_class << 'postal-address' if contact.has_postal_address?
+  extra_class << 'postal-address' if contact.post_addresses.any?
 %>
-<div id="contact_<%= contact.id %>" class="<%= ['contact', extra_class].flatten.join(' ') %>">
+<div id="contact_<%= contact.content_id %>" class="<%= ['contact', extra_class].flatten.join(' ') %>">
   <div class="content">
     <h3><%= contact.title %></h3>
     <div class="vcard contact-inner">
-    <% if contact.has_postal_address? %>
-      <%= render_hcard_address(contact) %>
+    <% contact.post_addresses.each do |address| %>
+      <%= render_hcard_address(address) %>
     <% end %>
-    <% if contact.email.present? || contact.contact_form_url.present? || contact.contact_numbers.any? %>
+    <% if contact.email_addresses.any? || contact.phone_numbers.any? || contact.contact_form_links.any? %>
       <div class="email-url-number">
-      <% if contact.email.present? %>
+      <% contact.email_addresses.each do |email| %>
         <p class="email">
-          <span class="type"><%= t('contact.email') %></span>
-          <a href="mailto:<%= contact.email %>" class="email"><%= contact.email %></a>
+          <span class="type"><%= t('govspeak.contact.email') %></span>
+          <a href="mailto:<%= email[:email] %>" class="email"><%= email[:title].present? ? email[:title] : email[:email] %></a>
         </p>
       <% end %>
-      <% if contact.contact_form_url.present? %>
+      <% contact.contact_form_links.each do |form_link| %>
         <p class="contact_form_url">
-          <span class="type"><%= t('contact.contact_form') %></span>
-          <a href="<%= contact.contact_form_url %>"><%= contact.contact_form_url.truncate(25) %></a>
+          <span class="type"><%= t('govspeak.contact.contact_form') %></span>
+          <a href="<%= form_link[:link] %>"><%= form_link[:link].truncate(25) %></a>
         </p>
       <% end %>
-      <% contact.contact_numbers.each do |number| %>
+      <% contact.phone_numbers.each do |number| %>
         <p class="tel">
-          <span class="type"><%= number[:label] %></span>
+          <span class="type"><%= number[:title] %></span>
           <%= number[:number] %>
         </p>
       <% end %>
       </div>
     <% end %>
-    <% if contact.comments.present? %>
-      <p class="comments"><%= auto_link(format_with_html_line_breaks(h(contact.comments))) %></p>
-    <% end %>
-    <% if contact.worldwide_organisation_path %>
-      <a href="<%= contact.worldwide_organisation_path %>">Access and opening times</a>
+    <% if contact.description.present? %>
+      <p class="comments"><%= Rinku.auto_link(format_with_html_line_breaks(contact.description)) %></p>
     <% end %>
     </div>
   </div>