govspeak 10.4.0 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3bf8e18b1cfd9bb3c71bf3774e9232c0c3defa120fd60f983fa9acf47c0b51
-  data.tar.gz: 813f4543fa558f0394e29f06afcc52b6e95ed10714b25ae02607c7f185f78a8b
+  metadata.gz: e0c936c8543dbb14d96466ed3247e7a12270cd9235693b37905039a663f82988
+  data.tar.gz: b0b18ad7d4f43d2e6fda4a858ca310823551adf44d88c610ec38a51889f56e88
 SHA512:
-  metadata.gz: 4aa85cc0a63094caaf65aef58851ece00cf9dd3cf32d2ff8c876758a07fb7d139ac7dc19a9b3446b73b8d31a8bef137c4b3b0e41ba1079223c4530fe95e212cf
-  data.tar.gz: ccaa75526e6f9e947f1a2409156a60ca16d904b29c1a877ce8b84264ea2c655dd2a6991c2b992608d992ee26bb0ceb2189e1bc6b12f698091b9956b154f1ac25
+  metadata.gz: 8179405f6139a4890a70b5de379df13d772f8104311a7fa8ef841c66d74b4471d790769a03cc26511dc9540413e2366e7c4f46930552d1cbedadb81c3fa96d65
+  data.tar.gz: 10a9ef6773b3724fa13264fca599435bf69f6aeabd370b3ad263097bc86d4596492269b4e1150d5be5929a7d250b887d96f104b1346f7bbe6ad4040f17e316be

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 10.5.0
+
+* Pass locale to child instances of `Govspeak::Document` (where one instance instantiates another) and to `HtmlValidator`
+* Fall back to English when provided with an invalid locale or a translation is not available for the given locale
+
+## 10.4.1
+
+* Update dependencies
+
 ## 10.4.0
 
 * Support abbreviations in informationals

data/lib/govspeak/html_validator.rb

@@ -4,6 +4,7 @@ class Govspeak::HtmlValidator
   def initialize(govspeak_string, options = {})
     @govspeak_string = govspeak_string.dup.force_encoding(Encoding::UTF_8)
     @allowed_image_hosts = options[:allowed_image_hosts]
+    @locale = options[:locale]
   end
 
   def invalid?
@@ -28,6 +29,7 @@ private
       govspeak_string,
       sanitize:,
       allowed_image_hosts: @allowed_image_hosts,
+      locale: @locale,
     ).to_html
   end
 end

data/lib/govspeak/post_processor.rb

@@ -150,12 +150,12 @@ module Govspeak
     extension("use custom footnotes") do |document|
       document.css("a.footnote").map do |el|
         footnote_number = el[:href].gsub(/\D/, "")
-        label = I18n.t("govspeak.footnote.label", locale: govspeak_document.locale)
+        label = Govspeak::TranslationHelper.t_with_fallback("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?
-        aria_label = I18n.t("govspeak.footnote.backlink_aria_label", locale: govspeak_document.locale)
+        aria_label = Govspeak::TranslationHelper.t_with_fallback("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

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

data/lib/govspeak/template_renderer.rb

@@ -14,10 +14,8 @@ module Govspeak
       erb.result(template_binding)
     end
 
-    def t(*args)
-      options = args.last.is_a?(Hash) ? args.last.dup : {}
-      key = args.shift
-      I18n.t!(key, **options.merge(locale:))
+    def t(key, **options)
+      Govspeak::TranslationHelper.t_with_fallback(key, **options.merge(locale:))
     end
 
     def format_with_html_line_breaks(string)

data/lib/govspeak/translation_helper.rb

@@ -0,0 +1,18 @@
+module Govspeak
+  module TranslationHelper
+    def self.t_with_fallback(key, **options)
+      if I18n.available_locales.none?(options[:locale]&.to_sym)
+        options[:locale] = I18n.default_locale
+      end
+
+      if options[:locale] != I18n.default_locale
+        options[:default] = I18n.t(
+          key,
+          **options.merge(locale: I18n.default_locale),
+        )
+      end
+
+      I18n.t(key, **options)
+    end
+  end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "10.4.0".freeze
+  VERSION = "10.5.0".freeze
 end

data/lib/govspeak.rb

@@ -17,6 +17,7 @@ require "govspeak/blockquote_extra_quote_remover"
 require "govspeak/post_processor"
 require "govspeak/link_extractor"
 require "govspeak/template_renderer"
+require "govspeak/translation_helper"
 require "govspeak/presenters/attachment_presenter"
 require "govspeak/presenters/contact_presenter"
 require "govspeak/presenters/h_card_presenter"
@@ -94,7 +95,10 @@ module Govspeak
     end
 
     def valid?(validation_options = {})
-      Govspeak::HtmlValidator.new(@source, validation_options).valid?
+      Govspeak::HtmlValidator.new(
+        @source,
+        validation_options.merge({ locale: @locale }),
+      ).valid?
     end
 
     def headers
@@ -152,13 +156,20 @@ module Govspeak
 
     def self.wrap_with_div(class_name, character, parser = Kramdown::Document)
       extension(class_name, surrounded_by(character)) do |body|
-        content = parser ? parser.new("#{body.strip}\n").to_html : body.strip
+        content = if parser
+                    parser.new("#{body.strip}\n", locale: @locale).to_html
+                  else
+                    body.strip
+                  end
         %(\n<div class="#{class_name}">\n#{content}</div>\n)
       end
     end
 
     def insert_strong_inside_p(body, parser = Govspeak::Document)
-      parser.new(body.strip).to_html.sub(/^<p>(.*)<\/p>$/, "<p><strong>\\1</strong></p>")
+      parser
+        .new(body.strip, locale: @locale)
+        .to_html
+        .sub(/^<p>(.*)<\/p>$/, "<p><strong>\\1</strong></p>")
     end
 
     extension("button", %r{
@@ -192,15 +203,14 @@ module Govspeak
 
     extension("highlight-answer") do |body|
       %(\n\n<div class="highlight-answer">
-#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+#{Govspeak::Document.new(body.strip, locale: @locale).to_html}</div>\n)
     end
 
     extension("stat-headline", %r${stat-headline}(.*?){/stat-headline}$m) do |body|
       %(\n\n<div class="stat-headline">
-#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+#{Govspeak::Document.new(body.strip, locale: @locale).to_html}</div>\n)
     end
 
-    # FIXME: these surrounded_by arguments look dodgy
     extension("external", surrounded_by("x[", ")x")) do |body|
       Kramdown::Document.new("[#{body.strip}){:rel='external'}").to_html
     end
@@ -214,7 +224,7 @@ module Govspeak
     end
 
     extension("helpful", surrounded_by("%")) do |body|
-      %(\n\n<div role="note" aria-label="Warning" class="application-notice help-notice">\n#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+      %(\n\n<div role="note" aria-label="Warning" class="application-notice help-notice">\n#{Govspeak::Document.new(body.strip, locale: @locale).to_html}</div>\n)
     end
 
     extension("barchart", /{barchart(.*?)}/) do |captures|
@@ -350,13 +360,22 @@ module Govspeak
        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:)
+      extension(
+        "devolved-#{devolved_option}",
+        /:#{devolved_option}:(.*?):#{devolved_option}:/m,
+      ) do |body|
+        header_content = Govspeak::TranslationHelper.t_with_fallback(
+          "govspeak.devolved.#{devolved_option}",
+          locale:,
+        )
+        body_content = Govspeak::Document
+          .new(body.strip, locale: @locale)
+          .to_html
 
         <<~HTML
           <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 class="devolved-body">#{body_content}</div>
           </div>
         HTML
       end
@@ -422,3 +441,5 @@ end
 I18n.load_path.unshift(
   *Dir.glob(File.expand_path("locales/*.yml", Govspeak.root)),
 )
+
+I18n.default_locale = :en

data/test/govspeak_test.rb

@@ -341,8 +341,6 @@ Teston
 
   # Regression test - the surrounded_by helper doesn't require the closing x
   # so 'xaa' was getting picked up by the external link helper above
-  # TODO: review whether we should require closing symbols for these extensions
-  #       need to check all existing content.
   test_given_govspeak "xaa" do
     assert_html_output "<p>xaa</p>"
     assert_text_output "xaa"

data/test/test_helper.rb

@@ -8,6 +8,7 @@ require "bundler"
 Bundler.setup :default, :development, :test
 
 require "minitest/autorun"
+require "mocha/minitest"
 
 require "support/html_helpers"
 

data/test/translation_helper_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+
+class TranslationHelperTest < Minitest::Test
+  extend Minitest::Spec::DSL
+
+  describe ".t_with_fallback" do
+    before do
+      I18n.expects(:available_locales).returns(%i[en cy])
+      I18n
+        .expects(:default_locale)
+        .at_least_once
+        .at_most(2)
+        .returns(:en)
+    end
+
+    it "passes the provided key and options with a locale to I18n.t" do
+      I18n.expects(:t).with(
+        "whatever",
+        a_translation_variable: "my favourite value",
+        locale: instance_of(Symbol),
+      )
+
+      Govspeak::TranslationHelper.t_with_fallback(
+        "whatever",
+        a_translation_variable: "my favourite value",
+      )
+    end
+
+    it "passes the default locale to I18n.t when matching the provided locale" do
+      I18n.expects(:t).with("whatever", locale: :en)
+      Govspeak::TranslationHelper.t_with_fallback("whatever", locale: :en)
+    end
+
+    it "passes a fallback translation using the default locale to I18n.t when the provided locale is supported but non-default" do
+      I18n.expects(:t).with("whatever", locale: :en).returns("WHATEVER!")
+      I18n.expects(:t).with("whatever", locale: :cy, default: "WHATEVER!")
+
+      Govspeak::TranslationHelper.t_with_fallback("whatever", locale: :cy)
+    end
+
+    it "passes the default locale to I18n.t when the provided locale is unsupported" do
+      I18n.expects(:t).with("whatever", locale: :en)
+      Govspeak::TranslationHelper.t_with_fallback("whatever", locale: :yo)
+    end
+
+    it "passes the default locale to I18n.t when a locale is not provided" do
+      I18n.expects(:t).with("whatever", locale: :en)
+      Govspeak::TranslationHelper.t_with_fallback("whatever")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 10.4.0
+  version: 10.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -179,6 +179,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -213,14 +227,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.15
+        version: 5.1.17
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.15
+        version: 5.1.17
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +281,7 @@ files:
 - lib/govspeak/presenters/image_presenter.rb
 - lib/govspeak/structured_header_extractor.rb
 - lib/govspeak/template_renderer.rb
+- lib/govspeak/translation_helper.rb
 - lib/govspeak/version.rb
 - lib/kramdown/parser/govuk.rb
 - lib/templates/contact.html.erb
@@ -334,6 +349,7 @@ files:
 - test/presenters/h_card_presenter_test.rb
 - test/support/html_helpers.rb
 - test/test_helper.rb
+- test/translation_helper_test.rb
 homepage: http://github.com/alphagov/govspeak
 licenses: []
 metadata: {}
@@ -351,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Markup language for single domain
 test_files:
@@ -379,3 +395,4 @@ test_files:
 - test/presenters/h_card_presenter_test.rb
 - test/support/html_helpers.rb
 - test/test_helper.rb
+- test/translation_helper_test.rb