From: Andy Allan <git@gravitystorm.co.uk>
Date: Wed, 29 Mar 2023 17:50:44 +0000 (+0100)
Subject: Add some validations for i18n values
X-Git-Tag: live~1297^2
X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/387d130e87b79cb428f7554c1a233de5d0627ae9

Add some validations for i18n values

These only apply to the en.yml file for now, but can be expanded
in due course.
---

diff --git a/test/lib/i18n_test.rb b/test/lib/i18n_test.rb
index 9c7d8e568..3f46955b3 100644
--- a/test/lib/i18n_test.rb
+++ b/test/lib/i18n_test.rb
@@ -55,6 +55,20 @@ class I18nTest < ActiveSupport::TestCase
     end
   end
 
+  def test_en_for_raw_html
+    en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
+    assert_nothing_raised do
+      check_values_for_raw_html(en)
+    end
+  end
+
+  def test_en_for_nil_values
+    en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
+    assert_nothing_raised do
+      check_values_for_nil(en)
+    end
+  end
+
   private
 
   def translation_keys(scope = nil)
@@ -81,4 +95,25 @@ class I18nTest < ActiveSupport::TestCase
   rescue I18n::MissingTranslationData
     [:zero, :one, :other]
   end
+
+  def check_values_for_raw_html(hash)
+    hash.each_pair do |k, v|
+      if v.is_a? Hash
+        check_values_for_raw_html(v)
+      else
+        next unless k.end_with?("_html")
+        raise "Avoid using raw html in '#{k}: #{v}'" if v.include? "<"
+      end
+    end
+  end
+
+  def check_values_for_nil(hash)
+    hash.each_pair do |k, v|
+      if v.is_a? Hash
+        check_values_for_nil(v)
+      else
+        raise "Avoid nil values in '#{k}: nil'" if v.nil?
+      end
+    end
+  end
 end