air18n 0.1.30 → 0.1.31

data/lib/air18n/phrase_translation.rb

@@ -56,11 +56,97 @@ module Air18n
       all_locales
     end
 
+    def self.create_translation(phrase_id, phrase_key, target_locale, value, user_id, do_xss_check, allow_verification)
+      pt = PhraseTranslation.new
+      pt.user_id = user_id
+      pt.phrase_id = phrase_id
+      pt.key = phrase_key
+      pt.locale = target_locale
+
+      latest = pt.phrase.latest_translation(pt.locale)
+
+      pt.value = normalize_translation_value(value)
+      normalized_latest_value = latest.present? && normalize_translation_value(latest.value)
+
+      value_same_as_latest = pt.value == normalized_latest_value
+
+      if latest && value_same_as_latest && latest.is_stale && user_id == latest.user_id
+        latest.is_stale = false
+        if latest.save
+          response_obj = {
+            :status => 'success',
+            :message => 'Translation marked as up-to-date.',
+            :phrase_id => latest.phrase_id,
+            :key => latest.key,
+            :locale => latest.locale,
+            :value => latest.value,
+            :is_verification => latest.is_verification
+          }
+        else
+          response_obj = { :status => 'error', :message => latest.errors.values.join('; ') }
+        end
+      else
+        do_save = false
+        message = ""
+
+        safeness = XssDetector.safe?(pt.phrase.value, pt.value, I18n.default_locale, pt.locale)
+
+        if pt.value.empty?
+          message = "Translation empty; nothing saved."
+        elsif do_xss_check && !safeness[:safe]
+          message = safeness[:reason]
+        elsif (latest && value_same_as_latest) && (latest.user_id != 0)
+          if !allow_verification
+            allowed, error = false, "Verification of non-stale phrases is currently disabled in '#{pt.locale}'"
+          else
+            allowed, error = pt.verification_allowed?(latest)
+          end
+          if allowed
+            pt.is_verification = true
+            do_save = true
+            message = "Translation verified."
+          else
+            message = error
+          end
+        else
+          do_save = true
+          message = "Translation saved."
+        end
+
+        if do_save
+          if pt.save
+            response_obj = {
+              :status => 'success',
+              :message => message,
+              :phrase_id => pt.phrase_id,
+              :key => pt.key,
+              :locale => pt.locale,
+              :value => pt.value,
+              :is_verification => pt.is_verification
+            }
+          else
+            response_obj = {:status => 'error', :message => pt.errors.values.join('; ')}
+          end
+        else
+          response_obj = {:status => 'error', :message => message}
+        end
+      end
+
+      response_obj
+    end
+
+    # Computes monthly activity for months between opts[:since] and opts[:to].
+    # If opts[:to] is not set, starts from the current month.
+    # If opts[:since] is not set, goes back until a month in which there is no activity.
+    # If user_id is 0, computes activity for all users.
     def self.translator_activity_data_master(user_id = 0, opts = {})
-      d = Date.today.beginning_of_month
+      to_date = opts[:to] ? opts[:to] : Date.today
+      d = to_date.beginning_of_month
       activities = []
 
       while true
+        break if opts[:since] && d < opts[:since]
+
         if d < Date.new(2012, 8, 02)
           activity_for_month = translator_activity_data(user_id, opts.merge(:since => d, :to => (d >> 1)))
         elsif d < Date.new(2012, 10, 02)
@@ -69,7 +155,7 @@ module Air18n
           activity_for_month = translator_activity_data_v3(user_id, opts.merge(:since => d, :to => (d >> 1)))
         end
 
-        break if activity_for_month.blank? && !(user_id == 0 && d >= (Date.today - 2.years))
+        break if !opts[:since] && activity_for_month.blank?
 
         activities += activity_for_month
         d = d << 1
@@ -376,8 +462,16 @@ module Air18n
           compare_to = translation_pair[:previous_translation].scan(/[[:alnum:]]+/).size
         end
 
-        proportion_translated = [distance.to_f / compare_to.to_f, 1.0].min
-        proportion_verified = 1.0 - proportion_translated
+        if compare_to == 0
+          proportion_translated = 0.0
+          proportion_verified = 0.0
+
+          LoggingHelper.error("Word counts for weird pair: #{translation_pair.inspect}")
+          LoggingHelper.error("distance: #{distance.inspect}, compare to: #{compare_to.inspect}")
+        else
+          proportion_translated = [distance.to_f / compare_to.to_f, 1.0].min
+          proportion_verified = 1.0 - proportion_translated
+        end
       end
 
       [(translation_pair[:source_word_count] * proportion_translated).round,
@@ -637,6 +731,7 @@ module Air18n
     end
 
     private
+
     def quote_vars(vars)
       vars.map { |var| "%{#{var}}" }.join(", ")
     end
@@ -679,5 +774,17 @@ module Air18n
       # ap dm
       dm[input_b.length][input_a.length]
     end
+
+    # Called on every translation before it is stored in the database.
+    # Strips whitespace from ends and makes an attempt to remove spurious HTML
+    # changes like reordering of HTML attributes within tags.
+    def self.normalize_translation_value(value)
+      # Translators like to add extra whitespace, and extra whitespace sometimes
+      # messes up things!
+      # We also remove alt="" because ckeditor likes to add that for no reason,
+      # and it adds it in different order arbitrarily which makes translations
+      # change even when they don't really change.
+      value.strip.gsub(' alt=""', '')
+    end
   end
 end

data/lib/air18n/version.rb

@@ -1,3 +1,3 @@
 module Air18n
-  VERSION = "0.1.30"
+  VERSION = "0.1.31"
 end

data/spec/lib/air18n/phrase_translation_spec.rb

@@ -132,6 +132,88 @@ describe Air18n::PhraseTranslation do
     end
   end
 
+  context 'create_translation' do
+    it 'should create translations properly' do
+        phrase = FactoryGirl.create(:phrase, :key => 'create translation', :value => 'why hello there')
+        user_id_first = 9
+        user_id_second = 10
+        do_xss_check = true
+        allow_verification = true
+
+        ##### 1. First translation of new phrase.
+
+        response = Air18n::PhraseTranslation.create_translation(
+          phrase.id, phrase.key, :es, 'whyo helloo thereo newword0', user_id_first, do_xss_check, allow_verification)
+        response.should include(
+          :status => 'success', :message => 'Translation saved.')
+
+        translation = phrase.latest_translation(:es)
+        translation.value.should == 'whyo helloo thereo newword0'
+        translation.key.should == 'create translation'
+        translation.source_word_count.should == 3
+        translation.source_hash.should == "2ac1a5cdad0d3ca0b0c318000c2f7378"
+
+        ##### 2. Tweak to existing translation to add some words.
+
+        response = Air18n::PhraseTranslation.create_translation(
+          phrase.id, phrase.key, :es, 'whyo helloo newword1 thereo newword2', user_id_first, do_xss_check, allow_verification)
+
+        translation = phrase.latest_translation(:es)
+        translation.value.should == 'whyo helloo newword1 thereo newword2'
+        translation.source_word_count.should == 3
+        translation.source_hash.should == "2ac1a5cdad0d3ca0b0c318000c2f7378"
+
+        ##### 3. Tweak to existing translation to delete a word.
+
+        response = Air18n::PhraseTranslation.create_translation(
+          phrase.id, phrase.key, :es, 'whyo helloo newword1 newword2', user_id_first, do_xss_check, allow_verification)
+
+        translation = phrase.latest_translation(:es)
+        translation.value.should == 'whyo helloo newword1 newword2'
+        translation.source_word_count.should == 3
+        translation.source_hash.should == "2ac1a5cdad0d3ca0b0c318000c2f7378"
+
+        ##### 4. Submission of unchanged translation.
+
+        response = Air18n::PhraseTranslation.create_translation(
+          phrase.id, phrase.key, :es, 'whyo helloo newword1 newword2', user_id_first, do_xss_check, allow_verification)
+        response.should include(
+          :status => 'error', :message => 'You last translated this phrase, so somebody else must verify it.')
+
+        unchanged_translation = phrase.latest_translation(:es)
+        unchanged_translation.id.should == translation.id
+
+        ##### 5. Submission of unchanged translation for stale phrase.
+
+        phrase.value = 'why hello there, good day'
+        phrase.save!
+
+        response = Air18n::PhraseTranslation.create_translation(
+          phrase.id, phrase.key, :es, 'whyo helloo newword1 newword2', user_id_first, do_xss_check, allow_verification)
+        response.should include(
+          :status => 'success', :message => 'Translation marked as up-to-date.')
+
+        translation = phrase.latest_translation(:es)
+        translation.value.should == 'whyo helloo newword1 newword2'
+        translation.source_word_count.should == 3
+        translation.is_verification.should == false  # Not actually a verification.
+        translation.source_hash.should == "2ac1a5cdad0d3ca0b0c318000c2f7378"
+
+        ##### 6. Verification by a different translator.
+
+        response = Air18n::PhraseTranslation.create_translation(
+          phrase.id, phrase.key, :es, 'whyo helloo newword1 newword2', user_id_second, do_xss_check, allow_verification)
+        response.should include(
+          :status => 'success', :message => 'Translation verified.')
+
+        translation = phrase.latest_translation(:es)
+        translation.value.should == 'whyo helloo newword1 newword2'
+        translation.source_word_count.should == 5
+        translation.is_verification.should == true
+        translation.source_hash.should == "6f20684ed3e1fa2c9ccd30249d5c9f7a"
+    end
+  end
+
   context 'word counts' do
     it 'should keep track of translated and verified word count in old regime' do
       Air18n::PhraseTranslation.destroy_all
@@ -148,7 +230,7 @@ describe Air18n::PhraseTranslation do
         phrase_verification = FactoryGirl.create(:phrase_translation, :phrase => @phrase2, :user_id => @user2, :is_verification => true, :created_at => Date.new(2012, 05, 04))
       end
 
-      data = Air18n::PhraseTranslation.translator_activity_data_master
+      data = Air18n::PhraseTranslation.translator_activity_data_master(0, :since => Date.new(2012, 4, 1))
 
       data.should include(
         {:year=>2012,
@@ -198,7 +280,7 @@ describe Air18n::PhraseTranslation do
         verification = FactoryGirl.create(:phrase_translation, :value => 'oogie boogie boo', :phrase => @phrase1, :user_id => @user1, :source_hash => 'new default text', :source_word_count => 13, :is_verification => true, :created_at => Date.new(2012, 10, 5))
       end
 
-      data = Air18n::PhraseTranslation.translator_activity_data_master
+      data = Air18n::PhraseTranslation.translator_activity_data_master(0, :since => Date.new(2012, 9, 1))
 
       # Example Scenario:
       #   Translator A translates phrase Y when it is 8 English words
@@ -530,6 +612,21 @@ describe Air18n::PhraseTranslation do
         words_translated, words_verified = Air18n::PhraseTranslation.word_counts_from_translation_pair(pair)
         words_translated.should == 0
         words_verified.should == 1
+
+        pair = {
+          :translation=>".",
+          :previous_translation=>".",
+          :was_stale=>true,
+          :locale=>"pl",
+          :user_id=>2055948,
+          :previous_user_id=>1701571,
+          :datetime=>Date.new(2012, 11, 13),
+          :source_word_count=>0,
+          :phrase_key=>"helpers.label.collection.name"
+        }
+        words_translated, words_verified = Air18n::PhraseTranslation.word_counts_from_translation_pair(pair)
+        words_translated.should == 0
+        words_verified.should == 0
       end
 
       it 'should compute correct monthly activities' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: air18n
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.1.31
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2012-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n