govspeak 6.8.4 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ed6a74578a19fb89e4c855494d27708d7809e925a6029b5b391fbe474f5d49
-  data.tar.gz: 74f0b44824ff948767ae8e8f1a5f95ae784f07ea3ab424f66a46ee0d07efb6af
+  metadata.gz: 8013e06cbc3f6f61be8953690c30bf05999ee7b405127bf9ab05566021dff5d6
+  data.tar.gz: d0db3c14af86be0a18662a1aacc9d6f058e0e72295957c478206e41dc97ca06f
 SHA512:
-  metadata.gz: c022e6a898d40e41ea571d9f39863f6235822810d2823f99d17e58eb559ab7e0b2b35c2a60cdec627270b9fe3d31c39224f820e5e8f3378f8df811478ca6203d
-  data.tar.gz: facb052f32abfcdc7e54fb6799d7e052d1a951aedce6db6b582fa716654bb6cc6730ff99af65a2af511dc0039b4f07f8f9669accbadf8821b01f2280c22933c8
+  metadata.gz: 07aedd1b981eb39f4b13327cb1192b598fbd0b90a1fc5f0a3c85d05e9baa428022435fe1891cbd576b824f410b5f9daf68b96d0742dfbdc05abcda1b946cdb9d
+  data.tar.gz: 75f8333f15d52a9e4e358abf8319daf1e05a2800f347937f2b63c52f1d860d691b30b72013ad07e310e2f9926ed63a8b344b5509271a9161a5a307353ea6feaf

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 7.0.1
+
+* Govspeak was stripping superscript from markdown when it shouldn't have. [#264](https://github.com/alphagov/govspeak/pull/264)
+
+## 7.0.0
+
+* BREAKING CHANGE Remove `PriorityList`, the `PrimaryList` JS module to render the priority list on the frontend is to be removed [#249](https://github.com/alphagov/govspeak/pull/249)
+
 ## 6.8.4
 
 * Fix bug where inconsistent linebreaks trigger validations [#250](https://github.com/alphagov/govspeak/pull/250)

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ..gemspec
 gemspec

data/README.md

@@ -292,29 +292,6 @@ For lists where you want to specify the numbering and have multiple indent level
     $EndLegislativeList
     (to indent, add 2 spaces)
 
-## Priority Lists
-
-For lists where you want to specify a number of items to be highlighted as priority.
-
-    $PriorityList:3
-    - Item 1
-    - Item 2
-    - Item 3
-    - Item 4
-    - Item 5
-
-creates a list with priority items flagged with a class
-
-```html
-<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
 
     :england:content goes here:england:
@@ -692,4 +669,9 @@ which outputs
   Start Now
   <svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" role="presentation" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg>
 </a>
-```
+```
+
+## Licence
+
+[MIT License](LICENCE)
+

data/lib/govspeak/post_processor.rb

@@ -85,20 +85,20 @@ module Govspeak
 
     extension("Add table headers and row / column scopes") do |document|
       document.css("thead th").map do |el|
-        el.content = el.content.gsub(/^# /, "")
-        el.content = el.content.gsub(/[[:space:]]/, "") if el.content.blank? # Removes a strange whitespace in the cell if the cell is already blank.
-        el.name = "td" if el.content.blank? # This prevents a `th` with nothing inside it; a `td` is preferable.
-        el[:scope] = "col" if el.content.present? # `scope` shouldn't be used if there's nothing in the table heading.
+        el.inner_html = el.inner_html.gsub(/^# /, "")
+        el.inner_html = el.inner_html.gsub(/[[:space:]]/, "") if el.inner_html.blank? # Removes a strange whitespace in the cell if the cell is already blank.
+        el.name = "td" if el.inner_html.blank? # This prevents a `th` with nothing inside it; a `td` is preferable.
+        el[:scope] = "col" if el.inner_html.present? # `scope` shouldn't be used if there's nothing in the table heading.
       end
 
       document.css(":not(thead) tr td:first-child").map do |el|
-        next unless el.content.match?(/^#($|\s.*$)/)
+        next unless el.inner_html.match?(/^#($|\s.*$)/)
 
         # Replace '# ' and '#', but not '#Word'.
         # This runs on the first child of the element to preserve any links
         el.children.first.content = el.children.first.content.gsub(/^#($|\s)/, "")
-        el.name = "th" if el.content.present? # This also prevents a `th` with nothing inside it; a `td` is preferable.
-        el[:scope] = "row" if el.content.present? # `scope` shouldn't be used if there's nothing in the table heading.
+        el.name = "th" if el.inner_html.present? # This also prevents a `th` with nothing inside it; a `td` is preferable.
+        el[:scope] = "row" if el.inner_html.present? # `scope` shouldn't be used if there's nothing in the table heading.
       end
     end
 
@@ -106,7 +106,7 @@ module Govspeak
       document.css(".govuk-button").map do |el|
         button_html = GovukPublishingComponents.render(
           "govuk_publishing_components/components/button",
-          text: el.content,
+          text: el.inner_html,
           href: el["href"],
           start: el["data-start"],
           data_attributes: {
@@ -123,7 +123,7 @@ module Govspeak
     extension("use custom footnotes") do |document|
       document.css("a.footnote").map do |el|
         footnote_number = el[:href].gsub(/\D/, "")
-        el.content = "[footnote #{footnote_number}]"
+        el.inner_html = "[footnote #{footnote_number}]"
       end
       document.css("[role='doc-backlink']").map do |el|
         backlink_number = " #{el.css('sup')[0].content}" if el.css("sup")[0].present?

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.8.4".freeze
+  VERSION = "7.0.1".freeze
 end

data/lib/govspeak.rb

@@ -405,19 +405,6 @@ module Govspeak
       end
     end
 
-    extension("Priority list", /#{NEW_PARAGRAPH_LOOKBEHIND}\$PriorityList:(\d+)\s*$(.*?)(?:^\s*$|\Z)/m) do |number_to_show, body|
-      number_to_show = number_to_show.to_i
-      tagged = 0
-      Govspeak::Document.new(body.strip).to_html.gsub(/<li>/) do |match|
-        if tagged < number_to_show
-          tagged += 1
-          '<li class="primary-item">'
-        else
-          match
-        end
-      end
-    end
-
     extension("embed link", /\[embed:link:\s*(.*?)\s*\]/) do |content_id|
       link = links.detect { |l| l[:content_id] == content_id }
       next "" unless link

data/test/govspeak_button_test.rb

@@ -7,18 +7,18 @@ class GovspeakTest < Minitest::Test
   include GovspeakTestHelper
 
   test_given_govspeak "{button start cross-domain-tracking:UA-23066786-5}[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_selector 'a.gem-c-button.govuk-button--start[data-module="cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
+    assert_html_selector 'a.gem-c-button.govuk-button--start[data-module="govuk-button cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   # The same as above but with line breaks
   test_given_govspeak "{button start cross-domain-tracking:UA-23066786-5}\n\n\n[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start)\n\n\n{/button}" do
-    assert_html_selector 'a.gem-c-button.govuk-button--start[data-module="cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
+    assert_html_selector 'a.gem-c-button.govuk-button--start[data-module="govuk-button cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
   test_given_govspeak "{button cross-domain-tracking:UA-23066786-5}[Start now](https://www.registertovote.service.gov.uk/register-to-vote/start){/button}" do
-    assert_html_selector 'a.gem-c-button:not(.govuk-button--start)[data-module="cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
+    assert_html_selector 'a.gem-c-button:not(.govuk-button--start)[data-module="govuk-button cross-domain-tracking"][data-tracking-code="UA-23066786-5"][href="https://www.registertovote.service.gov.uk/register-to-vote/start"]'
     assert_text_output "Start now"
   end
 
@@ -47,7 +47,7 @@ class GovspeakTest < Minitest::Test
     assert_html_output %(
       <p>Text before the button with line breaks</p>
 
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="http://www.gov.uk">Start Now</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="http://www.gov.uk">Start Now</a></p>
 
       <p>test after the button</p>
     )
@@ -65,21 +65,21 @@ 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 %(
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Line breaks</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="https://gov.uk/random">Line breaks</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="https://gov.uk/random">Continue</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" 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 %(
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">More line breaks</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="https://gov.uk/random">More line breaks</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="https://gov.uk/random">Continue</a></p>
 
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Continue</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="https://gov.uk/random">Continue</a></p>
     )
   end
 
@@ -104,7 +104,7 @@ class GovspeakTest < Minitest::Test
       <p>lorem lorem lorem
       lorem lorem lorem</p>
 
-      <p><a class="gem-c-button govuk-button" role="button" draggable="false" href="https://gov.uk/random">Random page</a></p>
+      <p><a class="gem-c-button govuk-button" role="button" data-module="govuk-button" draggable="false" href="https://gov.uk/random">Random page</a></p>
 
       <p>lorem lorem lorem
       lorem lorem lorem</p>

data/test/govspeak_table_with_headers_test.rb

@@ -131,6 +131,34 @@ class GovspeakTableWithHeadersTest < Minitest::Test
 )
   end
 
+  def expected_outcome_for_table_with_table_headers_containing_superscript
+    %(
+<table>
+  <thead>
+    <tr>
+      <th scope="col">Foo<sup>bar</sup>
+</th>
+      <th scope="col">Third Column</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Cell</td>
+      <td>Cell</td>
+    </tr>
+  </tbody>
+</table>
+)
+  end
+
+  def document_body_with_table_headers_containing_superscript
+    @document_body_with_table_headers_containing_superscript ||= Govspeak::Document.new(%(
+| Foo<sup>bar</sup>     | Third Column        |
+| ---------------       | ------------------- |
+| Cell                  | Cell                |
+))
+  end
+
   def expected_outcome_for_table_headers_containing_links
     %(
 <table>
@@ -242,4 +270,8 @@ class GovspeakTableWithHeadersTest < Minitest::Test
   test "Table headers are not blank" do
     assert_equal document_body_with_blank_table_headers.to_html, expected_outcome_for_table_with_blank_table_headers
   end
+
+  test "Table header superscript should parse" do
+    assert_equal document_body_with_table_headers_containing_superscript.to_html, expected_outcome_for_table_with_table_headers_containing_superscript
+  end
 end

data/test/govspeak_test.rb

@@ -1219,139 +1219,6 @@ Teston
     assert document.valid?
   end
 
-  expected_priority_list_output = %(
-    <ul>
-      <li class="primary-item">List item 1</li>
-      <li class="primary-item">List item 2</li>
-      <li class="primary-item">List item 3</li>
-      <li>List item 4</li>
-      <li>List item 5</li>
-    </ul>
-  )
-
-  test "Single priority list ending with EOF" do
-    govspeak = "$PriorityList:3
- * List item 1
- * List item 2
- * List item 3
- * List item 4
- * List item 5"
-
-    given_govspeak(govspeak) do
-      assert_html_output(expected_priority_list_output)
-    end
-  end
-
-  test "Single priority list ending with newlines" do
-    govspeak = "$PriorityList:3
-* List item 1
-* List item 2
-* List item 3
-* List item 4
-* List item 5
-
-"
-
-    given_govspeak(govspeak) do
-      assert_html_output(expected_priority_list_output)
-    end
-  end
-
-  test 'Single priority list with \n newlines' do
-    govspeak = "$PriorityList:3\n * List item 1\n * List item 2\n * List item 3\n * List item 4\n * List item 5"
-
-    given_govspeak(govspeak) do
-      assert_html_output(expected_priority_list_output)
-    end
-  end
-
-  test 'Single priority list with \r\n newlines' do
-    govspeak = "$PriorityList:3\r\n * List item 1\r\n * List item 2\r\n * List item 3\r\n * List item 4\r\n * List item 5"
-
-    given_govspeak(govspeak) do
-      assert_html_output(expected_priority_list_output)
-    end
-  end
-
-  test "Multiple priority lists" do
-    govspeak = "
-$PriorityList:3
-* List item 1
-* List item 2
-* List item 3
-* List item 4
-* List item 5
-
-$PriorityList:1
-* List item 1
-* List item 2"
-
-    given_govspeak(govspeak) do
-      assert_html_output %(
-        <ul>
-          <li class="primary-item">List item 1</li>
-          <li class="primary-item">List item 2</li>
-          <li class="primary-item">List item 3</li>
-          <li>List item 4</li>
-          <li>List item 5</li>
-        </ul>
-
-        <ul>
-          <li class="primary-item">List item 1</li>
-          <li>List item 2</li>
-        </ul>
-      )
-    end
-  end
-
-  test "Priority list placed incorrectly" do
-    govspeak = "
-    This is a paragraph
-    $PriorityList:3
-    * List item 1
-    * List item 2
-    * List item 3
-    * List item 4
-    * List item 5"
-
-    given_govspeak(govspeak) do
-      assert_html_output("
-      <p>This is a paragraph
-      $PriorityList:3
-      * List item 1
-      * List item 2
-      * List item 3
-      * List item 4
-      * List item 5</p>")
-    end
-  end
-
-  test "Priority list placed correctly" do
-    govspeak = "
-    This is a paragraph
-
-    $PriorityList:3
-    * List item 1
-    * List item 2
-    * List item 3
-    * List item 4
-    * List item 5"
-
-    given_govspeak(govspeak) do
-      assert_html_output %(
-        <p>This is a paragraph</p>
-
-        <ul>
-          <li class="primary-item">List item 1</li>
-          <li class="primary-item">List item 2</li>
-          <li class="primary-item">List item 3</li>
-          <li>List item 4</li>
-          <li>List item 5</li>
-        </ul>
-      )
-    end
-  end
-
   test "should remove quotes surrounding a blockquote" do
     govspeak = %(
 He said:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.8.4
+  version: 7.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: 4.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.6.0
+        version: 4.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -327,29 +327,29 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/govspeak_attachments_image_test.rb
-- test/govspeak_link_extractor_test.rb
-- test/govspeak_table_with_headers_test.rb
-- test/govspeak_attachment_test.rb
-- test/govspeak_extract_contact_content_ids_test.rb
+- test/blockquote_extra_quote_remover_test.rb
+- test/govspeak_attachment_link_test.rb
+- test/govspeak_images_test.rb
 - test/test_helper.rb
-- test/html_validator_test.rb
-- test/govspeak_test_helper.rb
-- test/html_sanitizer_test.rb
 - test/govspeak_footnote_test.rb
-- test/govspeak_images_test.rb
 - test/govspeak_button_test.rb
+- test/govspeak_link_test.rb
+- test/html_sanitizer_test.rb
 - test/govspeak_test.rb
-- test/blockquote_extra_quote_remover_test.rb
+- test/govspeak_table_with_headers_test.rb
+- test/html_validator_test.rb
+- test/govspeak_attachments_image_test.rb
 - test/govspeak_images_bang_test.rb
+- test/govspeak_link_extractor_test.rb
 - test/presenters/h_card_presenter_test.rb
-- test/govspeak_contacts_test.rb
-- test/govspeak_attachment_link_test.rb
-- test/govspeak_attachments_inline_test.rb
-- test/govspeak_link_test.rb
+- test/govspeak_test_helper.rb
+- test/govspeak_attachment_test.rb
 - test/govspeak_structured_headers_test.rb
+- test/govspeak_attachments_inline_test.rb
+- test/govspeak_contacts_test.rb
+- test/govspeak_extract_contact_content_ids_test.rb