govspeak 6.5.3 → 6.5.8

data/test/blockquote_extra_quote_remover_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class BlockquoteExtraQuoteRemoverTest < Minitest::Test
@@ -14,85 +12,85 @@ class BlockquoteExtraQuoteRemoverTest < Minitest::Test
   end
 
   test "ignores nil" do
-    assert_leaves_untouched nil
+    assert_nil Govspeak::BlockquoteExtraQuoteRemover.remove(nil)
   end
 
   test "ignores text without double quotes" do
-    assert_leaves_untouched %{no quotes\na few lines,\n\n\n\nbut no quotes\n\n}
+    assert_leaves_untouched %(no quotes\na few lines,\n\n\n\nbut no quotes\n\n)
   end
 
   test "ignores text without a quote symbol" do
-    assert_leaves_untouched %{quotes\n"but not with a > symbol"}
+    assert_leaves_untouched %(quotes\n"but not with a > symbol")
   end
 
   test "transforms text with surrounding quotes" do
     assert_remover_transforms(
-      %{He said:\n> "yes, it's true!"\n\napparently.} =>
-      %{He said:\n> yes, it's true!\n\napparently.},
+      %(He said:\n> "yes, it's true!"\n\napparently.) =>
+      %(He said:\n> yes, it's true!\n\napparently.),
     )
   end
 
   test "leaves quotes in the middle of the string" do
     assert_remover_transforms(
-      %{He said:\n> "yes, it's true!" whilst sipping a cocktail. "And yes, I did rather enjoy it." \n\napparently.} =>
-      %{He said:\n> yes, it's true!" whilst sipping a cocktail. "And yes, I did rather enjoy it.\n\napparently.},
+      %(He said:\n> "yes, it's true!" whilst sipping a cocktail. "And yes, I did rather enjoy it." \n\napparently.) =>
+      %(He said:\n> yes, it's true!" whilst sipping a cocktail. "And yes, I did rather enjoy it.\n\napparently.),
     )
   end
 
   test "leaves trailing text and quote intact" do
     assert_remover_transforms(
-      %{He said:\n> "yes, it's true!" whilst sipping a cocktail.} =>
-      %{He said:\n> yes, it's true!" whilst sipping a cocktail.},
+      %(He said:\n> "yes, it's true!" whilst sipping a cocktail.) =>
+      %(He said:\n> yes, it's true!" whilst sipping a cocktail.),
     )
   end
 
   test "windows line breaks" do
     assert_remover_transforms(
-      %{Sir George Young MP, said\r\n>  "I welcome the positive public response to the e-petitions site, which is important way of building a bridge between people and Parliament.”\r\n## The special relationship} =>
-      %{Sir George Young MP, said\r\n> I welcome the positive public response to the e-petitions site, which is important way of building a bridge between people and Parliament.\r\n## The special relationship},
+      %(Sir George Young MP, said\r\n>  "I welcome the positive public response to the e-petitions site, which is important way of building a bridge between people and Parliament.”\r\n## The special relationship) =>
+      %(Sir George Young MP, said\r\n> I welcome the positive public response to the e-petitions site, which is important way of building a bridge between people and Parliament.\r\n## The special relationship),
     )
   end
 
   test "no space in front" do
     assert_remover_transforms(
-      %{>"As we continue with the redundancy process we will ensure we retain the capabilities that our armed forces will require to meet the challenges of the future. The redundancy programme will not impact adversely on the current operations in Afghanistan, where our armed forces continue to fight so bravely on this country's behalf."} =>
-      %{> As we continue with the redundancy process we will ensure we retain the capabilities that our armed forces will require to meet the challenges of the future. The redundancy programme will not impact adversely on the current operations in Afghanistan, where our armed forces continue to fight so bravely on this country's behalf.},
+      %(>"As we continue with the redundancy process we will ensure we retain the capabilities that our armed forces will require to meet the challenges of the future. The redundancy programme will not impact adversely on the current operations in Afghanistan, where our armed forces continue to fight so bravely on this country's behalf.") =>
+      %(> As we continue with the redundancy process we will ensure we retain the capabilities that our armed forces will require to meet the challenges of the future. The redundancy programme will not impact adversely on the current operations in Afghanistan, where our armed forces continue to fight so bravely on this country's behalf.),
     )
   end
 
   test "handles space after a quote" do
     assert_remover_transforms(
-      %{>" Test"} =>
-      %{> Test},
+      %(>" Test") =>
+      %(> Test),
     )
   end
 
   test "remove double double quotes" do
     assert_remover_transforms(
-      %{We heard it said:\n\n> ""Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.""} =>
-      %{We heard it said:\n\n> Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.},
+      %(We heard it said:\n\n> ""Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners."") =>
+      %(We heard it said:\n\n> Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.),
     )
     assert_remover_transforms(
-      %{> ""Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.} =>
-      %{> Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.},
+      %(> ""Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.) =>
+      %(> Today the coalition is remedying those deficiencies by putting in place a new fast track process where the people's elected representatives have responsibility for the final decisions about Britain's future instead of unelected commissioners.),
     )
   end
 
   test "removes quotes correctly from multi-line blockquotes" do
     assert_remover_transforms(
-      %{> "Here is a block quote using 2 lines and two of the arrows.\n> I am not sure how this will render.  I think it will mash them together."} =>
-      %{> Here is a block quote using 2 lines and two of the arrows.\n> I am not sure how this will render.  I think it will mash them together.},
+      %(> "Here is a block quote using 2 lines and two of the arrows.\n> I am not sure how this will render.  I think it will mash them together.") =>
+      %(> Here is a block quote using 2 lines and two of the arrows.\n> I am not sure how this will render.  I think it will mash them together.),
     )
   end
 
   test "preserves multiline blockquotes with plain newlines quotes" do
     assert_remover_transforms(
-      %{> "line 1\n> \n> "line 2\n> \n> "line 3"} =>
-      %{> line 1\n> \n> line 2\n> \n> line 3},
-      )
+      %(> "line 1\n> \n> "line 2\n> \n> "line 3") =>
+      %(> line 1\n> \n> line 2\n> \n> line 3),
+    )
   end
 
   test "preserve newlines when there's a blockquote with additional text after" do
-    assert_leaves_untouched(%{> \n> blah})
+    assert_leaves_untouched(%(> \n> blah))
   end
 end

data/test/govspeak_attachment_link_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class GovspeakAttachmentLinkTest < Minitest::Test

data/test/govspeak_attachment_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class GovspeakAttachmentTest < Minitest::Test

data/test/govspeak_attachments_image_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class GovspeakAttachmentsImageTest < Minitest::Test
@@ -77,11 +75,11 @@ class GovspeakAttachmentsImageTest < Minitest::Test
       "[embed:attachments:image:1fe8]",
       [build_attachment(id: 10, url: "http://a.b/c.jpg", title: "My Title", content_id: "1fe8")],
     )
-    expected_html_output = %{
+    expected_html_output = %(
       <figure id="attachment_10" class="image embedded">
         <div class="img"><img src="http://a.b/c.jpg" alt="My Title"></div>
       </figure>
-    }
+    )
     assert_match(compress_html(expected_html_output), compress_html(rendered))
   end
 

data/test/govspeak_attachments_inline_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class GovspeakAttachmentsInlineTest < Minitest::Test
@@ -141,10 +139,10 @@ class GovspeakAttachmentsInlineTest < Minitest::Test
         number_of_pages: 2,
       )],
     )
-    link = %{<a href="#{Regexp.quote('http://a.b/test.txt')}">My Attached Text File</a>}
-    type = %{<span class="type">Plain text</span>}
-    file_size = %{<span class="file-size">2 KB</span>}
-    pages = %{<span class="page-length">2 pages</span>}
+    link = %(<a href="#{Regexp.quote('http://a.b/test.txt')}">My Attached Text File</a>)
+    type = %(<span class="type">Plain text</span>)
+    file_size = %(<span class="file-size">2 KB</span>)
+    pages = %(<span class="page-length">2 pages</span>)
     assert_match(/#{link}\s+\(#{type}, #{file_size}, #{pages}\)/, rendered)
   end
 

data/test/govspeak_button_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 require "govspeak_test_helper"
 
@@ -46,13 +44,13 @@ class GovspeakTest < Minitest::Test
   end
 
   test_given_govspeak "Text before the button with line breaks \n\n\n{button}[Start Now](http://www.gov.uk){/button}\n\n\n test after the button" do
-    assert_html_output %{
+    assert_html_output %(
       <p>Text before the button with line breaks</p>
 
       <p><a class="gem-c-button govuk-button" role="button" href="http://www.gov.uk">Start Now</a></p>
 
       <p>test after the button</p>
-    }
+    )
     assert_text_output "Text before the button with line breaks Start Now test after the button"
   end
 
@@ -82,23 +80,23 @@ class GovspeakTest < Minitest::Test
 
   # Make sure button renders when typical linebreaks are before it, seen in publishing applications
   test_given_govspeak "{button}[Line breaks](https://gov.uk/random){/button}\r\n\r\n{button}[Continue](https://gov.uk/random){/button}\r\n\r\n{button}[Continue](https://gov.uk/random){/button}" do
-    assert_html_output %{
+    assert_html_output %(
       <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Line breaks</a></p>
 
       <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
 
       <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
-    }
+    )
   end
 
   test_given_govspeak "{button}[More line breaks](https://gov.uk/random){/button}\n\n{button}[Continue](https://gov.uk/random){/button}\n\n{button}[Continue](https://gov.uk/random){/button}" do
-    assert_html_output %{
+    assert_html_output %(
       <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">More line breaks</a></p>
 
       <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
 
       <p><a class="gem-c-button govuk-button" role="button" href="https://gov.uk/random">Continue</a></p>
-    }
+    )
   end
 
   test_given_govspeak %{
@@ -114,7 +112,7 @@ class GovspeakTest < Minitest::Test
     lorem lorem lorem
     lorem lorem lorem
   } do
-    assert_html_output %{
+    assert_html_output %(
       <h2 id="register-to-vote">Register to vote</h2>
 
       <p>Introduction text about the service.</p>
@@ -126,6 +124,6 @@ class GovspeakTest < Minitest::Test
 
       <p>lorem lorem lorem
       lorem lorem lorem</p>
-    }
+    )
   end
 end

data/test/govspeak_contacts_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class GovspeakContactsTest < Minitest::Test
@@ -61,7 +59,7 @@ class GovspeakContactsTest < Minitest::Test
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
 
     rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
-    expected_html_output = %{
+    expected_html_output = %(
       <div id="contact_4f3383e4-48a2-4461-a41d-f85ea8b89ba0" class="contact postal-address">
         <div class="content">
           <h3>Government Digital Service</h3>
@@ -89,7 +87,7 @@ class GovspeakContactsTest < Minitest::Test
           </div>
         </div>
       </div>
-    }
+    )
 
     assert_equal(compress_html(expected_html_output), compress_html(rendered))
   end
@@ -105,7 +103,7 @@ class GovspeakContactsTest < Minitest::Test
     contact = build_contact(post_addresses: [])
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
     rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
-    expected_html_output = %{
+    expected_html_output = %(
       <div id="contact_4f3383e4-48a2-4461-a41d-f85ea8b89ba0" class="contact">
         <div class="content">
           <h3>Government Digital Service</h3>
@@ -127,7 +125,7 @@ class GovspeakContactsTest < Minitest::Test
           </div>
         </div>
       </div>
-    }
+    )
     assert_equal(compress_html(expected_html_output), compress_html(rendered))
   end
 
@@ -140,11 +138,11 @@ class GovspeakContactsTest < Minitest::Test
     ])
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
     rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
-    expected = %{
+    expected = %(
       <p class="adr">
         <span class="street-address">125 Kingsway</span>
       </p>
-    }
+    )
     assert_match(compress_html(expected), compress_html(rendered))
   end
 
@@ -156,7 +154,7 @@ class GovspeakContactsTest < Minitest::Test
     ])
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
     rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
-    refute_match(%{<p class="adr">}, compress_html(rendered))
+    refute_match(%(<p class="adr">), compress_html(rendered))
   end
 
   test "contact with an empty email address is not rendered" do
@@ -167,7 +165,7 @@ class GovspeakContactsTest < Minitest::Test
     ])
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
     rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
-    refute_match(%{<p class="email">}, compress_html(rendered))
+    refute_match(%(<p class="email">), compress_html(rendered))
   end
 
   test "contact with an empty contact form is not rendered" do
@@ -178,7 +176,7 @@ class GovspeakContactsTest < Minitest::Test
     ])
     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))
+    refute_match(%(<p class="contact_form_url">), compress_html(rendered))
   end
 
   test "contact with an empty phone number is not rendered" do
@@ -189,7 +187,7 @@ class GovspeakContactsTest < Minitest::Test
     ])
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
     rendered = Govspeak::Document.new(govspeak, contacts: [contact]).to_html
-    refute_match(%{<p class="tel">}, compress_html(rendered))
+    refute_match(%(<p class="tel">), compress_html(rendered))
   end
 
   test "it auto links text in the description" do
@@ -197,7 +195,7 @@ class GovspeakContactsTest < Minitest::Test
 
     govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
     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>},
+    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

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 
 class GovspeakExtractContactContentIdsTest < Minitest::Test

data/test/govspeak_footnote_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+require "govspeak_test_helper"
+
+class GovspeakFootnoteTest < Minitest::Test
+  include GovspeakTestHelper
+
+  test_given_govspeak "
+    Footnotes can be added[^1].
+
+    [^1]: And then later defined.
+
+    Footnotes can be added too[^2].
+
+    [^2]: And then later defined too." do
+    assert_html_output '
+      <p>Footnotes can be added<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote">[footnote 1]</a></sup>.</p>
+
+      <p>Footnotes can be added too<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote">[footnote 2]</a></sup>.</p>
+
+      <div class="footnotes" role="doc-endnotes">
+        <ol>
+          <li id="fn:1" role="doc-endnote">
+            <p>And then later defined. <a href="#fnref:1" class="reversefootnote" role="doc-backlink">[go to where this is referenced]</a></p>
+          </li>
+          <li id="fn:2" role="doc-endnote">
+            <p>And then later defined too. <a href="#fnref:2" class="reversefootnote" role="doc-backlink">[go to where this is referenced]</a></p>
+          </li>
+        </ol>
+      </div>'
+  end
+end

data/test/govspeak_images_bang_test.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require "test_helper"
 require "govspeak_test_helper"
 
@@ -20,40 +18,40 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax renders an image in options[:images]" do
     given_govspeak "!!1", images: [Image.new] do
       assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
-        %{</figure>},
+        %(<figure class="image embedded">) +
+        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
+        %(</figure>),
       )
     end
   end
 
   test "!!n syntax escapes alt text" do
-    given_govspeak "!!1", images: [Image.new(alt_text: %{my alt '&"<>})] do
+    given_govspeak "!!1", images: [Image.new(alt_text: %(my alt '&"<>))] 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>},
+        %(<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
 
   test "!!n syntax renders nothing if not found" do
     doc = Govspeak::Document.new("!!1")
-    assert_equal %{\n}, doc.to_html
+    assert_equal %(\n), doc.to_html
   end
 
   test "Image:image-id syntax renders nothing" do
     doc = Govspeak::Document.new("[Image:another-id]", images: [Image.new])
-    assert_equal %{\n}, doc.to_html
+    assert_equal %(\n), doc.to_html
   end
 
   test "!!n syntax adds image caption if given" do
     given_govspeak "!!1", images: [Image.new(caption: "My Caption & so on")] do
       assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n} +
-        %{<figcaption><p>My Caption &amp; so on</p></figcaption>} +
-        %{</figure>},
+        %(<figure class="image embedded">) +
+        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
+        %(<figcaption><p>My Caption &amp; so on</p></figcaption>) +
+        %(</figure>),
       )
     end
   end
@@ -61,9 +59,9 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax ignores a blank caption" do
     given_govspeak "!!1", images: [Image.new(caption: "  ")] do
       assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
-        %{</figure>},
+        %(<figure class="image embedded">) +
+        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
+        %(</figure>),
       )
     end
   end
@@ -71,10 +69,10 @@ class GovspeakImagesBangTest < Minitest::Test
   test "¡¡n syntax adds image credit if given" do
     given_govspeak "!!1", images: [Image.new(credit: "My Credit & so on")] do
       assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n} +
-        %{<figcaption><p>Image credit: My Credit &amp; so on</p></figcaption>} +
-        %{</figure>},
+        %(<figure class="image embedded">) +
+        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
+        %(<figcaption><p>Image credit: My Credit &amp; so on</p></figcaption>) +
+        %(</figure>),
       )
     end
   end
@@ -82,9 +80,9 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax ignores a blank credit" do
     given_govspeak "!!1", images: [Image.new(credit: "  ")] do
       assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>} +
-        %{</figure>},
+        %(<figure class="image embedded">) +
+        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>) +
+        %(</figure>),
       )
     end
   end
@@ -92,13 +90,13 @@ class GovspeakImagesBangTest < Minitest::Test
   test "!!n syntax adds image caption and credit if given" do
     given_govspeak "!!1", images: [Image.new(caption: "My Caption & so on", credit: "My Credit & so on")] do
       assert_html_output(
-        %{<figure class="image embedded">} +
-        %{<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n} +
-        %{<figcaption>} +
-          %{<p>My Caption &amp; so on</p>\n} +
-          %{<p>Image credit: My Credit &amp; so on</p>} +
-        %{</figcaption>} +
-        %{</figure>},
+        %(<figure class="image embedded">) +
+        %(<div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div>\n) +
+        %(<figcaption>) +
+          %(<p>My Caption &amp; so on</p>\n) +
+          %(<p>Image credit: My Credit &amp; so on</p>) +
+        %(</figcaption>) +
+        %(</figure>),
       )
     end
   end