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 language[:code]
  81       assert language[:native_name]
  82     end
  83   end
  84
  85   def test_en_for_nil_values
  86     en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
  87     assert_nothing_raised do
  88       check_values_for_nil(en)
  89     end
  90   end
  91
  92   # We should avoid using the key `zero:` in English, since that key
  93   # is used for "numbers ending in zero" in other languages.
  94   def test_en_for_zero_key
  95     en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
  96     assert_nothing_raised do
  97       check_keys_for_zero(en)
  98     end
  99   end
 100
 101   private
 102
 103   def translation_keys(scope = nil)
 104     plural_keys = plural_keys(I18n.default_locale)
 105
 106     I18n.t(scope || ".", :locale => I18n.default_locale).map do |key, value|
 107       scoped_key = scope ? "#{scope}.#{key}" : key
 108
 109       case value
 110       when Hash
 111         if value.keys - plural_keys == []
 112           scoped_key
 113         else
 114           translation_keys(scoped_key)
 115         end
 116       when String
 117         scoped_key
 118       end
 119     end.flatten
 120   end
 121
 122   def plural_keys(locale)
 123     I18n.t("i18n.plural.keys", :locale => locale, :raise => true) + [:zero]
 124   rescue I18n::MissingTranslationData
 125     [:zero, :one, :other]
 126   end
 127
 128   def check_values_for_raw_html(hash)
 129     hash.each_pair do |k, v|
 130       if v.is_a? Hash
 131         check_values_for_raw_html(v)
 132       else
 133         next unless k.to_s.end_with?("_html")
 134         raise "Avoid using raw html in '#{k}: #{v}'" if v.include? "<"
 135       end
 136     end
 137   end
 138
 139   def check_values_for_nil(hash)
 140     hash.each_pair do |k, v|
 141       if v.is_a? Hash
 142         check_values_for_nil(v)
 143       else
 144         raise "Avoid nil values in '#{k}: nil'" if v.nil?
 145       end
 146     end
 147   end
 148
 149   def check_keys_for_zero(hash)
 150     hash.each_pair do |k, v|
 151       if v.is_a? Hash
 152         check_keys_for_zero(v)
 153       else
 154         raise "Avoid using 'zero' key in '#{k}: #{v}'" if k.to_s == "zero"
 155       end
 156     end
 157   end
 158 end