air18n 0.1.15 → 0.1.16

data/lib/air18n/backend.rb

@@ -3,6 +3,7 @@ require 'i18n'
 require 'air18n/logging_helper'
 require 'air18n/prim_and_proper'
 require 'air18n/pseudo_locales'
+require 'air18n/smart_count'
 
 module Air18n
   class Backend
@@ -111,6 +112,8 @@ module Air18n
     # 5) Makes the :xx locale translations.
     # 6) Asks PrimAndProper to make en-GB translations and other best-guess
     #    translations if appropriate.
+    # 7) Chooses the correct translation form based on options[:smart_count] if
+    # present.
     def lookup(locale, key, scope = [], options = {})
       # Useful i18n logging for debugging translation lookup problems.
       # LoggingHelper.info "Lookup! key is #{key.inspect}, options are #{options.inspect}"
@@ -202,7 +205,7 @@ module Air18n
       end
 
       unless options[:disable_xss_check]
-        xss_detection = XssDetector::safe?(default, result)
+        xss_detection = XssDetector::safe?(default, result, I18n.default_locale, locale_fallen_back_to)
         if !xss_detection[:safe]
           # Kill the translation if the result is unsafe.
           LoggingHelper.error "Killing unsafe translation! Default is #{default.inspect}, result is #{result.inspect}, reason for kill is #{xss_detection[:result]}"
@@ -210,9 +213,15 @@ module Air18n
         end
       end
 
+      # Strip whitespace from both sides. For fun?
+      result = result.strip if result.present?
+
       # Handle pseudo-locales.
       result = PseudoLocales.translate(locale, result)
 
+      # Handle smart counts.
+      result = SmartCount.choose(result, locale_fallen_back_to, options[SmartCount::INTERPOLATION_VARIABLE_NAME])
+
       result
     end
   end

data/lib/air18n/phrase_translation.rb

@@ -14,7 +14,9 @@ module Air18n
     before_create :set_latest
     before_create :set_source_hash
 
+    validate :check_plural_forms
     validate :check_matching_variables
+    validate :check_max_length
 
     # Sets is_latest of this translation, and removes the is_latest flag from all
     # previous translations.
@@ -296,7 +298,14 @@ module Air18n
       true
     end
 
-    def check_matching_variables
+    def check_plural_forms
+      result = SmartCount::valid?(self.value, self.locale)
+      if !result[:valid]
+        self.errors.add(:value, result[:reason])
+      end
+    end
+
+    def check_max_length
       if /maxlength:(\d+)/ =~ key
         max_length = $1.to_i
         length = value.size
@@ -304,29 +313,39 @@ module Air18n
           self.errors.add(:value, "Translation has #{length} characters; maximum length #{max_length} characters.")
         end
       end
-      unless variables_match?
-        our_variables = self.variables
-        their_variables = self.phrase.variables
-        our_extra = our_variables - their_variables
-        their_extra = their_variables - our_variables
-        problems = []
-        def quote(vars)
-          vars.map { |var| "%{#{var}}" }.join(", ")
-        end
-        unless their_extra.empty?
-          problems << "Var #{quote their_extra} missing from translation"
-        end
-        unless our_extra.empty?
-          problems << "Var #{quote our_extra} should not be in translation"
+    end
+
+    def check_matching_variables
+      our_variables = self.variables
+      their_variables = self.phrase.variables
+
+      if SmartCount::applies?(self.phrase.value) || SmartCount::applies?(self.value)
+        our_variables = SmartCount::dedupe_things_like_tags_or_variables(
+          self.locale, our_variables)
+          their_variables = SmartCount::dedupe_things_like_tags_or_variables(
+            I18n.default_locale, their_variables)
+      end
+
+      LoggingHelper.info "our variables: #{our_variables.inspect}"
+      LoggingHelper.info "their variables: #{their_variables.inspect}"
+
+      our_extra = our_variables - their_variables
+      their_extra = their_variables - our_variables
+      problems = []
+      if !their_extra.empty? || !our_extra.empty?
+        if !their_extra.empty?
+          problems << "Var #{quote_vars their_extra} missing from translation"
         end
-        unless problems.empty?
-          self.errors.add(:value, problems.join('; '))
+        if !our_extra.empty?
+          problems << "Var #{quote_vars our_extra} should not be in translation"
         end
+      elsif our_variables.group_by{|t| t} != their_variables.group_by{|t| t}
+        # This is to catch smart-count-related cases.
+        problems << "Vars don't match: #{quote_vars their_variables} vs. #{quote_vars our_variables}"
+      end
+      unless problems.empty?
+        self.errors.add(:value, problems.join('; '))
       end
-    end
-
-    def variables_match?
-      self.variables == self.phrase.variables
     end
 
     def variables
@@ -335,10 +354,10 @@ module Air18n
 
     def self.detect_variables(search_in)
       case search_in
-      when String then Set.new(search_in.scan(/\{\{(\w+)\}\}/).flatten + search_in.scan(/\%\{(\w+)\}/).flatten)
+      when String then search_in.scan(/\{\{(\w+)\}\}/).flatten + search_in.scan(/\%\{(\w+)\}/).flatten
       when Array then search_in.inject(Set[]) { |carry, item| carry + detect_variables(item) }
       when Hash then search_in.values.inject(Set[]) { |carry, item| carry + detect_variables(item) }
-      else Set[]
+      else []
       end
     end
 
@@ -403,5 +422,10 @@ module Air18n
       end
       return [true]
     end
+
+    private
+    def quote_vars(vars)
+      vars.map { |var| "%{#{var}}" }.join(", ")
+    end
   end
 end

data/lib/air18n/smart_count.rb

@@ -0,0 +1,174 @@
+module Air18n
+  module SmartCount
+    # Class for choosing the right plural form of a phrase based on an
+    # interpolation variable with special name "smart_count" (set below in
+    # OPTION_NAME constant).
+    #
+    # If a phrase uses the smart_count interpolation variable, translators can
+    # specify multiple translations, one per possible pluralization form of the
+    # language. If there is more than one pluralization form, translations are
+    # separated by ";" (set below in DELIMITER constant).
+
+    INTERPOLATION_VARIABLE_NAME = :smart_count
+    INTERPOLATION_VARIABLE_PLACEHOLDER = "%{#{INTERPOLATION_VARIABLE_NAME}}"
+    DELIMITER = ';'
+
+    # C.F.
+    # https://developer.mozilla.org/en-US/docs/Localization_and_Plurals
+    # http://translate.sourceforge.net/wiki/l10n/pluralforms
+    PLURAL_TYPES = {
+      :chinese_like => {
+        :num_forms => 1,
+        :doc => ['One form for all counts.'],
+        :rule => lambda { |n| 0 } },
+
+      :german_like => {
+        :num_forms => 2,
+        :doc => ['Count is 1', 'Everything else (0, 2, 3, ...)'],
+        :rule => lambda { |n| n != 1 ? 1 : 0 } },
+
+      :french_like => {
+        :num_forms => 2,
+        :doc => ['Count is 0 or 1', 'Everything else (2, 3, 4, ...)'],
+        :rule => lambda { |n| n > 1 ? 1 : 0 } },
+
+      :russian_like => {
+        :num_forms => 3,
+        :doc => ['Count ends in 1, excluding 11 (1, 21, 31, ...)', 'Count ends in 2-4, excluding 12-14 (2, 3, 4, 22, ...)', 'Everything else (0, 5, 6, ...)'],
+        :rule => lambda { |n| n % 10 == 1 && n % 100 != 11 ? 0 : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20) ? 1 : 2 } },
+
+      :czech_like => {
+        :num_forms => 3,
+        :doc => ['Count is 1', 'Count is 2, 3, 4', 'Everything else (0, 5, 6, ...)'],
+        :rule => lambda { |n| (n == 1) ? 0 : (n >= 2 && n <= 4) ? 1 : 2 } },
+
+      :polish_like => {
+        :num_forms => 3,
+        :doc => ['Count is 1', 'Count ends in 2-4, excluding 12-14 (2, 3, 4, 22, ...)', 'Everything else (0, 5, 6, ...)'],
+        :rule => lambda { |n| (n == 1 ? 0 : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20) ? 1 : 2) } },
+
+      :icelandic_like => {
+        :num_forms => 2,
+        :doc => ['Count ends in 1, excluding 11 (1, 21, 31, ...)', 'Everything else (0, 2, 3, ...)'],
+        :rule => lambda { |n| (n % 10 != 1 || n % 100 == 11) ? 1 : 0 } },
+    }
+
+    PLURAL_TYPE_NAME_TO_LANGUAGES = {
+      :chinese_like => [:id, :ja, :ko, :ms, :th, :tr, :zh, ],
+      :german_like => [:da, :de, :en, :es, :fi, :el, :he, :hu, :it, :nl, :no, :pt, :sv, ],
+      :french_like => [:fr, :tl, ],
+      :russian_like => [:hr, :ru, ],
+      :czech_like => [:cs],
+      :polish_like => [:pl],
+      :icelandic_like => [:is],
+    }
+
+    LANGUAGE_TO_PLURAL_TYPE_NAME = PLURAL_TYPE_NAME_TO_LANGUAGES.inject({}) do |carry, (type, languages)|
+      languages.each { |l| carry[l] = type }
+      carry
+    end
+
+    module_function
+
+    # Chooses the right version of 'text' for the value of the 'smart_count' in
+    # 'locale'.
+    #
+    # Examples:
+    #   choose("%{smart_count} bewertung; %{smart_count} bewertungen",
+    #          :de, 0)
+    #     => %{smart_count} bewertungen
+    #   choose("%{smart_count} bewertung; %{smart_count} bewertungen",
+    #          :de, 1)
+    #     => %{smart_count} bewertung
+    #   choose("%{smart_count} bewertung; %{smart_count} bewertungen",
+    #          :de, 2)
+    #     => %{smart_count} bewertungen
+    #
+    # If 'count' is nil or 'text' contains too few alternative versions, this
+    # method degrades gracefully by returning the first version of text.
+    #
+    # Returns if nil if text is blank.
+    def choose(text, locale, count)
+      return text if text.blank?
+
+      texts = text.split(DELIMITER)
+      if count
+        chosen_text = texts[plural_type_index(locale, count)] || texts.first
+        chosen_text.strip
+      else
+        texts.first.strip
+      end
+    end
+
+    def plural_type_name(locale)
+      LANGUAGE_TO_PLURAL_TYPE_NAME[I18n.language_from_locale(locale)] ||
+        LANGUAGE_TO_PLURAL_TYPE_NAME[I18n.default_language]
+    end
+
+    def plural_type_index(locale, count)
+      PLURAL_TYPES[plural_type_name(locale)][:rule].call(count)
+    end
+
+    def hint(text, locale)
+      if applies?(text)
+        PLURAL_TYPES[plural_type_name(locale)][:doc].join(DELIMITER + ' ')
+      end
+    end
+
+    def applies?(text)
+      !!text.index(INTERPOLATION_VARIABLE_PLACEHOLDER)
+    end
+
+    def num_forms(locale)
+      PLURAL_TYPES[plural_type_name(locale)][:num_forms]
+    end
+
+    # Takes a list of things (for example tags or variables), counts up how
+    # many of each thing there are, then returns a new list that has each thing
+    # but with a possibly different count.
+    #
+    # The count of each thing in the returned list is determined by:
+    # - If the count is a multiple of the number of plural forms for 'locale',
+    # count is divided by the number of plural forms.
+    # - Otherwise count is set to 0.
+    #
+    # The returned list is reordered so that all instances of the same thing
+    # are consecutive, and are ordered in the same order as the first of each
+    # thing in the original list.
+    #
+    # This method is useful for ensuring that HTML tags or interpolation
+    # variables match in smart-count phrases between languages that might have
+    # different numbers of plural forms.
+    def dedupe_things_like_tags_or_variables(locale, things)
+      return things if things.blank?
+
+      num_forms = num_forms(locale)
+      grouped_things = things.group_by { |t| t }
+      deduped = grouped_things.inject([]) do |carry, (thing, list_of_things)|
+        count_of_thing = list_of_things.size
+        if count_of_thing % num_forms == 0
+          deduped_count_of_thing = count_of_thing / num_forms
+        else
+          deduped_count_of_thing = 0
+        end
+        deduped_count_of_thing.times { carry << thing }
+        carry
+      end
+    end
+
+    def valid?(text, locale)
+      if applies?(text)
+        size = text.split(DELIMITER).size
+        num_forms = num_forms(locale)
+        if size == num_forms
+          { :valid => true }
+        else
+          { :valid => false,
+            :reason => "Must specify #{num_forms} forms separated by \"#{DELIMITER}\" (#{size} #{size == 1? 'was' : 'were'} specified)" }
+        end
+      else
+        { :valid => true }
+      end
+    end
+  end
+end

data/lib/air18n/version.rb

@@ -1,3 +1,3 @@
 module Air18n
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
 end

data/lib/air18n/xss_detector.rb

@@ -2,11 +2,19 @@ module Air18n
   module XssDetector
     module_function
 
-    def safe?(text_a, text_b)
+    def safe?(text_a, text_b, locale_a, locale_b)
       text_a = text_a.to_s
       text_b = text_b.to_s
       tags_a = normalize_tags(extract_tags(text_a))
       tags_b = normalize_tags(extract_tags(text_b))
+      if SmartCount::applies?(text_a) || SmartCount::applies?(text_b)
+        LoggingHelper.info "tags_a were: #{tags_a.inspect}"
+        LoggingHelper.info "tags_b were: #{tags_b.inspect}"
+        tags_a = SmartCount::dedupe_things_like_tags_or_variables(locale_a, tags_a)
+        tags_b = SmartCount::dedupe_things_like_tags_or_variables(locale_b, tags_b)
+        LoggingHelper.info "tags_a now: #{tags_a.inspect}"
+        LoggingHelper.info "tags_b now: #{tags_b.inspect}"
+      end
       if has_dubious_escape_characters?(text_a) || has_dubious_escape_characters?(text_b)
         { :safe => false, :reason => 'Backslashes are not allowed' }
       elsif tags_a.group_by{|t| t} != tags_b.group_by{|t| t}

data/spec/lib/air18n/backend_spec.rb

@@ -148,6 +148,31 @@ describe Air18n::Backend do
     end
   end
 
+  context 'Smart counting' do
+    it 'should count smartly' do
+      backend = Air18n::Backend.new
+      backend.lookup(
+        :en, 'smart count reviews', @scope,
+        :default => "%{smart_count} review; %{smart_count} reviews",
+        :smart_count => 1
+      ).should == '%{smart_count} review'
+      backend.lookup(
+        :en, 'smart count reviews', @scope,
+        :default => "%{smart_count} review; %{smart_count} reviews",
+        :smart_count => 3
+      ).should == '%{smart_count} reviews'
+
+      # If a phrase is untranslated in Chinese, this can turn into "3 review"
+      # on the Chinese site if we are not careful and use the Chinese plural
+      # rules for this English fallback. This test catches this bug.
+      backend.lookup(
+        :zh, 'smart count reviews', @scope,
+        :default => "%{smart_count} review; %{smart_count} reviews",
+        :smart_count => 3
+      ).should == '%{smart_count} reviews'
+    end
+  end
+
   context 'Keeping track of which phrases have screenshots' do
     before do
       @backend = Air18n::Backend.new

data/spec/lib/air18n/phrase_translation_spec.rb

@@ -54,6 +54,73 @@ describe Air18n::PhraseTranslation do
       translation.errors.should include :value
       translation.errors[:value].should include "Var %{time_zone} missing from translation; Var %{time_zon} should not be in translation"
     end
+
+    context 'smart_count' do
+      before :all do
+        @phrase = FactoryGirl.create(:phrase, :key => 'variables with smart count reviews', :value => "%{smart_count} review in %{location};%{smart_count} reviews in %{location}")
+      end
+
+      it 'Should check variables with smart count in language with one plural form' do
+        translation = FactoryGirl.create(
+          :phrase_translation,
+          :phrase => @phrase,
+          :locale => :ja,
+          :key => 'variables with smart count reviews',
+          :value => '%{location}で%{smart_count}レビュー')
+          validated = translation.save
+          validated.should == true
+          translation.value = '%{smart_count}レビュー'
+          translation.save.should be_false
+          translation.errors.should include :value
+          translation.errors[:value].should include "Var %{location} missing from translation"
+      end
+
+      it 'Should check variables with smart count in language with two plural forms' do
+        translation = FactoryGirl.create(
+          :phrase_translation,
+          :phrase => @phrase,
+          :locale => :fr,
+          :key => 'variables with smart count reviews',
+          :value => 'a %{location} %{smart_count} commentaire; a %{location} %{smart_count} commentaires')
+          validated = translation.save
+          validated.should == true
+          translation.value = 'a %{location} %{smart_count} commentaire; a %{location} %{smart_countz} commentaires'
+          translation.save.should be_false
+          translation.errors.should include :value
+          translation.errors[:value].should include "Var %{smart_count} missing from translation"
+      end
+
+      it 'Should check variables with smart count in language with three plural forms' do
+        translation = FactoryGirl.create(
+          :phrase_translation,
+          :phrase => @phrase,
+          :locale => :pl,
+          :key => 'variables with smart count reviews',
+          :value => 'a %{location} %{smart_count} ends-in-one-except-eleven; a %{location} %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen; a %{location} %{smart_count} everything-else')
+          validated = translation.save
+          validated.should == true
+          translation.value = 'a %{location} %{smart_count} ends-in-one-except-eleven; a %{location} %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen; a %{smart_count} everything-else'
+
+          translation.save.should be_false
+          translation.errors.should include :value
+          translation.errors[:value].should include "Var %{location} missing from translation"
+      end
+
+      it 'Should complain about missing plural forms' do
+        translation = FactoryGirl.create(
+          :phrase_translation,
+          :phrase => @phrase,
+          :locale => :de,
+          :key => 'variables with smart count reviews',
+          :value => 'a %{location} %{smart_count} bewertung; a %{location} %{smart_count} bewertungen')
+          validated = translation.save
+          validated.should == true
+          translation.value = 'a %{location} %{smart_count} bewertung, a %{location} %{smart_count} bewertungen'
+          translation.save.should be_false
+          translation.errors.should include :value
+          translation.errors[:value].should include "Must specify 2 forms separated by \";\" (1 was specified)"
+      end
+    end
   end
 
   context 'helpers' do

data/spec/lib/air18n/smart_count_spec.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'air18n/smart_count'
+
+describe Air18n::SmartCount do
+  def test_choose(text, locale, answers)
+    answers.each_with_index do |answer, n|
+      Air18n::SmartCount::choose(text, locale, n).should == answer
+    end
+  end
+
+  describe "choose" do
+    it "should work in Japanese" do
+      review_text = "%{smart_count} レビュー"
+      answers =
+        ["%{smart_count} レビュー"] * 26
+      test_choose(review_text, :de, answers)
+    end
+
+    it "should work in German" do
+      review_text = "%{smart_count} bewertung; %{smart_count} bewertungen"
+      answers =
+        ["%{smart_count} bewertungen"] * 1 +
+        ["%{smart_count} bewertung"] * 1 +
+        ["%{smart_count} bewertungen"] * 24
+      test_choose(review_text, :de, answers)
+    end
+
+    it "should work in French" do
+      review_text = "%{smart_count} commentaire; %{smart_count} commentaires"
+      answers =
+        ["%{smart_count} commentaire"] * 2 +
+        ["%{smart_count} commentaires"] * 24
+      test_choose(review_text, :fr, answers)
+    end
+
+    it "should work in Russian" do
+      review_text = "%{smart_count} ends-in-one-except-eleven; %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen; %{smart_count} everything-else"
+      answers =
+        ["%{smart_count} everything-else"] * 1 +
+        ["%{smart_count} ends-in-one-except-eleven"] * 1 +
+        ["%{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"] * 3 +
+        ["%{smart_count} everything-else"] * 16 +
+        ["%{smart_count} ends-in-one-except-eleven"] * 1 +
+        ["%{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"] * 3 +
+        ["%{smart_count} everything-else"] * 1
+      test_choose(review_text, :ru, answers)
+    end
+
+    it "should work in Czech" do
+      review_text = "%{smart_count} one; %{smart_count} two-through-four; %{smart_count} everything-else"
+      answers =
+        ["%{smart_count} everything-else"] * 1 +
+        ["%{smart_count} one"] * 1 +
+        ["%{smart_count} two-through-four"] * 3 +
+        ["%{smart_count} everything-else"] * 21
+      test_choose(review_text, :cs, answers)
+    end
+
+    it "should work in Polish" do
+      review_text = "%{smart_count} one; %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen; %{smart_count} everything-else"
+      answers =
+        ["%{smart_count} everything-else"] * 1 +
+        ["%{smart_count} one"] * 1 +
+        ["%{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"] * 3 +
+        ["%{smart_count} everything-else"] * 17 +
+        ["%{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"] * 3 +
+        ["%{smart_count} everything-else"] * 1
+      test_choose(review_text, :pl, answers)
+    end
+  end
+
+  describe "degenerate choose" do
+    it "should work if too few translated forms are given" do
+      # One of the three Russian forms, the "everything else" form, is missing.
+      # The fallback should be the first form, "ends in one except eleven".
+      review_text = "%{smart_count} ends-in-one-except-eleven; %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"
+      answers =
+        ["%{smart_count} ends-in-one-except-eleven"] * 1 +
+        ["%{smart_count} ends-in-one-except-eleven"] * 1 +
+        ["%{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"] * 3 +
+        ["%{smart_count} ends-in-one-except-eleven"] * 16 +
+        ["%{smart_count} ends-in-one-except-eleven"] * 1 +
+        ["%{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"] * 3 +
+        ["%{smart_count} ends-in-one-except-eleven"] * 1
+      test_choose(review_text, :ru, answers)
+    end
+
+    it "should work with nil count" do
+      review_text = "%{smart_count} ends-in-one-except-eleven; %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen"
+      Air18n::SmartCount::choose(review_text, :ru, nil).should == "%{smart_count} ends-in-one-except-eleven"
+    end
+
+    it "should work with nil text" do
+      Air18n::SmartCount::choose(nil, :ru, nil).should == nil
+    end
+  end
+
+  describe 'hint' do
+    it 'should work' do
+      Air18n::SmartCount::hint('hi there', :pl).should be_nil
+      Air18n::SmartCount::hint('%{smart_count} reviews', :pl).should ==
+        'Count is 1; Count ends in 2-4, excluding 12-14 (2, 3, 4, 22, ...); Everything else (0, 5, 6, ...)'
+    end
+  end
+
+  describe 'dedupe_things_like_tags_or_variables' do
+    it 'should work' do
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :fr, [:a, :b, :a, :b]).should == [:a, :b]
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :ja, [:a, :b, :a, :b]).should == [:a, :a, :b, :b]
+
+      # Polish has 3 plural forms.
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :pl, [:a, :b, :a, :b]).should == []
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :pl, [:a, :b, :a, :b, :a, :b]).should == [:a, :b]
+
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :pl, [:a, :b, :a, :a, :b, :a, :a, :b, :a]).should == [:a, :a, :b]
+
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :pl, []).should == []
+    end
+
+    it 'should be unlenient if one variable is repeated less often than others' do
+      Air18n::SmartCount::dedupe_things_like_tags_or_variables(
+        :fr, [:a, :b, :a]).should == [:a]
+    end
+  end
+
+  describe "valid?" do
+    it 'should work' do
+      Air18n::SmartCount::valid?('%{smart_count} レビュー', :ja).should == { :valid => true }
+      Air18n::SmartCount::valid?('%{smart_count} commentaire; %{smart_count} commentaires', :fr).should == { :valid => true }
+      Air18n::SmartCount::valid?('%{smart_count} ends-in-one-except-eleven; %{smart_count} ends-in-two-through-four-except-twelve-through-fourteen; %{smart_count} everything-else', :pl).should == { :valid => true }
+
+      Air18n::SmartCount::valid?('%{smart_count} a; %{smart_count} b; %{smart_count} c', :fr).should == {
+        :valid => false,
+        :reason => "Must specify 2 forms separated by \";\" (3 were specified)"
+      }
+    end
+  end
+end

data/spec/lib/air18n/xss_detector_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
+# encoding: utf-8
 
+require 'spec_helper'
 require 'air18n/xss_detector'
+require 'air18n/logging_helper'
 
 describe Air18n::XssDetector do
   describe "has_dubious_escape_characters?" do
@@ -12,31 +14,78 @@ describe Air18n::XssDetector do
 
   describe "safe?" do
     it "should detect safe texts" do
-      Air18n::XssDetector::safe?("safe", "safe").should == { :safe => true }
-      Air18n::XssDetector::safe?("<tag>", "<tag>").should == { :safe => true }
-      Air18n::XssDetector::safe?("safe", { "safe" => "whatevs" }).should == { :safe => true }
+      Air18n::XssDetector::safe?("safe", "safe", :en, :fr).should == { :safe => true }
+      Air18n::XssDetector::safe?("<tag>", "<tag>", :en, :fr).should == { :safe => true }
+      Air18n::XssDetector::safe?("safe", { "safe" => "whatevs" }, :en, :fr).should == { :safe => true }
     end
 
     it "should detect dubious escape characters" do
-      Air18n::XssDetector::safe?("Let's escape a \\' there", "safe").should == { :safe => false, :reason => "Backslashes are not allowed" }
-      Air18n::XssDetector::safe?("safe", "Let's escape a \\' there").should == { :safe => false, :reason => "Backslashes are not allowed" }
+      Air18n::XssDetector::safe?("Let's escape a \\' there", "safe", :en, :fr).should == { :safe => false, :reason => "Backslashes are not allowed" }
+      Air18n::XssDetector::safe?("safe", "Let's escape a \\' there", :en, :fr).should == { :safe => false, :reason => "Backslashes are not allowed" }
     end
 
     it "should detect tag mismatches" do
-      Air18n::XssDetector::safe?("<tag>", "safe").should == { :safe => false, :reason => "HTML tags don't match: #{['<tag>'].inspect} vs. #{[].inspect}" }
-      Air18n::XssDetector::safe?("safe", "<tag>").should == { :safe => false, :reason => "HTML tags don't match: #{[].inspect} vs. #{['<tag>'].inspect}" }
-      Air18n::XssDetector::safe?("<b>safe</b>", "<b>safe</b><b>").should == { :safe => false, :reason => "HTML tags don't match: #{['<b>', '</b>'].inspect} vs. #{['<b>', '</b>', '<b>'].inspect}" }
+      Air18n::XssDetector::safe?("<tag>", "safe", :en, :fr).should == { :safe => false, :reason => "HTML tags don't match: #{['<tag>'].inspect} vs. #{[].inspect}" }
+      Air18n::XssDetector::safe?("safe", "<tag>", :en, :fr).should == { :safe => false, :reason => "HTML tags don't match: #{[].inspect} vs. #{['<tag>'].inspect}" }
+      Air18n::XssDetector::safe?("<b>safe</b>", "<b>safe</b><b>", :en, :fr).should == { :safe => false, :reason => "HTML tags don't match: #{['<b>', '</b>'].inspect} vs. #{['<b>', '</b>', '<b>'].inspect}" }
     end
 
     it "should allow quote mismatches in tags" do
-      Air18n::XssDetector::safe?("<a href='/help/question/280' target='_blank'>Why is this required?</a>", "<a href='/help/question/280' target='_blank'>...</a>").should == { :safe => true }
-      Air18n::XssDetector::safe?("<tag href='hi'>", "<tag href=\"hi\">").should == { :safe => true }
+      Air18n::XssDetector::safe?("<a href='/help/question/280' target='_blank'>Why is this required?</a>", "<a href='/help/question/280' target='_blank'>...</a>", :en, :fr).should == { :safe => true }
+      Air18n::XssDetector::safe?("<tag href='hi'>", "<tag href=\"hi\">", :en, :fr).should == { :safe => true }
     end
 
     it "should allow reordering tags" do
       Air18n::XssDetector::safe?(
         "<span class='count'>%{count}</span> %{pluralized_review} left in <a href='#listings/search/%{encoded_search}' class='search_link'>%{city}, %{state} %{country}</a>",
-        "in <a href='#listings/search/%{encoded_search}' class='search_link'>%{city}, %{state} %{country}</a> <span class='count'>%{count}</span> %{pluralized_review} left"
+        "in <a href='#listings/search/%{encoded_search}' class='search_link'>%{city}, %{state} %{country}</a> <span class='count'>%{count}</span> %{pluralized_review} left",
+        :en, :ko
+      ).should == { :safe => true }
+    end
+
+    it "should work with smart count with one plural form" do
+      Air18n::XssDetector::safe?(
+        "<span class='count'>%{smart_count}</span> <span class='text'>review</span>;<span class='count'>%{smart_count}</span> <span class='text'>reviews</span>",
+        "<span class='text'>レビュー</span> <span class='count'>%{smart_count}</span>",
+        :en, :ja
+      ).should == { :safe => true }
+
+      # "spank" instead of "span" in the last tag.
+      Air18n::XssDetector::safe?(
+        "<span class='count'>%{smart_count}</span> <span class='text'>review</span>;<span class='count'>%{smart_count}</span> <span class='text'>reviews</span>",
+        "<span class='text'>レビュー</span> <span class='count'>%{smart_count}</spank>",
+        :en, :ja
+      ).should == { :safe => false, :reason => "HTML tags don't match: [\"<span class='count'>\", \"</span>\", \"</span>\", \"<span class='text'>\"] vs. [\"<span class='text'>\", \"</span>\", \"<span class='count'>\", \"</spank>\"]" }
+    end
+
+    it "should work with smart count with two plural forms" do
+      Air18n::XssDetector::safe?(
+        "<span class='count'>%{smart_count}</span> <span class='text'>review</span>;<span class='count'>%{smart_count}</span> <span class='text'>reviews</span>",
+        "<span class='text'>commentaire</span> <span class='count'>%{smart_count}</span>;<span class='text'>commentaires</span> <span class='count'>%{smart_count}</span>",
+        :en, :fr
+      ).should == { :safe => true }
+
+      # Second form not styled.
+      Air18n::LoggingHelper.info "GRRRRR"
+      Air18n::XssDetector::safe?(
+        "<span class='count'>%{smart_count}</span> <span class='text'>review</span>;<span class='count'>%{smart_count}</span> <span class='text'>reviews</span>",
+        "<span class='text'>commentaire</span> <span class='count'>%{smart_count}</span>;commentaires %{smart_count}",
+        :en, :fr
+      ).should == { :safe => false, :reason => "HTML tags don't match: [\"<span class='count'>\", \"</span>\", \"</span>\", \"<span class='text'>\"] vs. [\"</span>\"]" }
+
+      # Only one form being given leads to the same error.
+      Air18n::XssDetector::safe?(
+        "<span class='count'>%{smart_count}</span> <span class='text'>review</span>;<span class='count'>%{smart_count}</span> <span class='text'>reviews</span>",
+        "<span class='text'>commentaire</span> <span class='count'>%{smart_count}</span>",
+        :en, :fr
+      ).should == { :safe => false, :reason => "HTML tags don't match: [\"<span class='count'>\", \"</span>\", \"</span>\", \"<span class='text'>\"] vs. [\"</span>\"]" }
+    end
+
+    it "should work with smart count with three plural forms" do
+      Air18n::XssDetector::safe?(
+        "<span class='count'>%{smart_count}</span> <span class='text'>review</span>;<span class='count'>%{smart_count}</span> <span class='text'>reviews</span>",
+        "<span class='text'>ends-in-one-except-eleven</span> <span class='count'>%{smart_count}</span>;<span class='text'>ends-in-two-through-four-except-twelve-through-fourteen</span> <span class='count'>%{smart_count}</span>;<span class='text'>everything-else</span> <span class='count'>%{smart_count}</span>",
+        :en, :ru
       ).should == { :safe => true }
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: air18n
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -161,6 +161,7 @@ files:
 - lib/air18n/pseudo_locales.rb
 - lib/air18n/reflection.rb
 - lib/air18n/screenshot.rb
+- lib/air18n/smart_count.rb
 - lib/air18n/testing_support/factories.rb
 - lib/air18n/testing_support/factories/phrase.rb
 - lib/air18n/testing_support/factories/phrase_screenshot.rb
@@ -177,6 +178,7 @@ files:
 - spec/lib/air18n/phrase_translation_spec.rb
 - spec/lib/air18n/prim_and_proper_spec.rb
 - spec/lib/air18n/pseudo_locales_spec.rb
+- spec/lib/air18n/smart_count_spec.rb
 - spec/lib/air18n/xss_detector_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.github.com/airbnb/air18n
@@ -212,5 +214,6 @@ test_files:
 - spec/lib/air18n/phrase_translation_spec.rb
 - spec/lib/air18n/prim_and_proper_spec.rb
 - spec/lib/air18n/pseudo_locales_spec.rb
+- spec/lib/air18n/smart_count_spec.rb
 - spec/lib/air18n/xss_detector_spec.rb
 - spec/spec_helper.rb