govspeak 5.6.0 → 5.7.0

data/test/govspeak_attachments_test.rb

@@ -344,59 +344,6 @@ class GovspeakAttachmentTest < Minitest::Test
     end
   end
 
-  test "a full attachment rendering looks correct" do
-    attachment = {
-      id: 123,
-      content_id: "2b4d92f3-f8cd-4284-aaaa-25b3a640d26c",
-      title: "Attachment Title",
-      url: "http://example.com/test.pdf",
-      opendocument?: true,
-      order_url: "http://example.com/order",
-      price: 12.3,
-      isbn: "isbn-123",
-      unnumbered_command_paper?: true,
-    }
-    rendered = render_govspeak(
-      "[embed:attachments:2b4d92f3-f8cd-4284-aaaa-25b3a640d26c]",
-      [build_attachment(attachment)]
-    )
-    expected_html_output = %{
-      <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>
-            <span class="unnumbered-paper">
-              Unnumbered command paper
-            </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>
-          <p class="opendocument-help">
-            This file is in an <a rel="external" href="https://en.wikipedia.org/wiki/OpenDocument_software">OpenDocument</a> format
-          </p>
-          <div data-module="toggle" class="accessibility-warning" id="attachment-123-accessibility-help">
-            <h2>This file may not be suitable for users of assistive technology.
-              <a class="toggler" href="#attachment-123-accessibility-request" data-controls="attachment-123-accessibility-request" data-expanded="false">Request an accessible format.</a>
-            </h2>
-            <p id="attachment-123-accessibility-request" class="js-hidden">
-              If you use assistive technology (eg a screen reader) and need a
-              version of this document in a more accessible format, please email <a href="mailto:govuk-feedback@digital.cabinet-office.gov.uk?subject=Request%20for%20%27Attachment%20Title%27%20in%20an%20alternative%20format&amp;body=Details%20of%20document%20required%3A%0A%0A%20%20Title%3A%20Attachment%20Title%0A%20%20ISBN%3A%20isbn-123%0A%0APlease%20tell%20us%3A%0A%0A%20%201.%20What%20makes%20this%20format%20unsuitable%20for%20you%3F%0A%20%202.%20What%20format%20you%20would%20prefer%3F%0A">govuk-feedback@digital.cabinet-office.gov.uk</a>.
-              Please tell us what format you need. It will help us if you say what assistive technology you use.
-            </p>
-          </div>
-        </div>
-      </section>
-    }
-    assert_equal(compress_html(expected_html_output), compress_html(rendered))
-  end
-
   test "attachment that isn't provided" do
     govspeak = "[embed:attachments:906ac8b7-850d-45c6-98e0-9525c680f891]"
     rendered = Govspeak::Document.new(govspeak).to_html

data/test/govspeak_contacts_test.rb

@@ -3,38 +3,66 @@
 require 'test_helper'
 
 class GovspeakContactsTest < Minitest::Test
-
-  def build_contact(attrs={})
+  def build_contact(attrs = {})
     {
-      id: attrs.fetch(:id, 123456),
       content_id: attrs.fetch(:content_id, "4f3383e4-48a2-4461-a41d-f85ea8b89ba0"),
       title: attrs.fetch(:title, "Government Digital Service"),
-      recipient: attrs.fetch(:recipient, ""),
-      street_address: attrs.fetch(:street_address, "125 Kingsway"),
-      postal_code: attrs.fetch(:postal_code, "WC2B 6NH"),
-      locality: attrs.fetch(:locality, "Holborn"),
-      region: attrs.fetch(:region, "London"),
-      country_code: attrs.fetch(:country_code, "gb"),
-      email: attrs.fetch(:email, "people@digital.cabinet-office.gov.uk"),
-      contact_form_url: attrs.fetch(:contact_form_url, ""),
-      contact_numbers: attrs.fetch(:contact_numbers,
-                                   [{ label: "helpdesk", number: "+4412345 67890" }]),
-      comments: attrs.fetch(:comments, ""),
-      worldwide_organisation_path: attrs.fetch(:worldwide_organisation_path, nil),
+      description: attrs.fetch(:description, ""),
+      details: {
+        post_addresses: attrs.fetch(
+          :post_addresses,
+          [
+            {
+              title: "",
+              street_address: "125 Kingsway",
+              locality: "Holborn",
+              region: "London",
+              postal_code: "WC2B 6NH",
+              world_location: "United Kingdom",
+            }
+          ]
+        ),
+        email_addresses: attrs.fetch(
+          :email_addresses,
+          [
+            {
+              title: "",
+              email: "people@digital.cabinet-office.gov.uk",
+            }
+          ]
+        ),
+        phone_numbers: attrs.fetch(
+          :phone_numbers,
+          [
+            {
+              title: "helpdesk",
+              number: "+4412345 67890",
+            }
+          ]
+        ),
+        contact_form_links: attrs.fetch(
+          :contact_form_links,
+          [
+            {
+              link: "https://www.gov.uk/contact"
+            }
+          ]
+        )
+      }
     }
   end
 
   def compress_html(html)
-    html.gsub(/[\n\r]+[\s]*/,'')
+    html.gsub(/[\n\r]+[\s]*/, '')
   end
 
   test "contact is rendered when present in options[:contacts]" do
     contact = build_contact
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
 
-    rendered = Govspeak::Document.new(govspeak, { contacts: [contact] }).to_html
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
     expected_html_output = %{
-      <div id="contact_123456" class="contact postal-address">
+      <div id="contact_4f3383e4-48a2-4461-a41d-f85ea8b89ba0" class="contact postal-address">
         <div class="content">
           <h3>Government Digital Service</h3>
           <div class="vcard contact-inner">
@@ -49,6 +77,10 @@ class GovspeakContactsTest < Minitest::Test
                 <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="contact_form_url">
+                <span class="type">Contact form</span>
+                <a href="https://www.gov.uk/contact">https://www.gov.uk/con...</a>
+              </p>
               <p class="tel">
                 <span class="type">helpdesk</span>
                 +4412345 67890
@@ -65,27 +97,16 @@ class GovspeakContactsTest < Minitest::Test
   test "no contact is rendered when contact not present in options[:contacts]" do
     contact = build_contact(content_id: "19f06142-1b4a-47ce-b257-964badd0a5e2")
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
-    rendered = Govspeak::Document.new(govspeak, { contacts: [contact]}).to_html
-    assert_match("", rendered)
-  end
-
-  test "no contact is rendered when no contacts are supplied" do
-    rendered = Govspeak::Document.new("[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]").to_html
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
     assert_match("", rendered)
   end
 
   test "contact with no postal address omits the address info" do
-    contact = build_contact(
-      recipient: nil,
-      street_address: nil,
-      locality: nil,
-      region: nil,
-      postal_code: nil,
-    )
+    contact = build_contact(post_addresses: [])
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
-    rendered = Govspeak::Document.new(govspeak, { contacts: [contact] }).to_html
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
     expected_html_output = %{
-      <div id="contact_123456" class="contact">
+      <div id="contact_4f3383e4-48a2-4461-a41d-f85ea8b89ba0" class="contact">
         <div class="content">
           <h3>Government Digital Service</h3>
           <div class="vcard contact-inner">
@@ -94,6 +115,10 @@ class GovspeakContactsTest < Minitest::Test
                 <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="contact_form_url">
+                <span class="type">Contact form</span>
+                <a href="https://www.gov.uk/contact">https://www.gov.uk/con...</a>
+              </p>
               <p class="tel">
                 <span class="type">helpdesk</span>
                 +4412345 67890
@@ -106,11 +131,73 @@ class GovspeakContactsTest < Minitest::Test
     assert_equal(compress_html(expected_html_output), compress_html(rendered))
   end
 
-  test "worldwide office contact renders worldwide organisation link" do
-    contact = build_contact(worldwide_organisation_path: "/government/world/organisations/british-antarctic-territory")
+  test "contact with United Kingdom country address doesn't show the country" do
+    contact = build_contact(post_addresses: [
+      {
+        street_address: "125 Kingsway",
+        country_name: "United Kingdom",
+      }
+    ])
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
+    expected = %{
+      <p class="adr">
+        <span class="street-address">125 Kingsway</span>
+      </p>
+    }
+    assert_match(compress_html(expected), compress_html(rendered))
+  end
+
+  test "contact with an empty postal address is not rendered" do
+    contact = build_contact(post_addresses: [
+      {
+        street_address: "",
+      }
+    ])
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
+    refute_match(%{<p class="adr">}, compress_html(rendered))
+  end
+
+  test "contact with an empty email address is not rendered" do
+    contact = build_contact(email_addresses: [
+      {
+        email: "",
+      }
+    ])
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
+    refute_match(%{<p class="email">}, compress_html(rendered))
+  end
+
+  test "contact with an empty contact form is not rendered" do
+    contact = build_contact(contact_form_links: [
+      {
+        link: "",
+      }
+    ])
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
+    refute_match(%{<p class="contact_form_url">}, compress_html(rendered))
+  end
+
+  test "contact with an empty phone number is not rendered" do
+    contact = build_contact(phone_numbers: [
+      {
+        number: "",
+      }
+    ])
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
+    refute_match(%{<p class="tel">}, compress_html(rendered))
+  end
+
+  test "it auto links text in the description" do
+    contact = build_contact(description: "My description about https://www.gov.uk")
+
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
-    rendered = Govspeak::Document.new(govspeak, { contacts: [contact] }).to_html
-    organisation_link = %Q(<a href="/government/world/organisations/british-antarctic-territory">Access and opening times</a>)
-    assert_match(organisation_link, rendered)
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
+    assert_match(%{<p class="comments">My description about <a href="https://www.gov.uk">https://www.gov.uk</a></p>},
+                 compress_html(rendered))
   end
 end

data/test/govspeak_extract_contact_content_ids_test.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require 'test_helper'
+
+class GovspeakExtractContactContentIdsTest < Minitest::Test
+  test "contact content ids can be extracted from govspeak" do
+    content_id1 = SecureRandom.uuid
+    content_id2 = SecureRandom.uuid
+    govspeak = "Some text with a contact\n [Contact:#{content_id1}]\n\n[Contact:#{content_id2}]"
+
+    assert_equal(Govspeak::Document.new(govspeak).extract_contact_content_ids, [content_id1, content_id2])
+  end
+
+  test "only extracts contact content ids that are UUIDs" do
+    govspeak = "[Contact:12345]"
+
+    refute_equal(
+      Govspeak::Document.new(govspeak).extract_contact_content_ids,
+      %w[12345],
+    )
+  end
+
+  test "same contact repeated multiple times only yields a single result" do
+    content_id = SecureRandom.uuid
+    govspeak = "[Contact:#{content_id}]\n[Contact:#{content_id}][Contact:#{content_id}]"
+
+    assert_equal(Govspeak::Document.new(govspeak).extract_contact_content_ids, [content_id])
+  end
+end

data/test/govspeak_link_extractor_test.rb

@@ -45,7 +45,7 @@ class GovspeakLinkExtractorTest < Minitest::Test
   end
 
   test "Other content is not extracted from the body" do
-    refute_includes ["Heading"], links
+    refute_includes %w[Heading], links
   end
 
   test "Links are not extracted if they begin with #" do

data/test/govspeak_structured_headers_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class GovspeakStructuredHeadersTest < Minitest::Test
-
   def document_body
     %{
 ## Heading 1
@@ -46,7 +45,7 @@ class GovspeakStructuredHeadersTest < Minitest::Test
   end
 
   test "h2s are extracted as top level headings" do
-    expected_headings =  ["Heading 1", "Heading 2", "Heading 3", "Heading 4", "Heading 5"]
+    expected_headings = ["Heading 1", "Heading 2", "Heading 3", "Heading 4", "Heading 5"]
 
     assert_equal expected_headings, structured_headers.map(&:text)
   end
@@ -72,33 +71,33 @@ class GovspeakStructuredHeadersTest < Minitest::Test
     serialized_headers = structured_headers[1].to_h
 
     expected_serialized_headers = {
-      :text => "Heading 2",
-      :level => 2,
-      :id => "heading-2",
-      :headers =>  [
+      text: "Heading 2",
+      level: 2,
+      id: "heading-2",
+      headers: [
         {
-          :text => "Sub heading 2.1",
-          :level => 3,
-          :id => "sub-heading-21",
-          :headers => [],
+          text: "Sub heading 2.1",
+          level: 3,
+          id: "sub-heading-21",
+          headers: [],
         },
         {
-          :text => "Sub heading 2.2",
-          :level => 3,
-          :id => "sub-heading-22",
-          :headers =>  [
+          text: "Sub heading 2.2",
+          level: 3,
+          id: "sub-heading-22",
+          headers: [
             {
-              :text => "Sub sub heading 2.2.1",
-              :level => 4,
-              :id => "sub-sub-heading-221",
-              :headers => []
+              text: "Sub sub heading 2.2.1",
+              level: 4,
+              id: "sub-sub-heading-221",
+              headers: []
             },
           ],
         },
         {
-          :text => "Sub heading 2.3",
-          :level => 3, :id=>"sub-heading-23",
-          :headers => []
+          text: "Sub heading 2.3",
+          level: 3, id: "sub-heading-23",
+          headers: []
         },
       ],
     }

data/test/govspeak_test.rb

@@ -9,27 +9,27 @@ class GovspeakTest < Minitest::Test
   include GovspeakTestHelper
 
   test "simple smoke-test" do
-    rendered =  Govspeak::Document.new("*this is markdown*").to_html
+    rendered = Govspeak::Document.new("*this is markdown*").to_html
     assert_equal "<p><em>this is markdown</em></p>\n", rendered
   end
 
   test "simple smoke-test for simplified API" do
-    rendered =  Govspeak::Document.to_html("*this is markdown*")
+    rendered = Govspeak::Document.to_html("*this is markdown*")
     assert_equal "<p><em>this is markdown</em></p>\n", rendered
   end
 
   test "highlight-answer block extension" do
-    rendered =  Govspeak::Document.new("this \n{::highlight-answer}Lead in to *BIG TEXT*\n{:/highlight-answer}").to_html
-    assert_equal %Q{<p>this</p>\n\n<div class="highlight-answer">\n<p>Lead in to <em>BIG TEXT</em></p>\n</div>\n}, rendered
+    rendered = Govspeak::Document.new("this \n{::highlight-answer}Lead in to *BIG TEXT*\n{:/highlight-answer}").to_html
+    assert_equal %{<p>this</p>\n\n<div class="highlight-answer">\n<p>Lead in to <em>BIG TEXT</em></p>\n</div>\n}, rendered
   end
 
   test "stat-headline block extension" do
-    rendered =  Govspeak::Document.new("this \n{stat-headline}*13.8bn* Age of the universe in years{/stat-headline}").to_html
-    assert_equal %Q{<p>this</p>\n\n<aside class="stat-headline">\n<p><em>13.8bn</em> Age of the universe in years</p>\n</aside>\n}, rendered
+    rendered = Govspeak::Document.new("this \n{stat-headline}*13.8bn* Age of the universe in years{/stat-headline}").to_html
+    assert_equal %{<p>this</p>\n\n<aside class="stat-headline">\n<p><em>13.8bn</em> Age of the universe in years</p>\n</aside>\n}, rendered
   end
 
   test "extracts headers with text, level and generated id" do
-    document =  Govspeak::Document.new %{
+    document = Govspeak::Document.new %{
 # Big title
 
 ### Small subtitle
@@ -44,7 +44,7 @@ class GovspeakTest < Minitest::Test
   end
 
   test "extracts different ids for duplicate headers" do
-    document =  Govspeak::Document.new("## Duplicate header\n\n## Duplicate header")
+    document = Govspeak::Document.new("## Duplicate header\n\n## Duplicate header")
     assert_equal [
       Govspeak::Header.new('Duplicate header', 2, 'duplicate-header'),
       Govspeak::Header.new('Duplicate header', 2, 'duplicate-header-1')
@@ -52,7 +52,7 @@ class GovspeakTest < Minitest::Test
   end
 
   test "extracts headers when nested inside blocks" do
-    document =  Govspeak::Document.new %{
+    document = Govspeak::Document.new %{
 # First title
 
 <div markdown="1">
@@ -77,7 +77,7 @@ class GovspeakTest < Minitest::Test
   end
 
   test "extracts headers with explicitly specified ids" do
-    document =  Govspeak::Document.new %{
+    document = Govspeak::Document.new %{
 # First title
 
 ## Second title {#special}
@@ -105,23 +105,23 @@ Teston
   end
 
   test "should convert barchart" do
-    input = <<-END
-|col|
-|---|
-|val|
-{barchart}
-    END
+    input = <<~GOVSPEAK
+      |col|
+      |---|
+      |val|
+      {barchart}
+    GOVSPEAK
     html = Govspeak::Document.new(input).to_html
     assert_equal %{<table class=\"js-barchart-table mc-auto-outdent\">\n  <thead>\n    <tr>\n      <th>col</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>val</td>\n    </tr>\n  </tbody>\n</table>\n}, html
   end
 
   test "should convert barchart with stacked compact and negative" do
-    input = <<-END
-|col|
-|---|
-|val|
-{barchart stacked compact negative}
-    END
+    input = <<~GOVSPEAK
+      |col|
+      |---|
+      |val|
+      {barchart stacked compact negative}
+    GOVSPEAK
     html = Govspeak::Document.new(input).to_html
     assert_equal %{<table class=\"js-barchart-table mc-stacked compact mc-negative mc-auto-outdent\">\n  <thead>\n    <tr>\n      <th>col</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>val</td>\n    </tr>\n  </tbody>\n</table>\n}, html
   end
@@ -331,17 +331,17 @@ Teston
   test "should treat a mailto as internal" do
     html = Govspeak::Document.new("[link](mailto:a@b.com)").to_html
     refute html.include?('rel="external"')
-    assert_equal %Q{<p><a href="mailto:a@b.com">link</a></p>\n}, deobfuscate_mailto(html)
+    assert_equal %{<p><a href="mailto:a@b.com">link</a></p>\n}, deobfuscate_mailto(html)
   end
 
   test "permits mailto:// URI" do
     html = Govspeak::Document.new("[link](mailto://a@b.com)").to_html
-    assert_equal %Q{<p><a rel="external" href="mailto://a@b.com">link</a></p>\n}, deobfuscate_mailto(html)
+    assert_equal %{<p><a rel="external" href="mailto://a@b.com">link</a></p>\n}, deobfuscate_mailto(html)
   end
 
   test "permits dud mailto: URI" do
     html = Govspeak::Document.new("[link](mailto:)").to_html
-    assert_equal %Q{<p><a href="mailto:">link</a></p>\n}, deobfuscate_mailto(html)
+    assert_equal %{<p><a href="mailto:">link</a></p>\n}, deobfuscate_mailto(html)
   end
 
   test "permits trailing whitespace in an URI" do
@@ -420,11 +420,12 @@ Teston
     assert_text_output "Click here to start the tool"
   end
 
-  test_given_govspeak "Here is some text
+  test_given_govspeak "
+    Here is some text
 
-$CTA
-Click here to start the tool
-$CTA
+    $CTA
+    Click here to start the tool
+    $CTA
     " do
     assert_html_output %{
       <p>Here is some text</p>
@@ -639,17 +640,17 @@ $CTA
         %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
         %{</figure>}
       )
+    end
   end
-end
 
-test "alt text of referenced images is escaped" do
-  images = [OpenStruct.new(alt_text: %Q{my alt '&"<>}, url: "http://example.com/image.jpg")]
-  given_govspeak "!!1", images do
-    assert_html_output(
-      %{<figure class="image embedded">} +
-      %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>} +
-      %{</figure>}
-    )
+  test "alt text of referenced images is escaped" do
+    images = [OpenStruct.new(alt_text: %{my alt '&"<>}, url: "http://example.com/image.jpg")]
+    given_govspeak "!!1", images do
+      assert_html_output(
+        %{<figure class="image embedded">} +
+        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt '&amp;&quot;&lt;&gt;"></div>} +
+        %{</figure>}
+      )
     end
   end
 
@@ -657,7 +658,7 @@ test "alt text of referenced images is escaped" do
     doc = Govspeak::Document.new("!!1")
     doc.images = []
 
-    assert_equal %Q{\n}, doc.to_html
+    assert_equal %{\n}, doc.to_html
   end
 
   test "adds image caption if given" do
@@ -838,7 +839,7 @@ $PriorityList:1
   end
 
   test "should remove quotes surrounding a blockquote" do
-    govspeak = %Q{
+    govspeak = %{
 He said:
 
 > "I'm not sure what you mean!"