govspeak 6.7.0 → 6.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e93ed0928bdacce945ae5d1ea81d3bbc40508fcc1875c59e02297aed7f78e8
-  data.tar.gz: b6f7f01034081da748db3d02e81fe31f72f155f2921de02b6d07f65d04587e09
+  metadata.gz: 3b07175e22a88ddf687631c2a157d00f9649efc118ab3e535d95cbda00918d43
+  data.tar.gz: 430f7d18852c8fdd549812c0260b118108292f34f2767902217c9d57a80d1f8b
 SHA512:
-  metadata.gz: 00e6e768ecdc8ce782f849957370199bdbfde7a85973c83366590b09155395455f62be45e86bcf8864053070ecb3a9560645bef410e562121ef08acefe2bccac
-  data.tar.gz: dd68a811064c4e63a092b00ffef191db7f3221308eb84cf916304b8e2207522baea4e37226c09527c4dc25f618b74b2604b39fc96ac986dfbb8008e93454f8fb
+  metadata.gz: 0fd6c1d0b6e8a416fdeb6d7aba99868dfb8e9ccf80191666dc771dcdf56a9bf396297569759c172608c31daf7bf75a891914e98713fc0e99b8458220b3dd7934
+  data.tar.gz: 8a04ab8364ea6ac989b4a1549ce8c4f152ad57988144183f7db00b5b256fce4b5823d79ac611a4078f75ccee5bd1d42f5a81344140979d2066916c2693a35dc4

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Unreleased
+
+## 6.7.1
+
+* Update failing test [212](https://github.com/alphagov/govspeak/pull/212)
+* Fix stats headline HTML semantics [213](https://github.com/alphagov/govspeak/pull/213)
+
 ## 6.7.0
 
 * Update heading & docs [#206](https://github.com/alphagov/govspeak/pull/206)

data/README.md

@@ -18,6 +18,23 @@ then create a new document
     doc = Govspeak::Document.new "^Test^"
     puts doc.to_html
 
+## Changes appearing across GOV.UK
+
+Some additional steps or considerations are needed to ensure changes to govspeak cascade across GOV.UK in a holistic way.
+
+Once govspeak has been updated and version incremented then: 
+- [`govuk_publishing_components` govspeak](https://components.publishing.service.gov.uk/component-guide/govspeak) will also need updating to reflect your most recent change.
+- [Publishing apps](https://docs.publishing.service.gov.uk/apps.html) (including but not limited to [content-publisher](https://github.com/alphagov/content-publisher) & [whitehall](https://github.com/alphagov/whitehall)) also use govspeak, these apps will need to be released with the new govspeak version present.
+
+Also, consider if:
+- [whitehall](https://github.com/alphagov/whitehall) needs updating (as custom govspeak changes are present)
+- [govuk-content-schema](https://github.com/alphagov/govuk-content-schemas) needs updating
+- [govpspeak-preview](https://github.com/alphagov/govspeak-preview) is worth updating
+
+Any pages that use govspeak to generate Content will need to *republished* in order for the new changes to be reflected.  
+
+- Data Labs can help identify which pages need updating by [submitting a request](https://gov-uk.atlassian.net/wiki/spaces/GOVUK/pages/1860075525/GOV.UK+Data+Labs#Submitting-a-data-science-request) and [#govuk-2ndline](https://docs.publishing.service.gov.uk/manual/2nd-line.html) can help with republishing
+  
 # Extensions
 
 In addition to the [standard Markdown syntax](http://daringfireball.net/projects/markdown/syntax "Markdown syntax"), we have added our own extensions.
@@ -106,9 +123,9 @@ Statistic headlines highlight important numbers in content. Displays a statistic
 Creates the following:
 
 ```html
-<aside class="stat-headline">
+<div class="stat-headline">
   <p><em>13.8bn</em> years since the big bang</p>
-</aside>
+</div>
 ```
 
 ## Points of Contact
@@ -676,4 +693,4 @@ 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>
-```
+```

data/lib/govspeak.rb

@@ -185,8 +185,8 @@ module Govspeak
     end
 
     extension("stat-headline", %r${stat-headline}(.*?){/stat-headline}$m) do |body|
-      %(\n\n<aside class="stat-headline">
-#{Govspeak::Document.new(body.strip).to_html}</aside>\n)
+      %(\n\n<div class="stat-headline">
+#{Govspeak::Document.new(body.strip).to_html}</div>\n)
     end
 
     # FIXME: these surrounded_by arguments look dodgy

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "6.7.0".freeze
+  VERSION = "6.7.1".freeze
 end

data/test/govspeak_footnote_test.rb

@@ -20,13 +20,13 @@ class GovspeakFootnoteTest < Minitest::Test
     [^3]: And then they both point here." 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<sup id="fnref:1" role="doc-noteref"><a href="#fn:1" class="footnote" rel="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>
+      <p>Footnotes can be added too<sup id="fnref:2" role="doc-noteref"><a href="#fn:2" class="footnote" rel="footnote">[footnote 2]</a></sup>.</p>
 
-      <p>This footnote has a reference number<sup id="fnref:3" role="doc-noteref"><a href="#fn:3" class="footnote">[footnote 3]</a></sup>.</p>
+      <p>This footnote has a reference number<sup id="fnref:3" role="doc-noteref"><a href="#fn:3" class="footnote" rel="footnote">[footnote 3]</a></sup>.</p>
 
-      <p>And this footnote has the same reference number<sup id="fnref:3:1" role="doc-noteref"><a href="#fn:3" class="footnote">[footnote 3]</a></sup>.</p>
+      <p>And this footnote has the same reference number<sup id="fnref:3:1" role="doc-noteref"><a href="#fn:3" class="footnote" rel="footnote">[footnote 3]</a></sup>.</p>
 
       <div class="footnotes" role="doc-endnotes">
         <ol>

data/test/govspeak_test.rb

@@ -30,7 +30,7 @@ class GovspeakTest < Minitest::Test
 
   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 %(<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
+    assert_equal %(<p>this</p>\n\n<div class="stat-headline">\n<p><em>13.8bn</em> Age of the universe in years</p>\n</div>\n), rendered
   end
 
   test "extracts headers with text, level and generated id" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 6.7.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -372,24 +372,24 @@ signing_key:
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/govspeak_footnote_test.rb
-- test/html_sanitizer_test.rb
-- test/govspeak_test.rb
-- test/test_helper.rb
-- test/blockquote_extra_quote_remover_test.rb
-- test/govspeak_button_test.rb
-- test/html_validator_test.rb
+- test/govspeak_images_bang_test.rb
+- test/govspeak_attachment_test.rb
 - test/govspeak_link_extractor_test.rb
-- test/govspeak_attachment_link_test.rb
-- test/govspeak_link_test.rb
-- test/govspeak_contacts_test.rb
+- test/govspeak_attachments_inline_test.rb
+- test/govspeak_button_test.rb
 - test/govspeak_structured_headers_test.rb
-- test/govspeak_images_test.rb
+- test/govspeak_attachments_image_test.rb
+- test/govspeak_attachment_link_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
-- test/govspeak_table_with_headers_test.rb
-- test/govspeak_attachment_test.rb
-- test/govspeak_attachments_inline_test.rb
 - test/presenters/h_card_presenter_test.rb
+- test/govspeak_test.rb
+- test/html_sanitizer_test.rb
+- test/govspeak_footnote_test.rb
+- test/blockquote_extra_quote_remover_test.rb
+- test/test_helper.rb
+- test/govspeak_table_with_headers_test.rb
+- test/govspeak_images_test.rb
+- test/govspeak_link_test.rb
+- test/html_validator_test.rb
+- test/govspeak_contacts_test.rb
 - test/govspeak_test_helper.rb
-- test/govspeak_images_bang_test.rb
-- test/govspeak_attachments_image_test.rb