test/lib/i18n_test.rb

   1 require "test_helper"
   2
   3 class I18nTest < ActiveSupport::TestCase
   4   I18n.available_locales.each do |locale|
   5     define_method("test_#{locale.to_s.underscore}".to_sym) 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 value.is_a?(String), "#{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     lang = File.basename(filename, ".yml")
  60     define_method("test_#{lang}_for_raw_html".to_sym) do
  61       yml = YAML.load_file(filename)
  62       assert_nothing_raised do
  63         check_values_for_raw_html(yml)
  64       end
  65     end
  66   end
  67
  68   def test_en_for_nil_values
  69     en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
  70     assert_nothing_raised do
  71       check_values_for_nil(en)
  72     end
  73   end
  74
  75   # We should avoid using the key `zero:` in English, since that key
  76   # is used for "numbers ending in zero" in other languages.
  77   def test_en_for_zero_key
  78     en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
  79     assert_nothing_raised do
  80       check_keys_for_zero(en)
  81     end
  82   end
  83
  84   private
  85
  86   def translation_keys(scope = nil)
  87     plural_keys = plural_keys(I18n.default_locale)
  88
  89     I18n.t(scope || ".", :locale => I18n.default_locale).map do |key, value|
  90       scoped_key = scope ? "#{scope}.#{key}" : key
  91
  92       case value
  93       when Hash
  94         if value.keys - plural_keys == []
  95           scoped_key
  96         else
  97           translation_keys(scoped_key)
  98         end
  99       when String
 100         scoped_key
 101       end
 102     end.flatten
 103   end
 104
 105   def plural_keys(locale)
 106     I18n.t("i18n.plural.keys", :locale => locale, :raise => true) + [:zero]
 107   rescue I18n::MissingTranslationData
 108     [:zero, :one, :other]
 109   end
 110
 111   def check_values_for_raw_html(hash)
 112     hash.each_pair do |k, v|
 113       if v.is_a? Hash
 114         check_values_for_raw_html(v)
 115       else
 116         next unless k.to_s.end_with?("_html")
 117         raise "Avoid using raw html in '#{k}: #{v}'" if v.include? "<"
 118       end
 119     end
 120   end
 121
 122   def check_values_for_nil(hash)
 123     hash.each_pair do |k, v|
 124       if v.is_a? Hash
 125         check_values_for_nil(v)
 126       else
 127         raise "Avoid nil values in '#{k}: nil'" if v.nil?
 128       end
 129     end
 130   end
 131
 132   def check_keys_for_zero(hash)
 133     hash.each_pair do |k, v|
 134       if v.is_a? Hash
 135         check_keys_for_zero(v)
 136       else
 137         raise "Avoid using 'zero' key in '#{k}: #{v}'" if k.to_s == "zero"
 138       end
 139     end
 140   end
 141 end