govspeak 10.2.5 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885072211496e1f2cce10e8fe3ff9418575cd9952bb946071ccb79ed2f8b69c7
-  data.tar.gz: 41e668ae971c69d4f95d3c27634eabfd08e0f2803dfb20c2b5219ef5b528beba
+  metadata.gz: c0b86000c8998edfcccee37082c8779bc99ccbbfdbc9bf28a624a64444e45aa8
+  data.tar.gz: 965066276488ad504054c3251606ffee542e09c5958fe1dc94c2377a43d9beff
 SHA512:
-  metadata.gz: 684d975fc93d6618e37d760d89b92756a11cd1817fea10bda56ffb8e9d4a82c608fa19a877c2b809f2aa932b9b780aa1c7fd5e4bb588a4f72e456c450f1f5f3a
-  data.tar.gz: 1973391e3ff9ca6337f0cca4a817625b61911d3e5275c060e8181576cc9f617780a80210f6f31ded094af2ae9002a2ffacf28271de57984fe8c2c4a60f0af3a7
+  metadata.gz: 04aee10a7928ad945b7c269f24c87301966a467b2c1131b205a810f2e13a0211ea5b44ae68c515c626ff10d349562c35cdd2f3389a70cca50ee4d27b2d621ea0
+  data.tar.gz: 983127e90594c5937a4178ee735d0f700e0f52025d6a1d2417fa0f5c0367ccb155e27a57fe6590627c6e23668d0942667931913d87afd74e4818f08a89b88a97

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 10.3.0
+
+* Add Welsh translations for various components: devolved content headings, footnote labels, and image credit labels ([#417](https://github.com/alphagov/govspeak/pull/417))
+
 ## 10.2.5
 
 * Update dependencies

data/lib/govspeak/post_processor.rb

@@ -150,11 +150,13 @@ module Govspeak
     extension("use custom footnotes") do |document|
       document.css("a.footnote").map do |el|
         footnote_number = el[:href].gsub(/\D/, "")
-        el.inner_html = "[footnote #{footnote_number}]"
+        label = I18n.t("govspeak.footnote.label", locale: govspeak_document.locale)
+        el.inner_html = "[#{label} #{footnote_number}]"
       end
       document.css("[role='doc-backlink']").map do |el|
         backlink_number = " #{el.css('sup')[0].content}" if el.css("sup")[0].present?
-        el["aria-label"] = "go to where this is referenced#{backlink_number}"
+        aria_label = I18n.t("govspeak.footnote.backlink_aria_label", locale: govspeak_document.locale)
+        el["aria-label"] = "#{aria_label}#{backlink_number}"
       end
     end
 

data/lib/govspeak/presenters/image_presenter.rb

@@ -1,9 +1,10 @@
 module Govspeak
   class ImagePresenter
-    attr_reader :image
+    attr_reader :image, :locale
 
-    def initialize(image)
+    def initialize(image, locale: "en")
       @image = image
+      @locale = locale
     end
 
     def url
@@ -34,7 +35,7 @@ module Govspeak
       lines = []
       lines << "<figcaption>"
       lines << %(<p>#{caption}</p>) if caption.present?
-      lines << %(<p>#{I18n.t('govspeak.image.figure.credit', credit:)}</p>) if credit.present?
+      lines << %(<p>#{I18n.t('govspeak.image.figure.credit', credit:, locale:)}</p>) if credit.present?
       lines << "</figcaption>"
       lines.join
     end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "10.2.5".freeze
+  VERSION = "10.3.0".freeze
 end

data/lib/govspeak.rb

@@ -225,7 +225,7 @@ module Govspeak
       image = images[image_number.to_i - 1]
       next "" unless image
 
-      render_image(ImagePresenter.new(image))
+      render_image(ImagePresenter.new(image, locale:))
     end
 
     # DEPRECATED: use 'AttachmentLink:attachment-id' instead
@@ -332,20 +332,18 @@ module Govspeak
       BODY
     end
 
-    def self.devolved_options
-      { "scotland" => "Scotland",
-        "england" => "England",
-        "england-wales" => "England and Wales",
-        "northern-ireland" => "Northern Ireland",
-        "wales" => "Wales",
-        "london" => "London" }
-    end
+    %w[scotland
+       england
+       england-wales
+       northern-ireland
+       wales
+       london].each do |devolved_option|
+      extension("devolved-#{devolved_option}", /:#{devolved_option}:(.*?):#{devolved_option}:/m) do |body|
+        header_content = I18n.t("govspeak.devolved.#{devolved_option}", locale:)
 
-    devolved_options.each do |k, v|
-      extension("devolved-#{k}", /:#{k}:(.*?):#{k}:/m) do |body|
         <<~HTML
-          <div class="devolved-content #{k}">
-          <p class="devolved-header">This section applies to #{v}</p>
+          <div class="devolved-content #{devolved_option}">
+          <p class="devolved-header">#{header_content}</p>
           <div class="devolved-body">#{Govspeak::Document.new(body.strip).to_html}</div>
           </div>
         HTML
@@ -375,7 +373,7 @@ module Govspeak
       image = images.detect { |c| c.is_a?(Hash) && c[:id] == image_id }
       next "" unless image
 
-      render_image(ImagePresenter.new(image))
+      render_image(ImagePresenter.new(image, locale:))
     end
 
     extension("Attachment", /^\[Attachment:\s*(.*?)\s*\]/) do |attachment_id|

data/locales/cy.yml

@@ -4,3 +4,16 @@ cy:
     contact:
       contact_form: Ffurflen cysylltu
       email: E-bost
+    devolved:
+      scotland: Mae'r adran hon yn berthnasol i'r Alban
+      england: Mae'r adran hon yn berthnasol i Loegr
+      england-wales: Mae'r adran hon yn berthnasol i Gymru a Lloegr
+      northern-ireland: Mae'r adran hon yn berthnasol i Ogledd Iwerddon
+      wales: Mae'r adran hon yn berthnasol i Gymru
+      london: Mae'r adran hon yn berthnasol i Lundain
+    footnote:
+      label: troednodyn
+      backlink_aria_label: ewch i ble mae hyn wedi'i gyfeirio
+    image:
+      figure:
+        credit: "Credyd delwedd: %{credit}"

data/locales/en.yml

@@ -4,6 +4,16 @@ en:
     contact:
       email: Email
       contact_form: Contact form
+    devolved:
+      scotland: This section applies to Scotland
+      england: This section applies to England
+      england-wales: This section applies to England and Wales
+      northern-ireland: This section applies to Northern Ireland
+      wales: This section applies to Wales
+      london: This section applies to London
+    footnote:
+      label: footnote
+      backlink_aria_label: go to where this is referenced
     image:
       figure:
         credit: "Image credit: %{credit}"

data/test/govspeak_contacts_test.rb

@@ -198,4 +198,22 @@ class GovspeakContactsTest < Minitest::Test
     assert_match(%(<p class="comments">My description about <a href="https://www.gov.uk">https://www.gov.uk</a></p>),
                  compress_html(rendered))
   end
+
+  test "uses localised email label when locale is not English" do
+    contact = build_contact
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact], locale: "cy").to_html
+    assert_match(%(<p class="email"><span class="type">E-bost</span>),
+                 compress_html(rendered))
+  end
+
+  test "uses localised contact form label when locale is not English" do
+    contact = build_contact
+    govspeak = "[Contact:4f3383e4-48a2-4461-a41d-f85ea8b89ba0]"
+
+    rendered = Govspeak::Document.new(govspeak, contacts: [contact], locale: "cy").to_html
+    assert_match(%(<p class="contact_form_url"><span class="type">Ffurflen cysylltu</span>),
+                 compress_html(rendered))
+  end
 end

data/test/govspeak_devolved_content_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+require "govspeak_test_helper"
+
+class GovspeakDevolvedTest < Minitest::Test
+  include GovspeakTestHelper
+
+  test "uses localised heading when locale is not English" do
+    given_govspeak ":scotland: Rwy'n ddatganoledig iawn\n ac yn Albanaidd iawn \n:scotland:", locale: "cy" do
+      assert_html_output(
+        %(
+        <div class="devolved-content scotland">
+        <p class="devolved-header">Mae'r adran hon yn berthnasol i'r Alban</p>
+        <div class="devolved-body">
+        <p>Rwy’n ddatganoledig iawn
+         ac yn Albanaidd iawn</p>
+        </div>
+        </div>),
+      )
+    end
+  end
+end

data/test/govspeak_footnote_test.rb

@@ -43,4 +43,24 @@ class GovspeakFootnoteTest < Minitest::Test
       </div>),
     )
   end
+
+  test "uses localised labels when locale is not English" do
+    given_govspeak "
+    Gellir ychwanegu troednodiadau[^1].
+
+    [^1]: Ac yna wedi'i ddiffinio'n ddiweddarach.", locale: "cy" do
+      assert_html_output(
+        %(
+        <p>Gellir ychwanegu troednodiadau<sup id="fnref:1"><a href="#fn:1" class="footnote" rel="footnote" role="doc-noteref">[troednodyn 1]</a></sup>.</p>
+
+        <div class="footnotes" role="doc-endnotes">
+          <ol>
+            <li id="fn:1">
+              <p>Ac yna wedi’i ddiffinio’n ddiweddarach. <a href="#fnref:1" class="reversefootnote" role="doc-backlink" aria-label="ewch i ble mae hyn wedi'i gyfeirio">↩</a></p>
+            </li>
+          </ol>
+        </div>),
+      )
+    end
+  end
 end

data/test/govspeak_images_test.rb

@@ -49,6 +49,14 @@ class GovspeakImagesTest < Minitest::Test
     end
   end
 
+  test "Image:image-id syntax adds image credit with localised label when locale is not English" do
+    given_govspeak "[Image:image-id]", { images: [build_image(credit: "Fy Nghredyd ac ati")], locale: "cy" } 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>Credyd delwedd: Fy Nghredyd ac ati</p></figcaption></figure>",
+      )
+    end
+  end
+
   test "Image:image-id syntax ignores a blank credit" do
     given_govspeak "[Image:image-id]", images: [build_image(credit: "  ")] do
       assert_html_output(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 10.2.5
+  version: 10.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -213,14 +213,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 5.1.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 5.1.14
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -317,6 +317,7 @@ files:
 - test/govspeak_attachments_inline_test.rb
 - test/govspeak_button_test.rb
 - test/govspeak_contacts_test.rb
+- test/govspeak_devolved_content_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb
@@ -349,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Markup language for single domain
 test_files:
@@ -360,6 +361,7 @@ test_files:
 - test/govspeak_attachments_inline_test.rb
 - test/govspeak_button_test.rb
 - test/govspeak_contacts_test.rb
+- test/govspeak_devolved_content_test.rb
 - test/govspeak_extract_contact_content_ids_test.rb
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb