Merge branch 'master' into hybrid_storage

Author: vincentvanbush

lib/lit/cache.rb

@@ -49,11 +49,12 @@ def keys
       localizations.keys
     end
 
-    def update_locale(key, value, force_array = false)
+    def update_locale(key, value, force_array = false, unless_changed = false)
       key = key.to_s
       locale_key, key_without_locale = split_key(key)
       locale = find_locale(locale_key)
       localization = find_localization(locale, key_without_locale, value, force_array, true)
+      return localization.get_value if unless_changed && localization.is_changed?
       localizations[key] = localization.get_value if localization
     end
 
@@ -62,11 +63,11 @@ def update_cache(key, value)
       localizations[key] = value
     end
 
-    def delete_locale(key)
+    def delete_locale(key, unless_changed = false)
       key = key.to_s
       locale_key, key_without_locale = split_key(key)
       locale = find_locale(locale_key)
-      delete_localization(locale, key_without_locale)
+      delete_localization(locale, key_without_locale, unless_changed)
     end
 
     def load_all_translations
@@ -227,8 +228,9 @@ def find_localization_for_delete(locale, key_without_locale)
           where(localization_key_id: localization_key.id).first
     end
 
-    def delete_localization(locale, key_without_locale)
+    def delete_localization(locale, key_without_locale, unless_changed = false)
       localization = find_localization_for_delete(locale, key_without_locale)
+      return if unless_changed && localization.try(:is_changed?)
       if localization
         localizations.delete("#{locale.locale}.#{key_without_locale}")
         localization_keys.delete(key_without_locale)

lib/lit/i18n_backend.rb

@@ -83,24 +83,24 @@ def lookup(locale, key, scope = [], options = {})
       content
     end
 
-    def store_item(locale, data, scope = [])
+    def store_item(locale, data, scope = [], unless_changed = false)
       if data.respond_to?(:to_hash)
         data.to_hash.each do |key, value|
-          store_item(locale, value, scope + [key])
+          store_item(locale, value, scope + [key], unless_changed)
         end
       elsif data.respond_to?(:to_str)
         key = ([locale] + scope).join('.')
-        @cache[key] ||= data
+        @cache.update_locale(key, data, false, unless_changed)
       elsif data.nil?
         key = ([locale] + scope).join('.')
-        @cache.delete_locale(key)
+        @cache.delete_locale(key, unless_changed)
       end
     end
 
     def load_translations_to_cache
       ActiveRecord::Base.transaction do
         (@translations || {}).each do |locale, data|
-          store_item(locale, data) if valid_locale?(locale)
+          store_item(locale, data, [], true) if valid_locale?(locale)
         end
       end
     end

test/support/en.yml

@@ -0,0 +1,3 @@
+en:
+  foo: bar
+  nil_thing:

test/support/en_changed.yml

@@ -0,0 +1,3 @@
+en:
+  foo: barbar
+  nil_thing: not nil anymore

test/test_helper.rb

@@ -13,6 +13,11 @@
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
+# Helper for adding sample .yml file to load path
+def load_sample_yml(fname)
+  I18n.load_path << "#{File.dirname(__FILE__)}/support/#{fname}"
+end
+
 ActiveSupport::TestCase.fixture_path = File.expand_path('../fixtures', __FILE__)
 
 ## do not enforce available locales

test/unit/lit_behaviour_test.rb

@@ -136,6 +136,75 @@ def teardown
     Lit.loader = old_loader
   end
 
+  test 'it wont overwrite existing UI-changed values with those from yaml' do
+    load_sample_yml('en.yml')
+    old_loader = Lit.loader
+    Lit.loader = nil
+    Lit.init
+
+    # Defaults from yml: en.foo: bar, en.nil_thing: [nothing]
+    assert_equal 'bar', I18n.t('foo')
+    assert_equal 'no longer nil', I18n.t('nil_thing', default: 'no longer nil')
+
+    foo_loc = Lit::LocalizationKey.find_by_localization_key('foo').localizations.first
+    nil_loc = Lit::LocalizationKey.find_by_localization_key('nil_thing').localizations.first
+
+    # Check if default values have been loaded into DB
+    assert_equal 'bar', foo_loc.default_value
+    assert_equal 'no longer nil', nil_loc.default_value
+
+    # Translate as if it was done in UI (is_changed set to true)
+    foo_loc.update(translated_value: 'barbar', is_changed: true)
+    nil_loc.update(translated_value: 'new one', is_changed: true)
+    [foo_loc, nil_loc].each do |loc|
+      Lit.init.cache.update_cache loc.full_key, loc.get_value
+    end
+
+    # Translations should be changed as intended
+    assert_equal 'barbar', I18n.t('foo')
+    assert_equal 'new one', I18n.t('nil_thing')
+
+    # Reload Lit, UI-changed translations should be intact
+    Lit.loader = nil
+    Lit.init
+    assert_equal 'barbar', I18n.t('foo')
+    assert_equal 'new one', I18n.t('nil_thing')
+
+    Lit.loader = old_loader
+  end
+
+  test 'it will overwrite existing values with those from yaml for unchanged localizations' do
+    load_sample_yml('en.yml')
+    old_loader = Lit.loader
+    Lit.loader = nil
+    Lit.init
+
+    # Defaults from en.yml: en.foo: bar, en.nil_thing: [nothing]
+    assert_equal 'bar', I18n.t('foo')
+    assert_equal 'no longer nil', I18n.t('nil_thing', default: 'no longer nil')
+
+    foo_loc = Lit::LocalizationKey.find_by_localization_key('foo')
+                                  .localizations.first
+    nil_loc = Lit::LocalizationKey.find_by_localization_key('nil_thing')
+                                  .localizations.first
+
+    # Check if default values have been loaded into DB
+    assert_equal 'bar', foo_loc.default_value
+    assert_equal 'no longer nil', nil_loc.default_value
+
+    # Defaults from en_changed.yml en.foo: barbar, en.nil_thing: not nil anymore
+    # Swap yml file and reload Lit, changes in yml file should be visible
+    I18n.load_path = []
+    load_sample_yml('en_changed.yml')
+
+    Lit.loader = nil
+    Lit.init
+    assert_equal 'barbar', I18n.t('foo')
+    assert_equal 'not nil anymore', I18n.t('nil_thing')
+
+    Lit.loader = old_loader
+  end
+
   private
 
   def find_localization_for(key, locale)