govspeak 8.3.4 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474078f8179d567c75b47f781c5d567072a6889a79554fefb81172316828f5fc
-  data.tar.gz: aa5a44c15285543a1749b3cf129c66eeea2cb6b58d0b98c9970bc5130320c8fb
+  metadata.gz: bcb8f916d4ecf2cd7dacead34261e62a22484ad59faf2abb95e7ab41bf41afd0
+  data.tar.gz: f581a4a55a699cfe3726ca166701bb5a368644e474d568984f9aa67bd42b4af7
 SHA512:
-  metadata.gz: 210b4b75330ff66604483b61e0c2f5c78292ab7e3a957839af6f4fb7e5123b8649366945b01a4a03841f0924166475e28751e4e2531cfe10a125ba506b3f9ec6
-  data.tar.gz: 5c164df64fa4ba9c0bdba31d55644550267543e2549e764cab614db0bf2a2e07cd602d571c51ecad4ec9f402e0d76be5052cb21195616be98aba8c99a843d3c7
+  metadata.gz: a16fda897761b036e9ab947e14edbe577c25411001f5819a2005b23cd85bc80876783c6afa6a62b96a607a89b7a8a0e0db92de4e17dc81f4af8a00b35ad23263
+  data.tar.gz: 601ce5bf4d18aa1553c36dba150e0c1b5a59ca3357550a8357f665d9e059e7f5ca742ede3b1d19491f93d6229d73bd0cb055d777b3fb51fba39ef99857986a83

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 8.4.0
+
+* Drop support for Ruby 3.0. The minimum required Ruby version is now 3.1.4.
+* Add support for Ruby 3.3.
+* Allow acronyms within example blocks.
+* Allow tables within example blocks.
+* Allow acronyms within address blocks.
+
 ## 8.3.4
 
 * Fix tables within call to action component ([#306](https://github.com/alphagov/govspeak/pull/306))

data/README.md

@@ -28,7 +28,7 @@ Once govspeak has been updated and version incremented then:
 
 Also, consider if:
 - [whitehall](https://github.com/alphagov/whitehall) needs updating (as custom govspeak changes are present)
-- [govpspeak-preview](https://github.com/alphagov/govspeak-preview) needs updating
+- [govspeak-preview](https://github.com/alphagov/govspeak-preview) needs updating
 
 Any pages that use govspeak to generate Content will need to *republished* in order for the new changes to be reflected.  
 

data/lib/govspeak/html_sanitizer.rb

@@ -34,8 +34,8 @@ class Govspeak::HtmlSanitizer
     # currently does – i.e. to return Sanitize config without any transformers.
     # e.g. https://github.com/alphagov/hmrc-manuals-api/blob/4a83f78d0bb839520155623fd9b63b3b12a3b13a/app/validators/no_dangerous_html_in_text_fields_validator.rb#L44
     config_with_transformers = Sanitize::Config.merge(
-      sanitize_config(allowed_elements: allowed_elements),
-      transformers: transformers,
+      sanitize_config(allowed_elements:),
+      transformers:,
     )
 
     Sanitize.clean(@dirty_html, config_with_transformers)
@@ -48,7 +48,7 @@ class Govspeak::HtmlSanitizer
 
     Sanitize::Config.merge(
       Sanitize::Config::RELAXED,
-      elements: elements,
+      elements:,
       attributes: {
         # We purposefully disable style attributes which Sanitize::Config::RELAXED allows
         :all => Sanitize::Config::RELAXED[:attributes][:all] + %w[role aria-label] - %w[style],

data/lib/govspeak/html_validator.rb

@@ -26,7 +26,7 @@ private
   def govspeak_to_html(sanitize:)
     Govspeak::Document.new(
       govspeak_string,
-      sanitize: sanitize,
+      sanitize:,
       allowed_image_hosts: @allowed_image_hosts,
     ).to_html
   end

data/lib/govspeak/post_processor.rb

@@ -67,7 +67,7 @@ module Govspeak
 
         attachment_html = GovukPublishingComponents.render(
           "govuk_publishing_components/components/attachment",
-          attachment: attachment,
+          attachment:,
           margin_bottom: 6,
           locale: govspeak_document.locale,
         )
@@ -86,7 +86,7 @@ module Govspeak
 
         attachment_html = GovukPublishingComponents.render(
           "govuk_publishing_components/components/attachment_link",
-          attachment: attachment,
+          attachment:,
           locale: govspeak_document.locale,
         )
         el.swap(attachment_html)

data/lib/govspeak/presenters/attachment_presenter.rb

@@ -51,7 +51,7 @@ module Govspeak
     MS_POWERPOINT_PRESENTATION_HUMANIZED_CONTENT_TYPE = "MS Powerpoint Presentation".freeze
 
     def file_abbr_tag(abbr, title)
-      content_tag(:abbr, abbr, title: title)
+      content_tag(:abbr, abbr, title:)
     end
 
     def humanized_content_type(file_extension)

data/lib/govspeak/presenters/image_presenter.rb

@@ -34,7 +34,7 @@ module Govspeak
       lines = []
       lines << "<figcaption>"
       lines << %(<p>#{caption}</p>) if caption.present?
-      lines << %(<p>#{I18n.t('govspeak.image.figure.credit', credit: credit)}</p>) if credit.present?
+      lines << %(<p>#{I18n.t('govspeak.image.figure.credit', credit:)}</p>) if credit.present?
       lines << "</figcaption>"
       lines.join
     end

data/lib/govspeak/template_renderer.rb

@@ -17,7 +17,7 @@ module Govspeak
     def t(*args)
       options = args.last.is_a?(Hash) ? args.last.dup : {}
       key = args.shift
-      I18n.t!(key, **options.merge(locale: locale))
+      I18n.t!(key, **options.merge(locale:))
     end
 
     def format_with_html_line_breaks(string)

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "8.3.4".freeze
+  VERSION = "8.4.0".freeze
 end

data/lib/govspeak.rb

@@ -98,7 +98,7 @@ module Govspeak
     end
 
     def extracted_links(website_root: nil)
-      Govspeak::LinkExtractor.new(self, website_root: website_root).call
+      Govspeak::LinkExtractor.new(self, website_root:).call
     end
 
     def extract_contact_content_ids
@@ -292,10 +292,17 @@ module Govspeak
     wrap_with_div("place", "$P", Govspeak::Document)
     wrap_with_div("information", "$I", Govspeak::Document)
     wrap_with_div("additional-information", "$AI")
-    wrap_with_div("example", "$E", Govspeak::Document)
+
+    extension("example", surrounded_by("$E")) do |body|
+      <<~BODY
+        <div class="example" markdown="1">
+          #{body.strip.gsub(/\A^\|/, "\n|").gsub(/\|$\Z/, "|\n")}
+        </div>
+      BODY
+    end
 
     extension("address", surrounded_by("$A")) do |body|
-      %(\n<div class="address"><div class="adr org fn"><p>\n#{body.sub("\n", '').gsub("\n", '<br />')}\n</p></div></div>\n)
+      %(\n<div class="address"><div class="adr org fn"><p markdown="1">\n#{body.sub("\n", '').gsub("\n", '<br />')}\n</p></div></div>\n)
     end
 
     extension("legislative list", /#{NEW_PARAGRAPH_LOOKBEHIND}\$LegislativeList\s*$(.*?)\$EndLegislativeList/m) do |body|
@@ -310,7 +317,7 @@ module Govspeak
 
     extension("numbered list", /^[ \t]*((s\d+\.\s.*(?:\n|$))+)/) do |body|
       body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do
-        "<li>#{Govspeak::Document.new(Regexp.last_match(2).strip, attachments: attachments).to_html}</li>\n"
+        "<li>#{Govspeak::Document.new(Regexp.last_match(2).strip, attachments:).to_html}</li>\n"
       end
       %(<ol class="steps">\n#{body}</ol>)
     end

data/test/govspeak_attachment_link_test.rb

@@ -2,7 +2,7 @@ require "test_helper"
 
 class GovspeakAttachmentLinkTest < Minitest::Test
   def render_govspeak(govspeak, attachments = [])
-    Govspeak::Document.new(govspeak, attachments: attachments).to_html
+    Govspeak::Document.new(govspeak, attachments:).to_html
   end
 
   test "renders an empty string for attachment link that is not found" do

data/test/govspeak_attachment_test.rb

@@ -2,7 +2,7 @@ require "test_helper"
 
 class GovspeakAttachmentTest < Minitest::Test
   def render_govspeak(govspeak, attachments = [])
-    Govspeak::Document.new(govspeak, attachments: attachments).to_html
+    Govspeak::Document.new(govspeak, attachments:).to_html
   end
 
   test "renders an empty string for attachment link that is not found" do

data/test/govspeak_attachments_image_test.rb

@@ -11,7 +11,7 @@ class GovspeakAttachmentsImageTest < Minitest::Test
   end
 
   def render_govspeak(govspeak, attachments = [])
-    Govspeak::Document.new(govspeak, attachments: attachments).to_html
+    Govspeak::Document.new(govspeak, attachments:).to_html
   end
 
   def compress_html(html)

data/test/govspeak_attachments_inline_test.rb

@@ -11,7 +11,7 @@ class GovspeakAttachmentsInlineTest < Minitest::Test
   end
 
   def render_govspeak(govspeak, attachments = [])
-    Govspeak::Document.new(govspeak, attachments: attachments).to_html
+    Govspeak::Document.new(govspeak, attachments:).to_html
   end
 
   test "renders an empty string for an inline attachment not found" do

data/test/govspeak_button_test.rb

@@ -118,7 +118,7 @@ class GovspeakTest < Minitest::Test
   " do
     assert_text_output "Start now JSA"
     assert_html_output %(
-      <p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="govuk-button" draggable="false" href="https://www.apply-for-new-style-jsa.dwp.gov.uk/?lang=cy"><span> Start now <abbr title="Jobseeker's Allowance">JSA</abbr></span><svg class="govuk-button__start-icon govuk-!-display-none-print" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" focusable="false" aria-hidden="true"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>
+      <p><a class="gem-c-button govuk-button govuk-button--start" role="button" data-module="govuk-button" data-ga4-attributes='{"event_name":"navigation","type":"start button"}' draggable="false" href="https://www.apply-for-new-style-jsa.dwp.gov.uk/?lang=cy"><span> Start now <abbr title="Jobseeker's Allowance">JSA</abbr></span><svg class="govuk-button__start-icon govuk-!-display-none-print" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewbox="0 0 33 40" focusable="false" aria-hidden="true"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"></path></svg></a></p>
     )
   end
 end

data/test/govspeak_test.rb

@@ -393,6 +393,19 @@ Teston
     assert_text_output "street road"
   end
 
+  test_given_govspeak "
+    $A
+    street with ACRONYM
+    road
+    $A
+
+    *[ACRONYM]: This is the acronym explanation" do
+    assert_html_output %(
+      <div class="address"><div class="adr org fn"><p>
+      street with <abbr title="This is the acronym explanation">ACRONYM</abbr><br>road<br>
+      </p></div></div>)
+  end
+
   test_given_govspeak "
     $P
     $I
@@ -1247,6 +1260,47 @@ Teston
     )
     end
 
+  test_given_govspeak "
+    $E
+    This is an ACRONYM.
+    $E
+
+    *[ACRONYM]: This is the acronym explanation
+  " do
+    assert_html_output %(
+      <div class="example">
+        <p>This is an <abbr title="This is the acronym explanation">ACRONYM</abbr>.</p>
+      </div>
+    )
+  end
+
+  test_given_govspeak "
+    $E
+    |Heading 1|Heading 2|
+    |-|-|
+    |information|more information|
+    $E" do
+    assert_html_output %(
+    <div class="example">
+
+    <table>
+      <thead>
+        <tr>
+          <th scope="col">Heading 1</th>
+          <th scope="col">Heading 2</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>information</td>
+          <td>more information</td>
+        </tr>
+      </tbody>
+    </table>
+
+  </div>)
+  end
+
   test_given_govspeak "
     $LegislativeList
     * 1. Item 1[^1] with an ACRONYM

data/test/govspeak_test_helper.rb

@@ -55,7 +55,7 @@ module GovspeakTestHelper
       lines = text.split "\n"
       digits = Math.log10(lines.size + 2).ceil
       lines.map
-        .with_index { |line, i| sprintf("%<number>#{digits}d: %<line>s", number: i + 1, line: line) }
+        .with_index { |line, i| sprintf("%<number>#{digits}d: %<line>s", number: i + 1, line:) }
         .join("\n")
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 8.3.4
+  version: 8.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.2.2
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +39,7 @@ dependencies:
         version: 2.3.8
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 2.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +49,7 @@ dependencies:
         version: 2.3.8
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 2.8.8
 - !ruby/object:Gem::Dependency
   name: govuk_publishing_components
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +57,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '35.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 43.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,6 +67,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '35.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 43.5.1
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +91,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.14.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -86,6 +101,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.14.7
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +111,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -100,6 +121,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +214,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.14.0
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.14.0
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -319,14 +343,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: 3.1.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.21
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain