air18n 0.4.1 → 0.4.2

data/lib/air18n/backend.rb

@@ -182,7 +182,11 @@ module Air18n
       #   I18n.t('foo', :default => 'Foo', :locale => @current_user.preferred_locale)
       locale = locale.to_sym
 
-      default = options[:default] && options[:default].is_a?(String) && options[:default]
+      default = if options[:default] && options[:default].is_a?(String)
+                  options[:default]
+                else
+                  nil
+                end
       overrides_previous_default = !options[:default_is_low_priority]
 
       I18n.fallbacks_for(locale).each do |l|

data/lib/air18n/phrase.rb

@@ -1,14 +1,18 @@
 module Air18n
   class Phrase < ActiveRecord::Base
     has_many :phrase_translations, :dependent=>:delete_all
-    has_many :phrase_revisions, :foreign_key => 'key', :primary_key => 'key', :dependent=>:delete_all
+    has_many :phrase_revisions, :foreign_key => :key, :primary_key => :key, :dependent=>:delete_all
     has_many :phrase_screenshots, :foreign_key => 'phrase_key', :primary_key => 'key', :dependent=>:delete_all
 
     after_update :mark_translations_stale
     after_update :record_phrase_revision
 
+    after_create :copy_existing_translations
+
     validates_uniqueness_of :key
 
+    # When we change a phrase's text, we mark its existing translations as
+    # stale.
     def mark_translations_stale
       translations = PhraseTranslation.find_all_by_phrase_id(id)
       translations.each do |translation|
@@ -20,6 +24,8 @@ module Air18n
       end
     end
 
+    # When we change a phrase's text, we record the text. This is so we have a
+    # record of all default texts that a phrase key has taken on in the past.
     def record_phrase_revision
       value_hash = compute_value_hash
       if value_hash.present?
@@ -27,11 +33,52 @@ module Air18n
       end
     end
 
+    # When we create a phrase with the same default text as an existing phrase,
+    # we copy the older phrase's existing translations over.
+    def copy_existing_translations
+      existing_phrase = Phrase.
+          where(:value => self.value).
+          where('`phrases`.id < ?', self.id).
+          last
+      if existing_phrase.present?
+        translations = PhraseTranslation.
+            where(:phrase_id => existing_phrase.id).
+            latest.
+            order('`phrase_translations`.id DESC')
+        translations_by_language = translations.group_by do |pt|
+          I18n.language_from_locale(pt.locale)
+        end
+
+        # We do some gymnastics here to create the translations so that we
+        # create the ones for e.g. "zh" after the ones for "zh-TW" .
+        #
+        # This is because translations for specific locales are sometimes
+        # generated from the more general locale.
+        translations_by_language.each do |language, translations|
+          translations_with_language_last = translations.sort_by do |pt|
+            -pt.locale.to_s.size
+          end
+          translations_with_language_last.each do |pt|
+            PhraseTranslation.create_translation(
+              self.id,
+              self.key,
+              pt.locale,
+              pt.value,
+              0,  # user ID: 0 means automated
+              false,  # do xss check? no
+              false  # allow verification? no
+            )
+          end
+        end
+      end
+    end
+
     def compute_value_hash
       value.present? ? Digest::MD5.new.update(value).to_s : ""
     end
 
     # TODO(jkb) retire this method, it is very old and ugly.
+    # It is used by the contextual translations code.
     def self.by_key lookup
       if !@by_key then
         @by_key = {}

data/lib/air18n/version.rb

@@ -1,3 +1,3 @@
 module Air18n
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/spec/lib/air18n/backend_spec.rb

@@ -65,6 +65,16 @@ describe Air18n::Backend do
     it 'should not barf on arrays' do
       @backend.lookup(I18n.default_locale, ['january', 'february'], @scope).should == nil
     end
+
+    it 'should not store or return default hashes' do
+      @backend.lookup(
+        I18n.default_locale, 'translation hash', @scope, :default => {}
+      ).should == nil
+      @backend.lookup(I18n.default_locale, 'translation hash', @scope).should == nil
+
+      # Should not have created a phrase for this new key.
+      Air18n::Phrase.find_by_key('translation hash').should_not be_present
+    end
   end
 
   context 'I18n backend initialization' do

data/spec/lib/air18n/phrase_spec.rb

@@ -3,25 +3,57 @@
 require 'spec_helper'
 
 describe Air18n::Phrase do
-  context 'revisions' do
-    it "should keep track of its revisions" do
+  context 'creating a new phrase' do
+    it 'should keep track of its revisions' do
       phrase = FactoryGirl.create(:phrase, :key => 'revisions key')
-      phrase.value = "new value"
+      phrase.value = 'new value'
       phrase.save!
       phrase.phrase_revisions.size.should == 1
-      phrase.phrase_revisions.first.value_hash.should == "14979451a8c46ae1691eb3aedab3359d"
+      phrase.phrase_revisions.first.value_hash.should == '14979451a8c46ae1691eb3aedab3359d'
 
-      phrase.value = "second value"
+      phrase.value = 'second value'
       phrase.save!
       revisions = phrase.revisions_in_order
-      revisions.map(&:value_hash).should == ["14979451a8c46ae1691eb3aedab3359d", "5d10ab09a3cd6e0227c2c79fd8e525b7"]
+      revisions.map(&:value_hash).should == ['14979451a8c46ae1691eb3aedab3359d', '5d10ab09a3cd6e0227c2c79fd8e525b7']
 
-      phrase.value = "new value"
+      phrase.value = 'new value'
       phrase.save!
       revisions = phrase.revisions_in_order
-      revisions.map(&:value_hash).should == ["14979451a8c46ae1691eb3aedab3359d", "5d10ab09a3cd6e0227c2c79fd8e525b7"]
-      Air18n::PhraseRevision.value_from_hash('revisions key', "14979451a8c46ae1691eb3aedab3359d").should == "new value"
-      Air18n::PhraseRevision.value_from_hash('revisions key', "5d10ab09a3cd6e0227c2c79fd8e525b7").should == "second value"
+      revisions.map(&:value_hash).should == ['14979451a8c46ae1691eb3aedab3359d', '5d10ab09a3cd6e0227c2c79fd8e525b7']
+      Air18n::PhraseRevision.value_from_hash('revisions key', '14979451a8c46ae1691eb3aedab3359d').should == 'new value'
+      Air18n::PhraseRevision.value_from_hash('revisions key', '5d10ab09a3cd6e0227c2c79fd8e525b7').should == 'second value'
+    end
+
+    it 'should copy over existing translations' do
+      # Create an old phrase that we don't want to copy the translations of.
+      @phrase0 = FactoryGirl.create(:phrase, :key => 'copying, key 0', :value => 'copying, value 1')
+      FactoryGirl.create(:phrase_translation,
+                         :phrase => @phrase0,
+                         :value => 'copying, old Traditional Chinese value 1',
+                         :locale => :"zh-TW")
+
+      # Create a phrase that we do want to copy the translations of.
+      @phrase1 = FactoryGirl.create(:phrase, :key => 'copying, key 1', :value => 'copying, value 1')
+      FactoryGirl.create(:phrase_translation,
+                         :phrase => @phrase1,
+                         :value => 'copying, Simplified Chinese value 1',
+                         :locale => :"zh")
+      FactoryGirl.create(:phrase_translation,
+                         :phrase => @phrase1,
+                         :value => 'copying, Traditional Chinese value 1',
+                         :locale => :"zh-TW")
+      FactoryGirl.create(:phrase_translation,
+                         :phrase => @phrase1,
+                         :value => 'copying, French value 1',
+                         :locale => :fr)
+
+      # Create a phrase with the same default text.
+      @phrase2 = FactoryGirl.create(:phrase, :key => 'copying, key 2', :value => 'copying, value 1')
+
+      # Should have three translations auto-populated.
+      @phrase2.phrase_translations.size.should == 3
+
+      @phrase2.latest_translation(:"zh-TW").id.should < @phrase2.latest_translation(:zh).id
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: air18n
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n