test/lib/i18n_test.rb

   1 require "test_helper"
   2
   3 class I18nTest < ActiveSupport::TestCase
   4   I18n.available_locales.each do |locale|
   5     test locale.to_s do
   6       without_i18n_exceptions do
   7         # plural_keys = plural_keys(locale)
   8
   9         translation_keys.each do |key|
  10           variables = []
  11
  12           default_value = I18n.t(key, :locale => I18n.default_locale)
  13
  14           if default_value.is_a?(Hash)
  15             variables.push("count")
  16
  17             default_value.each_value do |subvalue|
  18               subvalue.scan(/%\{(\w+)\}/) do
  19                 variables.push(Regexp.last_match(1))
  20               end
  21             end
  22           else
  23             default_value.scan(/%\{(\w+)\}/) do
  24               variables.push(Regexp.last_match(1))
  25             end
  26           end
  27
  28           variables.push("attribute") if key =~ /^(active(model|record)\.)?errors\./
  29
  30           value = I18n.t(key, :locale => locale, :fallback => true)
  31
  32           if value.is_a?(Hash)
  33             value.each do |subkey, subvalue|
  34               # assert plural_keys.include?(subkey), "#{key}.#{subkey} is not a valid plural key"
  35
  36               next if subvalue.nil?
  37
  38               subvalue.scan(/%\{(\w+)\}/) do
  39                 assert_includes variables, Regexp.last_match(1), "#{key}.#{subkey} uses unknown interpolation variable #{Regexp.last_match(1)}"
  40               end
  41             end
  42
  43             assert_includes value, :other, "#{key}.other plural key missing"
  44           else
  45             assert_kind_of String, value, "#{key} is not a string"
  46
  47             value.scan(/%\{(\w+)\}/) do
  48               assert_includes variables, Regexp.last_match(1), "#{key} uses unknown interpolation variable #{Regexp.last_match(1)}"
  49             end
  50           end
  51         end
  52
  53         assert_includes %w[ltr rtl], I18n.t("html.dir", :locale => locale), "html.dir must be ltr or rtl"
  54       end
  55     end
  56   end
  57
  58   Rails.root.glob("config/locales/*.yml").each do |filename|
  59     code = File.basename(filename, ".yml")
  60     test "#{code} for raw html" do
  61       yml = YAML.load_file(filename)
  62       assert_nothing_raised do
  63         check_values_for_raw_html(yml)
  64       end
  65     end
  66
  67     test "#{code} present once in ui_languages.yml" do
  68       assert_equal(1, AVAILABLE_LANGUAGES.count { |language| language[:code] == code })
  69     end
  70   end
  71
  72   def test_ui_languages_have_yml_files
  73     AVAILABLE_LANGUAGES.each do |language|
  74       assert_path_exists Rails.root.join("config/locales/#{language[:code]}.yml")
  75     end
  76   end
  77
  78   def test_ui_languages_have_required_fields
  79     AVAILABLE_LANGUAGES.each do |language|
  80       assert_pattern { language => { code: String, native_name: String, english_name: String } }
  81     end
  82   end
  83
  84   def test_en_for_nil_values
  85     en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
  86     assert_nothing_raised do
  87       check_values_for_nil(en)
  88     end
  89   end
  90
  91   # We should avoid using the key `zero:` in English, since that key
  92   # is used for "numbers ending in zero" in other languages.
  93   def test_en_for_zero_key
  94     en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
  95     assert_nothing_raised do
  96       check_keys_for_zero(en)
  97     end
  98   end
  99
 100   private
 101
 102   def translation_keys(scope = nil)
 103     plural_keys = plural_keys(I18n.default_locale)
 104
 105     I18n.t(scope || ".", :locale => I18n.default_locale).map do |key, value|
 106       scoped_key = scope ? "#{scope}.#{key}" : key
 107
 108       case value
 109       when Hash
 110         if value.keys - plural_keys == []
 111           scoped_key
 112         else
 113           translation_keys(scoped_key)
 114         end
 115       when String
 116         scoped_key
 117       end
 118     end.flatten
 119   end
 120
 121   def plural_keys(locale)
 122     I18n.t("i18n.plural.keys", :locale => locale, :raise => true) + [:zero]
 123   rescue I18n::MissingTranslationData
 124     [:zero, :one, :other]
 125   end
 126
 127   def check_values_for_raw_html(hash)
 128     hash.each_pair do |k, v|
 129       if v.is_a? Hash
 130         check_values_for_raw_html(v)
 131       else
 132         next unless k.to_s.end_with?("_html")
 133         raise "Avoid using raw html in '#{k}: #{v}'" if v.include? "<"
 134       end
 135     end
 136   end
 137
 138   def check_values_for_nil(hash)
 139     hash.each_pair do |k, v|
 140       if v.is_a? Hash
 141         check_values_for_nil(v)
 142       else
 143         raise "Avoid nil values in '#{k}: nil'" if v.nil?
 144       end
 145     end
 146   end
 147
 148   def check_keys_for_zero(hash)
 149     hash.each_pair do |k, v|
 150       if v.is_a? Hash
 151         check_keys_for_zero(v)
 152       else
 153         raise "Avoid using 'zero' key in '#{k}: #{v}'" if k.to_s == "zero"
 154       end
 155     end
 156   end
 157 end