Avoid using the zero key for pluralisation in English

[rails.git] / test / lib / i18n_test.rb

diff --git a/test/lib/i18n_test.rb b/test/lib/i18n_test.rb
index ea67e084eeab12223e3540468feccdac1b38145e..def2442bf3120023fcba78ccefe9000147f7e6cf 100644 (file)
--- a/test/lib/i18n_test.rb
+++ b/test/lib/i18n_test.rb
@@ -1,79 +1,138 @@
-require 'test_helper'
+require "test_helper"

 
 class I18nTest < ActiveSupport::TestCase
   I18n.available_locales.each do |locale|
     define_method("test_#{locale.to_s.underscore}".to_sym) do
 
 class I18nTest < ActiveSupport::TestCase
   I18n.available_locales.each do |locale|
     define_method("test_#{locale.to_s.underscore}".to_sym) do

-      plural_keys = plural_keys(locale)
+      without_i18n_exceptions do
+        # plural_keys = plural_keys(locale)

 
 

-      translation_keys.each do |key|
-        variables = []
+        translation_keys.each do |key|
+          variables = []

 
 

-        default_value = I18n.t(key, :locale => I18n.default_locale)
+          default_value = I18n.t(key, :locale => I18n.default_locale)

 
 

-        if default_value.is_a?(Hash)
-          variables.push("count")
+          if default_value.is_a?(Hash)
+            variables.push("count")

 
 

-          default_value.each do |subkey,subvalue|
-            subvalue.scan(/%\{(\w+)\}/) do
-              variables.push($1)
+            default_value.each_value do |subvalue|
+              subvalue.scan(/%\{(\w+)\}/) do
+                variables.push(Regexp.last_match(1))
+              end
+            end
+          else
+            default_value.scan(/%\{(\w+)\}/) do
+              variables.push(Regexp.last_match(1))

             end
           end
             end
           end

-        else
-          default_value.scan(/%\{(\w+)\}/) do
-            variables.push($1)
-          end
-        end

 
 

-        if key =~ /^(active(model|record)\.)?errors\./
-          variables.push("attribute")
-        end
+          variables.push("attribute") if key =~ /^(active(model|record)\.)?errors\./

 
 

-        value = I18n.t(key, :locale => locale, :fallback => true)
+          value = I18n.t(key, :locale => locale, :fallback => true)

 
 

-        if value.is_a?(Hash)
-          value.each do |subkey,subvalue|
-#            assert plural_keys.include?(subkey), "#{key}.#{subkey} is not a valid plural key"
+          if value.is_a?(Hash)
+            value.each do |subkey, subvalue|
+              # assert plural_keys.include?(subkey), "#{key}.#{subkey} is not a valid plural key"
+
+              next if subvalue.nil?

 
 

-            unless subvalue.nil?

               subvalue.scan(/%\{(\w+)\}/) do
               subvalue.scan(/%\{(\w+)\}/) do

-                assert variables.include?($1), "#{key}.#{subkey} uses unknown interpolation variable #{$1}"
+                assert_includes variables, Regexp.last_match(1), "#{key}.#{subkey} uses unknown interpolation variable #{Regexp.last_match(1)}"

               end
             end
               end
             end

-          end
-        else
-          assert value.is_a?(String), "#{key} is not a string"

 
 

-          value.scan(/%\{(\w+)\}/) do
-            assert variables.include?($1), "#{key} uses unknown interpolation variable #{$1}"
+            assert_includes value, :other, "#{key}.other plural key missing"
+          else
+            assert value.is_a?(String), "#{key} is not a string"
+
+            value.scan(/%\{(\w+)\}/) do
+              assert_includes variables, Regexp.last_match(1), "#{key} uses unknown interpolation variable #{Regexp.last_match(1)}"
+            end

           end
         end
           end
         end

+
+        assert_includes %w[ltr rtl], I18n.t("html.dir", :locale => locale), "html.dir must be ltr or rtl"

       end
       end

+    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

 
 

-      assert ["ltr", "rtl"].include?(I18n.t("html.dir", :locale => locale)), "html.dir must be ltr or rtl"
+  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
     end
   end

-private
+
+  # We should avoid using the key `zero:` in English, since that key
+  # is used for "numbers ending in zero" in other languages.
+  def test_en_for_zero_key
+    en = YAML.load_file(Rails.root.join("config/locales/en.yml"))
+    assert_nothing_raised do
+      check_keys_for_zero(en)
+    end
+  end
+
+  private
+

   def translation_keys(scope = nil)
     plural_keys = plural_keys(I18n.default_locale)
 
   def translation_keys(scope = nil)
     plural_keys = plural_keys(I18n.default_locale)
 

-    I18n.t(scope || ".", :locale => I18n.default_locale).map do |key,value|
+    I18n.t(scope || ".", :locale => I18n.default_locale).map do |key, value|

       scoped_key = scope ? "#{scope}.#{key}" : key
 
       scoped_key = scope ? "#{scope}.#{key}" : key
 

-      if value.kind_of?(Hash)
+      case value
+      when Hash

         if value.keys - plural_keys == []
           scoped_key
         else
           translation_keys(scoped_key)
         end
         if value.keys - plural_keys == []
           scoped_key
         else
           translation_keys(scoped_key)
         end

-      elsif value.kind_of?(String)
+      when String

         scoped_key
       end
     end.flatten
   end
 
   def plural_keys(locale)
         scoped_key
       end
     end.flatten
   end
 
   def plural_keys(locale)

-    I18n.t("i18n.plural.keys", :locale => locale, :raise => true) + [ :zero ]
+    I18n.t("i18n.plural.keys", :locale => locale, :raise => true) + [:zero]

   rescue I18n::MissingTranslationData
   rescue I18n::MissingTranslationData

-    [ :zero, :one, :other ]
+    [: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
+
+  def check_keys_for_zero(hash)
+    hash.each_pair do |k, v|
+      if v.is_a? Hash
+        check_keys_for_zero(v)
+      else
+        raise "Avoid using 'zero' key in '#{k}: #{v}'" if k.to_s == "zero"
+      end
+    end

   end
 end
   end
 end