govspeak 7.0.2 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14fa86649f2bb73e47685e2fb16ae978b1dff2a3f7bef496fd7520186547d854
-  data.tar.gz: 203651a48459e58f8974a4621ba3ea0651133077c79b94d0cbf489df8049ceae
+  metadata.gz: 8b23cb6b80ef9b9d71a55b5cf0c1ffa1d33c3127ebac6290e7ed57de253439bd
+  data.tar.gz: 5bbe38f1188c1159d7af520b22dc2fc011e95256c53be222170081220c11fa64
 SHA512:
-  metadata.gz: 4f9af0743b85af02263ece3934eb4b8df41b25f1dad626bfd65216dd405110b66c08bf32cbcf1c44a93a0678d8934131e37ec0ca66e37148516d9e3e3ca25ff2
-  data.tar.gz: 175745b808a77d6d7a60b85b617b1df9596c5c2483d0fac784c1d8c42a2eaea71ee2dc7ffdd0f5968417126b97fea0a1583c70598793795da08bd821fa7b1c21
+  metadata.gz: 13e3cbc3237ad2b739ff8d984d35e040e1379e716791fb9ed7d789b4d4ca9ce6398a53cb8bf095df68af80257aa5d1e2659803857f88677073576685da65df60
+  data.tar.gz: 0f9dc64d2983ffa7c546d54f96c852500d92b2b01e2b48d163784b5d41a2a6e38202d8385665c264287b8035d0b8d96059a5fd0be7f065774d602b3caeefc84b

data/CHANGELOG.md

@@ -1,6 +1,15 @@
+## 7.1.1
+
+* Make image and attachment embedding syntax more consistent [#274](https://github.com/alphagov/govspeak/pull/274)
+
+## 7.1.0
+
+* Drop support for Ruby 2.7 [#272](https://github.com/alphagov/govspeak/pull/272)
+* Replace inline style attributes in td/th elements with classes [#268](https://github.com/alphagov/govspeak/pull/268)
+
 ## 7.0.2
 
-* Fix for abbreviations nested in button. [#267] (https://github.com/alphagov/govspeak/pull/267)
+* Fix for abbreviations nested in button. [#267](https://github.com/alphagov/govspeak/pull/267)
 
 ## 7.0.1
 

data/lib/govspeak/html_sanitizer.rb

@@ -69,6 +69,8 @@ class Govspeak::HtmlSanitizer
         "svg" => Sanitize::Config::RELAXED[:attributes][:all] + %w[xmlns width height viewbox focusable],
         "path" => Sanitize::Config::RELAXED[:attributes][:all] + %w[fill d],
         "div" => [:data],
+        # @TODO  These style attributes can be removed once we've checked there
+        # isn't hardcoded HTML in documents that uses them
         "th" => Sanitize::Config::RELAXED[:attributes]["th"] + %w[style],
         "td" => Sanitize::Config::RELAXED[:attributes]["td"] + %w[style],
         "govspeak-embed-attachment" => %w[content-id],

data/lib/govspeak/post_processor.rb

@@ -102,6 +102,23 @@ module Govspeak
       end
     end
 
+    extension("convert table cell inline styles to classes") do |document|
+      document.css("th[style], td[style]").each do |el|
+        style = el.remove_attribute("style")
+        matches = style.value.scan(/text-align:\s*(left|center|right)/).flatten
+
+        next unless matches.any?
+
+        class_name = "cell-text-#{matches.last}"
+
+        if el[:class]
+          el[:class] += " #{class_name}"
+        else
+          el[:class] = class_name
+        end
+      end
+    end
+
     extension("use gem component for buttons") do |document|
       document.css(".govuk-button").map do |el|
         button_html = GovukPublishingComponents.render(

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "7.0.2".freeze
+  VERSION = "7.1.1".freeze
 end

data/lib/govspeak.rb

@@ -32,7 +32,7 @@ module Govspeak
   class Document
     Parser = Kramdown::Parser::Govuk
     PARSER_CLASS_NAME = Parser.name.split("::").last
-    UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.freeze
+    UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i
     NEW_PARAGRAPH_LOOKBEHIND = %q{(?<=\A|\n\n|\r\n\r\n)}.freeze
 
     @extensions = []
@@ -424,14 +424,14 @@ module Govspeak
       renderer.render(contact: ContactPresenter.new(contact))
     end
 
-    extension("Image", /#{NEW_PARAGRAPH_LOOKBEHIND}\[Image:\s*(.*?)\s*\]/) do |image_id|
+    extension("Image", /^\[Image:\s*(.*?)\s*\]/) do |image_id|
       image = images.detect { |c| c.is_a?(Hash) && c[:id] == image_id }
       next "" unless image
 
       render_image(ImagePresenter.new(image))
     end
 
-    extension("Attachment", /#{NEW_PARAGRAPH_LOOKBEHIND}\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|
+    extension("Attachment", /^\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|
       next "" if attachments.none? { |a| a[:id] == attachment_id }
 
       %(<govspeak-embed-attachment id="#{attachment_id}"></govspeak-embed-attachment>)

data/test/govspeak_attachment_test.rb

@@ -21,7 +21,7 @@ class GovspeakAttachmentTest < Minitest::Test
     assert_match(/Attachment Title/, rendered)
   end
 
-  test "only renders attachment when markdown extension starts on a line" do
+  test "only renders attachment when markdown extension starts on a new line" do
     attachment = {
       id: "attachment.pdf",
       url: "http://example.com/attachment.pdf",
@@ -34,5 +34,10 @@ class GovspeakAttachmentTest < Minitest::Test
     rendered = render_govspeak("[Attachment:attachment.pdf] some text", [attachment])
     assert_match(/<section class="gem-c-attachment/, rendered)
     assert_match(/<p>some text<\/p>/, rendered)
+
+    rendered = render_govspeak("some text\n[Attachment:attachment.pdf]\nsome more text", [attachment])
+    assert_match(/<p>some text<\/p>/, rendered)
+    assert_match(/<section class="gem-c-attachment/, rendered)
+    assert_match(/<p>some more text<\/p>/, rendered)
   end
 end

data/test/govspeak_images_bang_test.rb

@@ -80,4 +80,30 @@ class GovspeakImagesBangTest < Minitest::Test
       )
     end
   end
+
+  test "!!n syntax must start on a new line" do
+    given_govspeak "some text !!1", images: [Image.new] do
+      assert_html_output("<p>some text !!1</p>")
+    end
+
+    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>",
+      )
+    end
+
+    given_govspeak "!!1 some text", 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>\n<p>some text</p>",
+      )
+    end
+
+    given_govspeak "some text\n!!1\nsome more text", images: [Image.new] do
+      assert_html_output <<~HTML
+        <p>some text</p>
+        <figure class="image embedded"><div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div></figure>
+        <p>some more text</p>
+      HTML
+    end
+  end
 end

data/test/govspeak_images_test.rb

@@ -88,5 +88,13 @@ class GovspeakImagesTest < Minitest::Test
         "<figure class=\"image embedded\"><div class=\"img\"><img src=\"http://example.com/image.jpg\" alt=\"my alt\"></div></figure>\n<p>some text</p>",
       )
     end
+
+    given_govspeak "some text\n[Image:image-id]\nsome more text", images: [build_image] do
+      assert_html_output <<~HTML
+        <p>some text</p>
+        <figure class="image embedded"><div class="img"><img src="http://example.com/image.jpg" alt="my alt"></div></figure>
+        <p>some more text</p>
+      HTML
+    end
   end
 end

data/test/govspeak_table_with_headers_test.rb

@@ -58,21 +58,21 @@ class GovspeakTableWithHeadersTest < Minitest::Test
 <table>
   <thead>
     <tr>
-      <td style="text-align: left"></td>
-      <th style="text-align: center" scope="col">Second Column</th>
-      <th style="text-align: right" scope="col">Third Column</th>
+      <td class="cell-text-left"></td>
+      <th scope="col" class="cell-text-center">Second Column</th>
+      <th scope="col" class="cell-text-right">Third Column</th>
     </tr>
   </thead>
   <tbody>
     <tr>
-      <th style="text-align: left" scope="row">First row</th>
-      <td style="text-align: center">Cell</td>
-      <td style="text-align: right">Cell</td>
+      <th scope="row" class="cell-text-left">First row</th>
+      <td class="cell-text-center">Cell</td>
+      <td class="cell-text-right">Cell</td>
     </tr>
     <tr>
-      <th style="text-align: left" scope="row">Second row</th>
-      <td style="text-align: center">Cell</td>
-      <td style="text-align: right">Cell</td>
+      <th scope="row" class="cell-text-left">Second row</th>
+      <td class="cell-text-center">Cell</td>
+      <td class="cell-text-right">Cell</td>
     </tr>
   </tbody>
 </table>
@@ -255,7 +255,7 @@ class GovspeakTableWithHeadersTest < Minitest::Test
     assert_equal document_body_with_hashes_for_row_headers.to_html, expected_outcome
   end
 
-  test "Cells are aligned correctly" do
+  test "Cells are given classes to indicate alignment" do
     assert_equal document_body_with_alignments.to_html, expected_outcome_for_table_with_alignments
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 7.0.2
+  version: 7.1.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '23'
+        version: '35.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '23'
+        version: '35.1'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 4.10.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -320,36 +320,36 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain
 test_files:
 - test/blockquote_extra_quote_remover_test.rb
 - test/govspeak_attachment_link_test.rb
-- test/govspeak_images_test.rb
-- test/test_helper.rb
-- test/govspeak_footnote_test.rb
+- test/govspeak_attachment_test.rb
+- test/govspeak_attachments_image_test.rb
+- test/govspeak_attachments_inline_test.rb
 - test/govspeak_button_test.rb
+- test/govspeak_contacts_test.rb
+- test/govspeak_extract_contact_content_ids_test.rb
+- test/govspeak_footnote_test.rb
+- test/govspeak_images_bang_test.rb
+- test/govspeak_images_test.rb
+- test/govspeak_link_extractor_test.rb
 - test/govspeak_link_test.rb
-- test/html_sanitizer_test.rb
-- test/govspeak_test.rb
+- test/govspeak_structured_headers_test.rb
 - test/govspeak_table_with_headers_test.rb
+- test/govspeak_test.rb
+- test/govspeak_test_helper.rb
+- test/html_sanitizer_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_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
+- test/test_helper.rb