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